FlightGear wiki - User contributions [en]

User:Elgaton/Draft:Translate FlightGear

2018-08-08T15:38:03Z

Elgaton: Initial version

{{WIP}}

FlightGear supports localization, that is, showing the user interface in the user's native language rather than in English. At the time of writing (August 2018), not all parts of the simulator are localized, but efforts are underway to make it so.

This page will help you translate FlightGear to a new language or improve the existing translations.

== What can be translated ==
The following parts of the simulator can be translated:
* the menus, splash screens, startup tips and the text shown when the <code>--help</code> command-line option is used (FlightGear 2.7.0 and later);
* the shortcut file on Linux systems (FlightGear 2017.1 and later);
* the man pages (FlightGear 2017.3 and later).

== How to translate the interface ==
Each language in the world has an associated two-letter code (the ISO 639-1 language code). You can find their list on the [https://www.loc.gov/standards/iso639-2/php/code_list.php Library of Congress Web site].

Interface language files are saved in [{{fgdata url|path=Translations}} the Translations directory in the FGDATA repository]; each language is stored inside a directory having the corresponding ISO 639-1 code as its name.

There is also a [{{fgdata url|path=python3-flightgear}} set of translation helper scripts] which help you create a new translation or update an existing one.

=== Preparing the translation environment ===
On the machine you are going to use to translate FlightGear, install:
* '''Python 3''': on Microsoft Windows and Mac OS X systems, download the latest 3.x build from the [https://www.python.org/downloads/ official site]; on Linux, install it from your distribution's package manager;
* '''Git''': on Microsoft Windows, download it from the [https://git-scm.com/ official site]; on Mac OS X, run <code>git --help</code> from a terminal to have it downloaded and installed if needed; on Linux, install it from your distribution's package manager;
* an editor for XLIFF files, like [http://doc.qt.io/qt-5/linguist-translators.html QT Linguist].

Open a terminal, go into the directory you would like to clone the repositories into and type the following command to clone the FGMeta repository:
$ git clone git://git.code.sf.net/p/flightgear/fgmeta/ fgmeta
Then, follow the instructions in [[FlightGear Git: data developers#Preparations]] to clone FGData ''inside'' the <code>fgmeta</code> directory.

=== Translating the interface into a new language ===
If there is no translation for your language:
<ol>
<li>Check the <code>PLURAL_FORMS</code> variable inside [{{fgmeta url|path=python3-flightgear/flightgear/meta/i18n.py}} python3-flightgear/flightgear/meta/i18n.py] to make sure that your language is listed. If it is not, add a new entry for it - it should have the following form:
<pre>
"LANGUAGE_CODE": ["singular", "plural"],
</pre>
where <code><i>LANGUAGE_CODE</i></code> is the language code and what follows is an array of plural forms for the language (in the same order as they are displayed in the Qt Linguist tool).</li>
<li>Open a terminal and change into the <code>python3-flightgear</code> directory inside your FGData clone.</li>
<li>Run <code>./fg-new-translations --transl-dir="<i>FGDATA_CLONE_PATH</i>/Translations" <i>LANGUAGE_CODE</i></code> to create the new files. Replace <code><i>FGDATA_CLONE_PATH</i></code> with the path of the directory you cloned FGData into and <code><i>LANGUAGE_CODE</i></code> with the language code.</li>
</ol>

=== Updating an existing translation ===
If a translation for your language already exists:
# Open a terminal and change into the <code>python3-flightgear</code> directory inside your FGData clone.
# Run <code>./fg-update-translation-files --transl-dir="<i>FGDATA_CLONE_PATH</i>/Translations" merge-new-master <i>LANGUAGE_CODE</i></code> to update the translation files. Replace <code><i>FGDATA_CLONE_PATH</i></code> with the path of the directory you cloned FGData into and <code><i>LANGUAGE_CODE</i></code> with the language code.

=== Translating the files ===
# Open the XLT files inside <code><i>FGDATA_CLONE_PATH</i>/Translations/<i>LANGUAGE_CODE</i></code> with the XLIFF file editor and translate them.
# If you want to test your translation, you will need to [[Building FlightGear|build the latest FlightGear version from source]]. After you have built it, start FlightGear to test your translation, passing the <code>--fg-root=<i>FGDATA_CLONE_PATH</i></code> option to have it read the translations from your FGData clone. By default, the simulator will select the locale of your operating system as the language to use; you can explicitly select a language using the command-line option <code>--language=<i>LANGUAGE_CODE</i></code>.

Note that the user interface might have not full Unicode support (some special/accented characters might not be shown): should you encounter such a location, please write to the flightgear-devel mailing list at {{Mailing list e-mail address|flightgear-devel}}.

== How to translate the shortcut file ==
Open [{{flightgear url|path=package/org.flightgear.FlightGear.desktop}} the FlightGear <code>.desktop</code> file] and translate the ''GenericName'', ''Comment'' and ''Keywords'' keys (add the <code>GenericName[<i>LANGUAGE_CODE</i>]</code>, <code>Comment[<i>LANGUAGE_CODE</i>]</code> and <code>Keywords[<i>LANGUAGE_CODE</i>]</code> keys, where <code><i>LANGUAGE_CODE</i></code> is the two letter ISO 639-1 code of the language).

== How to translate the man pages ==
# Determine the two letter ISO 639-1 language code for the language you want to translate the man pages to.
# Check whether your language already has a subdirectory below [{{flightgear url|path=man}} the man pages directory]. If it does not, create an empty directory in it named after the language code, then copy <code>man1</code> and <code>man5</code> from the man pages directory to the directory of your language.
# Edit [{{flightgear url|path=man/CMakeLists.txt}} man/CMakeLists.txt] and add the instruction <code>add_subdirectory(LANGUAGE_CODE)</code> in the <code>if(NOT WIN32)</code> block (where ''LANGUAGE_CODE'' is the language code).
# Edit <code>man/LANGUAGE_CODE/man1/CMakeLists.txt</code> and <code>man/LANGUAGE_CODE/man5/CMakeLists.txt</code>: on the last row, set the installation directory (<code>DESTINATION</code>), respectively, to <code>${CMAKE_INSTALL_MANDIR}/LANGUAGE_CODE/man1</code> and <code>${CMAKE_INSTALL_MANDIR}/LANGUAGE_CODE/man5</code>.
# Open the man pages in the subdirectory of your language and translate them.

== Related content ==
* [[Howto: Translate FlightGear Launch Control‎‎]]
* [[Translation requests]]

[[Category:Howto|Translate FlightGear]]

Cessna 172P/info

2017-12-09T15:41:17Z

Elgaton: Translate the template to Italian

<includeonly>{{infobox aircraft
| name = Cessna 172P Skyhawk
| hangar = fgdata
| image = c172p-thumbnail.jpg
| image2 = C172p-cockpit2.jpg
| type = Civil aircraft/Civil utility aircraft
| config = High wing aircraft/Fixed gear aircraft
| propulsion = Propeller aircraft/Single-engine aircraft
| manufacturer = Cessna
| authors = David Megginson/Gilberto Agostinho/Wayne Bragg/Juan Vera del Campo/onox/Fernando Barbosa/Daniel Dubreuil/Jonathan Schellhase/Israel Hernandez/Tuomas Kuosmanen/Anders Gidenstam/Waldo Kitty/algefaen
| fdm = JSBSim
| fgname = c172p
| status-fdm = 4
| status-systems = 5
| status-cockpit = 5
| status-model = 4
| ready = tutorials/checklist
| devel-repo = {{github url|user=Juanvvc|repo=c172p-detailed}}
| download = {{github zip file|user=Juanvvc|repo=c172p-detailed|full=1}}
| liverydbid = 70
| forumtid = 25157
| note = {{LangSwitch
| ar = هذه هيا طائرة فلايت جير الإفتراضية ويتم توزيعها كجزء من حزمة البرنامج
| en = This is the default FlightGear aircraft and is distributed as part of the base package.
| de = Dies ist das FlightGear Standardflugzeug und im Basispaket der Software enthalten.
| es = Este es el avión predeterminado de FlightGear y se distribuye como parte de la descarga de FlightGear.
| it = Questo è l'aeromobile predefinito di FlightGear ed è distribuito come parte del pacchetto di base.
| zh = 这是FlightGear的默认机型，并被包括在FlightGear主程序中。
}}
| navbar = 1
}}</includeonly><noinclude>
This is the aircraft infobox subpage of the [[Cessna 172P]].
[[Category:Aircraft infobox documentation]]
</noinclude>

Template:Infobox aircraft

2017-12-09T15:40:17Z

Elgaton: Partially translate the template to Italian

<includeonly>{{Infobox
| title = {{{name|{{LangSwitch
| de = Unbekanntes Flugzeug
| en = Unknown Aircraft
| es = Avión desconocido
| fr = Aéronef Inconnu
| it = Aeromobile sconosciuto
| th = เครื่องบินที่ไม่รู้จัก
| zh = 未知机型
}}
}}}
| above{{#if:{{{hangar|}}}||NULL}}
= {{hangar banner|{{{hangar}}}}}
| image = {{#if: {{{image|}}}
| [[File:{{{image}}}|300px|{{{alt|}}}]]
| [[Special:UploadWizard|{{LangSwitch
| de = Benötigt ein Bild
| en = Image requested
| es = Necesita una imagen
| it = Immagine richiesta
| th = ถ่ายรูปเครื่องบินนี้เลยสิ!
| zh = 需要图片
}}]] [[Category:Aircraft requiring a screenshot]]
}}
| caption = {{{alt|}}}
| image2 = {{#if: {{{image2|}}}
| [[File:{{{image2}}}{{!}}300px|{{{alt2|}}}]]
| [[Category:Aircraft requiring a cockpit screenshot]]
}}
| caption2 = {{{alt2|}}}
| label1 = {{LangSwitch
| de = Typ
| en = Type
| es = Tipo
| fr = Type
| it = Tipo
| ja = て
| nl = Type
| pl = Typu
| pt = Tipo
| ru = тип
| th = ชนิดเครื่องบิน
| zh = 类型
}}
| data1 = {{craft type|{{#titleparts:/{{{type|}}}|1|2}}}}{{craft type|{{#titleparts:/{{{type|}}}|1|3}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|4}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|5}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|6}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|7}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|8}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|9}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|10}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|11}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|12}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|13}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|14}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|15}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|16}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|17}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|18}}|pre=, <nowiki></nowiki>}}{{craft type|{{#titleparts:/{{{type|}}}|1|19}}|pre=, <nowiki></nowiki>}}
| label2 = {{LangSwitch
| de = Konfiguration
| en = Configuration
| es = Configuración
| fi = Kokoonpanoon
| fr = Configuration
| it = Configurazione
| ja = 設定
| nl = Configuratie
| pl = Konfiguracja
| pt = Configuração
| ru = конфигурация
| th = โครงสร้างของเครื่องบิน
| zh = 构型
}}
| data2 = {{craft configuration|{{#titleparts:/{{{config|}}}|1|2}}}}{{craft configuration|{{#titleparts:/{{{config|}}}|1|3}}|pre=, <nowiki></nowiki>}}{{craft configuration|{{#titleparts:/{{{config|}}}|1|4}}|pre=, <nowiki></nowiki>}}{{craft configuration|{{#titleparts:/{{{config|}}}|1|5}}|pre=, <nowiki></nowiki>}}{{craft configuration|{{#titleparts:/{{{config|}}}|1|6}}|pre=, <nowiki></nowiki>}}{{craft configuration|{{#titleparts:/{{{config|}}}|1|7}}|pre=, <nowiki></nowiki>}}{{craft configuration|{{#titleparts:/{{{config|}}}|1|8}}|pre=, <nowiki></nowiki>}}{{craft configuration|{{#titleparts:/{{{config|}}}|1|9}}|pre=, <nowiki></nowiki>}}
| label3 = {{LangSwitch
| de = Antrieb
| en = Propulsion
| es = Propulsión
| fr = Propulsion
| it = Propulsione
| ja = 推進
| nl = Aandrijving
| pt = Propulsão
| ru = движение
| th = เครื่องยนต์
| zh = 动力
}}
| data3 = {{craft propulsion|{{#titleparts:/{{{propulsion|}}}|1|2}}}}{{craft propulsion|{{#titleparts:/{{{propulsion|}}}|1|3}}|pre=, <nowiki></nowiki>}}{{craft propulsion|{{#titleparts:/{{{propulsion|}}}|1|4}}|pre=, <nowiki></nowiki>}}{{craft propulsion|{{#titleparts:/{{{propulsion|}}}|1|5}}|pre=, <nowiki></nowiki>}}{{craft propulsion|{{#titleparts:/{{{propulsion|}}}|1|6}}|pre=, <nowiki></nowiki>}}{{craft propulsion|{{#titleparts:/{{{propulsion|}}}|1|7}}|pre=, <nowiki></nowiki>}}{{craft propulsion|{{#titleparts:/{{{propulsion|}}}|1|8}}|pre=, <nowiki></nowiki>}}{{craft propulsion|{{#titleparts:/{{{propulsion|}}}|1|9}}|pre=, <nowiki></nowiki>}}
| label4 = {{LangSwitch
| de = Hersteller
| en = Manufacturer
| es = Fabricante
| fr = Constructeur
| it = Costruttore
| ja = メーカー
| nl = Fabrikant
| pl = Producent
| pt = Fabricante
| ru = производитель
| th = ผู้ผลิต
| zh = 制造商
}}
| data4 = {{craft manufacturer|{{#titleparts:/{{{manufacturer|}}}|1|2}}}}{{craft manufacturer|{{#titleparts:/{{{manufacturer|}}}|1|3}}|pre=, <nowiki></nowiki>}}{{craft manufacturer|{{#titleparts:/{{{manufacturer|}}}|1|4}}|pre=, <nowiki></nowiki>}}{{craft manufacturer|{{#titleparts:/{{{manufacturer|}}}|1|5}}|pre=, <nowiki></nowiki>}}{{craft manufacturer|{{#titleparts:/{{{manufacturer|}}}|1|6}}|pre=, <nowiki></nowiki>}}{{craft manufacturer|{{#titleparts:/{{{manufacturer|}}}|1|7}}|pre=, <nowiki></nowiki>}}{{craft manufacturer|{{#titleparts:/{{{manufacturer|}}}|1|8}}|pre=, <nowiki></nowiki>}}{{craft manufacturer|{{#titleparts:/{{{manufacturer|}}}|1|9}}|pre=, <nowiki></nowiki>}}
| label5 = {{LangSwitch
| de = Autor(en)
| en = Author(s)
| es = Autor(es)
| fr = Créateur(s)
| it = Autore/i
| th = ผู้สร้าง(ใน FlightGear)
| zh = 作者
}}
| data5 = {{#if: {{{devel-team|}}} | <div class="toccolours mw-collapsible mw-collapsed" style="padding: 0px; border: none">{{{devel-team}}}<div class="mw-collapsible-content">}}{{#if: {{{authors|{{{author1|}}}}}}
| {{#if: {{#titleparts:/{{{authors|}}}|1|3}} 
| {{#if: {{#titleparts:/{{{authors|}}}|1|2}} | * {{#titleparts:/{{{authors|}}}|1|2}} }}
| {{#if: {{{author1|}}}
| {{#if: {{{authors|}}}
| {{#if: {{#titleparts:/{{{authors|}}}|1|2}} | * {{#titleparts:/{{{authors|}}}|1|2}} }}
| {{#if: {{#titleparts:/{{{authors|}}}|1|2}} | {{#titleparts:/{{{authors|}}}|1|2}} }}
}}
| {{#if: {{#titleparts:/{{{authors|}}}|1|2}} | {{#titleparts:/{{{authors|}}}|1|2}} }}
}}
}}{{#if: {{#titleparts:/{{{authors|}}}|1|3}} | * {{#titleparts:/{{{authors|}}}|1|3}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|4}} | * {{#titleparts:/{{{authors|}}}|1|4}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|5}} | * {{#titleparts:/{{{authors|}}}|1|5}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|6}} | * {{#titleparts:/{{{authors|}}}|1|6}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|7}} | * {{#titleparts:/{{{authors|}}}|1|7}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|8}} | * {{#titleparts:/{{{authors|}}}|1|8}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|9}} | * {{#titleparts:/{{{authors|}}}|1|9}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|10}} | * {{#titleparts:/{{{authors|}}}|1|10}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|11}} | * {{#titleparts:/{{{authors|}}}|1|11}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|12}} | * {{#titleparts:/{{{authors|}}}|1|12}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|13}} | * {{#titleparts:/{{{authors|}}}|1|13}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|14}} | * {{#titleparts:/{{{authors|}}}|1|14}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|15}} | * {{#titleparts:/{{{authors|}}}|1|15}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|16}} | * {{#titleparts:/{{{authors|}}}|1|16}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|17}} | * {{#titleparts:/{{{authors|}}}|1|17}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|18}} | * {{#titleparts:/{{{authors|}}}|1|18}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|19}} | * {{#titleparts:/{{{authors|}}}|1|19}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|20}} | * {{#titleparts:/{{{authors|}}}|1|20}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|21}} | * {{#titleparts:/{{{authors|}}}|1|21}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|22}} | * {{#titleparts:/{{{authors|}}}|1|22}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|23}} | * {{#titleparts:/{{{authors|}}}|1|23}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|24}} | * {{#titleparts:/{{{authors|}}}|1|24}} }}{{#if: {{#titleparts:/{{{authors|}}}|1|25}} | * {{#titleparts:/{{{authors|}}}|1|25}} }}{{#if: {{{authors|}}} 
| {{#if: {{{author1|}}} | * {{{author1}}} }}
| {{#if: {{{author2|}}}
| {{#if: {{{author1|}}} | * {{{author1}}} }}
| {{#if: {{{author1|}}} | {{{author1}}} }}
}}
}}{{#if: {{{author2|}}} | * {{{author2}}} }}{{#if: {{{author3|}}} | * {{{author3}}} }}{{#if: {{{author4|}}} | * {{{author4}}} }}{{#if: {{{author5|}}} | * {{{author5}}} }}{{#if: {{{author6|}}} | * {{{author6}}} }}{{#if: {{{author7|}}} | * {{{author7}}} }}{{#if: {{{author8|}}} | * {{{author8}}} }}{{#if: {{{author9|}}} | * {{{author9}}} }}{{#if: {{{author10|}}} | * {{{author10}}} }}{{#if: {{{author11|}}} | * {{{author11}}} }}{{#if: {{{author12|}}} | * {{{author12}}} }}{{#if: {{{author13|}}} | * {{{author13}}} }}{{#if: {{{author14|}}} | * {{{author14}}} }}{{#if: {{{author15|}}} | * {{{author15}}} }}{{#if: {{{author16|}}} | * {{{author16}}} }}{{#if: {{{author17|}}} | * {{{author17}}} }}{{#if: {{{author18|}}} | * {{{author18}}} }}{{#if: {{{author19|}}} | * {{{author19}}} }}{{#if: {{{author20|}}} | * {{{author20}}} }}{{#if: {{{author21|}}} | * {{{author21}}} }}{{#if: {{{author22|}}} | * {{{author22}}} }}{{#if: {{{author23|}}} | * {{{author23}}} }}{{#if: {{{author24|}}} | * {{{author24}}} }}{{#if: {{{author25|}}} | * {{{author25}}} }}{{#if: {{{author26|}}} | * {{{author26}}} }}{{#if: {{{author27|}}} | * {{{author27}}} }}{{#if: {{{author28|}}} | * {{{author28}}} }}{{#if: {{{author29|}}} | * {{{author29}}} }}{{#if: {{{author30|}}} | * {{{author30}}} }}
| {{LangSwitch
| de = Unbekannt
| en = Unknown
| es = Desconocido
| fr = Inconnu
| it = Sconosciuto
| th = ไม่ทราบ
| zh = 未知
}}
}}{{#if: {{{devel-team|}}} | </div></div>}}
| label6 = FDM
| data6 = {{#if: {{{fdm|}}}
| {{FDM link|{{#titleparts:/{{{fdm|}}}|1|2}}}}{{FDM link|{{#titleparts:/{{{fdm|}}}|1|3}}|pre=, <nowiki></nowiki>}}{{FDM link|{{#titleparts:/{{{fdm|}}}|1|4}}|pre=, <nowiki></nowiki>}}{{FDM link|{{#titleparts:/{{{fdm|}}}|1|5}}|pre=, <nowiki></nowiki>}}{{FDM link|{{#titleparts:/{{{fdm|}}}|1|6}}|pre=, <nowiki></nowiki>}}{{FDM link|{{#titleparts:/{{{fdm|}}}|1|7}}|pre=, <nowiki></nowiki>}}{{FDM link|{{#titleparts:/{{{fdm|}}}|1|8}}|pre=, <nowiki></nowiki>}}{{FDM link|{{#titleparts:/{{{fdm|}}}|1|9}}|pre=, <nowiki></nowiki>}}
| {{LangSwitch
| de = Unbekannt
| en = Unknown
| es = Desconocido
| fr = Inconnu
| it = Sconosciuto
| th = ไม่ทราบ
| zh = 未知
}}
}}
| label7 = --aircraft=
| data7 = {{#if: {{{fgname|}}}
| {{#if: {{#titleparts:/{{{fgname|}}}|1|2}} | <tt>{{#titleparts:/{{{fgname|}}}|1|2}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|3}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|3}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|4}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|4}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|5}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|5}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|6}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|6}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|7}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|7}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|8}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|8}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|9}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|9}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|10}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|10}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|11}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|11}}</tt>}}{{#if: {{#titleparts:/{{{fgname|}}}|1|12}} | <tt><br/>{{#titleparts:/{{{fgname|}}}|1|12}}</tt>}}
}}{{#if: {{{fgname1|}}}
| {{#if: {{{fgname|}}}
| <tt><br/>{{{fgname1}}}</tt>
| <tt>{{{fgname1}}}</tt>
}}
}}{{#if: {{{fgname2|}}} | <tt><br/>{{{fgname2}}}</tt>}}{{#if: {{{fgname3|}}} | <tt><br/>{{{fgname3}}}</tt>}}{{#if: {{{fgname4|}}} | <tt><br/>{{{fgname4}}}</tt>}}{{#if: {{{fgname5|}}} | <tt><br/>{{{fgname5}}}</tt>}}{{#if: {{{fgname6|}}} | <tt><br/>{{{fgname6}}}</tt>}}{{#if: {{{fgname7|}}} | <tt><br/>{{{fgname7}}}</tt>}}{{#if: {{{fgname8|}}} | <tt><br/>{{{fgname8}}}</tt>}}{{#if: {{{fgname9|}}} | <tt><br/>{{{fgname9}}}</tt>}}{{#if: {{{fgname10|}}} | <tt><br/>{{{fgname10}}}</tt>}}
| label8 = {{LangSwitch
| de = Stand
| en = Status
| es = Estado
| fr = Etat
| it = Stato
| ja = ステータス
| nl = Status
| pl = Status
| pt = Situação
| ru = статус
| th = คะแนนความละเอียด
| zh = 开发状况
}}
| data8 = {{#if: {{{status-fdm|}}}
| {{#ifexpr: {{#expr: {{{status-fdm|}}}+{{{status-systems|}}}+{{{status-cockpit|}}}+{{{status-model|}}} }} > 17
| {{LangSwitch
| de = [[De/Flugzeugbewertung#Gesamtwertung|Fortgeschrittene Produktion]]
| en = [[Aircraft rating system#Overall status|Advanced production]]
| es = [[Aircraft rating system#Overall status|Producción avanzada]]
| fr = [[Fr/Aircraft status indication#Statut global|Production avancée]]
}}
[[Category:Aircraft status: Advanced production]]
| {{#ifexpr: {{#expr: {{{status-fdm|}}}+{{{status-systems|}}}+{{{status-cockpit|}}}+{{{status-model|}}} }} > 15
| {{LangSwitch
| de = [[De/Flugzeugbewertung#Gesamtwertung|Produktion]]
| en = [[Aircraft rating system#Overall status|Production]]
| es = [[Aircraft rating system#Overall status|Producción]]
| fr = [[Fr/Aircraft status indication#Statut global|Production]]
}}
[[Category:Aircraft status: Production]]
| {{#ifexpr: {{#expr: {{{status-fdm|}}}+{{{status-systems|}}}+{{{status-cockpit|}}}+{{{status-model|}}} }} > 11
| {{LangSwitch
| de = [[De/Flugzeugbewertung#Gesamtwertung|Frühe Produktion]]
| en = [[Aircraft rating system#Overall status|Early production]]
| es = [[Aircraft rating system#Overall status|Producción temprana]]
| fr = [[Fr/Aircraft status indication#Statut global|Production précoce]]
}}
[[Category:Aircraft status: Early production]]
| {{#ifexpr: {{#expr: {{{status-fdm|}}}+{{{status-systems|}}}+{{{status-cockpit|}}}+{{{status-model|}}} }} > 8
| {{LangSwitch
| de = [[De/Flugzeugbewertung#Gesamtwertung|Beta]]
| en = [[Aircraft rating system#Overall status|Beta]]
| fr = [[Fr/Aircraft status indication#Statut global|Bêta]]
}}
[[Category:Aircraft status: Beta]]
| {{#ifexpr: {{#expr: {{{status-fdm|}}}+{{{status-systems|}}}+{{{status-cockpit|}}}+{{{status-model|}}} }} < 9
| {{LangSwitch
| de = [[De/Flugzeugbewertung#Gesamtwertung|Alpha]]
| en = [[Aircraft rating system#Overall status|Alpha]]
| fr = [[Fr/Aircraft status indication#Statut global|Alpha]]
}}
[[Category:Aircraft status: Alpha]]
|
}}
}}
}}
}}
}}
| {{#if:{{{status|}}}
| {{LangSwitch
| de = [[De/Flugzeugbewertung|{{{status}}}]]
| en = [[Aircraft rating system|{{{status}}}]]
| fr = [[Fr/Aircraft status indication|{{{status}}}]]
}}
| {{LangSwitch
| de = [[De/Flugzeugbewertung|Unbekannt]]
| en = [[Aircraft rating system|Unknown]]
| es = [[Aircraft rating system|Desconocido]]
| fr = [[Fr/Aircraft status indication|Inconnu]]
}}
}}
}}
| label9 = &emsp;FDM
| data9 = {{#if:{{{status-fdm|}}}
| [[File:stars-{{{status-fdm}}}.png|link={{LangSwitch
| de = De/Flugzeugbewertung#Flight Dynamics Model (FDM)
| en = Aircraft rating system#Flight Dynamics Model (FDM)
| fr = Fr/Aircraft status indication#Modèle de vol dynamique
}}
]]
}}
| label10 = &emsp;{{LangSwitch
| de = Systeme
| en = Systems
| es = Sistemas
| fr = Systèmes
| it = Sistemi
| th = ระบบที่ใช้งานได้
| zh = 系统
}}
| data10 = {{#if:{{{status-systems|}}}
| [[File:stars-{{{status-systems}}}.png|link={{LangSwitch
| de = De/Flugzeugbewertung#Systeme
| en = Aircraft rating system#Systems
| fr = Fr/Aircraft status indication#Systèmes
}}
]]
}}
| label11 = &emsp;{{LangSwitch
| ca = Cabina de pilotatge
| de = Cockpit
| en = Cockpit
| es = Cabina de vuelo
| fi = Ohjaamo
| fr = Cockpit
| it = Cabina di pilotaggio
| ja = コックピット
| nl = Cockpit
| pl = Kokpit
| pt = Cabine de pilotagem
| ru = Кабина
| sl = Pilotska kabina
| th = ห้องนักบินและปุ่มต่างๆ
| zh = 驾驶舱
}}
| data11 = {{#if:{{{status-cockpit|}}}
| [[File:stars-{{{status-cockpit}}}.png|link={{LangSwitch
| de = De/Flugzeugbewertung#Cockpit
| en = Aircraft rating system#Cockpit
| fr = Fr/Aircraft status indication#Cockpit
}}
]]
}}
| label12 = &emsp;{{LangSwitch
| de = Modell
| en = Model
| es = Modelo
| fr = Modèle
| it = Modello
| th = แบบจำลอง
| zh = 模型
}}
| data12 = {{#if:{{{status-model|}}}
| [[File:stars-{{{status-model}}}.png|link={{LangSwitch
| de = De/Flugzeugbewertung#Äußeres Modell
| en = Aircraft rating system#External Model
| fr = Fr/Aircraft status indication#Modèle externe
}}
]]
}}
| label13 = {{LangSwitch
| de = Unterstützt
| en = Supports
| es = Apoya
| fr = Soutien
| it = Supporta
| th = คุณลักษณะที่สนับสนุน
| zh = 支持功能
}}
| data13 = {{Ready|{{#titleparts:/{{{ready|}}}|1|2}}}} {{Ready|{{#titleparts:/{{{ready|}}}|1|3}}}} {{Ready|{{#titleparts:/{{{ready|}}}|1|4}}}} {{Ready|{{#titleparts:/{{{ready|}}}|1|5}}}} {{Ready|{{#titleparts:/{{{ready|}}}|1|6}}}} {{Ready|{{#titleparts:/{{{ready|}}}|1|7}}}} {{Ready|{{#titleparts:/{{{ready|}}}|1|8}}}} {{Ready|{{#titleparts:/{{{ready|}}}|1|9}}}}
| label20 = {{LangSwitch
| de = Entwicklung
| en = Development
| es = Desarrollo
| fr = Développement
| it = Sviluppo
| ja = 開発
| nl = Ontwikkeling
| pl = Rozwój
| pt = Desenvolvimento
| ru = развитие
| th = ที่พัฒนา
| zh = 开发
}}
| data20 = {{#if: {{{devel-hangar|}}}
| &emsp;
| {{#if: {{{devel-website|}}}
| &emsp;
| {{#if: {{{devel-repo|}}}
| &emsp;
| {{#if: {{{development|}}}
| &emsp;
| {{#switch: {{{hangar|none}}}
| bermuda
| none =
| #default = &emsp;
}}
}}
}}
}}
}}
| label21 = &emsp;{{LangSwitch
| de = Hangar
| en = Hangar
| es = Hangar
| fr = Hangar
| it = Hangar
| th = หน่วยงาน ("Hangar")
| zh = 机库
}}
| data21 = {{hangar banner|{{{devel-hangar|}}}|size=180px}}
| label22 = &emsp;{{LangSwitch
| de = Webseite
| en = Website
| es = Página web
| fr = Site Internet
| it = Sito Web
| ja = ウェブサイト
| nl = Website
| pl = Strona
| pt = Website
| ru = веб-сайт
| th = เว็บไซต์ของหน่วยงาน
| zh = 网站
}}
| data22 = {{#if: {{{devel-website|}}}
| [[File:Applications-internet 32x32.png | 30px | {{LangSwitch
| de = Die Webseite für die Entwicklungen von {{{name|}}}.
| en = The website for the {{{name|}}} developments.
| es = La página web para los desarrollos de {{{name|}}}.
| fr = Le site internet des développements de {{{name|}}}.
| it = Il sito Web di sviluppo di {{{name|}}}.
| th = เว็บไซต์ของผู้ที่พัฒนา {{{name|}}}
}} | link={{{devel-website}}}
]]
| {{#switch: {{{hangar|}}}
| aucafly
| buckaroo
| bulldogrs
| dave
| fgaddon
| fguk
| helijah
| herbyw
| lake of constance
| paf
| prestes =
[[File:Applications-internet 32x32.png | 30px | {{LangSwitch
| de = Die Webseite für die Entwicklungen von {{{name|}}}.
| en = The website for the {{{name|}}} developments.
| es = La página web para los desarrollos de {{{name|}}}.
| fr = Le site internet des développements de {{{name|}}}.
| fr = Il sito Web di sviluppo di {{{name|}}}.
| th = เว็บไซต์ของผู้ที่พัฒนา {{{name|}}}
| zh = 用于开发{{{name|}}}的网站
}} | link={{#switch: {{{hangar|}}}
| aucafly = https://aucafly.wordpress.com/
| buckaroo = http://www.buckarooshangar.com/flightgear/
| bulldogrs = https://bulldogrs.wordpress.com/
| dave = http://www.daveshangar.org/
| fgaddon = http://wiki.flightgear.org/FGAddon
| fguk = http://fguk.eu/index.php/hangar
| helijah = {{LangSwitch
| en = http://helijah.free.fr/flightgear/hangaren.htm
| fr = http://helijah.free.fr/flightgear/hangar.htm
}}
| herbyw = https://github.com/HerbyW
| lake of constance = http://www.marc-kraus.de
| paf = http://equipe-flightgear.forumactif.com/t835-hangar-de-la-p-a-f-paf-team-hangar
| prestes = http://presteshangar.wikidot.com/{{{aircraft|}}}
}}
]]
}}
}}
| label23 = &emsp;{{LangSwitch
| de = Repository
| en = Repository
| es = Repositorio
| fr = Référentiel
| it = Repository
| ja = レポジトリ
| nl = Repository
| pl = Repozytorium
| pt = Repositório
| ru = хранилище
| zh = 代码仓库
}}
| data23 = {{#if:{{{devel-repo|{{{development|}}}}}}
| [[File:Preferences-system 32x32.png | 30px | {{LangSwitch
| de = Die Entwicklungs-Repository des {{{name|}}}.
| en = The development repository of the {{{name|}}}.
| es = El Repositorio de desarrollo de {{{name|}}}.
| fr = Le référentiel de développement du {{{name|}}}.
| it = Il repository di sviluppo di {{{name|}}}.
| th = Repository ที่ใช้พัฒนา {{{name|}}}
}} | link={{{devel-repo|{{{development|}}}}}}
]]
| {{#switch: {{{hangar|}}}
| aucafly
| bulldogrs
| emilianh
| fgaddon
| herbyw
| it0uchpods =
[[File:Preferences-system 32x32.png | 30px | {{LangSwitch
| de = Die Entwicklungs-Repository des {{{name|}}}.
| en = The development repository of the {{{name|}}}.
| es = El Repositorio de desarrollo de {{{name|}}}.
| fr = Le référentiel de développement du {{{name|}}}.
| it = Il repository di sviluppo di {{{name|}}}.
| th = Repository ที่ใช้พัฒนา {{{name|}}}
}} | link={{#switch: {{{hangar|}}}
| aucafly = {{github url|proj=aucafly|repo={{{aircraft|}}}}}
| bulldogrs = {{github url|proj=aucafly|repo={{{aircraft|}}}}}
| emilianh = {{gitlab url|user=emilianh|repo={{{aircraft|}}}}}
| fgaddon = {{fgaddon aircraft url|{{{aircraft|}}}}}
| herbyw = {{github url|user=HerbyW|repo={{{aircraft|}}}}}
| it0uchpods = {{github url|user=it0uchpods|repo={{{aircraft|}}}}}
}}
]]
}}
}}
| label30 = {{LangSwitch
| de = Herunterladen
| en = Download
| es = Descargar
| fr = Télécharger
| it = Download
| ja = ダウンロード
| ru = загрузка
| th = ดาวน์โหลด
| zh = 下载地址
}}
| data30 = {{#if: {{{download|{{{hangar|}}}}}}
| {{#switch: {{{download|{{{hangar|none}}}}}}
| bermuda
| prestes
| none =
| #default = [[File:Folder-downloads 32x32.png | 30px | {{#switch: {{{hangar|fgaddon}}}
| fgaddon = {{LangSwitch
| de = Lade das Flugzeug-Paket des {{{name|}}} für die aktuelle stabile Version ({{current release|cr}}) herunter.
| en = Download the {{{name|}}} aircraft package for the current stable release ({{current release|cr}}).
| es = Descargar el paquete de avion {{{name|}}} para la versión estable actua ({{current release|cr}}).
| fr = Téléchargez le paquet de l'avion {{{name|}}} pour la version stable actuelle ({{current release|cr}}).
| fr = Scarica il pacchetto dell'aeromobile {{{name|}}} per la versione stabile corrente ({{current release|cr}}).
| th = ดาวน์โหลดเครื่องบิน {{{name|}}} สำหรับรุ่นปัจจุบัน({{current release|cr}})
}}
| fgdata = {{LangSwitch
| de = Das UFO ist bereits im Basispaket enthalten.
| en = The UFO comes as part of the base package.
| es = El UFO está incluido en el paquete básico.
| it = L'UFO è parte del pacchetto di base.
| th = UFO จะมาพร้อมกับโปรแกรมอยู่แล้ว
}}
| #default = {{LangSwitch
| de = de = Lade das Flugzeug-Paket herunter.
| en = Download the aircraft package.
| es = Descargar el paquete de avion.
| fr = Téléchargez le paquet de l'avion.
| it = Scarica il pacchetto dell'aeromobile.
| th = ดาวน์โหลดเครื่องบิน
}}
}} | link={{#if:{{{download|}}}
| {{{download}}}
| {{#switch: {{{hangar|}}}
| aucafly = {{github zip file|proj=aucafly|repo={{{aircraft|}}}|full=1}}
| buckaroo = http://www.buckarooshangar.com/flightgear/models/{{{aircraft|}}}.zip
| bulldogrs = {{github zip file|proj=aucafly|repo={{{aircraft|}}}|full=1}}
| dave = http://www.daveshangar.org/
| emilianh = {{gitlab zip file|user=emilianh|repo={{{aircraft|}}}|tag=latest|full=1}}
| fgaddon = http://mirrors.ibiblio.org/flightgear/ftp/Aircraft/{{{aircraft|}}}.zip
| fgdata = https://sourceforge.net/projects/flightgear/files/
| fguk = http://fguk.eu/index.php/hangar
| helijah = {{LangSwitch
| en = http://helijah.free.fr/flightgear/hangaren.htm
| fr = http://helijah.free.fr/flightgear/hangar.htm
}}
| herbyw = {{github zip file|user=HerbyW|repo={{{aircraft|}}}|full=1}}
| it0uchpods = {{github zip file|user=it0uchpods|repo={{{aircraft|}}}|full=1}}
| lake of constance = http://www.marc-kraus.de
| paf = http://equipe-flightgear.forumactif.com/t835-hangar-de-la-p-a-f-paf-team-hangar#14330
}}
}}]]
}}
}}
| label31 = {{LangSwitch
| de = Livree
| en = Liveries
| es = Libreas
| fr = Livrée
| it = Livree
| th = ลวดลาย
| zh = 涂装
}}
| data31{{#if:{{{liverydbid|}}}||NULL}}
= [[File:Applications-graphics 32x32.png | 30px | {{LangSwitch
| de = Durchsuchen Sie die FlightGear Livree Datenbank für die {{{name|}}}.
| en = Browse the FlightGear livery database for the {{{name|}}}.
| es = Navegar por la FlightGear base de datos de libreas para {{{name|}}}.
| fr = Parcourez la base de données de livrée de FlightGear pour le {{{name|}}}.
| it = Sfoglia il database livree di FlightGear per il {{{name|}}}.
| th = ดูลายสายการบินสำหรับ {{{name|}}}
}} | link=http://liveries.flightgear.org/aircraft.php?id={{{liverydbid|}}}&display=2 ]]
| label32 = {{LangSwitch
| de = Forum
| en = Forum
| fr = Forum
| it = Forum
| zh = 论坛
}}
| data32{{#if:{{{forumtid|}}}||NULL}}
= [[File:Meeting-attending 32x32.png | 30px | {{LangSwitch
| de = Das FlightGear Forum-Thread für die {{{name|}}}.
| en = The FlightGear forum thread for the {{{name|}}}.
| es = El FlightGear foro thread para {{{name|}}}.
| fr = Le fil de discussion dans le forum de FlightGear pour le {{{name|}}}.
| it = Il thread di discussione del forum di FlightGear per il {{{name|}}}.
| th = ดูหน้าเว็บบอรด์ FlightGear ของ {{{name|}}}
}} | link=https://forum.flightgear.org/viewtopic.php?t={{{forumtid|}}} ]]
| label40 = {{LangSwitch
| de = Lizenz
| en = License
| es = Licencia
| fr = Licence
| it = Licenza
| ja = ライセンス
| pl = Licencja
| pt = Licença
| ru = лицензия
| th = ลิขสิทธิ์
| zh = 授权
}}
| data40 = {{#if:{{{licence|{{{license|}}}}}}
| {{license|{{{licence|{{{license}}}}}}}}
| {{#switch: {{{hangar|}}}
| aucafly = {{license|GPLv3+}}
| bulldogrs = {{license|GPLv3+}}
| dave = {{license|CC BY-NC-SA 4.0}}
| fgaddon = {{license|GPLv2+}}
| herbyw = {{license|GPLv2+}}
| prestes = {{license|Unknown}}
}}
}}
| data41 = {{#if:{{{licence|{{{license|}}}}}}
| {{#switch: {{{license|{{{licence|GPLv2+}}}}}}
| GPL | GPL2 | GPLv2 | GPLv2+ =
| #default =
{{non-GPL2
| width = 100%
| product =
{{#switch: {{{craft|aircraft}}}
| aircraft =
{{LangSwitch
| de = Dieses Flugzeug
| en = This aircraft
| es = Este avión
| fr = Cet aéronef
| it = Quest'aeromobile
| th = เครื่องบินนี้
}}
| spacecraft =
{{LangSwitch
| de = Dieses Raumschiff
| en = This spacecraft
| es = Esta nave espacial
| fr = Cet véhicule spatial
| it = Questo veicolo spaziale
| th = ยานอวกาศนี้
}}
| vehicle =
{{LangSwitch
| de = Dieses Fahrzeug
| en = This vehicle
| es = Este vehículo
| fr = Cet véhicule
| it = Questo veicolo
| th = รถยนต์นี้
}}
| seacraft =
{{LangSwitch
| de = Dieses Wasserfahrzeug
| en = This seacraft
| es = Esta moto acuática
| fr = Cette embarcation
| it = Quest'imbarcazione
| th = ยานพาหนะนี้
}}
}}
| meaning =
{{LangSwitch
| de = Teile davon nicht im offiziellen FlightGear-Repositorys wiederverwendet werden dürfen
| en = parts cannot be reused in the official FlightGear repositories
| es = partes no pueden ser reutilizados en los repositorios oficiales de FlightGear
| fr = des parties ne peuvent pas être réutilisées dans les dépôts officiel de FlightGear
| it = delle sue parti non possono essere riutilizzate nei repository ufficiali di FlightGear
| th = ไม่สามารถนำทั้งหมด หรือส่วนใดส่วนหนึ่ง มาใช้ใน FGAddon ได้
}}
}}
}}
| {{#switch: {{{hangar|}}}
| aucafly
| bulldogrs
| prestes
| dave =
{{non-GPL2
| width = 100%
| product =
{{#switch: {{{craft|aircraft}}}
| aircraft =
{{LangSwitch
| de = Dieses Flugzeug
| en = This aircraft
| es = Este avión
| fr = Cet aéronef
| it = Quest'aeromobile
| th = เครื่องบินนี้
}}
| spacecraft =
{{LangSwitch
| de = Dieses Raumschiff
| en = This spacecraft
| es = Esta nave espacial
| fr = Cet véhicule spatial
| it = Questo veicolo spaziale
| th = ยานอวกาศนี้
}}
| vehicle =
{{LangSwitch
| de = Dieses Fahrzeug
| en = This vehicle
| es = Este vehículo
| fr = Cet véhicule
| it = Questo veicolo
| th = รถยนต์นี้
}}
| seacraft =
{{LangSwitch
| de = Dieses Wasserfahrzeug
| en = This seacraft
| es = Esta moto acuática
| fr = Cette embarcation
| it = Quest'imbarcazione
| th = ยานพาหนะนี้
}}
}}
| meaning =
{{LangSwitch
| de = Teile davon nicht im offiziellen FlightGear-Repositorys wiederverwendet werden dürfen
| en = parts cannot be reused in the official FlightGear repositories
| es = partes no pueden ser reutilizados en los repositorios oficiales de FlightGear
| fr = des parties ne peuvent pas être réutilisées dans les dépôts officiel de FlightGear
| it = delle sue parti non possono essere riutilizzate nei repository ufficiali di FlightGear
| th = ไม่สามารถนำทั้งหมด หรือส่วนใดส่วนหนึ่ง มาใช้ใน FGAddon ได้
}}
}}
}}
}}
| data45 = {{#if: {{{note|}}} | {{note|{{{note}}}|width=100%|padding=0px|margin=0px}} }}
| float{{#if:{{{float|}}}||NULL}}
= {{{float}}} 
| data60 = {{#ifeq: {{{navbar|}}}
| 1
| <div style="text-align: right; width: 300px">{{navbar|:{{#titleparts: {{PAGENAME}} | | {{{navbarlevel|-1}}}}}/info|mini=1}}</div>
}}
}}{{#if: {{{image}}} | | [[Category:Image requested]]}}{{#switch: {{{hangar|}}}
| aucafly = [[Category:AUCAFLY hangar]]
| bermuda = [[Category:Bermuda Triangle]]
| buckaroo = [[Category:Buckaroo's hangar]]
| bulldogrs = [[Category:Bulldog RS hangar]]
| dave = [[Category:Dave's hangar]]
| fgaddon = [[Category:FGAddon hangar]]
| fgdata = [[Category:FGData hangar]]
| fguk = [[Category:FGUK hangar]]
| grtux = [[Category:GRTux hangar]]
| helijah = [[Category:Helijah hangar]]
| herbyw = [[Category:HerbyW's hangar]]
| it0uchpods = [[Category:it0uchpods hangar]]
| lake of constance = [[Category:Lake of Constance hangar]]
| paf = [[Category:PAF hangar]]
| prestes = [[Category:Prestes hangar]]
| #default = [[Category:Unknown hangar]]
}}{{#switch: {{{devel-hangar|}}}
| aucafly = [[Category:AUCAFLY hangar]]
| buckaroo = [[Category:Buckaroo's hangar]]
| bulldogrs = [[Category:Bulldog RS hangar]]
| dave = [[Category:Dave's hangar]]
| fgaddon = [[Category:FGAddon hangar]]
| fgdata = [[Category:FGData hangar]]
| fguk = [[Category:FGUK hangar]]
| grtux = [[Category:GRTux hangar]]
| helijah = [[Category:Helijah hangar]]
| herbyw = [[Category:HerbyW's hangar]]
| it0uchpods = [[Category:it0uchpods hangar]]
| lake of constance = [[Category:Lake of Constance hangar]]
| paf = [[Category:PAF hangar]]
| prestes = [[Category:Prestes hangar]]
}}{{#switch: {{{craft|aircraft}}}
| aircraft = [[Category:All aircraft]]
| spacecraft = [[Category:All spacecraft]]
| vehicle = [[Category:All vehicles]]
| seacraft = [[Category:All seacraft]]
}}</includeonly><noinclude>
{{Informative template|1=
== Goal ==
This infobox is used to summarize the key points of an aircraft, spacecraft, vehicle, or seacraft. The focus is on FlightGear – the template is not designed to replicate the content of the corresponding Wikipedia article. If a graphic is present – either a hangar logo or screenshot – the infobox will be set to a width of 300 px.

== Usage ==
For instructions on how to use this template in a translation-friendly way, please see the [[#Translations - using subpages]] section below.
{{obr}}'''infobox aircraft'''
{{!}} ''name'' =
{{!}} ''hangar'' =
{{!}} ''aircraft'' =
{{!}} ''image'' =
{{!}} ''alt'' =
{{!}} ''image2'' =
{{!}} ''alt2'' =
<nowiki></nowiki>
{{!}} ''type'' =
{{!}} ''config'' =
{{!}} ''propulsion'' =
{{!}} ''manufacturer'' =
<nowiki></nowiki>
{{!}} ''authors'' =
{{!}} ''author1'' =
...
{{!}} ''author30'' =
{{!}} ''devel-team'' =
{{!}} ''fdm'' =
{{!}} ''fgname'' =
{{!}} ''fgname1'' =
...
{{!}} ''fgname10'' =
<nowiki></nowiki>
{{!}} ''status-fdm'' =
{{!}} ''status-systems'' =
{{!}} ''status-cockpit'' =
{{!}} ''status-model'' =
{{!}} ''status'' =
<nowiki></nowiki>
{{!}} ''ready'' =
{{!}} ''devel-hangar'' =
{{!}} ''devel-website'' =
{{!}} ''devel-repo'' =
{{!}} ''download'' =
{{!}} ''liverydbid'' =
{{!}} ''forumtid'' =
<nowiki></nowiki>
{{!}} ''license'' =
{{!}} ''note'' =
{{!}} ''craft'' =
{{!}} ''navbar'' =
{{!}} ''navbarlevel'' =
{{cbr}}

All parameters are optional.

=== Basic data ===
{{caution|For multi-part parameters using <code>/</code> separators, these are limited by the constraints of the [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions#.23titleparts Mediawiki <code>#titleparts:</code> function]. Therefore a maximum of 25 elements and 255 characters are allowed. Links, URLs, or underscores are not supported, so a number of alternative numbered parameters are provided. If you have other requirements, please discuss this on the [[{{TALKPAGENAME}}|discussion page]].}}

; name: The name of the aircraft. This will be displayed at the top of the infobox.

; hangar: The optional aircraft hangar. This adds the hangar logo at 300 px or text and a link for the hanger, automatically creates development repository and download links for hangars which support this, and adds a hangar specific category to the article. This can currently be one of {{param||fgaddon}}, {{param||buckaroo}}, {{param||fguk}}, {{param|helijah}}, {{param|herbyw}}, {{param|lake of constance}}, {{param|paf}}.

; aircraft: The name of the aircraft in the hangar. This is only used if the {{param|hangar}} parameter is supplied. For [[FGAddon]], this corresponds to the aircraft directory in <code>[[$FG_AIRCRAFT]]/Aircraft/<aircraft-dir></code>. For other hangars, this is currently unused.

; image: Screenshot of the aircraft without the <code>File:</code> or <code>Image:</code> prefix. The graphic will be set to a width of 300 px.

; alt: Caption for the screenshot.

; image2: Additional screenshot without the <code>File:</code> or <code>Image:</code> prefix (''preferably a cockpit screenshot''). The graphic will be set to a width of 300 px.

; alt2: Caption for the second screenshot.

; type: The type of aircraft, spacecraft, vehicle, or seacraft. Although this can be any text, special parameter values, independent of capitalisation, will be associated with a category. This will result in the automatic addition of a internal wiki link to the category in the infobox as well as appending the category to the article. See the [[#Craft types|Craft types]] section below for a table of values. Multiple values for the parameter can be supplied when each type is separated by <code>/</code>. For example <code>{{!}} type = Civil utility aircraft/Military utility aircraft</code>.

; config: The configuration of the aircraft, spacecraft, vehicle, or seacraft. Although this can be any text, special parameter values, independent of capitalisation, will be associated with a category. This will result in the automatic addition of a internal wiki link to the category in the infobox as well as appending the category to the article. See the [[#Craft configurations|Craft configurations]] section below for a table of values. Multiple values for the parameter can be supplied when each configuration is separated by <code>/</code>. For example <code>{{!}} config = Biplane aircraft/Delta-wing aircraft</code>.

; propulsion: The aircraft, spacecraft, vehicle, or seacraft propulsion. Although this can be any text, special parameter values, independent of capitalisation, will be associated with a category. This will result in the automatic addition of a internal wiki link to the category in the infobox as well as appending the category to the article. See the [[#Craft propulsion|Craft propulsion]] section below for a table of values. Multiple values for the parameter can be supplied when each value is separated by <code>/</code>. For example <code>{{!}} propulsion = Twin-engined aircraft/Propeller aircraft</code>.

; manufacturer: The aircraft, spacecraft, vehicle, or seacraft manufacturer. Although this can be any text, special parameter values, independent of capitalisation, will be associated with a category. This will result in the automatic addition of a internal wiki link to the category in the infobox as well as appending the category to the article. See the [[#Craft manufacturer|Craft manufacturer]] section below for a table of values. Multiple values for the parameter can be supplied when each value is separated by <code>/</code>. For example <code>{{!}} manufacturer = Boeing/Rockwell</code>.

; authors: The list of aircraft authors. The special slash character <code>/</code> can be used to separate authors, for example: <code>{{!}} fgname = me/you</code>, resulting in each author being placed on a separate line. The <code>/</code> character cannot be used within a single author element so instead the <code>,</code> or <code>&</code> separating characters should be used.

; author{1-30}: Optional aircraft authors to add to the list. These should be given in order from {{param|author1}} upwards. This bypasses the [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions#.23titleparts Mediawiki <code>#titleparts:</code> function], allowing for the author name to be a link.

; devel-team: The optional name of the development team. If this parameter is supplied, then the author list will be packed into a collapsible element that is, by default, not shown but has a <code>[Expand]</code> link to see the authors.

; fdm: The [[Flight Dynamics Model]] of the aircraft. If one of the values of {{param|JSBSim}}, {{param|YASim}}, {{param|UIUC}}, or {{param|LaRCsim}} are supplied, independent of capitalisation, then an automatic link to the corresponding wiki page will be created. Multiple values for the parameter can be supplied when each type is separated by <code>/</code>, for example <code>{{!}} type = UIUC/YASim/JSBSim/magic carpet</code>.

; fgname: The name(s) of the aircraft to use when launching FlightGear from the command line. If multiple aircraft in different <code>*-set.xml</code> files are available, each name should be separated by the slash character <code>/</code>. For example <code>{{!}} fgname = dhc6/dhc6F/dhc6S</code>

; fgname{1-10}: An alternative way to specify the fgname, if the [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions#.23titleparts Mediawiki <code>#titleparts:</code> function] is problematic. This is necessary if there are underscores in the name.

; status-fdm: The [[Aircraft rating system#Flight Dynamics Model .28FDM.29|status of the Flight Dynamics Model]]. For details, please [[#Aircraft status|see below]].

; status-systems: The [[Aircraft rating system#Systems|status of the systems]] For details, please [[#Aircraft status|see below]].

; status-cockpit: The [[Aircraft rating system#Cockpit|status of the cockpit]] For details, please [[#Aircraft status|see below]].

; status-model: The [[Aircraft rating system#External Model|status of the external model]] For details, please [[#Aircraft status|see below]].

; status: The fall-back status text, if none of the other {{param|status-*}} parameters are set. This corresponds to the old [[Aircraft rating system]].

; ready: Add icons to display certain capabilities supported by the aircraft. Please see the [[#Ready icons]] section below for details.

; devel-hangar: The hangar where aircraft developments occur. This is similar to the {{param|hangar}} parameter, and will add the hangar banner to the infobox. The aim is to point readers to the hangar responsible for the current developments, so as to minimise duplicated developments.

; devel-website: The URL for the development website.

; devel-repo: The URL for the development repository. If the {{param|hangar}} parameter is supplied, the development link may be automatically created. Note that hardcoded URLs should be avoided where ever possible and the [[:Category:Repository link templates|family of repository link templates]] should be used instead.

; development: Depreciated. This has been replaced by the {{param|devel-repo}} parameter.

; download: The URL for downloading the aircraft. If the {{param|hangar}} parameter is supplied, the download link may be automatically created. For repository snapshots, please avoid hardcoded URLs and instead use the [[:Category:Repository link templates|family of repository link templates]].

; liverydbid: The [[FlightGear livery database|livery database]] ID of the aircraft.

; forumtid: The [https://forum.flightgear.org FlightGear forum] topic ID for the aircraft. This is the number after the <code>t=</code> part of the URL.

; license: Also {{param|licence}}. This will add licensing information to the infobox. Please see the [[#Licensing]] section below for a list of special values.

; note: A special note to show within a {{tl|note}} message box at the end of the aircraft infobox.

; craft: The craft type, defaulting to {{param||aircraft}}. This can be one of {{param||aircraft}}, {{param||spacecraft}}, {{param||vehicle}}, or {{param||seacraft}}. This will be used to add one of the categories [[:Category:All aircraft]], [[:Category:All spacecraft]], [[:Category:All vehicles]], or [[:Category:All seacraft]] to the page.

; navbar: If this is set to {{param||1}}, a {{tl|navbar}} element will be added to the very end of infobox. This is very useful when using [[#Translations - using subpages|subpages]]. It will have the form of <code>{{navbar|{{PAGENAME}}|mini=1}}</code>. Note that the navbar will point to pages of the form <code>{{obr}}PAGENAME{{cbr}}/info</code>, excluding the language code part of the page name.

; navbarlevel: This is used if the {{param|navbar}} parameter is set. It allows for <code>/</code> characters in the base PAGENAME. If a single slash is present, then this should be set to {{param||-2}}.

; float: A parameter reserved solely for template developers. This corresponds to the {{tl|Infobox}} {{param|float}} parameter.

{{craft type/doc}}

{{craft configuration/doc}}

{{craft propulsion/doc}}

{{craft manufacturer/doc}}

=== Aircraft status ===
Instead of a custom {{param|status}} text, you can use the [[aircraft rating system]]. The overall status is auto-calculated and will be displayed. If you use the aircraft rating system, the {{param|status}} parameter will be ignored.

See [[Aircraft rating system]] for instructions on how to rate your aircraft.

=== Ready icons ===
Several icons are available for highlighting certain capabilities of the aircraft. Separate them with the slash character <code>/</code>, for example <code>{{!}} ready = airrefuel/bombable</code>. The allowed values are:

{{ready/doc table}}

This is implemented using the {{tl|ready}} template.

=== Translations - using subpages ===
When using this template in an article, the use of subpage organisation is recommended for facilitating translations.

==== Transclusion of the subpage ====

Instead of transcluding this template directly into the article, the subpage <code>{{obr}}{{mediawiki|Help:Magic_words#Page_names|PAGENAME}}{{cbr}}/info</code> can be created. Using the example of the [[de Havilland Canada DHC-6 Twin Otter]], to the very start of the article simply add:

{{obr}}:{{obr}}{{mediawiki|Help:Magic_words#Page_names|PAGENAME}}{{cbr}}/info{{cbr}}

For translations, e.g. [[De/de Havilland Canada DHC-6 Twin Otter]] and [[Fr/de Havilland Canada DHC-6 Twin Otter]], a different syntax is needed to strip out the language prefix from the page name. The text to copy and paste to the top of the article is:

{{obr}}:{{obr}}#{{mediawiki|Help:Extension:ParserFunctions##titleparts|titleparts}}:{{obr}}PAGENAME{{cbr}}{{!}}{{!}}2{{cbr}}/info{{cbr}}

==== Subpage structure ====

Then create your <code>{{obr}}PAGENAME{{cbr}}/info</code> multi-language page with, for the example of [[de Havilland Canada DHC-6 Twin Otter/info]] (also see the [[#de Havilland Canada DHC-6 Twin Otter|DHC-6 example]] below):

<includeonly>{{obr}}infobox aircraft
{{!}} name = de Havilland Canada DHC-6 Twin Otter
{{!}} hangar = fgaddon
{{!}} aircraft = dhc6
{{!}} image = Dhc6-splash1.jpg
{{!}} alt = {{obr}}LangSwitch
{{!}} de = Die DHC-6 Twin Otter im Flug
{{!}} en = The DHC-6 Twin Otter in flight
{{!}} fr = Le DHC-6 Twin Otter en vol
{{cbr}}
{{!}} image2 = Twin Otter - interior shadows.jpg
{{!}} alt2 = {{obr}}LangSwitch
{{!}} de = Cockpit des Twin Otter mit Innenbeschattung
{{!}} en = Cockpit of the Twin Otter with interior shading
{{!}} fr = Cockpit du Twin Otter avec un ombrage intérieur
{{cbr}}
{{!}} type = Civil utility aircraft/Military utility aircraft/Seaplanes and flying boat
{{!}} config = High wing aircraft/Fixed gear aircraft/Tricycle landing gear aircraft
{{!}} propulsion = Twin-engine aircraft/Propeller aircraft
{{!}} manufacturer = de Havilland Canada
{{!}} authors = Syd Adams (Initial model)/Christian Thiriot (3D, Textures)/Bo Lan (Nasal, FDM, Systems)/Jonathan Schellhase (3D, Nasal, Systems, Sound, misc)/others (see below)
{{!}} devel-team = {{obr}}LangSwitch
{{!}} de = DHC-6 Twin Otter Entwicklungsteam
{{!}} en = DHC-6 Twin Otter team
{{!}} fr = L'équipe du DHC-6 Twin Otter
{{cbr}}
{{!}} fdm = YASim
{{!}} fgname = dhc6/dhc6F/dhc6S
{{!}} status-fdm = 4
{{!}} status-systems = 4
{{!}} status-cockpit = 5
{{!}} status-model = 5
{{!}} ready = checklist/tutorials/rembrandt
{{!}} liverydbid = 57
{{!}} forumtid = 21965
{{!}} navbar = 1
{{cbr}}</includeonly><noinclude>
This is the aircraft infobox subpage of the [[[[de Havilland Canada DHC-6 Twin Otter]]]].
[[[[:Category:Aircraft infobox documentation]]]]
</noinclude>

The <code><includeonly></code> tags prevent the <code>{{obr}}PAGENAME{{cbr}}/info</code> pages from being scattered throughout the [[:Category:Controllable craft]] subcategories (by temporarily removing or deleting a character in the initial tag, the infobox can be previewed). The <code><noinclude></code> tags means that only the <code>{{obr}}PAGENAME{{cbr}}/info</code> page will be added to the [[:Category:Aircraft infobox documentation]] category.

Note the use of the {{param|navbar}} parameter. This is allows the <code>{{obr}}PAGENAME{{cbr}}/info</code> subpage to be easily accessed from the main article.

==== Full translation ====

For a full translation of the aircraft infobox, a number of templates on top of this one need to be translated:

* <div class="plainlinks">[{{fullurl:Template:{{PAGENAME}}|action=edit}} Edit this template]<div>
* <div class="plainlinks">[{{fullurl:Template:Craft type|action=edit}} Edit Template:Craft_type]</div>
* <div class="plainlinks">[{{fullurl:Template:Craft configuration|action=edit}} Edit Template:Craft_configuration]</div>
* <div class="plainlinks">[{{fullurl:Template:Craft propulsion|action=edit}} Edit Template:Craft_propulsion]</div>
* <div class="plainlinks">[{{fullurl:Template:Craft manufacturer|action=edit}} Edit Template:Craft_manufacturer]</div>
* <div class="plainlinks">[{{fullurl:Template:hangar banner|action=edit}} Edit Template:Hangar_banner]</div>

=== Licensing ===

If the {{param|license}} or {{param|licence}} parameter has one of the special values listed in the following table, a link to the licensing information will be automatically created.

{{license/doc table}}

== Examples ==

Apart from the examples below, see the [[Special:WhatLinksHere/Template:infobox aircraft|articles using this template]] to learn how to use it.

=== Empty template ===

{{obr}}Infobox aircraft{{cbr}}

{{infobox aircraft|float=none}}

=== Base package aircraft ===

==== Cessna 172P Skyhawk ====
This is an example for the [[Cessna 172P]] article, specifically in the [[Cessna 172P/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Cessna 172P Skyhawk
{{!}} hangar = fgdata
{{!}} image = c172p-thumbnail.jpg
{{!}} type = Civil aircraft/Civil utility aircraft
{{!}} config = High wing aircraft/Fixed gear aircraft
{{!}} propulsion = Propeller aircraft/Single-engine aircraft
{{!}} manufacturer = Cessna
{{!}} authors = David Megginson/Gilberto Agostinho/Wayne Bragg/Juan Vera del Campo/onox/Fernando Barbosa/Daniel Dubreuil/Jonathan Schellhase/Israel Hernandez/Tuomas Kuosmanen/Anders Gidenstam/Waldo Kitty/algefaen
{{!}} devel-team = C172P development team
{{!}} fdm = JSBSim
{{!}} fgname = c172p
{{!}} status-fdm = 4
{{!}} status-systems = 5
{{!}} status-cockpit = 5
{{!}} status-model = 4
{{!}} ready = dualcontrol/tutorials/checklist
{{!}} devel-repo = {{obr}}github url{{!}}user=Juanvvc{{!}}repo=c172p-detailed{{cbr}}
{{!}} download = {{obr}}github zip file{{!}}user=Juanvvc{{!}}repo=c172p-detailed{{!}}full=1{{cbr}}
{{!}} liverydbid = 70
{{!}} forumtid = 25157
{{!}} note = This is the default FlightGear aircraft and is distributed as part of the base package.
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Cessna 172P Skyhawk
| hangar = fgdata
| image = c172p-thumbnail.jpg
| type = Civil aircraft/Civil utility aircraft
| config = High wing aircraft/Fixed gear aircraft
| propulsion = Propeller aircraft/Single-engine aircraft
| manufacturer = Cessna
| authors = David Megginson/Gilberto Agostinho/Wayne Bragg/Juan Vera del Campo/onox/Fernando Barbosa/Daniel Dubreuil/Jonathan Schellhase/Israel Hernandez/Tuomas Kuosmanen/Anders Gidenstam/Waldo Kitty/algefaen
| devel-team = C172P development team
| fdm = JSBSim
| fgname = c172p
| status-fdm = 4
| status-systems = 5
| status-cockpit = 5
| status-model = 4
| ready = dualcontrol/tutorials/checklist
| devel-repo = {{github url|user=Juanvvc|repo=c172p-detailed}}
| download = {{github zip file|user=Juanvvc|repo=c172p-detailed|full=1}}
| liverydbid = 70
| forumtid = 25157
| note = This is the default FlightGear aircraft and is distributed as part of the base package.
| navbar = 1
| float = none
}}

=== Official FGAddon hangar ===

==== Space Shuttle ====
This is an example for the [[Space Shuttle]] article, specifically in the [[Space Shuttle/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Space Shuttle
{{!}} hangar = fgaddon
{{!}} aircraft = SpaceShuttle
{{!}} image = Shuttle FG01.jpg
{{!}} alt = Space Shuttle <nowiki>''Atlantis''</nowiki> in orbit
{{!}} image2 = Shuttle_Cockpit.jpg
{{!}} alt2 = Space Shuttle cockpit (April 2015)
{{!}} type = Spaceplane/Glider aircraft/Hypersonic aircraft
{{!}} config = Delta-wing aircraft
{{!}} authors = Thorsten Renk (flight dynamics)/Richard Harrison (cockpit and avionics)/Chris Kuhn (cockpit)/NASA/japreja (3D)/HerbyW (3D)
{{!}} devel-team = Shuttle development team
{{!}} fdm = JSBSim
{{!}} fgname = SpaceShuttle/SpaceShuttle-orbit/SpaceShuttle-launch/SpaceShuttle-entry/SpaceShuttle-approach/SpaceShuttle-TAEM
{{!}} status-fdm = 4
{{!}} status-systems = 4
{{!}} status-cockpit = 2
{{!}} status-model = 3
{{!}} devel-website = https://sourceforge.net/projects/fgspaceshuttledev/
{{!}} devel-repo = {{obr}}[[Template:sourceforge url|sourceforge url]]{{!}}proj=fgspaceshuttledev{{!}}repo=code{{!}}branch=development{{cbr}}
{{!}} forumtid = 25747
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Space Shuttle
| hangar = fgaddon
| aircraft = SpaceShuttle
| image = Shuttle FG01.jpg
| alt = Space Shuttle ''Atlantis'' in orbit
| image2 = Shuttle_Cockpit.jpg
| alt2 = Space Shuttle cockpit (April 2015)
| type = Spaceplane/Glider aircraft/Hypersonic aircraft
| config = Delta-wing aircraft
| authors = Thorsten Renk (flight dynamics)/Richard Harrison (cockpit and avionics)/Chris Kuhn (cockpit)/NASA/japreja (3D)/HerbyW (3D)
| devel-team = Shuttle development team
| fdm = JSBSim
| fgname = SpaceShuttle/SpaceShuttle-orbit/SpaceShuttle-launch/SpaceShuttle-entry/SpaceShuttle-approach/SpaceShuttle-TAEM
| status-fdm = 4
| status-systems = 4
| status-cockpit = 2
| status-model = 3
| devel-website = https://sourceforge.net/projects/fgspaceshuttledev/
| devel-repo = {{sourceforge url|proj=fgspaceshuttledev|repo=code|branch=development}}
| forumtid = 25747
| navbar = 1
| float = none
}}

==== de Havilland Canada DHC-6 Twin Otter ====
This is an example for the [[de Havilland Canada DHC-6 Twin Otter]] article, specifically in the [[de Havilland Canada DHC-6 Twin Otter/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = de Havilland Canada DHC-6 Twin Otter
{{!}} hangar = fgaddon
{{!}} aircraft = dhc6
{{!}} image = Dhc6-splash1.jpg
{{!}} alt = {{obr}}LangSwitch
{{!}} de = Die DHC-6 Twin Otter im Flug
{{!}} en = The DHC-6 Twin Otter in flight
{{!}} fr = Le DHC-6 Twin Otter en vol
{{cbr}}
{{!}} image2 = Twin Otter - interior shadows.jpg
{{!}} alt2 = {{obr}}LangSwitch
{{!}} de = Cockpit des Twin Otter mit Innenbeschattung
{{!}} en = Cockpit of the Twin Otter with interior shading
{{!}} fr = Cockpit du Twin Otter avec un ombrage intérieur
{{cbr}}
{{!}} type = Civil utility aircraft/Military utility aircraft/Seaplanes and flying boat
{{!}} config = High wing aircraft/Monoplane aircraft/Fixed gear aircraft/Tricycle landing gear aircraft
{{!}} propulsion = Twin-engine aircraft/Propeller aircraft
{{!}} manufacturer = de Havilland Canada
{{!}} authors = Syd Adams (Initial model)/Christian Thiriot (3D, Textures)/Bo Lan (Nasal, FDM, Systems)/Jonathan Schellhase (3D, Nasal, Systems, Sound, misc)/others (see below)
{{!}} devel-team = {{obr}}LangSwitch
{{!}} de = DHC-6 Twin Otter Entwicklungsteam
{{!}} en = DHC-6 Twin Otter team
{{!}} fr = L'équipe du DHC-6 Twin Otter
{{cbr}}
{{!}} fdm = YASim
{{!}} fgname = dhc6/dhc6F/dhc6S
{{!}} status-fdm = 4
{{!}} status-systems = 4
{{!}} status-cockpit = 5
{{!}} status-model = 5
{{!}} ready = checklist/tutorials/rembrandt
{{!}} liverydbid = 57
{{!}} forumtid = 21965
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = de Havilland Canada DHC-6 Twin Otter
| hangar = fgaddon
| aircraft = dhc6
| image = Dhc6-splash1.jpg
| alt = {{LangSwitch
| de = Die DHC-6 Twin Otter im Flug
| en = The DHC-6 Twin Otter in flight
| fr = Le DHC-6 Twin Otter en vol
}}
| image2 = Twin Otter - interior shadows.jpg
| alt2 = {{LangSwitch
| de = Cockpit des Twin Otter mit Innenbeschattung
| en = Cockpit of the Twin Otter with interior shading
| fr = Cockpit du Twin Otter avec un ombrage intérieur
}}
| type = Civil utility aircraft/Military utility aircraft/Seaplanes and flying boat
| config = High wing aircraft/Monoplane aircraft/Fixed gear aircraft/Tricycle landing gear aircraft
| propulsion = Twin-engine aircraft/Propeller aircraft
| manufacturer = de Havilland Canada
| authors = Syd Adams (Initial model)/Christian Thiriot (3D, Textures)/Bo Lan (Nasal, FDM, Systems)/Jonathan Schellhase (3D, Nasal, Systems, Sound, misc)/others (see below)
| devel-team = {{LangSwitch
| de = DHC-6 Twin Otter Entwicklungsteam
| en = DHC-6 Twin Otter team
| fr = L'équipe du DHC-6 Twin Otter
}}
| fdm = YASim
| fgname = dhc6/dhc6F/dhc6S
| status-fdm = 4
| status-systems = 4
| status-cockpit = 5
| status-model = 5
| ready = checklist/tutorials/rembrandt
| liverydbid = 57
| forumtid = 21965
| navbar = 1
| float = none
}}

==== Piper Seneca II ====
This is an example for the [[Piper PA34-200T Seneca II]] article, specifically in the [[Piper PA34-200T Seneca II/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Piper PA34-200T Seneca II
{{!}} hangar = fgaddon
{{!}} aircraft = SenecaII
{{!}} image = Piper_SenecaII.jpg
{{!}} type = Civil aircraft/Civil utility aircraft
{{!}} propulsion = Twin-engine aircraft
{{!}} manufacturer = Piper
{{!}} authors = Torsten Dreyer
{{!}} fdm = JSBSim
{{!}} fgname = SenecaII
{{!}} status-fdm = 5
{{!}} status-systems = 5
{{!}} status-cockpit = 4
{{!}} status-model = 3
{{!}} ready = tutorials
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Piper PA34-200T Seneca II
| hangar = fgaddon
| aircraft = SenecaII
| image = Piper_SenecaII.jpg
| type = Civil aircraft/Civil utility aircraft
| propulsion = Twin-engine aircraft
| manufacturer = Piper
| authors = Torsten Dreyer
| fdm = JSBSim
| fgname = SenecaII
| status-fdm = 5
| status-systems = 5
| status-cockpit = 4
| status-model = 3
| ready = tutorials
| navbar = 1
| float = none
}}

==== Follow me ====
This is an example for the [[Follow me]] article, specifically in the [[Follow me/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Follow me
{{!}} hangar = fgaddon
{{!}} aircraft = followme
{{!}} image = Follow_me.jpg
{{!}} type = Automobile/Utility vehicle
{{!}} authors = Gijs de Rooy
{{!}} fdm = JSBSim
{{!}} fgname = followme
{{!}} status-fdm = 4
{{!}} status-systems = 2
{{!}} status-cockpit = 3
{{!}} status-model = 4
{{!}} forumtid = 858
{{!}} craft = vehicle
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Follow me
| hangar = fgaddon
| aircraft = followme
| image = Follow_me.jpg
| type = Automobile/Utility vehicle
| authors = Gijs de Rooy
| fdm = JSBSim
| fgname = followme
| status-fdm = 4
| status-systems = 2
| status-cockpit = 3
| status-model = 4
| craft = vehicle
| forumtid = 858
| navbar = 1
| float = none
}}

==== Wright Flyer ====
This is an example for the [[Wright Flyer]] article, specifically in the [[Wright Flyer/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Wright Flyer
{{!}} hangar = fgaddon
{{!}} aircraft = wrightFlyer1903
{{!}} image = 1903 Wright Flyer.jpg
{{!}} alt = The ''Wright Flyer'' on the ground.
{{!}} type = First airplane/Experimental aircraft
{{!}} config = Biplane aircraft/Canard aircraft
{{!}} propulsion = Propeller aircraft
{{!}} manufacturer = Wright brothers
{{!}} authors = Jim Wilson (3D model)
{{!}} author1 = Prof. <nowiki><span class="plainlinks">[http://www.ae.illinois.edu/directory/profile/m-selig Michael Selig]</span></nowiki> (UIUC FDM)
{{!}} author2 = Erik Hofman (JSBSim FDM)
{{!}} fdm = UIUC/JSBSim
{{!}} fgname = wrightFlyer1903/wrightFlyer1903-jsbsim
{{!}} status = Production
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Wright Flyer
| hangar = fgaddon
| aircraft = wrightFlyer1903
| image = 1903 Wright Flyer.jpg
| alt = The ''Wright Flyer'' on the ground.
| type = First airplane/Experimental aircraft
| config = Biplane aircraft/Canard aircraft
| propulsion = Propeller aircraft
| manufacturer = Wright brothers
| authors = Jim Wilson (3D model)
| author1 = Prof. <span class="plainlinks">[http://www.ae.illinois.edu/directory/profile/m-selig Michael Selig]</span> (UIUC FDM)
| author2 = Erik Hofman (JSBSim FDM)
| fdm = UIUC/JSBSim
| fgname = wrightFlyer1903/wrightFlyer1903-jsbsim
| status = Production
| navbar = 1
| float = none
}}

==== Farman IV ====
This is an example for the [[Farman IV]] article, specifically in the [[Farman IV/info]] subpage.
{{obr}}infobox aircraft
{{!}} name = Farman IV
{{!}} hangar = fgaddon
{{!}} aircraft = Farman-IV
{{!}} image = Farman-IV.jpg
{{!}} type = Historical aircraft/Military aircraft
{{!}} config = Biplane aircraft
{{!}} propulsion = Propeller aircraft/Twin-engine piston aircraft
{{!}} manufacturer = Farman
{{!}} authors = Emmanuel Baranger (3D, FDM)
{{!}} fdm = YASim
{{!}} fgname = farman-IV
{{!}} status-fdm = 2
{{!}} status-systems = 1
{{!}} status-cockpit = 1
{{!}} status-model = 4
{{!}} devel-hangar = helijah
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Farman IV
| hangar = fgaddon
| aircraft = Farman-IV
| image = Farman-IV.jpg
| type = Historical aircraft/Military aircraft
| config = Biplane aircraft
| propulsion = Propeller aircraft/Twin-engine piston aircraft
| manufacturer = Farman
| authors = Emmanuel Baranger (3D, FDM)
| fdm = YASim
| fgname = farman-IV
| status-fdm = 2
| status-systems = 1
| status-cockpit = 1
| status-model = 4
| devel-hangar = helijah
| navbar = 1
| float = none
}}

==== Boeing-Sikorsky RAH-66 Comanche ====
This is an example for the [[Boeing-Sikorsky RAH-66 Comanche]] article, specifically in the [[Boeing-Sikorsky RAH-66 Comanche/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Boeing-Sikorsky RAH-66 Comanche
{{!}} hangar = fgaddon
{{!}} aircraft = rah-66
{{!}} image = RAH-66 splash.png
{{!}} image2 = rah-66-cockpit.png
{{!}} type = Helicopter/Military helicopter/Military reconnaissance aircraft/Attack aircraft
{{!}} manufacturer = Boeing/Sikorsky
{{!}} author1 = {{obr}}[[Template:usr|usr]]{{!}}pjedvaj{{!}}Petar Jedvaj{{cbr}}
{{!}} author2 = Edin Hozic
{{!}} author3 = Stephen Madeira
{{!}} author4 = Gary Brown
{{!}} fdm = YASim
{{!}} fgname = rah-66
{{!}} status-fdm = 4
{{!}} status-systems = 2
{{!}} status-cockpit = 3
{{!}} status-model = 5
{{!}} forumtid = 14908
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Boeing-Sikorsky RAH-66 Comanche
| hangar = fgaddon
| aircraft = rah-66
| image = RAH-66 splash.png
| image2 = rah-66-cockpit.png
| type = Helicopter/Military helicopter/Military reconnaissance aircraft/Attack aircraft
| manufacturer = Boeing/Sikorsky
| author1 = {{usr|pjedvaj|Petar Jedvaj}}
| author2 = Edin Hozic
| author3 = Stephen Madeira
| author4 = Gary Brown
| fdm = YASim
| fgname = rah-66
| status-fdm = 4
| status-systems = 2
| status-cockpit = 3
| status-model = 5
| forumtid = 14908
| navbar = 1
| float = none
}}

=== Aucafly hangar ===

==== Aucafly T1 ====
This is an example for the [[Aucafly T1]] article.

{{obr}}infobox aircraft
{{!}} name = Aucafly T1
{{!}} hangar = aucafly
{{!}} aircraft = AUCAFLYT1
{{!}} image = Aucafly T1.png
{{!}} alt = Aucafly T1 leaving San Francisco International Airport
{{!}} type = Civil aircraft/Fictional aircraft
{{!}} propulsion = Propeller aircraft
{{!}} manufacturer = Aucafly
{{!}} authors = Ausdkunst/D-Echo (FDM)
{{!}} fdm = YASim
{{!}} fgname = aucaflyt1
{{!}} status-fdm = 0
{{!}} status-systems = 2
{{!}} status-cockpit = 2
{{!}} status-model = 2
{{!}} devel-website = https://aucafly.wordpress.com/2016/06/07/t1-world-premiere/
{{!}} craft = vehicle
{{cbr}}

{{infobox aircraft
| name = Aucafly T1
| hangar = aucafly
| aircraft = AUCAFLYT1
| image = Aucafly T1.png
| alt = Aucafly T1 leaving San Francisco International Airport
| type = Civil aircraft/Fictional aircraft
| propulsion = Propeller aircraft
| manufacturer = Aucafly
| authors = Ausdkunst/D-Echo (FDM)
| fdm = YASim
| fgname = aucaflyt1
| status-fdm = 0
| status-systems = 2
| status-cockpit = 2
| status-model = 2
| devel-website = https://aucafly.wordpress.com/2016/06/07/t1-world-premiere/
| craft = vehicle
| float = none
}}

=== Buckaroo's hangar ===

==== Velocity XL RG ====
This is an example for the [[Velocity XL RG]] article, specifically in the [[Velocity XL RG/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Velocity XL RG
{{!}} hangar = buckaroo
{{!}} aircraft = Velocity_XL_RG
{{!}} image = Velocity-XL-RG.jpg
{{!}} alt = Velocity XL RG in flight
{{!}} image2 = Velocity-XL-RG cabin 01.jpg
{{!}} alt2 = Velocity XL RG cabin
{{!}} type = Civil aircraft/Civil utility aircraft
{{!}} config = Canard aircraft/Pusher aircraft
{{!}} propulsion = Propeller aircraft/Single-engine aircraft
{{!}} manufacturer = Velocity
{{!}} authors = Gary Neely
{{!}} fdm = YASim
{{!}} fgname = Velocity-XL-RG
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Velocity XL RG
| hangar = buckaroo
| aircraft = Velocity_XL_RG
| image = Velocity-XL-RG.jpg
| alt = Velocity XL RG in flight
| image2 = Velocity-XL-RG cabin 01.jpg
| alt2 = Velocity XL RG cabin
| type = Civil aircraft/Civil utility aircraft
| config = Canard aircraft/Pusher aircraft
| propulsion = Propeller aircraft/Single-engine aircraft
| manufacturer = Velocity
| authors = Gary Neely
| fdm = YASim
| fgname = Velocity-XL-RG
| navbar = 1
| float = none
}}

=== Dave's hangar ===

==== McDonnell F-4 Phantom II ====
This is an example for the [[McDonnell F-4 Phantom II]] article, specifically in the [[McDonnell F-4 Phantom II/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = McDonnell Douglas F-4 Phantom II
{{!}} hangar = dave
{{!}} image = F4N.JPG
{{!}} type = Military aircraft/Interceptor aircraft/Fighter aircraft/Bomber aircraft
{{!}} manufacturer = McDonnell/McDonnell Douglas
{{!}} authors = Dave Culp
{{!}} fdm = JSBSim
{{!}} fgname = F-4N
{{!}} download = http://www.daveshangar.org/aircraft/F-4N.tar.gz
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = McDonnell Douglas F-4 Phantom II
| hangar = dave
| image = F4N.JPG
| type = Military aircraft/Interceptor aircraft/Fighter aircraft/Bomber aircraft
| manufacturer = McDonnell/McDonnell Douglas
| authors = Dave Culp
| fdm = JSBSim
| fgname = F-4N
| download = http://www.daveshangar.org/aircraft/F-4N.tar.gz
| navbar = 1
| float = none
}}

=== Emilian H's hangar ===

==== IAR 80 ====
This is an example for the [[IAR 80]] article, specifically in the [[IAR 80/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = IAR 80
{{!}} hangar = emilianh
{{!}} aircraft = IAR80
{{!}} image = Iar80-flight.jpg
{{!}} alt = The IAR 80 in its the default livery.
{{!}} image2 = Iar80-cockpit-dusk.jpg
{{!}} alt2 = The IAR 80's cockpit as dusk
{{!}} type = Fighter aircraft
{{!}} config = Low wing aircraft
{{!}} propulsion = Propeller aircraft/Single-engine aircraft
{{!}} manufacturer = Industria Aeronautică Română (IAR)
{{!}} authors = Emilian Huminiuc (3D model, textures, YASim FDM)/Ron Jensen (JSBSim FDM)
{{!}} fdm = YASim/JSBSim
{{!}} fgname = IAR80-YASim
{{!}} status-fdm = 5
{{!}} status-systems = 4
{{!}} status-cockpit = 5
{{!}} status-model = 5
{{!}} license = CC-BY-NC-ND 4.0/GPLv2
{{!}} note = The JSBSim FDM is in beta
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = IAR 80
| hangar = emilianh
| aircraft = IAR80
| image = Iar80-flight.jpg
| alt = The IAR 80 in its the default livery.
| image2 = Iar80-cockpit-dusk.jpg
| alt2 = The IAR 80's cockpit as dusk
| type = Fighter aircraft
| config = Low wing aircraft
| propulsion = Propeller aircraft/Single-engine aircraft
| manufacturer = Industria Aeronautică Română (IAR)
| authors = Emilian Huminiuc (3D model, textures, YASim FDM)/Ron Jensen (JSBSim FDM)
| fdm = YASim/JSBSim
| fgname = IAR80-YASim
| status-fdm = 5
| status-systems = 4
| status-cockpit = 5
| status-model = 5
| license = CC-BY-NC-ND 4.0/GPLv2
| note = The JSBSim FDM is in beta
| navbar = 1
| float = none
}}

=== HerbyW's hangar ===

==== Space Shuttle (FG Space Program) ====
This is an example for the [[Space Shuttle (FG Space Program)]] article, specifically in the [[Space Shuttle (FG Space Program)/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Shuttle
{{!}} hangar = herbyw
{{!}} aircraft = shuttle
{{!}} image = Atlantis.png
{{!}} alt = Shuttle ''Atlantis''
{{!}} type = Spaceplane
{{!}} config = Delta-wing aircraft
{{!}} authors = HerbyW (FDM)/Firefly (3D)/Original Project Jon S. Berndt
{{!}} fdm = JSBSim
{{!}} fgname = shuttle/shuttle-Atlantis/shuttle-Columbia/shuttle-Launcher
{{!}} status-fdm = 2
{{!}} status-systems = 1
{{!}} status-cockpit = 0
{{!}} status-model = 3
{{!}} ready = rembrandt
{{!}} craft = spacecraft
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Shuttle
| hangar = herbyw
| aircraft = shuttle
| image = Atlantis.png
| alt = Shuttle ''Atlantis''
| type = Spaceplane
| config = Delta-wing aircraft
| authors = HerbyW (FDM)/Firefly (3D)/Original Project Jon S. Berndt
| fdm = JSBSim
| fgname = shuttle/shuttle-Atlantis/shuttle-Columbia/shuttle-Launcher
| status-fdm = 2
| status-systems = 1
| status-cockpit = 0
| status-model = 3
| ready = rembrandt
| craft = spacecraft
| navbar = 1
| float = none
}}

=== Lake of Constance hangar ===

==== Boeing 707-420 ====
This is an example for the [[Boeing 707-420]] article, specifically in the [[Boeing 707-420/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Boeing 707-420/430
{{!}} hangar = lake of constance
{{!}} image = Splash707-420.png
{{!}} alt = {{LangSwitch
{{!}} de = Splash Screen der Boeing 707-420/430
{{!}} en = The 707-420/430's splash screen
}}
{{!}} type = Airliner/Military tanker aircraft
{{!}} config = Low wing aircraft/Monoplane aircraft/Retractable gear aircraft/Tricycle landing gear aircraft
{{!}} propulsion = Quadjet
{{!}} manufacturer = Boeing
{{!}} fdm = JSBSim
{{!}} authors = {{LangSwitch
{{!}} de = Marc Kraus - Lake of Constance Hangar/Original von Innis Cunningham
{{!}} en = Marc Kraus - Lake of Constance Hangar/Original model by Innis Cunningham
}}
{{!}} fgname = 707/707-TT/EC-137D
{{!}} status-fdm = 4
{{!}} status-systems = 5
{{!}} status-cockpit = 5
{{!}} status-model = 5
{{!}} ready = tutorials/checklist/rembrandt/airrefuel
{{!}} download = http://www.marc-kraus.de
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Boeing 707-420/430
| hangar = lake of constance
| image = Splash707-420.png
| alt = {{LangSwitch
| de = Splash Screen der Boeing 707-420/430
| en = The 707-420/430's splash screen
}}
| type = Airliner/Military tanker aircraft
| config = Low wing aircraft/Monoplane aircraft/Retractable gear aircraft/Tricycle landing gear aircraft
| propulsion = Quadjet
| manufacturer = Boeing
| fdm = JSBSim
| authors = {{LangSwitch
| de = Marc Kraus - Lake of Constance Hangar/Original von Innis Cunningham
| en = Marc Kraus - Lake of Constance Hangar/Original model by Innis Cunningham
}}
| fgname = 707/707-TT/EC-137D
| status-fdm = 4
| status-systems = 5
| status-cockpit = 5
| status-model = 5
| ready = tutorials/checklist/rembrandt/airrefuel
| download = http://www.marc-kraus.de
| navbar = 1
| float = none
}}

=== PAF hangar ===

==== Douglas C-47 Skytrain ====
This is an example for the [[Douglas C-47 Skytrain]] article, specifically in the [[Douglas C-47 Skytrain/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Douglas DC-3 C-47
{{!}} hangar = paf
{{!}} image = Dc-3-splash.png
{{!}} type = Airliner/Military transport aircraft
{{!}} config = Low wing aircraft
{{!}} propulsion = Twin-engine piston aircraft
{{!}} manufacturer = Douglas
{{!}} authors = PAF team (FDM, Hydraulic, Electric, Dual Control, Instruments, 3D)/Emmanuel Baranger (Exterior & interior 3D model)
{{!}} status-fdm = 4
{{!}} status-systems = 4
{{!}} status-cockpit = 4
{{!}} status-model = 4
{{!}} fdm = YASim/JSBSim
{{!}} fgname = dc-3-jsbsim (wheels)/dc-3-yasim (wheels)/dc-3A (Amphibius)/dc-3-copilot/dc-3-psg1/dc-3-psg2/dc-3-psg3/dc-3-psg4
{{!}} ready = dualcontrol/tutorials
{{!}} devel-website = <nowiki>http://equipe-flightgear.forumactif.com/t756-douglas-dc-3-c-47-part-2-2</nowiki>
{{!}} download = <nowiki>http://clement.delhamaide.free.fr/PAF/Douglas-Dc3.tar.gz</nowiki>
{{!}} liverydbid = 76
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Douglas DC-3 C-47
| hangar = paf
| image = Dc-3-splash.png
| type = Airliner/Military transport aircraft
| config = Low wing aircraft
| propulsion = Twin-engine piston aircraft
| manufacturer = Douglas
| authors = PAF team (FDM, Hydraulic, Electric, Dual Control, Instruments, 3D)/Emmanuel Baranger (Exterior & interior 3D model)
| status-fdm = 4
| status-systems = 4
| status-cockpit = 4
| status-model = 4
| fdm = YASim/JSBSim
| fgname = dc-3-jsbsim (wheels)/dc-3-yasim (wheels)/dc-3A (Amphibius)/dc-3-copilot/dc-3-psg1/dc-3-psg2/dc-3-psg3/dc-3-psg4
| ready = dualcontrol/tutorials
| devel-website = http://equipe-flightgear.forumactif.com/t756-douglas-dc-3-c-47-part-2-2
| download = http://clement.delhamaide.free.fr/PAF/Douglas-Dc3.tar.gz
| liverydbid = 76
| navbar = 1
| float = none
}}

=== Prestes hangar ===

==== Boeing 707-400 ====
This is an example for the [[Boeing 707-400]] article, specifically in the [[Boeing 707-400/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Boeing 707-400
{{!}} hangar = prestes
{{!}} aircraft = boeing-707-400
{{!}} image = 707-400.png
{{!}} alt = Lufthanse 707-400
{{!}} image2 = 707-400b.png
{{!}} alt2 = The VARIG 707-400 PAX
{{!}} type = Airliner
{{!}} config = Low wing aircraft
{{!}} propulsion = Jet aircraft/Four-engine aircraft
{{!}} manufacturer = Boeing
{{!}} authors = Isaias V. Prestes/Innis Cunningham/Erik Hofman (FDM)
{{!}} fdm = JSBSim
{{!}} fgname = 707-400
{{!}} status = Alpha
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Boeing 707-400
| hangar = prestes
| aircraft = boeing-707-400
| image = 707-400.png
| alt = Lufthanse 707-400
| image2 = 707-400b.png
| alt2 = The VARIG 707-400 PAX
| type = Airliner
| config = Low wing aircraft
| propulsion = Jet aircraft/Four-engine aircraft
| manufacturer = Boeing
| authors = Isaias V. Prestes/Innis Cunningham/Erik Hofman (FDM)
| fdm = JSBSim
| fgname = 707-400
| status = Alpha
| navbar = 1
| float = none
}}

=== Lost aircraft ===

==== C-17 Globemaster III ====
This is an example for the [[C-17 Globemaster III]] article, specifically in the [[C-17 Globemaster III/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = C-17 Globemaster III
{{!}} hangar = bermuda
{{!}} image = C17inflight.png
{{!}} type = Military transport aircraft/Strategic aircraft/Tactical airlifter
{{!}} config = High wing aircraft
{{!}} propulsion = Jet aircraft/Four-engine aircraft
{{!}} manufacturer = McDonnell Douglas/Boeing
{{!}} authors = Jon Bourgeois (FDM)/Adam Fothergill (3D)
{{!}} fdm = JSBSim
{{!}} fgname = C-17
{{!}} status = Not released yet
{{!}} note = The <nowiki>[http://cid-4501304d324ef633.office.live.com/self.aspx/.Public/C-17/C-17%2020100418.zip original download link]</nowiki> is dead.
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = C-17 Globemaster III
| hangar = bermuda
| image = C17inflight.png
| type = Military transport aircraft/Strategic aircraft/Tactical airlifter
| config = High wing aircraft
| propulsion = Jet aircraft/Four-engine aircraft
| manufacturer = McDonnell Douglas/Boeing
| authors = Jon Bourgeois (FDM)/Adam Fothergill (3D)
| fdm = JSBSim
| fgname = C-17
| status = Not released yet
| note = The [http://cid-4501304d324ef633.office.live.com/self.aspx/.Public/C-17/C-17%2020100418.zip original download link] is dead.
| navbar = 1
| float = none
}}

=== No hangar ===

==== Pipistrel Virus SW ====
This is an example for the [[Pipistrel Virus SW]] article, specifically in the [[Pipistrel Virus SW/info]] subpage.

{{obr}}infobox aircraft
{{!}} name = Pipistrel Virus SW
{{!}} image = Pipistrel Virus SW.png
{{!}} type = Civil aircraft/Civil utility aircraft
{{!}} propulsion = Propeller aircraft/Single-engine aircraft
{{!}} manufacturer = Pipistrel
{{!}} author1 = {{obr}}usr{{!}}Nick R{{cbr}}
{{!}} fdm = JSBSim
{{!}} fgname = virus-sw
{{!}} status = Development
{{!}} devel-repo = {{obr}}[[Template:github url|github url]]{{!}}user=Nick-R9{{!}}repo=pipistrel-virus-sw{{cbr}}
{{!}} download = <nowiki>http://www.fgpipistrel.org/downloads/</nowiki>
{{!}} navbar = 1
{{cbr}}

{{infobox aircraft
| name = Pipistrel Virus SW
| image = Pipistrel Virus SW.png
| type = Civil aircraft/Civil utility aircraft
| propulsion = Propeller aircraft/Single-engine aircraft
| manufacturer = Pipistrel
| author1 = {{usr|Nick R}}
| fdm = JSBSim
| fgname = virus-sw
| status = Development
| devel-repo = {{github url|user=Nick-R9|repo=pipistrel-virus-sw}}
| download = http://www.fgpipistrel.org/downloads/
| navbar = 1
| float = none
}}

}}

[[Category:Infobox templates|Aircraft]]
</noinclude>

Template:Hangar banner

2017-12-09T15:30:41Z

Elgaton: Translate the template to Italian

{{#switch: {{{1|fgaddon}}}
| aucafly = [[File:Aucafly banner.jpg|{{{size|300px}}}|AUCAFLY hangar|alt=AUCAFLY hangar|link=https://aucafly.wordpress.com/]]
| bermuda = [[File:Bermudastriangle.png|{{{size|300px}}}|Bermuda Triangle disappearance|alt=Bermuda Triangle disappearance|link=:Category:Bermuda Triangle|]]
| buckaroo = <big><big>[http://www.buckarooshangar.com/flightgear Buckaroo's Hangar]</big></big>
| bulldogrs = [[File:BulldogRS_banner.jpg|{{{size|300px}}}|Bulldog_RS_hangar|alt=Bulldog RS hangar|link=https://bulldogrs.wordpress.com/]]
| dave = [[File:Dave's hangar logo.png|{{{size|300px}}}|Dave's hangar|alt=Dave's hangar|link=http://www.daveshangar.org/]]
| fgaddon = [[File:FGAddon logo.png|{{{size|300px}}}
| {{LangSwitch
| ar = FGAddon: حظيرة الطائرات الخاصة بفلايت جير
| de = FGAddon: Der offizielle FlightGear-Flugzeughangar
| en = FGAddon: The official FlightGear hangar
| es = FGADDON: El hangar official de FlightGear
| fr = FGAddon: Le hangar d'aéronef officiel de FlightGear
| it = FGAddon: l'hangar ufficiale di FlightGear
| th = FGAddon: ที่รวบรวมเครื่องบินของ FlightGear เอง

}}
| alt=FGAddon|link=FGAddon
]]
| fgdata = [[File:FGData_logo.png|{{{size|300px}}}
| {{LangSwitch
| ar = FGData: طائرات الحزمة الرئيسية لدى فلايت جير
| de = FGData: Flugzeuge des FlightGear-Basispakets.
| en = FGData: Aircraft of the base FlightGear package.
| fr = FGData: Les aéronefs FlightGear de base.
| it = FGData: gli aeromobili del pacchetto FlightGear di base.
| th = FGData: มาพร้อมกับโปรแกรม
}}
| alt=FlightGear|link=FlightGear
]]
| fguk = [[File:Fguk.png|{{{size|300px}}}|FGUK hangar|alt=FGUK hangar|link=http://www.fguk.eu/index.php/hangar]]
| grtux = <big><big>[https://sites.google.com/site/grtuxhangar/ GRTux hangar]</big></big>
| helijah = [[File:Helijahlogo300whiteframed.png|{{{size|300px}}}|Helijah hangar|alt=Helijah hangar|link=http://helijah.free.fr/flightgear/hangar.htm]]
| herbyw = [[File:Herbywlogo.png|{{{size|300px}}}|HerbyW's hangar|alt=HerbyW's hangar|link=https://github.com/HerbyW]]
| it0uchpods = [[File:Ithhq.png|{{{size|300px}}}|It0uchpods hangar|alt=it0uchpods Hangar|link=https://github.com/it0uchpods]]
| lake of constance = [[File:Lakeofconstance.png|{{{size|300px}}}|Lake of Constance hangar|alt=Lake of Constance hangar|link=http://www.marc-kraus.de]]
| paf = <big><big>[http://equipe-flightgear.forumactif.com/t835-hangar-de-la-paf-paf-team-hangar#14330 PAF hangar]</big></big>
| prestes = <big><big>[http://presteshangar.wikidot.com/ Prestes hangar]</big></big>
}}<noinclude>
{{Informative template|1=
== Goal ==
This template is used to generate and embed an aircraft hangar banner graphic or text, linking to the hangar's website.

== Usage ==
{{obr}}hangar banner
{{!}} hangar =
{{!}} ''size'' =
{{cbr}}

== Examples ==

=== AUCAFLY hangar ===
{{obr}}hangar banner{{!}}aucafly{{cbr}}

{{hangar banner|aucafly}}

=== Bermuda Triangle ===
{{obr}}hangar banner{{!}}bermuda{{cbr}}

{{hangar banner|bermuda}}

=== Buckaroo's hangar ===
{{obr}}hangar banner{{!}}buckaroo{{cbr}}

{{hangar banner|buckaroo}}

=== Bulldog RS hangar ===
{{obr}}hangar banner{{!}}bulldogrs{{cbr}}

{{hangar banner|bulldogrs}}

=== Dave's hangar ===
{{obr}}hangar banner{{!}}dave{{cbr}}

{{hangar banner|dave}}

=== FGAddon hangar ===
{{obr}}hangar banner{{!}}fgaddon{{cbr}}

{{hangar banner|fgaddon}}

=== FGData hangar ===
{{obr}}hangar banner{{!}}fgdata{{cbr}}

{{hangar banner|fgdata}}

=== FGUK hangar ===
{{obr}}hangar banner{{!}}fguk{{cbr}}

{{hangar banner|fguk}}

=== GRTux hangar ===
{{obr}}hangar banner{{!}}grtux{{cbr}}

{{hangar banner|grtux}}

=== Helijah's hangar ===
{{obr}}hangar banner{{!}}helijah{{cbr}}

{{hangar banner|helijah}}

=== HerbyW's hangar ===
{{obr}}hangar banner{{!}}herbyw{{cbr}}

{{hangar banner|herbyw}}

=== it0uchpods hangar ===
{{obr}}hangar banner{{!}}it0uchpods{{cbr}}

{{hangar banner|it0uchpods}}

=== Lake of Constance hangar ===
{{obr}}hangar banner{{!}}lake of constance{{cbr}}

{{hangar banner|lake of constance}}

=== PAF hangar ===
{{obr}}hangar banner{{!}}paf{{cbr}}

{{hangar banner|paf}}

=== Prestes hangar ===
{{obr}}hangar banner{{!}}prestes{{cbr}}

{{hangar banner|prestes}}

}}

[[Category:Templates]]
</noinclude>

Template:Cessna

2017-12-09T15:28:47Z

Elgaton: Translate the template to Italian

{{Navbox
| name = Cessna
| title = {{LangSwitch
| ar = [[:Category:Cessna|Cessna]] طائرات
| de = [[:Category:Cessna|Cessna]] Flugzeuge
| en = [[:Category:Cessna|Cessna]] aircraft
| es = Aeronaves [[:Category:Cessna|Cessna]]
| fr = Aéronefs [[:Category:Cessna|Cessna]]
| it = Aeromobili [[:Category:Cessna|Cessna]]
| zh = [[:Category:Cessna|赛斯纳]]飞机
}}
| listclass = hlist

| group1 = {{LangSwitch
| de = Zivile Flugzeuge
| en = Civilian aircraft
| es = Aeronaves Civiles
| fr = Aéronefs civil
| it = Aeromobili civili
| zh = 民用飞机
}}
| list1 =
* [[Cessna 150|150L]]
* {{LangSwitch
| de = [[:de:Cessna 172P|172P]]
| en = [[Cessna 172P|172P]]
| es = [[:es:Cessna 172P|172P]]
| fr = [[:fr:Cessna 172P|172P]]
| it = [[:it:Cessna 172P|172P]]
| nl = [[:nl:Cessna 172P|172P]]
| zh = [[:zh:Cessna 172P|172P]]
}}
* [[Cessna 172R Skyhawk|172R]]
* [[Cessna 182S|182S]]
* [[Cessna C310|310]]
* {{LangSwitch
| de = [[:de:Cessna 337G Skymaster|337G Skymaster]]
| en = [[Cessna 337G Skymaster|337G Skymaster]]
| es = [[:es:Cessna 337G Skymaster|337G Skymaster]]
| fr = [[:fr:Cessna 337G Skymaster|337G Skymaster]]
| it = [[:it:Cessna 337G Skymaster|337G Skymaster]]
}}
* [[Cessna 550 Citation II|550 Citation II]]
* [[Cessna Citation Bravo|Citation Bravo]]
* {{LangSwitch
| de = [[:de:Cessna Citation X|Citation X]]
| en = [[Cessna Citation X|Citation X]]
| es = [[:es:Cessna Citation X|Citation X]]
| fr = [[:fr:Cessna Citation X|Citation X]]
| it = [[:it:Cessna Citation X|Citation X]]
}}

| group2 = {{LangSwitch
| de = Militärische Flugzeuge
| en = Military aircraft
| es = Aeronaves Militar
| fr = Aéronefs militaire
| it = Aeromobili militari
| zh = 军用飞机
}}
| list2 =
* [[Cessna T-37|T-37]]
}}<includeonly>{{main other| [[Category:Cessna]] }}</includeonly><noinclude>
{{Informative template|1=
__NOTOC__
== Goal ==
This navigation template links together Cessna aircraft.

Adding this template to a page in the article namespace will automatically add [[:Category:Cessna]] to that page.

== Usage ==
Put this line before the categories and the language links at the bottom of the article.

{{obr}}'''Cessna'''{{cbr}}

}}

[[Category:Manufacturer navigation templates]]
</noinclude>

Howto:Set up a multiplayer server

2017-10-22T13:10:42Z

Elgaton: Moved GitLab repository URLs to SourceForge repository URLs

This page is dedicated to providing a short overview of installing the [[FlightGear Multiplayer Server]] ('fgms'). The reader is assumed to be reasonably familiar with working in a Unix/Linux shell environment.

== Pre-Requisites ==
* A computer running a variant of *nix to compile and host the server. Speed of the machine isn't of great consequence as the protocol is a multiplexer which doesn't require much processing grunt.
** For specific documentation for setting up on FreeBSD see [[Howto:Set up a multiplayer server on FreeBSD]].
* direct/physical or remote access to the server (i.e. SSH/telnet, a conventional web hosting package will usually '''not''' be sufficient!)-suitable hosting packages are: dedicated root servers, virtual private servers, shell servers - for a collection of '''free''' shell account providers that may be suitable for fgms, see [[Free Shell Providers]] (you may want to check this out if you are interested in running fgms but don't have hosting yet)
* if the server is meant to be a public internet server: an internet connection, featuring sufficient upstream/downstream capabilities (see below for details concerning bandwidth requirements).
* firewall policies will need to be set up to allow for incoming and outgoing UDP traffic for the corresponding ports, the same applies to the administration port (TCP)
* permission to run unattended background processes (this may only be an issue with certain limited hosting packages)
* a working GNU toolchain including gcc/g++ (compiler), make & cmake
* fgms source code, currently version 0.10.23
* about 5-10 MB of hard disk space (mainly required for building the binary)

== Traffic & Bandwidth Considerations ==

Note: Currently (May 2008), the server code basically boils down to a packet multiplexer (i.e. most data is -unconditionally- transmitted to all 'active' clients), which may thus create considerable amounts of traffic; this ought to be taken into consideration due to bandwidth limitations in most hosting packages (i.e. '''fgms may create considerable amounts of traffic!'''). For basic calculations: inbound traffic is 25 Kilobit per second while outbound is 25 Kbits per second for each plane/client that can 'see' another.

By default, assuming a 10hz update interval, each active fgfs client will currently cause I/O traffic of approximately 5 kbytes/sec (one update consuming ~500 bytes) [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg16016.html].

As client updates have to be propagated to all other active clients by the server, this number has to be multiplied by the number of active clients -1 (i.e. clients within a configurable range, minus the originating client).
In addition, the fgms system allows for traffic updates to be sort of 'mirrored' on (relayed to) other configurable multiplayer/relay servers.

This feature makes it possible for users/clients to use an arbitrary server (with acceptable latency), but still see clients/vehicles connected to different servers. Thus, such relay servers may additionally increase inbound/outbound traffic considerably as all traffic is mirrored/propagated to such relays.

Having more servers should actually decrease the load on each server in high load situations, i.e. when most of the clients are within range of each other. See this
[http://www.gidenstam.org/FlightGear/fgms/fgms_bandwidth_estimates.txt brief note on the theoretical bandwidth behaviour of fgms.]

=== Facts ===
In March 2008, the main fgms multiplayer server (pigeond.net) was reported to consume approximately 15 gb of bandwidth per '''day''', with an average throughput of 200 kB/sec and peak loads of up to ~ 650 kB/sec [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg16016.html].

During the same month (the much less used but interconnected) mpserver06.flightgear.org had on average 742 MB incoming and 688 MB outgoing traffic per day (i.e. 72 kbit/sec respective 66 kbit/sec on average).

In September 2009, mpserver 05 had a massive peak bandwidth of 1.0 MB/sec. Average bandwidth consumed was about 9 GB of bandwidth per day. The average bandwidth usage per day is climbing due to more users moving from 02 to 05.

In July 2013, mpserver01 load was reported averaging at 10 MBit/sec

=== Reducing bandwidth requirements ===
Total network traffic is mainly determined by the number of active clients that 'see eachother' and configured mirrors.
If traffic considerations are relevant, the following options exist to reduce overall server/network load:

* configure a relatively low "server.out_of_reach" value, so that clients outside a certain range are not provided with updates (usually about 100 nm on the main server network)
* for virtual gatherings (i.e. fly-ins), have clients use airports and places that do not have lots of other traffic (i.e. in other words, avoid places like standard airports such as KSFO)
* avoid the use of unnecessary relay servers
* if you are not interested in your server being publicly available, only share its address with your friends privately
* for local testing/development purposes, you may want to run only a private fgms session, that may be specific to your LAN or even computer.

== Getting & Building fgms ==
* You will need the build tools cmake and make, and also g++ to compile the fgms application. These can usually be found in the package manager for most the common Linux distributions. You will also need the git client to fetch the source code from the repository, if you plan to download it from the command line interface (see below).
* Once the build tools are installed on your machine, create a directory to hold the source code. This could be named anything, such as fgms. Create it in your user home directory. Note that this WILL NOT be the directory where the program will be compiled.
* Now 'cd' into the directory you just made, where you will run the command to fetch the source code from the git repository (see below).
* To download the latest stable version via HTTP, you can use direct your browse to the URL https://sourceforge.net/projects/fgms/. Download and unzip the source code, and place it in the directory you created above.
* To download a file directly to your server from an ssh session, you can use git tools with the following command:
:<syntaxhighlight lang="bash">git clone https://git.code.sf.net/p/fgms/src</syntaxhighlight>

== Compiling FGMS ==

For FreeBSD-specific instructions, please see [[Howto:Set up a multiplayer server on FreeBSD]]

NOTE: In general, on any current machine this process should not take longer than about 60 seconds.

* Once you have the source code, 'cd' into the ~/fgms/ directory and note the presence of the CMakeLists.txt file and the README.cmake file. Open the README.cmake file and take a minute to read it over. Also, note the path to the CMakeLists.txt file, as you will need this in the following steps.

* Now create a build-fgms directory in your home directory, and 'cd' into it. From inside the ~/build-fgms/ directory, run the cmake command using the path to the CMakeLists.txt as an argument. For example: cmake /home/<user_name>/fgms/

* Once the build finishes, you can either run the "cmake --build ..." command as shown in the README.cmake file, or you can simply use "make" to build the program.

* Once the compilation process finishes, you need to install the program using "make install" (as user), or you can also install as root.

* Once the program has been installed, you need to copy the fgms_example.conf file from the /fgms/src/server directory, into the build-fgms directory. To do this from inside the /fgms/src/server directory, you can use this command: cp ./fgms_example.conf ~/build-fgms/

* Now 'cd' into the build-fgms directory, and rename the file you just copied as "fgms.conf" so that fgms can find the proper configuration.

== Setting up the config file ==

At this point you should have a working 'fgms' binary in the build-fgms directory. If the server will be offline or for private use (i.e. LAN-only, please comment out the relay servers section. This will save bandwidth from the server being consumed.

* Edit the fgms.conf file according to the instructions found elsewhere on this page, then save and close the file.

{{cquote|As long as you are not absolutly sure what you are doing you should:
- disable tracking
- disable HUB setting<ref>{{cite web |url=http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg40454.html|title=<nowiki>Re: [Flightgear-devel] New FlightGear Multiplayer Server</nowiki>|author=Oliver Schröder|date=Wed, 10 Jul 2013 13:53:55 -0700}}</ref>|Oliver Schröder}}

{{cquote|fgms will ignore traffic comming from unknown relays and since the multiplayer network is a star topology you should list only mpserver01
as your only relay. Currently mpserver01 is the only HUB, Although multiple HUBs should work I have not tested a multi HUB environment yet.
And for those interrested: Current traffic load on mpserver01 is around 10 MBit/s<ref>{{cite web |url=http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg40454.html|title=<nowiki>Re: [Flightgear-devel] New FlightGear Multiplayer Server</nowiki>|author=Oliver Schröder|date=Wed, 10 Jul 2013 13:53:55 -0700}}</ref>|Oliver Schröder}}

{{cquote|your fgms.conf should look like:
<pre>
# basic setting
server.name = mpserver02
server.port = 5000

# you can telnet to this port with this username/password
# and see statistics (nice cisco like CLI)
server.admin_port = 6002
server.admin_user = fred
server.admin_pass = fred

server.admin_enable = fred

# mpserver01 does this
server.tracked = false

# mpserver01 is hub
server.is_hub = false</pre><ref>{{cite web |url=http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg40454.html|title=<nowiki>Re: [Flightgear-devel] New FlightGear Multiplayer Server</nowiki>|author=Oliver Schröder|date=Wed, 10 Jul 2013 13:53:55 -0700}}</ref>|Oliver Schröder}}

{{cquote|<pre># don't set this too high
server.out_of_reach = 100

# your only relay should be mpserver01
relay.host = mpserver01.flightgear.org
relay.port = 5000

# you don't need a crossfeed, it's only interresting for fgms-developers
# crossfeed.host = foo.example.com
# crossfeed.port = 5002

# you can add static entries of IPs which get blocked,
# but it's generally not needed and you can add them via
# the admin CLI
# blacklist = 123.123.123.123</pre><ref>{{cite web |url=http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg40454.html|title=<nowiki>Re: [Flightgear-devel] New FlightGear Multiplayer Server</nowiki>|author=Oliver Schröder|date=Wed, 10 Jul 2013 13:53:55 -0700}}</ref>|Oliver Schröder}}

== Running FGMS for the first time ==

In addition to its configuration file, FGMS supports a number of configuration parameters that can be passed at startup (and that will by default override any configuration file settings), to get a summary of supported parameters, you may want to run:
$ ./fgms --help

Which should present you with the following output:

<pre>
options are:
-h print this help screen
-a PORT listen to PORT for telnet
-c config read 'config' as configuration file
-p PORT listen to PORT
-t TTL Time a client is active while not sending packets
-o OOR nautical miles two players must be apart to be out of reach
-l LOGFILE Log to LOGFILE
-v LEVEL verbosity (loglevel) in range 1 (few) and 5 (much)
-d do _not_ run as a daemon (stay in foreground)
-D do run as a daemon

the default is to run as a daemon, which can be overridden in the
config file.
commandline parameters always override config file options
</pre>

After having finished the fgms configuration, you can try running fgms and start up fgfs to use the new server.
=== Public Server ===
If you'd like to make it a public server, you can simply use your external (public) IP address to set up the multiplayer in fgfs.

For others to know about your public server you should notify the developers of the existence of your server by posting a message to the [[Mailing list|developers mailing list]].

Add your server to this list: http://wiki.flightgear.org/Howto:Multiplayer#Servers

== Related content ==
* [http://fgms.freeflightsim.org/ Website: fgms.freeflightsim.org]
* [[Howto: Multiplayer|Multiplayer howto]]
* [[MPmap]]

<references/>

[[Category:Howto]]
[[Category:Multiplayer]]

[[fr:Installer un serveur multijoueur]]

Howto:Translate FlightGear

2017-06-28T22:08:04Z

Elgaton: Add shortcut file and man pages translation instructions

FlightGear supports localization, that is, showing the user interface in the user's native language rather than in English. At the time of writing (June 2017), not all parts of the simulator are localized, but efforts are underway to make it so.

This page will help you translate FlightGear to a new language or improve the existing translations.

== What can be translated ==
The following parts of the simulator can be translated:
* the menus, splash screens, startup tips and the text shown when the <code>--help</code> command-line option is used (FlightGear 2.7.0 and later);
* the shortcut file on Linux systems (FlightGear 2017.1 and later);
* the man pages (FlightGear 2017.3 and later).

== How to translate the interface ==
# Determine the two letter ISO 639-1 language code for the language you want to translate FlightGear to. A list can be found on the [https://www.loc.gov/standards/iso639-2/php/code_list.php Library of Congress Web site].
# Check whether your language already has a subdirectory below [{{fgdata url|path=Translations}} the Translations directory]. If it does not, create an empty directory in it named after the language code, then [{{fgdata url|path=Translations/en}} download the latest English resources] and copy the files to the directory of your language.
# Open the XML files in the subdirectory of your language and translate the English strings in them. Do not translate the filenames and do not change the order, structure or indentation of the XML files (this helps with future maintenance when the language resources need to be updated for another FlightGear version).
# Start FlightGear to test your translation. By default, the simulator will select the locale of your operating system as the language to use; you can explicitly select a language using the command-line option <code>--language=<i>language code</i></code>.

Note that the user interface might have not full Unicode support (some special/accented characters might not be shown): should you encounter such a location, please write to the flightgear-devel mailing list at {{Mailing list e-mail address|flightgear-devel}}.

== How to translate the shortcut file ==
Open [{{flightgear url|path=package/org.flightgear.FlightGear.desktop}} the FlightGear <code>.desktop</code> file] and translate the ''GenericName'', ''Comment'' and ''Keywords'' keys (add the ''GenericName[xx]'', ''Comment[xx]'' and ''Keywords[xx]'' keys, where ''xx'' is the two letter ISO 639-1 code of the language).

== How to translate the man pages ==
# Determine the two letter ISO 639-1 language code for the language you want to translate the man pages to.
# Check whether your language already has a subdirectory below [{{flightgear url|path=man}} the man pages directory]. If it does not, create an empty directory in it named after the language code, then copy <code>man1</code> and <code>man5</code> from the man pages directory to the directory of your language.
# Edit [{{flightgear url|path=man/CMakeLists.txt}} man/CMakeLists.txt] and add the instruction <code>add_subdirectory(xx)</code> in the <code>if(NOT WIN32)</code> block (where ''xx'' is the language code).
# Edit <code>man/xx/man1/CMakeLists.txt</code> and <code>man/xx/man5/CMakeLists.txt</code>: on the last row, set the installation directory (<code>DESTINATION</code>), respectively, to <code>${CMAKE_INSTALL_MANDIR}/xx/man1</code> and <code>${CMAKE_INSTALL_MANDIR}/xx/man5</code>.
# Open the man pages in the subdirectory of your language and translate them.

== Related content ==
* [[Howto: Translate FlightGear Launch Control‎‎]]
* [[Translation requests]]

[[Category:Howto|Translate FlightGear]]

Mumble

2016-06-29T07:08:34Z

Elgaton: Remove empty section for now

{{Infobox Software
| title = Mumble
| logo =
| image =
| alt =
| developedby = Various
| initialrelease = 2005
| latestrelease = 1.2.16 (stable)
| writtenin = C++
| os = Windows, OS X, Linux, Android, iOS
| platform = PC, Mac, smartphones
| developmentstatus =
| developmentprogress =
| type = Voice chat software
| license = [https://github.com/mumble-voip/mumble/blob/master/LICENSE Open source]
| website = http://wiki.mumble.info/wiki/Main_Page
}}

'''Mumble''' is a free, open source VoIP software used by some ATCs and pilots on the multiplayer network.

== Installation and configuration ==
# Download Mumble from its [http://wiki.mumble.info/wiki/Main_Page official website] (choose the links from the ''Stable Release'' column). If you're on Linux, you can usually install it using your package manager.
# Start it and follow the instructions on your screen to configure the program.
{{tip|We suggest to choose the '''Push-To-Talk''' mode in the '''Voice Activity Detection''' step; if you choose another mode, make sure to calibrate the volume levels correctly (follow the on-screen instructions carefully). This way, your voice will be transmitted only when you mean to, and there will be less background noise on the channel.}}

== Connecting ==
<ol>
<li>Click on {{Menu item|Server|Connect}}.</li>
<li>If this is the first time you connect to the FlightGear Mumble server, click on {{button|Add New...}} at the bottom of the window and input the following parameters, then click {{button|OK}}:
{| class="wikitable"
|-
| '''Label'''
| <tt>FlightGear ATC</tt> (or another descriptive name of your choice)
|-
| '''Address'''
| <tt>mumble.allfex.org</tt>
|-
| '''Port'''
| <tt>64738</tt> (the default value)
|-
| '''Username'''
| A username (callsign) of your choice
|}</li>
<li>Select '''FlightGear ATC''' from the server list and click {{button|Connect}}.</li>
</ol>



== Using Mumble ==
When you are connected, Mumble will show a hierarchical list of channels on the right side of the main window.
* To enter an existing channel, right click on it and choose {{Menu item|Join Channel}}.
* To create a new channel (e.g. if you're acting as a controller), right click on the ''FlightGear'' channel and choose {{Menu item|Add}}. Input a name and (optionally) a description, then click {{button|OK}}.
{{note|The new channel is temporary and will be deleted when the last person in it exits the channel.}}
* To mute yourself, click the {{button|Mute}} button in the main toolbar.

== OpenRadar flickering when using Mumble ==
If you're using Mumble and OpenRadar at the same time, you might notice that the OpenRadar screen flickers. A solution is disabling the Mumble overlay (in Mumble, click on {{Menu item|Configure|Settings}}, open the '''Overlay''' section, deselect '''Enable Overlay''' and click {{button|OK}}).

[[Category:Air Traffic Control]]
[[Category:Software]]

FlightGear Newsletter June 2016

2016-06-19T09:29:30Z

Elgaton: Use the Appendix template for references

{{draft|newsletter|Please feel free to add content that you think will be of interest to the FlightGear community.<br>You can read the latest newsletter at [[FlightGear Newsletter May 2016]].}}

{{Newsletter-header|June 2016}}
<div style="border-bottom:3px double #BBB;">
{| width="100%" |
| valign="top" width="33%" |
{{Newsletter-cover-header|Development news}}<br>
{{Newsletter-cover-header|In the hangar}}<br>
[[#Aucafly T1|Aucafly T1]]<br>
[[#GTA V Washington|GTA V Washington]]<br>
| valign="top" width="33%" |
{{Newsletter-cover-header|Scenery Corner}}<br>
{{Newsletter-cover-header|Community News}}<br>
| valign="top" width="33%" |
{{Newsletter-cover-header|Contributing}}<br>
[[#Translators required|Translators required]]<br>
[[#FlightGear logos|FlightGear logos]]<br>
[[#Screenshots|Screenshots]]<br>
<small>[[#Screenshot of the Month|Screenshot of the Month]]</small>
|}</div>

== Development news ==

== In the hangar ==
=== Aucafly T1 ===
[[Aucafly T1]] has been released. It can be found in {{github source|proj=aucafly|repo=AUCAFLYT1|text=GitHub}}. See also the [https://aucafly.wordpress.com official website].
=== GTA V Washington ===
[[GTA V Washington]] has been released. It can be found in {{github source|proj=aucafly|repo=GTAWAS|text=GitHub}}. See also the [https://aucafly.wordpress.com official website].

<gallery mode="packed">
Aucafly_T1.png|[[Aucafly T1]]
GTA_V_Washington.jpg|GTA V Washington
</gallery>

== Scenery corner ==
As part of the new release, there's an opportunity for us to include some carrier aviation if we wanted to. The Marinha do Brasil (Brazilian Navy) operates the aircraft carrier São Paulo, which happens to have previously been the French aircraft carrier Foch, which we have a working model for. They also happen to operate Douglas AF-1 Skyhawks (aka [[Douglas A-4 Skyhawk|A4 Skyhawk]]), which we also have, albeit not in the appropriate livery and not quite up to date avionics. If anyone is interested in doing so, it might be a nice enhancement to include an AI scenario with the Foch off the coast of Rio, and include livery support on the A4 to match the Marinha do Brasil. As Brazil is one of the few countries operating CATOBAR aircraft carriers, it seems a fine opportunity to add an additional international flavour to the sim for the upcoming release.<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35147566/
|title = <nowiki> [Flightgear-devel] Naval aviation in Brazil </nowiki>
|author = <nowiki> Stuart Buchanan </nowiki>
|date = Jun 9th, 2016
|added = Jun 9th, 2016
|script_version = 0.40
}}</ref>
===Canary Islands===
[https://forum.flightgear.org/viewtopic.php?f=5&t=29773 Some work] in the Canary Islands, in [[Custom Spain and Portugal Scenery|Spain]]; dedicated textures for sandy and arid landscapes, airport buildings and structures (GXCO, GCLA, GCGM, GCHI, GCLB and others), shared objects (canary houses and hotel) and airport layout regeneration by [[User:D-ECHO|D-ECHO]] and [[User:Catalanoic|Catalanoic]].

== Community news ==

== Contributing ==
=== Translators required ===
{|
| [[File:en.gif]]
| The FlightGear Wiki still needs help for translating it into various languages. If you are interested in making the FlightGear Wiki multilingual, you can start by looking at [[Help:Translate]].
|-
| [[File:fr.gif]]
| Le wiki de FlightGear a toujours besoin d'aide pour être traduit en différentes langues. Si vous êtes intéressé par le rendre multilingue, commencez par lire [[:fr:Help:Traduire|Help:Traduire]].
|-
| [[File:de.gif]]
| Das FlightGear Wiki braucht noch Hilfe für sie in verschiedene Sprachen zu übersetzen. Wenn Sie bei der Herstellung der FlightGear Wiki mehrsprachiger interessiert sind, können Sie, indem Sie auf [[:de:Help:Übersetzen|Help:Übersetzen]] beginnen.
|-
| [[File:nl.gif]]
| De FlightGear Wiki kan nog steed hulp gebruiken bij het vertalen van artikelen. Als je interesse hebt om de wiki meertalig te maken, raden we je aan om een kijkje te nemen bij [[:nl:Help:Vertalen|Help:Vertalen]].
|-
| [[File:es.gif]]
| La wiki de FlightGear todavía necesita ayuda para traducirla a varios lenguajes. Si estás interesado en hacer la FlightGear wiki multilingüe, entonces comienza en [[:es:Help:Traducir|Help:Traducir]].
|-
| [[File:cat.gif]]
| La wiki de FlightGear encara necessita ajuda per traduir-la a diverses llengües. Si esteu interessat en fer la wiki de FlightGear multilingüe, llavors comenceu a [[:ca:Help:Traduir|Help:Traduir]].
|-
| [[File:pt.gif]]
| A wiki de FlightGear ainda necessita de ajuda para traduzi-la em vários idiomas. Se estás interessado em tornar a wiki de FlightGear multi-lingual, por favor começa em [[:pt:Help:Traduzir|Help:Traduzir]].
|}

=== FlightGear logos ===
If you want some graphic elements for your FlightGear-related site (such as a hangar or YouTube channel), please feel free to visit [[FlightGear logos]] for a repository of logos. And if you have some art skills, please don't hesitate to contribute with your own design creations.

=== Screenshots ===
The FlightGear project always needs screenshots, which show features that were added since the last release. These should be of good quality, especially in content and technical image properties. It is therefore recommended to use the best viable filter settings ([[anti-aliasing]], texture sharpening, etc.). More info at [[Howto:Make nice screenshots]].

==== Screenshot of the Month ====
Entries for this month's best screenshot can be submitted to [https://forum.flightgear.org/viewtopic.php?f=19&t=29720 this] forum topic. Be sure to see the [https://forum.flightgear.org/viewtopic.php?f=19&t=29720#p287514 first post] for participation rules. For purposes of convenience and organization, after all the entries have been submitted, a new forum topic will be started containing all shots in an easy-to-view layout. The voting will then take place there. Once the voting has finished, the best screenshot will be presented on this page.

{{Appendix}}

[[Category:FlightGear Newsletter|2016 06]]
[[Category:Changes after 2016.2]]

[[de:FlightGear Newsletter Juni 2016]]

FlightGear wiki:Village pump

2016-06-02T08:41:01Z

Elgaton: /* Categorizing aircraft infoboxes by hangar */ Feedback

{{Archives|[[/Archive 2012|2012]]|[[/Archive 2013|2013]]|[[/Archive 2014|2014]]|[[/Archive 2015|2015]]}}
{{shortcut|FGW:VP}}
Welcome to the '''Village Pump'''. This page is used to discuss the technical issues, operations and guidelines of the [[FlightGear wiki]].

Please <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit&section=new}} add new topics]</span> to the '''bottom''' of this page.

Old discussion should be moved to a [[FlightGear wiki:Village pump/Archive YEAR]]. These discussions can then be moved to a relevant talk page if appropriate.

== Welcome template? ==
I have been thinking about suggesting a welcome template, for example named {{obr}}welcome{{cbr}}, to place on top of (at least) new users user discussion pages.

It should welcome the (new) user

In addition, it should probably mention and/or link to pages mentioning:
* The introduction page/tutorial (Hmm, I do not think I did finish that one. See [[Help talk:Tutorial]] ([http://wiki.flightgear.org/index.php?title=Help_talk:Tutorial&oldid=70843 perm])).
* Help pages
* How to use categories (in particular not like #tags, ;-) but also that image and article categories should be separate, but link to each other)
* The portals
* The style manual
* Discussion pages and where to discuss what:
** How to use discussion pages
** The wiki in general: The village pump (this page)
** Wiki articles: Article discussion pages
** Wiki user actions: User discussion pages

Maybe it should also mention that FGAddon aircraft, effects, other features etc. (except for their articles) and their bugs should be discussed on the forum, unless developers say otherwise, and that core features should be discussed on the developer mailing list and core bugs on the bug tracker.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 20:31, 30 January 2016 (EST)

: I think this is a great idea. A nice concise summary with links to help a new user navigate the FlightGear jungle would be a great addition. It should however remain very short with simple sentences - while being complete - as many users are not native speakers. So maybe there should be translations of the template with manually added links at the bottom for easy access to all the translations?

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:35, 12 February 2016 (EST)

:: Regarding an introduction article, I have come to the conclusion that a complete but long article is probably not as helpful as short but specific help pages. In essence the latter would be easier to navigate and absorb. I have therefore started to slowly split up some of the help pages and have added one more section to [[Help:Contents]].
:: I think that a welcome phrase, a link to that page and the [[FlightGear wiki:Manual of Style|style manual]] might actually suffice for a welcome template for now. It is at least better than what we currently have (i.e. more or less nothing).
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 14:47, 4 March 2016 (EST)

:: I now consider
::* A Welcome message
::* A link to this page
::* A link to the help pages
::* A link to the manual of style
::* Some final welcoming words

:: A welcome template should probably also very briefly mention a pet peeve of mine: the categories.
:: Many (if not most) image uploaders seem to treat them like tags, but if say all screenshots of aircraft (probably >2000) would end up at [[:Category:Aircraft]] (instead of under a subcategory to [[:Category:Screenshots of aircraft]]), of what use would that page be when looking for a specific one? If people would like to be able to search for an aircraft, a concise but comprehensive image description is very hard to beat.
:: How do I convey all that in a way that is, short, to the point and easy to absorb (and act by)? And where is the best place?
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:46, 8 March 2016 (EST)

:: An early draft is now at [[User:Johan G/Template:Welcome to the wiki]]
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:52, 18 April 2016 (EDT)

::: Some comments on the draft:
::: * I'm not fully sure about using a prominent box - I think it stands out a bit too much. Wikipedia {{wikipedia|Template:Welcome|uses a simple thread on the Talk page}}; as an alternative, we could use lighter colors.
::: * I've also expanded the text a bit. My proposal would be (I've put it in a box, but I'm for the "thread" solution):
<div style="background: #fff; border: 1px #585858 solid; padding: 12px; margin: 12px">
[[Image:Example.png|left]] '''Welcome to the FlightGear wiki, {{#if: {{{name|}}} | {{{name}}} | {{BASEPAGENAME}}}}'''! We hope you will enjoy your stay!

See [[Help:Contents#Reading|Reading]] to learn how wikis work. You can also [[Special:CategoryTree/Root category|browse the existing page categories]].

Should you wish to create or edit some articles, ''do so''! Here are some resources to get you started:
* [[Help:Contents#Editing|How to edit pages]]
* [[Help:Discussion pages|Discussion pages]], where we discuss and agree on potential improvements
* [[FlightGear wiki:Manual of Style|The Manual of Style]], a set of guidelines to help editors maintain a consistent style and formatting (please follow them)
* [[Help:Contents|Wiki help page]]

If you have any questions, just start a topic on the [[FlightGear wiki:Village pump|''Discuss!'' page]]. Again, welcome!
</div>
::: ...where the image on the left is an appropriately chosen icon.
::: Finally, we could use the {{mediawiki|Extension:NewUserMessage|NewUserMessage extension}} to have the wiki software automatically post the message to the new user's talk page.
::: ---- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:30, 1 May 2016 (EDT)

== Permanently removing spam bots ==
For permanently removing spam bots, has the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] Mediawiki extension been considered? I use that regularly on [http://wiki.nmr-relax.com my own wiki], though there we have also reverted to communicating to the person via email before manually granting access (probably not an option here), as all of the Mediawiki captcha methods were recently cracked.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:15, 12 February 2016 (EST)

: Oh, for the extension, we simply have a user called 'Spam bot' in a blocked state, and merge the spam bot accounts into this one, deleting the old account.
: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:20, 12 February 2016 (EST)

:: I'd use the [https://www.mediawiki.org/wiki/Extension:AbuseFilter abuse filter extension] instead (much more powerful and automated) - other users have also proposed different remedies, see [http://forum.flightgear.org/viewtopic.php?f=42&t=28734 this forum thread]. Anyway, Gijs is going to upgrade MediaWiki shortly and review the current anti-spam measures.
:: -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:26, 13 February 2016 (EST)

::: A lot of the spam bots are using their name as advertising nowadays, so the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] extension is the only one I know which will allow a user and associated name to be permanently deleted.

::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:04, 14 February 2016 (EST)

:::: The problem now is that they're also adding the information to the page title, so that it will still show up in the deletion logs [http://wiki.flightgear.org/Special:Log/delete] in other words, there's still some SEO juice associated with deleted entries ... Another idea would be to allow admins to temporarily disable wiki registrations/article creation, e.g. if more than 2 admins agree, this could be done to protect the wiki from spam attacks.

::::: Hooray, you should sign your posts ;) The bots don't target the deletion logs, as that's a little pointless. It's a Special:* page, and the default Mediawiki robots.txt file tells all search engines to not index these pages. User pages, page histories, etc. are however normally indexed.

::::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:36, 19 February 2016 (EST)

:: The point was not what the bots are targeting, but what shows up in the logs - i.e. SEO-wise - Gijs' article blacklist stuff should help with that hopefully. PS: I could not find the signature button on the mobile device I am using, and I am not too good at remembering the correct number of tildes ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:04, 19 February 2016 (EST)

== WIP vs. Under construction ==
I have been beginning to miss the under construction template[http://wiki.flightgear.org/index.php?title=Template:Under_Construction&direction=prev&oldid=46229] more and more (though I could it definitively could be improved).

I have begun to appreciate the need to differentiate between letting readers that a page is to be considered a yet to be finished construction site (though we in a way have that through the {{tl|incomplete}} template) and letting the reader (and other editors) that a page will receive a large amount of work for some hours or even days, usually the use for {{tl|WIP}}.

In summary i miss templates giving a clear distinction between conditions akin to "Under construction" and "Caution - Wet floors", rather than "being worked on" and "could need more work".

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 10:11, 17 February 2016 (EST)

== [[Fr/Pilote automatique]] ==
Bonjour,

Je viens de créer la page de traduction en français de l'article original en anglais [[Autopilot]]. Vu mes faibles compétences en matière de pilotage, vu que je n'ai pas sur ma version téléchargée d'avion avec un pilote automatique, la traduction doit souffrir quelques approximations, si ce n'est des contresens plus ennuyeux. Si quelques bonnes âmes plus qualifiées pouvaient me faire la grâce d'une relecture... merci d'avance.

Cordialement, et Hop ! --[[User:F-WTSS|F-WTSS]] ([[User talk:F-WTSS|talk]]) 15:30, 18 February 2016 (EST)

== MediaWiki updated to 1.26.2 ==
I've updated MediaWiki to the latest stable release (1.26.2) today. I've still got to update some of the extensions, so there may be regressions for now. Please report bugs if you find any. For a list of changes, see https://www.mediawiki.org/wiki/Release_notes/1.26

[[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 10:47, 19 February 2016 (EST)

: Cheers! I was hoping that it would solve the uneditable Chinese, Russian, and other non-latin character-based pages (Polish strangely as well), but unfortunately [[FlightGear_wiki:Village_pump/Archive_2015#UTF-8_language_pages_cannot_be_edited|that issue remains]].

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 10:54, 19 February 2016 (EST)

:: Hm, looks that will require quite some attention indeed. I'm afraid that'll has to wait for now.
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

=== Nasal Syntaxhighlighting ===
: Thanks for your efforts, btw: Nasal syntax highlighting is gone again.
: {{unsigned|17:22, 19 February 2016‎|Hooray}}

:: Unfortunately this time it isn't me forgetting to copy a file. The SyntaxHighlight extension no longer uses GeSHi, but has switched to Pygments. This means our Nasal mapping no longer works and has to be re-written. If anyone is interested, be my guest. See http://pygments.org/docs/lexerdevelopment/
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

::: Hi Gijs,
::: I'm interested in making a Pygments Nasal lexer, but unfortunately I won't be able to work on it until the end of March at the earliest.
::: [[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:59, 23 February 2016 (EST)

:::: Unless Gijs is facing any problems, I don't think it's necessarily needed, see my comment/suggestion in this revision: [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=93166] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:20, 23 February 2016 (EST)

:::Hi Gijs,
:::Here's the code for a Nasal lexer. Be warned, it's thoroughly untested, but has the following features:
:::* Full support for all three string types (backtick, single quote, and double quote), including escapes and formatting strings (e.g., for {{func link|sprintf}}).
:::* All kinds of numbers, including numbers in scientific notation and octal and hex numbers.
:::* All global functions and variables as of FG v2016.1.1.
:::* Some of the commonly-used <code>props.Node</code> methods.
:::* All the other things that can be expected (keywords, punctuation, etc.).
:::I have also created a lexer based on the XML lexer for XML with embedded Nasal, which I thought would be useful.
:::Regards,
:::[[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:35, 2 April 2016 (EDT)

:::http://pygments.org/docs/lexerdevelopment/#adding-and-testing-a-new-lexer
:::<syntaxhighlight lang="python" enclose="div">
# -*- coding: utf-8 -*-
"""
Lexer for Nasal.
"""

from pygments.lexer import RegexLexer, words, include, inherit, bygroups, using
from pygments.token import Text, Keyword, Name, String, Number, Operator, Punctuation, Comment
from pygments.lexers.html import XmlLexer

__all__ = ['NasalLexer', 'XMLNasalLexer']

class NasalLexer(RegexLexer):

name = 'Nasal'
aliases = ['nasal']
filenames = ['*.nas']

tokens = {
'formatters': [
(r'%[-#0 +]*(?:[0-9]+)?(?:\.[0-9]+)?[dis%couxXeEfFgG]', String.Interpol),
],
'backtick': [
(r'`', String.Backtick, '#pop'),
(r'[^`\\]+', String.Backtick),
(r'\\n|\\r|\\t|\\`|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
],
'sqstring': [
(r"'", String.Single, '#pop'),
(r"[^'\\%]+", String.Single),
(r"\\'", String.Escape),
include('formatters'),
],
'dqstring': [
(r'"', String.Double, '#pop'),
(r'[^"\\%]+', String.Double),
(r'\\n|\\r|\\t|\\"|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
include('formatters'),
],
'root': [
(r'\s+', Text),
(r'#.*?$'m, Comment.Single),
(r':|\?|[!=<>+\-*\/~&|^]=?', Operator),
(words(('or', 'and'), suffix=r'\b'), Operator.Word),
(r'[{(\[})\]\.;,]', Punctuation),
(words(('for', 'foreach', 'forindex', 'while', 'break', 'return', 'continue', 'if', 'else', 'elsif'), suffix=r'\b'), Keyword),
(words(('var', 'func'), suffix=r'\b'), Keyword.Declaration),
(words(('nil'), suffix=r'\b'), Keyword.Constant),
(words(('me', 'arg'), suffix=r'\b'), Name.Builtin.Pseudo),
(words(('new', 'del', 'getNode', 'getParent', 'getChild', 'getChildren', 'removeChild', 'removeChildren', 'removeAllChildren', 'getName', 'getIndex', 'getType', 'getAttribute', 'setAttribute', 'getValue', 'setValue', 'setIntValue', 'setBoolValue', 'setDoubleValue', 'unalias', 'alias', 'getPath', 'getBoolValue', 'remove', 'setValues', 'getValues', 'initNode'), suffix=r'\b'), Keyword.Pseudo),
(r'0o[0-7]+', Number.Oct),
(r'0x[0-9a-fA-F]+', Number.Hex),
(r'\d*(?:\.\d*)?[eE][+-]?\d+', Number.Float),
(r'\d*\.\d*', Number.Float),
(r'\b[0-9]+\b', Number.Integer),
(words(('D2R', 'R2D', 'FT2M', 'M2FT', 'IN2M', 'M2IN', 'NM2M', 'M2NM', 'KT2MPS', 'MPS2KT', 'FPS2KT', 'KT2FPS', 'LB2KG', 'KG2LB', 'GAL2L', 'L2GAL'), suffix=r'\b'), Name.Variable.Global),
(words(('abort', 'abs', 'addcommand', 'airportinfo', 'airwaysRoute', 'assert', 'carttogeod', 'cmdarg', 'courseAndDistance', 'createViaTo', 'createDiscontinuity', 'createWP', 'createWPFrom', 'defined', 'directory', 'fgcommand', 'findAirportsByICAO', 'findAirportsWithinRange', 'findFixesByID', 'findNavaidByFrequency', 'findNavaidsByFrequency', 'findNavaidsByID', 'findNavaidsWithinRange', 'finddata', 'flightplan', 'geodinfo', 'geodtocart', 'getprop', 'greatCircleMove', 'interpolate', 'isa', 'logprint', 'magvar', 'maketimer', 'md5', 'navinfo', 'parse_markdown', 'parsexml', 'print', 'printf', 'printlog', 'rand', 'registerFlightPlanDelegate', 'removecommand', 'removelistener', 'resolvepath', 'setlistener', 'setprop', 'settimer', 'srand', 'systime', 'thisfunc', 'tileIndex', 'tilePath', 'values'), suffix=r'\b'), Name.Builtin),
(words(('append', 'bind', 'call', 'caller', 'chr', 'closure', 'cmp', 'compile', 'contains', 'delete', 'die', 'find', 'ghosttype', 'id', 'int', 'keys', 'left', 'num', 'pop', 'right', 'setsize', 'size', 'sort', 'split', 'sprintf', 'streq', 'substr', 'subvec', 'typeof'), suffix=r'\b'), Name.Builtin),
(words(('_createCondition', '_fgcommand', '_interpolate', '_setlistener'), suffix=r'\b'), Keyword.Reserved),
(r'`', String.Backtick, 'backtick'),
(r"'", String.Single, 'sqstring'),
(r'"', String.Double 'dqstring'),
(r'\b_\w*?\b', Keyword.Reserved),
#(r'\b\w*?\b', Name),
]
}

class XMLNasalLexer(XmlLexer):
"""
For Nasal code embedded in XML files.
"""

name = 'XML-Nasal'
aliases = ['xml-nasal', 'xml-ns']

tokens = {
'root': [
(r'(<(?:load|unload|script)>)(<!\[CDATA\[)?(.*?)(]]>)?(</(?:load|unload|script)>)', bygroups(Name.Tag, Comment.Preproc, using(NasalLexer), Comment.Preproc, Name.Tag),
inherit,
],
}
</syntaxhighlight>

:: We can use the ECMAScript/JavaScript lexer[http://pygments.org/docs/lexers/#lexers-for-javascript-and-related-languages] for now, my suggestion would be to copy that over to a file so that we can work on a custom Nasal lexer (Syntax is almost identical, with a few different keywords, and many others being irrelevant). What is missing/different can be obtained from other lexers that are similar, e.g. [http://pygments.org/docs/lexers/#lexers-for-other-c-like-languages] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:45, 19 February 2016 (EST)

:: Okay, here's the better/quick&easy way: We have Nasal support for some fairly popular editors, like [http://wiki.flightgear.org/Howto:Syntax_highlighting_for_Nasal#Vim|vim](originally created by Melchior<ref>https://sourceforge.net/p/flightgear/flightgear/ci/next/tree/scripts/syntax/nasal.vim</ref>), listed at [[Howto:Syntax_highlighting_for_Nasal]] - there are various free converters available that will read such a syntaxhighlighting file and convert it to a pygments class, e.g. see: https://github.com/honza/vim2pygments [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:00, 19 February 2016 (EST)

==== References ====
<references />

== The repository link templates ==
=== Complete overhaul of the repository link templates ===

I have now performed a complete overhaul of the repository link templates (see {{tl|repo link/doc related}}). This was motivated by the incomplete state of these templates, the lack of standardisation, the lack of SourceForge git repository support for {{tl|repo link}}, web-interface only support, etc. I have used a lot of recursive transclusion for standardisation, so that there is a single point for updating for any FlightGear infrastructure changes. This is the master {{tl|repo link}} template. All the other templates are subtemplates which recursively transclude from this master template. I have also created a number of documentation templates for simplifying template maintenance (see {{tl|repo link/doc related‎}}, {{tl|repo link/doc specific file git‎‎}}, {{tl|repo link/doc git clone‎‎}}, and {{tl|repo link/doc commit}}). The changes were constrained to maintain backwards compatibility as much as possible. However I would like to break this to allow the following templates to be updated to transclude from the master {{tl|repo link}} template:

* {{tl|flightgear file}},
* {{tl|simgear file}},
* {{tl|fgdata file}},
* {{tl|fgaddon file}}.

If no one objects, I would like to completely break these and expand and rename the parameter set to match the other <nowiki>{{* file}}</nowiki> repository templates (e.g. {{tl|terragear file}}). My overhaul currently does not include Hooray's ideas for non command line usages, i.e. different GUIs, but it enables it to be easily added via the master template and the addition of a single parameter to any subtemplates.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 15:05, 25 February 2016 (EST)

: I don't have any objections myself, I appreciate all the work you are putting into this, and would like to thank you for helping us clean up all that mess by doing such unglamorous work ;-) I also appreciate that your changes would facilitate adding a non-CLI mode to the corresponding templates. However, I would suggest to wait for Gijs' feedback, because he's ultimately the most likely person to veto something around here ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:31, 25 February 2016 (EST)

:: Johan seems to be the one who did a lot of the initial work on these <nowiki>{{* file}}</nowiki> templates, and Red Leader with the {{tl|repo link}} template. And they were involved in the general discussions ([[http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=87148#Repository_link_templates perm]). But I know Gijs was also involved in the design.

:: For the non-CLI mode, that will need -a lot- more planning. For example a definitive list of all these modes would be useful. Should this use an optional Mediawiki pop up extension showing a link to a general page that describes the action for all different GUIs, CLI, etc.? Should we have a switch box so that the reader can switch in-text between CLI, and the numerous GUIs? Are we going to have a large set of screenshots for each GUI? If so, I would strongly recommend the [https://www.mediawiki.org/wiki/Extension:Labeled_Section_Transclusion labelled section transclusion extension] for creating a single page for one GUI with everything for that GUI, as a tutorial. Here is [http://wiki.nmr-relax.com/Relax_4.0.1 an external example where I have used this], to fragment the base release page to create [http://wiki.nmr-relax.com/Relax_release_descriptions this meta page], as well as many other meta pages.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:14, 26 February 2016 (EST)

I am also thinking of changing the name of the <nowiki>{{* file}}</nowiki> templates, as I hope to make the scope of the templates far more general. The name <nowiki>{{* source}}</nowiki> or <nowiki>{{* repo}}</nowiki> might be better. For example these will allow the repository commit, tree view, log view (and maybe rss feed), with or without a file/directory path. And I would like to generalise this to handle both the SF web-interface and non-web net protocols (git://, ssh://, svn://, etc.). It will allow for CLI instructions to be built up and embedded in <nowiki>{{#tag:source|<content>|lang=sh}}</nowiki> tags. And I will defer all infrastructure decisions in the subtemplates to the single point of {{tl|project infrastructure}}, so that if there are changes in the future, then only this single template needs to be updated to update the entire wiki.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:22, 26 February 2016 (EST)

: The {{tl|project infrastructure}} template as a single point provider of various project infrastructure names and URL pairs seem like a great idea. If it work out well it will really lessen the maintenance by having less places needing updates, while allowing the various repository templates to be simple to use, in essence by having comprehensible names and no boiler plate parameters for their users.
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 15:15, 27 February 2016 (EST)

==== Repository link update ====
For those following, I have massively expanded the capabilities of the {{tl|repo link}} template:
* The SourceForge URLs are now comprehensive.
* Full support for the new query-based URLs for the Gitorious archives.
* Functional GitLab URLs.
* Generic repository support (used to create the {{tl|openscenegraph co}} template).
* Detailed documentation and extensive examples for checking the implementation (if you find any non-supported links, please add these as examples).
* Isolation of the '''cmd''' parameter from the CLI options — this is to enable future support for non-CLI instructions based on the value of '''cmd'''.

I have also completed a large set of subtemplates of {{tl|repo link}}, see the list at {{tl|repo link/doc related}}. This includes a full set of <nowiki>{{* source}}</nowiki> templates. I have left the original <nowiki>{{* file}}</nowiki> templates, rather than renaming and modifying them, so these are now redundant. All of the <nowiki>{{* source}}</nowiki>, <nowiki>{{* commit}}</nowiki>, <nowiki>{{* clone}}</nowiki>, and <nowiki>{{* co}}</nowiki> templates transclude from the master {{tl|repo link}} template to do all of the work.

One important template is {{tl|gitorious source}}. The support for the new query-based URLs for the Gitorious archives is now quite comprehensive in {{tl|repo link}}. Therefore I have converted almost every single FlightGear wiki link to https://gitorious.org to use {{tl|gitorious source}} instead. This fixes a lot of broken links and broken git instructions. I have reduced the number of hits for gitorious.org on the wiki (searching just for "gitorious") to 22 hits. This includes 2 very outdated articles ([[FlightGear Git: aircraft authors]], [[Fr/FlightGear et Git]]), 15 locked newsletters, 1 with no longer existent Gitorious merge request links, and 4 base URL links for Hangars. This way we can maintain the Gitorious web interface links and git command instructions in a functional state by simply updating the single source of {{tl|repo link}}.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 11:38, 29 February 2016 (EST)

: I just remembered [[Special:LinkSearch]], so make that 184 broken gitorious.org links remaining. Lots more work to do :)

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:46, 29 February 2016 (EST)

For some of these templates, e.g. {{tl|repo link/doc usage}}, I'm trying to implement some logic for automatic whitespace padding for documentation formatting, but the <code><nowiki>{{#len:string}}</nowiki></code> function is not enabled. According to {{mediawiki|Wikitext_parser/Core_parser_functions#.23len}} and {{mediawiki|Extension:StringFunctions}}, the option <code>$wgPFEnableStringFunctions = true;</code> should be set (in <code>LocalSettings.php</code>). Unless there is a reason for not using this, I was wondering if someone could enable this? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 09:53, 8 March 2016 (EST)

=== Archived newsletters and dead links? ===

Do we have a policy for the dead links in the FlightGear newsletters? It is obviously good to preserve the historic state. But there are many Gitorious links that could be made functional again using the {{tl|gitorious source}} template to point to the historic Gitorious archives (including the official FlightGear repositories, rather than using {{tl|fgdata source}}, for example). The https://gitorious.org links have been converted from URL/path based to query based, so absolutely all of the old links are broken. I am steadily converting all Gitorious links to use the [[Template:repo link/doc related|{{obr}}repo link{{cbr}} family of templates]], with the exception of the newsletters.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 04:52, 8 March 2016 (EST)

: I think it could be a good idea to try update old links in those newsletters. I sometimes look back at things and tend to think that I probably are not the only one doing that.
: I wonder if the rotten links should be replaced or stricken, but I think they could just as well be replaced. The key thing is that they go to the same resource or content, not weather they have been updated or not (also, the change will be visible in the revision history after all).
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 07:11, 8 March 2016 (EST)

:: I should add that I'm using [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=http%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] and [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>]. And I am also not touching the <code>User*</code> pages, <code>*talk*</code> pages, or pages tagged as out of date or up for deletion. For the newsletters I might look at these later when the broken Gitorious links are fixed in the rest of the wiki but, as these are locked, someone else might have make the switch to {{tl|gitorious source}}, {{tl|gitorious url}}, {{tl|gitorious clone}}, and {{tl|gitorious merge request}}.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 02:53, 9 March 2016 (EST)

::: I will temporarily add a table here for the templates in the newsletters and will slowly fix them one by one together with any other admin.
{{navbox
| title = Click "show" to show -->
| state = collapsed
| navbar = plain
| list1 =
http:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!}} No equivalent link for the Gitorious archive - project pages are dead. Maybe just use http://gitorious.org/?
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!}} Functional link, equivalent to {{gitorious url|fg|flightgear|commit=5c6fe952598053fa63631fc0161d666f22a50f51}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/headtrack

http://gitorious.org/arduinocockpit
{{!}} Project pages are dead, switched to {{gitorious url|headtrack|headtrack}}

{{gitorious url|arduinocockpit|arduinocockpit}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/arduinocockpi

http://gitorious.org/headtrack
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Missing project - i.e. {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra|text=migrated to GitLab}}. Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2011]]
{{!}} http://gitorious.org/flightgear-aircraft
{{!}} Switched to {{gitorious source}} and rephrased text slightly to help readers find the repositories.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} http://gitorious.org/anders-hangar/mtb_20m/trees/master
{{!}} Switch to {{gitorious url|proj=anders-hangar|repo=mtb_20m}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} http://gitorious.org/fg/flightgear/blobs/next/scripts/java/FGClient/src/FGFSDemo.java
{{!}} Switched to {{gitorious url|proj=fg|repo=flightgear|path=scripts/java/FGClient/src/FGFSDemo.java}}. This points to the old Gitorious repository to protect against path changes in the future.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2014]]
{{!}} http://gitorious.org/nasal-support/nasal-npp
{{!}} Switched to {{gitorious url|nasal-support|nasal-npp}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2015]]
{{!}} http://gitorious.org
{{!}} Switched to {{tl|gitorious source}} without parameters for the Gitorious base URL, to future-protect it.
{{!}}}

https:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/papillon81/flightgear-custom-scenery/

https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery

https://gitorious.org/papillon81/flightgear-custom-scenery/
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter December 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Fr/Nouvelles du projet FlightGear - décembre 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2012]]
{{!}} https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/README

https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/doc/doc-en.htm
{{!}} Switched to {{fgdata source|path=Aircraft/Instruments-3d/garmin196/README|full=1}} and {{fgdata source|path=Aircraft/Instruments-3d/garmin196/doc/doc-en.htm|full=1}} to point to the current FGData locations and removed the name "Gitorious" to make the text of the Garmin 196 GPS section still relevant
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter August 2012]]
{{!}} https://gitorious.org/mil-mi-6
{{!}} Switched to {{gitorious url|proj=mil-mi-6|repo=mi6dev}}, and changed from the non-existent project page to the main repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} https://gitorious.org/fgradar
{{!}} Switched from the project page to the direct repository {{gitorious url|fgradar|fgradar}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} https://gitorious.org/fg/flightgear/commit/913727239d6776c0508d206f395e16c265413ec3

https://gitorious.org/fg/flightgear/commit/eba03b5e469824ee8f1494723fcddbbc56155a08
{{!}} Switched to {{flightgear url|commit=913727239d6776c0508d206f395e16c265413ec3}} and {{flightgear url|commit=eba03b5e469824ee8f1494723fcddbbc56155a08}}. This deliberately points to the current repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2013]]
{{!}} https://gitorious.org/fg-radi/osm2city

https://gitorious.org/scenery-france-850
{{!}} Switched to the new GitLab repository {{gitlab source|proj=fg-radi|repo=osm2city|full=1}}

and removed the no longer existent scenery-france-850 repository, replacing it with "<s>Scenery repository (Gitorious)</s>".
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Switched to {{gitorious source|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console/repl.nas|line=708}}

{{gitorious url|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console|view=tree}}

{{fgdata-old url|commit=eaaf816b772649d5b0826a1d0bdd166dbc5b968f}}

{{flightgear commit|34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353}}

{{gitorious merge request|mr=54}}

{{gitorious merge request|mr=26}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Changes match the English article.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} https://gitorious.org/fg/fgdata/flightgear?p=fg/fgdata:flightgear.git;a=blob;f=keyboard.xml

https://gitorious.org/fg/fgdata?p=fg:fgdata.git;a=commit;h=f8c56dcc52ffd3d6dfca1d39dc4a72b6b3478368

https://gitorious.org/fg/hoorays-flightgear?p=fg:hoorays-flightgear.git;a=shortlog;h=refs/heads/topics/cppbind-fgprotocol
{{!}} This first link was the broken {{tl|git link}} template (see the table below). The other two links are not in the article?!
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter June 2014]]
{{!}} https://gitorious.org/eddp-custom-scenery/eddp-custom-scenery/
{{!}} Switched to {{tl|gitorious clone}} to provide functional '''git clone''' instructions.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2014]]
{{!}} https://gitorious.org/fg/hoorays-fgdata/source/2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876:Nasal/ai/aim9/aim9.fdm#L9
{{!}} Switch to {{gitorious url|proj=fg|repo=hoorays-fgdata|commit=2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876|path=Nasal/ai/aim9/aim9.fdm|line=9}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2015]]
{{!}} https://gitorious.org/fg/canvas-hackers-fgdata/source/f59c42134a5a77e343981dcff8278c3e2f094e87
{{!}} Switch to {{gitorious url|proj=fg|repo=canvas-hackers-fgdata|commit=f59c42134a5a77e343981dcff8278c3e2f094e87|view=summary}}
{{!}}}

Broken templates:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Template !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} {{tlx|Git link|gitorious|fg/fgdata|master|keyboard.xml|pre=$FG_ROOT/}}
{{!}} Switched to {{fgdata source|path=keyboard.xml|pre=$FG_ROOT}} to fix the Gitorious link created by the broken and depreciated {{tl|git link}} template.
{{!}}}

}}

::: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 12:06, 9 March 2016 (EST)

:::: I've added a '''notes''' column to help a little.

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:30, 9 March 2016 (EST)

=== Elimination of the dead Gitorious links ===
Thanks largely to the diversity and flexibility of the [[:Category:Repository link templates|{{obr}}repo link{{cbr}} family of templates]], I have now managed to eliminate almost every last dead Gitorious link in the FlightGear wiki! The locked Newsletter articles, user pages, and talk pages are the only exceptions. The page counts from the (Main) namespace are:
* [http://wiki.flightgear.org/index.php?target=http%3A%2F%2Fgitorious.org&namespace=0&title=Special%3ALinkSearch <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] — 37. Of these, 17 are for the front page with the news of the Gitorious to SourceForge migration, and the rest are Newsletters.
* [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org&namespace=0 <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>] — 166. Most of these links are valid and created by the {{obr}}gitorious *{{cbr}} subtemplates of {{tl|repo link}}. The remaining broken links are all in the locked Newsletters.
The Howto:* pages are not in the (Main) wiki namespace, but I've knocked those out too.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:54, 10 March 2016 (EST)

: thanks for doing all this unglamorous work - I am sorry that Gijs was apparently too busy to follow up on my suggestion to either provide you with admin access around here, or at least to help you run a Python script to do all this work in an automated, rather than manual, fashion. Hopefully, things will work out better next time. Again, thank you. Like I said, I think you should definitely be given admin access on the wiki, especially given your recent contributions - and I would gladly have my wiki status downgraded accordingly. In fact, if I was able to directly promote accounts accordingly, I would have done so months ago - however, it seems that Gijs is the only one to have those privileges, and he mentioned off-list that he's kinda busy with RL/exams etc, so it is to be expected that he's going to become a bottleneck more often - hopefully, this will be recongized as an actual issue, so that there will be more people able to promote new wiki admins. Sorry that things didn't work out better this time, and thanks so much for doing all this stuff manually. -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:49, 10 March 2016 (EST)

:: No problems! As for automating this, that would not have been possible. If you look at the changes, you'll see that each one is different <sup>[http://wiki.flightgear.org/index.php?title=Special:RecentChanges&to=20160310210655&limit=500]</sup>. I had to check each one, and update the link as required.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 16:08, 10 March 2016 (EST)

::: There's three of us actually (Curt, Simon and myself), no need to wait on me. See http://wiki.flightgear.org/index.php?title=Special%3AListUsers&username=&group=bureaucrat&limit=100 (Sek is inactive nowadays) ;-)
::: Please note that forum pms are really not the best way to contact me. I very much prefer email over forum pms as it's a lot easier to filter out the huge amounts of nonsense I'm receiving from stuff requiring actual attention.
::: Anyhow I've just promoted Bugman so he can edit locked articles.
::: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 05:06, 11 March 2016 (EST)

:::: Thank you. I'll try to preserve the original intent of the Newsletters while fixing the broken links (maybe even preserving any original URLs as Mediawiki link text, while pointing to the new URL). I will use the {{obr}}gitorious *{{cbr}} templates to point to the historical sources, and will probably use this for all of the Gitorious URLs so that we have full control over any future URL breakages via the single location of {{tl|repo link}}. For example, if they change the gitorious.org domain name to a https://archive.org subdomain (i.e. gitorious.archive.org).

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 06:40, 11 March 2016 (EST)

=== Regex parsing of template parameters? ===

For the {{tl|repo link}} template, I am currently trying to work out what to do for git branches and tags on the SourceForge infrastructure. The problem is that the presence of the character <code>/</code> within a branch or tag name requires the text <code>/~</code> to be appended to that name in the URL, for example:

* Tag <code>version/2016.1.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/version/2016.1.1/~/tree/simgear/ephemeris/ephemeris.cxx
* Branch <code>release/2016.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/release/2016.1/~/tree/simgear/ephemeris/ephemeris.cxx

I haven't found out a way to use regex to parse the <code>tag</code> or <code>branch</code> template parameters to automate this, hence I am thinking of just giving the instruction for the template user to append this text to the <code>tag</code> or <code>branch</code> parameter text themselves. However this is not ideal - a change of this behaviour on the SourceForge side requires end pages with SourceForge URLs to be updated, rather than just updating {{tl|repo link}}. I was wondering about possibility of installing the extension:

* [https://www.mediawiki.org/wiki/Extension:RegexParserFunctions Extension:RegexParserFunctions]

Though I'm not 100% sure if that will work. Or does someone else know an alternative? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:09, 22 April 2016 (EDT)

: not a solution, just a potential workaround would be checking for the most common prefix strings used in tags/branches (e.g. version, release, topic, topics) and explicitly rewrite the URL accordingly to append the /~ suffix -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 22 April 2016 (EDT)

:: That might be a solution. But I don't know how to do that without regex ;) We really only have #ifeq statements, but that has to match the whole string.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:44, 22 April 2016 (EDT)

As a temporary workaround, I'll update the SourceForge {{tl|repo link}} template instructions to tell the user to append <code>/~</code> to the branch or tag name, if the <code>/</code> character is present.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 10:31, 20 May 2016 (EDT)

== Discussion about quotes on the wiki ==
{{usr|Hooray}} have started a page now at [[FlightGear wiki:Quoting Guidelines]] ([http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Quoting_Guidelines&oldid=96104 perm]) for a discussion regarding guidelines for the use of quotes on the wiki. Join the discussion.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 18:17, 21 March 2016 (EDT)

In slight relation to this I have tried to make the wiki more consistently use the most common spelling and case, "Instant-Cquotes" and have changed the automatic categorization accordingly. All articles using the {{tl|FGCquote}} template can now be found in [[:Category:Articles containing Instant-Cquotes]] (currently some ~250 articles).

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 08:21, 23 March 2016 (EDT)

== Reorganizing the Git articles ==
I've noticed that the [[:Category:Git|Git articles]] suffer from duplication and are in part obsolete (especially with regard to the instructions for running Git on Windows). Thus, I propose the following reorganization:
* [[Development workflow]]: reorganization to explain how the patch submission process is organized from a high-level point of view (forking the repository from SourceForge, developing, pushing the commits to the personal fork, submitting a merge request/sending a patch to the mailing list);
* [[FlightGear Git]]: leave as is;
* '''Installing and configuring Git''' - new article about installing Git and configuring it (setting the username/e-mail address); merge the contents of [[FlightGear Git on Windows]] and [[Resources WRT running git on Win32]] here;
* [[FlightGear Git for laymen]] - make it follow [[FGW:MOS]], merge the contents of [[Howto:Start using git]] here;
* [[FlightGear Git: core developers]] and [[FlightGear Git: data developers]] - I'm uncertain about what I should do with them: the only piece information that would not be written in other articles is the list of alternative methods for cloning FGData;
* [[FlightGear Git: gitiquette]] and [[FlightGear Git: tips]] - make them follow [[FGW:MOS]].
Any comments? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:11, 13 May 2016 (EDT)

: This is sorely needed! For [[FlightGear Git: core developers]] and [[FlightGear Git: data developers]], maybe these can be merged into something like [[FlightGear Git: working with the repositories]]? The only real difference is the URL, but that is a minor difference with the [[:Category:Repository link templates]]. This could be generalised into a set of instructions for working with all git repositories for the core infrastructure, including forking and merge requests, with a current focus on the SourceForge web and non-web interfaces.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 08:17, 13 May 2016 (EDT)

:: Yes, I was thinking about a similar solution as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:16, 13 May 2016 (EDT)

: For the reorganisation of the articles, it would be good to make a lot of use of the {{tl|Project infrastructure}} template. This will abstract away the SourceForge infrastructure (well some instructions will be 100% SourceForge specific, so it won't be perfect). I would like to however have [[Template talk:Project infrastructure#Slight variation of the current architecture|Johan's design]] implemented first, as it would be quite beneficial.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 18:43, 14 May 2016 (EDT)
:: Thanks, didn't know it existed. Right now I'm fixing some last-minute bugs before the release, but I'll have a look at this. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:05, 15 May 2016 (EDT)

::: And while we're at it, we also have a handful of git related templates to abstract away UI-specifics, which would allow us/me to upload screenshots for different interfaces (CLI, tortoisegit etc), so that we only need to update the templates, and not touch any of those articles. OTOH, I cannot seem to find a recent discussion of the idea, only http://wiki.flightgear.org/Talk:Development_workflow and that has not been updated in 3 years. Any opinions ? -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 20:52, 15 May 2016 (EDT)
:::: I'm not fully sold on this one. I see the point of creating templates (for example, the Git commands mentioned in [[Talk:Development workflow]] can be used in aircraft pages to explain how to checkout a development version from a private repository), but, in my opinion, screenshots are a bit "heavy" to be reused in other articles (beside the Git ones). Did you plan to use them in other pages and, if yes, how? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 14:11, 23 May 2016 (EDT)

:: It was originally intended to document different UIs and workflows - i.e. by parameterizing the templates, so that a matching set of commands, and screenshots, could be shown. The basic idea was that we have a growing number of articles detailing git workflows (clone, checkout, push, branch etc) - and it seemed to make sense to have a single article/template documenting the specifics, so that other articles could merely use that template, while specifiying the "action" and any other variable items (repository, branch etc) - and then use a template to provide the matching command line. However, don't worry - we don't need to do it that way. Originally, it was all inspired by [[Howto:Build FlightGear with NetBeans using CMake]]. -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:23, 23 May 2016 (EDT)

== UTF-8 language pages cannot be edited ==

This is a continuation of [[FlightGear wiki:Village pump/Archive 2015#UTF-8 language pages cannot be edited]]. I can see that wiki editors are [[Zh/FlightGear Wiki|forced to create workarounds]], as the [[Main page]] in Chinese [http://wiki.flightgear.org/index.php?title=Zh/%E9%A6%96%E9%A1%B5&action=edit cannot be edited]. I think it is quite important to solve this ''"A database query error has occurred. This may indicate a bug in the software"'' issue. As the fix is quite dangerous (see {{mediawiki|Topic:S1q54kosfdkhz6w1}}), do we have a backup system? Do we have regular mysql and ftp dumps that can be backed up locally using rsync?

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 05:16, 15 May 2016 (EDT)

== Making wiki specific templates available via editor ? ==
We now have an increasing number of wiki specific templates that should be more widely used, so that it would make sense to integrate those with the default mediawiki editor - e.g. the URL encapsulating templates. -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:12, 16 May 2016 (EDT)

== Categorizing aircraft infoboxes by hangar ==
I would like to bring the discussions from [[Template talk:Infobox aircraft#fgaddon aircraft]] into here for greater exposure. The idea discussed there was to add <code>hangar</code> and <code>aircraft</code> parameters to automate and categorise the aircraft infoboxes. This is to help readers instantly identify the source of the aircraft and to give greater exposure to 3rd party hangars or independent aircraft. To show off the potential of this automated approach, I have created an example template at [[User:Bugman/Infobox Aircraft]] (see the bottom for an example based on the [[Space Shuttle]] infobox). Each [[FlightGear hangars#Third party sites|3rd party hangar]] can add one of the following options:

* The hangar logo, with a link to the hangar. For example I have created an initial test logo for FGAddon: [[File:FGAddon logo.png|80px]]
* Development repository link. An automatically created link, if the {{param|development}} parameter is not supplied.
* Download link. An automatically created link, if the {{param|download}} parameter is not supplied.
* A hangar category. For example [[:Category:FGAddon hangar]].

Feedback would be appreciated. Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 04:53, 25 May 2016 (EDT)

: Following from these ideas, I have made a proposal for a new template: [[Template talk:Infobox aircraft#Proposal for a new aircraft infobox template design (2016/06)]]. The more feedback on this, the better ;) Cheers!

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 10:17, 1 June 2016 (EDT)

:: Thanks for your work - looks good, the only change I would make is (as you noted in the template talk page) replacing the repository/download/livery database/forum thread icons with something more suitable and less "brilliant" icons (though I admit I don't have an alternative proposal for this right now). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 04:40, 2 June 2016 (EDT)

FlightGear wiki talk:Instant-Refs

2016-05-27T12:10:36Z

Elgaton: /* Upcoming dependencies */ Library now on the CDN

== more sources ==

at some point, we may also want to add support for other sources, such as:
* old forum URLs, i.e. not yet using the subdomain format (should be easy, it's just a different/additional URL after all)
* thread.gmane.org/gmane.games.flightgear.devel/
* jsbsim devel list
* github tickets
* the new SF.net issue tracker
* SF.net commit logs http://gitorious.org/fg/
* http://www.mail-archive.com/flightgear-devel@flightgear.org/ (until 2005)
* http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/maillist.html (until 10/2013)

that should cover all important sources. And it would allow us to also use the same script to help populate [[FlightGear Newsletter]] & [[Changelog 3.2|changelogs]], but also [[Release plan/Lessons learned]]. So this could be a real time-saver. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:40, 1 June 2014 (UTC)

== Automatic update of script and old quotes ==
Thanks for the heads-up. Now, that makes me wonder if I can adapt the script to automatically parse existing wiki articles and update cquotes there automatically by re-opening the URL and re-running the extraction logic :) BTW: That reminds me: I was going to investigate adopting the '''downloadURL''' attribute[http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating] so that scripts can auto-update --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:51, 11 June 2014 (UTC)

:: if we should continue to see this widely used, having a good way to re-download and re-run the script on pages with existing cquotes would be a good way to automatically update quotes. For that, we would want to encode certain meta info in each template, e.g.:
* script version
* quoting date/time
* quote URL
* selection offsets
* quoting settings (format)

We can hook into form submission to update arbitrary quotes/contents using this: http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Developer_Tools#Intercept_and_Modify_Form_Submissions

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:19, 15 November 2015 (EST)

=== Hosting ===
The script seems to be about to become sufficiently complex to deserve actual hosting:
* http://wiki.greasespot.net/User_Script_Hosting
* https://openuserjs.org/

(that would allow updating the script automatically)

: Hi, is there any progress being made on this? I think the best way to host it would be to put in in a SourceForge repository under the FlightGear project (I don't know if it allows direct downloads, though, and we would need to relicense the script because [https://opensource.org/faq#public-domain public domain licenses are not OSI-approved]); otherwise, I can submit it to [https://greasyfork.org/ GreasyFork] (OpenUserJS is unsuitable as [https://openuserjs.org/about/Terms-of-Service public domain licenses are not allowed]). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 03:58, 1 May 2016 (EDT)

:: I don't think anybody has looked into this recently - however, relicensing should be a no-brainer, given that all the code is in the public domain anyway. I am not sure if it's worth the hassle to put up under sourceforge/FlightGear; we also need to keep in mind that this is not exactly the most popular "tool" around here. So, before this becomes even better accessible, it might be a good idea to comply with some of the requests made, e.g. by adding support for a different output mode (without using the FGCquote template, just the copied text, plus the ref part), so that quote-heavy pages don't look that obnoxious.
:: Regarding hosting in general, I still think it may be a good idea, but we would probably need to make sure that some requirements are met, e.g. having a revision history, and to provide other contributors with access-alternatively, we should maintain a copy of the script in the wiki, and add a note saying that changes to it will be reviewed/integrated with the hosted script by one of us (if you'd volunteer to help with that, I'd suggest to just go ahead and set up a public repository).
:: Admittedly, this is going to remain a fairly FG specific script, it would need quite a bit of work to become useful for other purposes (even though other OSS projects may be easy to support). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 06:33, 1 May 2016 (EDT)

::: OK, I think we can leave the script here and host it on GreasyFork (it allows public domain scripts) - I'll put the page on my watchlist to make sure I update the script there every time there's a version bump. Does that look good to you and the other contributors? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:26, 1 May 2016 (EDT)

:::: Sounds good to me, given how the script has evolved over time, we've probably hit a natural limit already, i.e. being able to use multiple files easily, and update scripts automatically sounds like a useful thing to me. I don't know if greasyfork supports "teams" of contributors for better collaboration ? It might also be a good idea to generalize the script so that it supports arbitrary phpBB installations and mailing list archives other than just sourceforge (think gmane) - and maybe output formats other than just wikimedia markup, that way, the script may become more useful over time.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:46, 1 May 2016 (EDT)

::::: It doesn't as it only offers a user script downloading facility (source code repositories like GitHub and SourceForge are better suited for the kind of work you mention). I'll wait a bit in case Red Leader, Philosopher or bigstones have any objections/remarks, then I'll upload the script there. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:14, 1 May 2016 (EDT)

:: do they support extensions spread across multiple files ? That is something that would help us quite a bit cleaning up the current code, which has become a bit convoluted over time. Apart from that, nothing wrong with github et al - I am just not sure if they're suitable for automatically propagating updated changes.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:12, 2 May 2016 (EDT)

::: No, not that I know of (generally speaking, all user scripts are made of a single .user.js file). We could "hack" it by splitting the current script in multiple files and requiring them from a main one as libraries via the <tt>@include</tt> directive, but that would rule out most hosting solutions (many providers only allow GreaseMonkey scripts which include additional files only from a handful of trusted domains/CDNs, for safety reasons).
::: As for propagating changes on GitHub and other code repository, the update URL must remain constant throughout the lifetime of the script. I'm sure this can be done on GitHub by publishing updates not as releases (where the addresses change), but on GitHub Pages (a user script I use does exactly this); on SourceForge, the usual download hosting could do the trick, but I'd need to perform a test first. (I'd prefer SF to keep the script "inside" the FG project hierarchy, if possible). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:50, 2 May 2016 (EDT)

: actually, user scripts can be compromised of multiple files, e.g. via the require directive [http://stackoverflow.com/questions/8695459/is-it-possible-to-split-greasemonkey-user-scripts-into-multiple-files]. Personally, I would like to make use of that - we are already using that to include jQuery stuff, and it would help us organize the script a little better. I am not oposed to seeing the script hosted as some part of FG/SF, but I just don't think it's going to be a very popular idea - so far, everything worked out without major hinderance, so I would rather use an independent hosting solution, or continue to use the wiki to ensure that the barrier to entry/contributing isn't raised, e.g. by going through merge requests etc. Major contributions to the script like those from bigstones or Red Leader were simply "dropped" here directly, so this seems to have worked out really well.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:26, 2 May 2016 (EDT)

:: I've checked the [https://greasyfork.org/it/help/external-scripts GreasyFork external script policy]: as long as all the files are hosted on/uploaded to GreasyFork, it's not a problem. (Also, sorry about the typo, I wrote <tt>@include</tt> instead of <tt>@require</tt> by mistake). I guess I can proceed with the upload now? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 12:22, 2 May 2016 (EDT)

: sure, why not - it's in the public domain after all - feel free to make any changes to the script to have it auto-update. We can review everything once we have gathered a little more experience with this kind of scheme. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:27, 2 May 2016 (EDT)

:: {{done}} - I'm updating the installation instructions in the main page. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:52, 2 May 2016 (EDT)

::: Script at: https://greasyfork.org/en/scripts/19331-instant-cquotes
--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:18, 2 May 2016 (EDT)

:::: Regarding updates, bumping the version number is fine - I'll take the script at the wiki revision where the version is bumped and upload it. (Note that I will not perform any prior testing, so be extra careful - maybe I should add this in the note above the script?). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:08, 2 May 2016 (EDT)

:: sounds good, I will be sure to stop updating the version number without prior testing, we could also add some tests to the code to spot the more obvious mistakes - in fact, there is already an OpenLink helper that could be used to download a few postings and try to extract the corresponding fields, so that we would only bump the version number if that succeeds. BTW: Thanks for handling the hosting part, much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:25, 2 May 2016 (EDT)

== Issues ==
=== too greedy non-greedy regexes ===
The problem described in the previous section regarding regexes that eat up half messages seems to be related to my [http://blog.liip.ch/archive/2009/07/24/the-greedyness-of-non-greedy-regular-expressions.html misunderstanding of the non-greediness]. So, I managed to fix it for this one case, but this means that using .*? to match everything until you meet the following character (as I currently do pretty much everywhere) is dangerous and prone to failure. Any occurrence of that should be changed as I did in [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Instant-Cquotes&oldid=72839 this edit] and that's clearly cumbersome, not to say that it can still be incorrect: say I have
<nowiki><a someprop="href" href="http://www.link.org" ... ></nowiki>
If I want to mach anything between a and href, I use <tt><nowiki>[^(?:href)]*</nowiki></tt>, but that would match only up to the text inside someprop, so I'd have to check that it's not inside doublequotes... Well, I guess this is getting too complicated for handling it [http://blog.codinghorror.com/parsing-html-the-cthulhu-way/ the Chtulu way].

So my approach would be: fix this whenever the problem comes up, but don't overdo because we're already moving in dangerous ground. Or, rewrite it all using ''only'' xpaths *sobs*.
--[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 16:49, 17 June 2014 (UTC)

=== regex vectors ===

When testing things I realized that you are right: there are some scenarios where the regex may fail depending on how "complete" the selection is, because we obviously have hard-coded assumptions here. I'll see if it's feasible to also support vectors for regexes to extract the corresponding fields and try each regex in order to get a certain field, or if that doesn't make any sense... But quoting with/without author (anonymous quote) would be a valid test case here.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

: Probably going to look into this sooner or later because this could be a simple solution to also support PM quoting - without having to parse the actual URL, we'd just try different regexes in order and use the one that succeeds. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

=== Syntaxhighlighting ===
Need to investigate what needs to be updated to support quoting code sections, as per [http://forum.flightgear.org/viewtopic.php?f=66&t=21855&p=212585#p212581] --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:33, 14 June 2014 (UTC)

=== Postings that break our script for some reason ===
* http://forum.flightgear.org/viewtopic.php?f=19&t=23365

== Misc notes ==

=== Detecting failed XPaths ===
you've got a point, we should probably check if xpath/regexes succeed or fail, and show a warning so that we know that the scripts needs to be updated because some xpath/regex may have changed.

=== Paragraphs / br (trailing slash) ===
There are some minor issues now, i.e. newline2br will no longer contain the trailing forward slash, so there's probably some JavaScript/regex oddity involved here, maybe slashes just need to be escaped. Will be testing the code with a few different forum postings and check the resulting cquote
: {{done}}. That's because newline2br wasn't used at all in html mode. I added addNewlines which puts newlines after br's and list related tags, if there are more newlines to be added that should be the place.
: --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 14:03, 17 June 2014 (UTC)

=== support/ignore highlighted keywords/smilies ===
see [[Understanding Forward Compatibility]] for examples
: {{done}} --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 15:13, 17 June 2014 (UTC)

== Beyond just cquotes (newsletter/changelog) ==

Gijs has recently revamped the newsletter template rather significantly, see: [[FlightGear_Newsletter_June_2014]], and [[User_talk:Gijs#06.2F2014_newsletter:_too_much_of_a_]] - basically, we could extend the script to support another output FORMAT to directly create markup for the newsletter/changelog. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 20:40, 30 June 2014 (UTC)

== more styles/output formats ==

looking at some of the cleanup done by Red Leader recently, we could also directly support other styles/output formats to directly provide a format that looks well enough without requiring tons of manual editing. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:11, 13 February 2015 (EST)

== token matching for keywords/variables ==

seems like it might make sense to match common keywords/acronyms and variables, such as e.g.:
* FG_ROOT => [[$FG_ROOT]]
* FG_HOME => [[$FG_HOME]]
* FG_SRC => [[$FG_SRC]]

file names with a known prefix like $FG_ROOT could even be pattern-matched using git link: $FG_ROOT/Nasal/canvas/MapStructure.nas would become [[$FG_ROOT]]{{Git link|gitorious|fg/fgdata|master|Nasal/canvas/MapStructure.nass|text=/Nasal/canvas/MapStructure.nas}}

Equally, we could match common property paths to use code tags, e.g.: /sim/rendering would become <code>/sim/rendering</code>
Ultimately, it might be a good idea to get in touch with Johan_G, Gijs and Red Leader to see what kind of format they'd prefer, especially because this could then be directly used for creating newsletter contents. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:19, 13 February 2015 (EST)

== matching repository references using git link template ==

Most of us commonly refer to repository files using either the $FG_* references, or relative paths in the form of <code>src/Main/fg_init.cxx:line number</code>, we could automatically convert such references using the git/repo link template, e.g.:

{{FGCquote
|Further investigation found that the launcher *is* trying to add this directory to fg-aircraft (src/GUI/QtLauncher.cxx:772), but that this doesn't work because this option is processed before the launcher is run (intentionally, to allow the launcher to find aircraft in fg-aircraft: '''src/Main/main.cxx:448''').
|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33686356/
|title=<nowiki>Re: [Flightgear-devel] Launcher issues on Linux</nowiki>
|author=<nowiki>Rebecca N. Palmer</nowiki>
|date=<nowiki>2015-04-01</nowiki>
}}
}}

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:48, 1 April 2015 (EDT)

== chrome specific port ==

Hi Red Leader, when/if you do come up with a chrome specific version of the script, I would suggest to refactor existing APIs accordingly, so that we can come up with a common library of general purpose/utility helpers, so that both scripts can co-exist and use a common/shared file (think all the extraction/transformation logic), by referencing an external .js/JavaScript file that will be maintained/updated and hosted separately. I think this could be accomplished easily using jsfiddle. So basically, I am suggesting to come up with a shared back-end for both versions of the script. Given the complexity we're reaching meanwhile, as well as the number of edits and contributors, it may also make sense to consider using github for this at some point. One of the main advantages being that we could easily distribute updates automatically to all people who've installed the script, without them having to do anything manually.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 08:38, 23 June 2015 (EDT)

== Development resources ==

* https://www.youtube.com/watch?v=xpXNDT0SxM0
* http://wiki.greasespot.net/GM_getResourceText
* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script

== Future focus/development and priorities (De-quoting) ==

Given that most people involved in maintaining the wiki don't seem to particularly appreciate the nature of articles consisting mainly of quotes, and that we don't seem to have any other good way to populate new articles quickly, I was thinking of changing the focus of the script to dynamically create articles using quotes (with proper refs), that would be merely copy-edited, i.e. using the process we are currently using to "de-quote" such articles by 1) categorizing related quotes, 2) coming up with headers/sub-headers, 3) re-writing/merging certain quotes, 4) attributing them - linking back to the quotes archives.
Should we decide to pursue this, the script would be turned into a "wizard" where we can topics and sub-topics (wiki headings) and then add arbitrary text using the existing approach, but without using cquotes - i.e. the focus would be on extracting relevant contents, distilling them down and adding plenty of refs, including a references section at the bottom. Some tokens/words could be changed dynamically, but some kind of proof-reading/copy-editing would still need to be done afterwards, because people tend to use first person speech in their announcements/postings, which we would need to convert to 3rd person semi-automagically. Thoughts/ideas ?--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:11, 15 November 2015 (EST)

== changing and automating regex/xpath handling ==
{{See also|#Genetic_Expression_solver}}

We have currently hard-coded handling of different websites, regexes and xpath expressions so that things are a bit fragile at the moment, and once a website changes its style/template, our script would break immediately. However, we could change the way the script works by using a very simple NN (neural network) to come up with matching regex/xpath expressions automatically. The way this could work would be "supervised" training, where we would replace/adapt our existing CONFIG hash with a vector of URLs and contents to be extracted (date, time, title, posting). This kind of data would suffice entirely for a neural network to self-train itself and "learn" how to come up with regex/xpath expressions to extract the relevant contents, including not only hard-coded websites like sourceforge, but even completely different websites (think gmane) - because the "learning" routine would self-adapt by looking at how to get its contents, and never contain any hard-coded regex/xpath expressions anymore. The CONFIG hash would end up being a vector with "training data" for different websites to be supported. And whenever an expression fails, it could re-train itself accordingly.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:33, 15 November 2015 (EST)

== nested quotes and AJAX for thread titles ==

{{FGCquote
|1= http://sourceforge.net/p/flightgear/mailman/message/33451055/
{{cquote|As we move forward with FlightGear development and future versions, we will be expanding the "in app" aircraft center. This dialog inside flightgear lets you select, download, and switch to any of the aircraft in the library.|Curt}}
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=259879#p259879
| title = <nowiki>Re: New Canvas GUI</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Oct 7th, 2015
}}
}}

== AJAX mode/testing ==

We should probably add a dialog to store credentials that we can use for accessing the wiki, which would need to be shown after installing the script, i.e. first-time use

* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script
* http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Getting_Started#During_Installation
* https://www.safaribooksonline.com/library/view/greasemonkey-hacks/0596101651/ch01s06.html

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 20 November 2015 (EST)

== libraries ==

Referring to the [[#Hosting]] section, and my comment on wanting to use additional libs (like jQuery), I am primarily thinking about using a wizard-framework (e.g. jQuery steps) and a framework for creating wikimedia editor plugins (actions):

* http://mstratman.github.io/jQuery-Smart-Wizard/
* http://www.jquery-steps.com/
* http://www.jqueryrain.com/demo/jquery-step-form-wizard/
* https://www.mediawiki.org/wiki/Extension:WikiEditor

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:07, 2 May 2016 (EDT)

== About dequoting the script's article ==

Thanks for doing this, but I am frankly not sure if it's worth the effort - there are much more popular/important articles using tons of quotes than this one, and given the reputation of the script, having quotes in this article may actually be a useful thing to make the case for having quotes in the first place - thus, I would frankly not spend much time going through this particular article - in fact, I'd be very surprised if the greasyfork download stats showed more than 3-5 people actually downloading, and using, the script - so this is really just a niche tool, and we probably better spend our time doing other things, and reviewing other wiki articles, than the script's article - at the very least, I would suggest to retain the references to the original discussions revolving these quotes (just my 2c). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 19:00, 2 May 2016 (EDT)

: {{done}} I've added back the quotes as references. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:53, 3 May 2016 (EDT)

== Script configuration (persistence) ==

* https://wiki.greasespot.net/GM_config
* https://github.com/sizzlemctwizzle/GM_config/wiki
* https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API

== Work in progress ==

We have now several more or less related development efforts going on, and the code is also growing because of that - so it seems to make sense to summarize what's been going on recently. In general, all changes were made in response to the collection of feature requests and ideas we have accumulated over time - specifically, that means that the following roadmap is in the process of being implemented:

* establish unit testing, and add a few self-tests, so that the script can be more easily tested, updated/reviewed in the future
* rework the script to more easily support other sources (think gmane)
* make it much easier to update modified xpath/regex expressions (i.e. provide a UI for that)
* support persistence for script-specific settings
* make it easier for people to port/maintain the script by encapsulating platform specifics
* support asynchronous fetching of postings (AJAX), e.g. to fetch posting titles, attachments etc
* prepare the groundwork for supporting template-based output formats (think newsletter, changelog, articles)
* review what's necessary to allow the script to update fgcquote-based quotes automagically

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:47, 4 May 2016 (EDT)

== External genetic/neural network libraries ==
While uploading the latest version of the script, I noticed that the Genetic and Synaptic libraries are hosted on sites not on [https://greasyfork.org/en/help/external-scripts the approved GreasyFork list]. Shall I ask them to host them? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:28, 11 May 2016 (EDT)

: Thanks for pointing that out, I missed that completely, because everything is working correctly here - but obviously, I rarely get to actually download/install the latest version via greasyfork. Those libs should be safe to be added to the list, i.e. they're fairly established/popular, lest I'd not be using them. For now, this is just an experiment anyway. The idea is to update the xpath/regex code to evolve if/when the underlying website (theme) changes. But if there is a problem, we could use other libs - the code is just used for testing ATM. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:41, 11 May 2016 (EDT)

* https://github.com/subprotocol/genetic-js
* https://github.com/cazala/synaptic

:: {{ongoing}} I have submitted the libraries to the JSDelivr CDN; once they are up, I'll change the source URLs in the script and update it on GreasyFork as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:32, 17 May 2016 (EDT)

::: Hi Elgaton, thank you for taking care of this, it's very much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:55, 17 May 2016 (EDT)

:::: You're welcome! My merge requests for the CDN were approved (this took a bit longer than expected because I had made a small mistake - I forgot to include a file required by the Genetic.js library). The libraries should be up in a day or two, at which point I'll update the URLs in the script and submit the new version to GreasyFork. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:59, 20 May 2016 (EDT)

::::: {{done}} Everything should be fine now. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:16, 20 May 2016 (EDT)

:: Thank you for all the help with this, and also for updating the greasyfork info/screenshots ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:16, 21 May 2016 (EDT)

== Genetic Expression solver ==
[[File:Instant-cquotes-genetic-regex-solving.png|thumb|Screenshot showing the instant cquotes script with integrated regex solving support using genetic algorithms.]]

The genetic-js framework has been integrated, it is intended to help solve xpath/regex expressions procedurally using genetic algorithms/programming.

The idea is to provide a set of desired outputs (needles), available input data (haystack), and use existing (possibly outdated) regex/xpath expressions to seed a pool with potential solutions for retrieving the desired output. For now, this is just proof-of-concept, i.e. just an experiment.

For example, let's consider the typical format of a from header for any sourceforge posting:
<syntaxhighlight lang="javascript">
var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];
</syntaxhighlight>

The basic idea is to run a fitness function and score regex expressions based on not throwing an exception (which makes them valid), and by checking if the desired tokens are part of the output string, and evolve (mutate/cross-over) the "fittest" expressions - i.e. those that satisfy at least /some/ of the heuristics.

Some of the metrics that can be used by the fitness function to determine if an expression is "fit", are:
* valid expression
* relative offset/excess bytes in matches string
* number of examples it can successfully extract
* length of the expression
* runtime of the expression

The search space, and runtime, can be significantly reduced by looking at similarities between all examples and coming up with a subset string that contains all identical components (e.g. the <code>From:</code> part in the author regex) and use that for seeding the initial generations.

Ultimately, this would allow the script to self-update its regex/xpath expressions if/when the underlying website (themes) change, but it would also allow to add support for new websites, without ever manually adding the required xpath/regex expressions, i.e. all that is needed is a sufficiently large number of example datasets to obtain the author, date and title information, and a URL for the script to download the HTML markup of the posting in question:

{{Note|The date field won't work as is, because it's actually post-processed using a transformation function, so we'd need to undo the transformation or use the actual date string instead}}
<syntaxhighlight lang="javascript"> // vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
</syntaxhighlight>

Note how this no longer contains any hard-coded xpath/regex expressions - instead, the script can refer to the website specific defaults, and try those first, and if they fail, use those to seed new generations and evolve them procedurally until all tests succeed.

For a regex to be valid, it must work for all tests/examples.

Once the regex solver is working correctly, the code can be further generalized to also evolve xpath expressions (NOTE: the DOMParser API is /not/ available to webworkers ...) and chain those two components together.

* http://regex.inginf.units.it/how.html
* http://www.i-programmer.info/programming/perl/9503-automatically-generating-regular-expressions-with-genetic-programming.html
* http://jkff.info/articles/ire/
* http://www.networkworld.com/article/2955126/software/genetic-programming-meets-regular-expressions.html
* https://handcraftsman.wordpress.com/2012/04/11/evolving-a-regular-expression-with-go/
* http://stackoverflow.com/questions/4880402/how-to-auto-generate-regex-from-given-list-of-strings
* http://regex.inginf.units.it/
* http://www.genetic-programming.org/hc2014/Bartoli-Paper.pdf

== Hierarchical Clustering ==

Been tinkering with a JavaScript module to automatically cluster postings based on certain keywords in the topic/title or posting (e.g. Nasal, Canvas, 2D API, rendering): https://harthur.github.io/clusterfck/

Note that in conjunction with processing article sections and/or whole articles, this could help automatically come up with matching postings for articles and vice versa.

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:11, 19 May 2016 (EDT)

== Upcoming dependencies ==

The script is now using [http://markitup.jaysalvat.com/home/ markitup] to create the template editor. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:18, 21 May 2016 (EDT)

: I've [https://github.com/jsdelivr/jsdelivr/pull/11757 submitted a pull request] for the library to be distributed by jsDelivr. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 16:08, 21 May 2016 (EDT)

:: Thank you, but please don't make this a priority: I only just realized that it is introducing a bunch of jQuery issues, and that the project hasn't been updated in years, so it probably makes more sense to use something else - i.e. the "integration" itself only takes 10 lines of code, but fixing all the jQuery compatibility issues, would be non-trivial. Thanks anyway. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:19, 22 May 2016 (EDT)

::: {{Done}} -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 08:10, 27 May 2016 (EDT)

== Code beautifier ? ==

I still had, and have, pending changes that would need to go through the same beautifier you're using, or they'd be lost - so for now, I have just overwritten your beautified code, hope that you didn't do this manually (there really are tons of automated and configurable beautifiers out there). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:59, 21 May 2016 (EDT)

: Of course not - let me know when you've incorporated all changes so that I can beautify the script again. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 16:31, 21 May 2016 (EDT)

:: I have been using some web-based JavaScript syntax checking tools, too (e.g. www.jshint.com), so if it's a website, too - let's just share/document these tools here.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:34, 21 May 2016 (EDT)

::: I use [http://www.jslint.com JSLint] plus a bit of manual editing (if needed). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:34, 21 May 2016 (EDT)

FlightGear Git

2016-05-23T20:58:09Z

Elgaton: /* Repositories and branches */ Add branch details for all repositories in fgmeta

{{Git}}
'''Git''' is a {{wikipedia|version control system}} used by the [[FlightGear]] project to store all the files required to build and run the simulator. This includes all the programs, the data (e.g. textures, sounds), supporting tools, etc. Git tracks updates to every file as developers from around the world work together concurrently to create new versions. The sole exception is the official [[FGAddon]] aircraft repository that is Subversion rather than Git based.

While new FlightGear features and additions are in development, they are available from Git before they are available in the standard release version. Using Git allows users to use the newest possible version of FlightGear from the latest source files, to experiment with new aircraft or other features. However, it is not a beginner's tool. Using Git can expose the user to unstable features that show ugly error messages, or crash the computer.

As of May 2016, the repositories are located at {{Project infrastructure|name}}.

== Motivation ==
In May 2010, after a hardware failure on the [[CVS]] servers, the FlightGear project changed its version control system from CVS to Git.

Much has been written on the advantages of Git over CVS. For the FlightGear project, some advantages are:
* Much better support for branches and merging branches. This is especially important for creating bug fix releases for major releases while still allowing work on the next major release to continue. It is also very nice for a developer's personal workflow.
* Easier path for contributors to submit changes and developers to integrate them.
* Much better support for everyday tasks like searching the project history for changes, viewing changes, bisecting the project history to find the original source of a bug.

== Repositories and branches ==
The FlightGear project is split up in the repositories listed below.
{| class="wikitable"
! Name
! Contents
! Remarks
|-
| {{simgear source|text=simgear}}
| The simulation engine that FlightGear uses.
| rowspan="6" |
Those repositories have the following branches:
* ''next'': current tip of new development. This branch should always compile and run, but various things could be broken.
* ''release/*'': containing former and (if a specific branch was made for them) upcoming releases.

As of May 2016, FGRun is in the process of being replaced by the [[Qt5 Launcher|Qt5 launcher]].
|-
| {{flightgear source|text=flightgear}}
| FlightGear itself.
|-
| {{fgdata source|text=fgdata}}
| All data (default aircraft, dialogs, sounds) used by FlightGear.
|-
| {{fgmeta source|text=fgmeta}}
| FlightGear "meta" repository containing build and setup scripts for the whole project.
|-
| {{windows-3rd-party source|text=windows-3rd-party}}
| Prebuilt libraries needed to make FlightGear run on Windows.
|-
| {{fgrun source|text=fgrun}}
| The [[FGRun]] launcher for FlightGear.
|-
| {{fgaddon source|text=fgaddon}}
| SVN repository that holds all official aircraft (except the [[Cessna 172P]] default plane and the [[UFO]]).
|
|-
| {{fgcom source|text=fgcom}}
| [[FGCom 3.0|FGCom]], a voice-over-IP application used by [[multiplayer]] controllers to provide [[Air traffic control|ATC services]].
|
|-
| {{getstart source|text=getstart}}
| Sources for the ''Getting Started'' manual included with the simulator.
|
|-
| {{openradar source|text=openradar}}
| The [[OpenRadar]] application used by multiplayer controllers.
|
|-
| {{sceneryweb source|text=sceneryweb}}
| Source code and configuration files for the [http://mapserver.flightgear.org/ Mapserver], the [https://scenery.flightgear.org/ scenery portal] and the [[TerraGear scenery build server]].
|
|-
| {{terragear source|text=terragear}}
| The [[TerraGear]] scenery building toolkit.
|
|-
| {{terrafs source|text=terrafs}}
| A Linux tool to mount the TerraSync scenery as a remote file system.
|
|-
| MacLauncher
| Old FlightGear launcher for Mac.
| Deprecated by the [[Qt5 Launcher|Qt5 launcher]].
|}

== Related content ==
* [[FlightGear Git: splitting FGData]], an initiative to split the aircraft out of the FGData repository, in order to decrease its size and thus improve access to the average user/developer.

{{Building}}

[[Category:Core developer documentation]]
[[Category:FlightGear]]
[[Category:Git]]

[[fr:FlightGear et Git]]

FlightGear Git

2016-05-23T20:24:08Z

Elgaton: Use the {{Transclude|Project infrastructure}} template for the SF link; others to follow

{{Git}}
'''Git''' is a {{wikipedia|version control system}} used by the [[FlightGear]] project to store all the files required to build and run the simulator. This includes all the programs, the data (e.g. textures, sounds), supporting tools, etc. Git tracks updates to every file as developers from around the world work together concurrently to create new versions. The sole exception is the official [[FGAddon]] aircraft repository that is Subversion rather than Git based.

While new FlightGear features and additions are in development, they are available from Git before they are available in the standard release version. Using Git allows users to use the newest possible version of FlightGear from the latest source files, to experiment with new aircraft or other features. However, it is not a beginner's tool. Using Git can expose the user to unstable features that show ugly error messages, or crash the computer.

As of May 2016, the repositories are located at {{Project infrastructure|name}}.

== Motivation ==
In May 2010, after a hardware failure on the [[CVS]] servers, the FlightGear project changed its version control system from CVS to Git.

Much has been written on the advantages of Git over CVS. For the FlightGear project, some advantages are:
* Much better support for branches and merging branches. This is especially important for creating bug fix releases for major releases while still allowing work on the next major release to continue. It is also very nice for a developer's personal workflow.
* Easier path for contributors to submit changes and developers to integrate them.
* Much better support for everyday tasks like searching the project history for changes, viewing changes, bisecting the project history to find the original source of a bug.

== Repositories and branches ==
The FlightGear project is split up in the repositories listed below.
{| class="wikitable"
! Name
! Contents
! Remarks
|-
| {{simgear source|text=simgear}}
| The simulation engine that FlightGear uses.
| rowspan="3" |
Those repositories have the following branches:
* ''next'': current tip of new development. This branch should always compile and run, but various things could be broken.
* ''release/*'': containing former and (if a specific branch was made for them) upcoming releases.
|-
| {{flightgear source|text=flightgear}}
| FlightGear itself.
|-
| {{fgdata source|text=fgdata}}
| All data (default aircraft, dialogs, sounds) used by FlightGear.
|-
| {{fgaddon source|text=fgaddon}}
| SVN repository that holds all official aircraft (except the [[Cessna 172P]] default plane and the [[UFO]]).
|
|-
| {{fgrun source|text=fgrun}}
| The [[FGRun]] launcher for FlightGear.
| As of May 2016, in the process of being replaced by the [[Qt5 Launcher|Qt5 launcher]].
|-
| {{windows-3rd-party source|text=windows-3rd-party}}
| Prebuilt libraries needed to make FlightGear run on Windows.
|
|-
| {{fgmeta source|text=fgmeta}}
| FlightGear "meta" repository containing build and setup scripts for the whole project.
|
|-
| {{fgcom source|text=fgcom}}
| [[FGCom 3.0|FGCom]], a voice-over-IP application used by [[multiplayer]] controllers to provide [[Air traffic control|ATC services]].
|
|-
| {{getstart source|text=getstart}}
| Sources for the ''Getting Started'' manual included with the simulator.
|
|-
| {{openradar source|text=openradar}}
| The [[OpenRadar]] application used by multiplayer controllers.
|
|-
| {{sceneryweb source|text=sceneryweb}}
| Source code and configuration files for the [http://mapserver.flightgear.org/ Mapserver], the [https://scenery.flightgear.org/ scenery portal] and the [[TerraGear scenery build server]].
|
|-
| {{terragear source|text=terragear}}
| The [[TerraGear]] scenery building toolkit.
|
|-
| {{terrafs source|text=terrafs}}
| A Linux tool to mount the TerraSync scenery as a remote file system.
|
|-
| MacLauncher
| Old FlightGear launcher for Mac.
| Deprecated by the [[Qt5 Launcher|Qt5 launcher]].
|}

== Related content ==
* [[FlightGear Git: splitting FGData]], an initiative to split the aircraft out of the FGData repository, in order to decrease its size and thus improve access to the average user/developer.

{{Building}}

[[Category:Core developer documentation]]
[[Category:FlightGear]]
[[Category:Git]]

[[fr:FlightGear et Git]]

Template talk:Project infrastructure

2016-05-23T20:23:38Z

Elgaton: /* Other URLs */ Add scenery portal

== Hijack ==

@Hooray: This idea is too useful, so I might hijack it ;) I'll move this from {{tl|Project URL}} to {{tl|project infrastructure}}. Then the default option can be mode=url. I would like to have a mode=name returning SourceForge, and mode=abbrev returning sf. I will then use this in the {{tl|repo link}} family of templates to make the subtemplates 100% independent of the current infrastructure, so that the links will be timeless :) This single template could end up being the sole reference to SourceForge and other infrastructure on the whole wiki.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 02:08, 26 February 2016 (EST)

yes, that was the idea - I was just expecting to spend a few weeks doing this, and not to come back realizing that you finished the whole thing in a few hours. So, thank you very much for doing this. It is good for us to learn from the sourceforge transition and try to prevent certain issues in the future.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 06:43, 26 February 2016 (EST)

== Forum ==

probably need to extend the template a little to support this use-case: http://wiki.flightgear.org/index.php?title=Template:Forum&action=history

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 06:28, 26 February 2016 (EST)

: I guess an optional 'urn' parameter for appending to the URL, as well as a 'text' parameter to change the name of the link would do. Then {{tl|forum}} could transclude this template.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 06:56, 26 February 2016 (EST)

:: Done.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 08:38, 26 February 2016 (EST)

: Thank you, I just used this to implement this [[Template_talk:Project_infrastructure#Unified_search_handling]] --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:13, 17 April 2016 (EDT)

== Other URLs ==

* mumble servers, also to help us deal with incidents like [http://wiki.flightgear.org/index.php?title=Mumble&oldid=97410]
* scenemodels.flightgear.org
* scenery.flightgear.org
* liveries.flightgear.org
* multiplayer map
* add ticket/issue tracker template here ?
* FGCom server
* Lenny's ATC website

== Some suggestions ==
First off, implement this step by step, and think the architecture through during the process. Do not lock yourself in early.

I still have frustrations with annoying inconsistencies and non user friendly naming schemes in the FlightGear screenshot categories due to "flash-implementing" early ideas before thinking them through thoroughly.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 16:26, 27 February 2016 (EST)

:: just for the record, I do agree with this, but on the other hand, had bugman not taken my original idea and developed it much further, I would still be dabbling that - so, basically within a few hours, bugman went through several iterations of this, without needing much in terms of feedback, and I am pretty satisfied with it personally. I do get your point though, so I would suggest to document "best practices" - I am not much a wiki guru myself, I really only use a tiny fraction of its markup/features, and I am always glad for your contributions to my templates, because it's not something that I am very good at/interested in - I would rather write php/javascript code than having to memorize wikimedia templates myself. But if there is anything that we/I can do better to lighten your workload (Johan, Red Leader, Gijs), please just document your suggestions somewhere. In terms of the overall idea here, I believe it is the right thing to do, and while it my not address all your concerns, it is certainly better than the existing practice - and had we done this a few years ago, we would not be having certain problems now. So I would politely suggest that "we should not let the perfect be the enemy of the good" here, this isn't core development after all - it's just a wiki, and anything that helps reduce our workload is a good thing, until someone comes up with something better somewhere down the road. All in all, let's also keep [http://forum.flightgear.org/viewtopic.php?f=42&p=277816#p277816 this] in mind (which may have no immediate repercussions at all, or which may have unfortunate side effects in a few years/months. So, thanks again bugman for all you have handled so far - it's certainly much better, and much faster, than anything that I could have come up with in this timeframe, and I am very impressed with the quality of your wiki involvement - then again, thanks also to Johan for providing the kind of feedback that bugman asked for - but please let's not overthink this... Talking about the "architecture of a template" is a bit too much for my own taste --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 19:53, 27 February 2016 (EST)

=== The mode parameter ===
I think the '''mode''' parameter is slightly ambiguous and maybe misleading. I would expect it to be something like for example '''type''' or '''infrastructure''' rather than '''mode'''.

As this is an unnamed parameter this is merely a change in the documentation.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 16:26, 27 February 2016 (EST)

: I agree. This was just a quick and random choice, as I've been generating a lot of template content very quickly recently with the aim of having practical and functional implementations. So no real thought has gone into this. I'd suggest '''type''' to allow this template to be a universal resource.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 16:37, 27 February 2016 (EST)

=== The name value of the mode parameter ===
I would say that even though it is an important ''part'' of the project infrastructure SourceForge is merely the host of the main repositories.

Here I would probably rather expect something like for example '''host''' or '''main-repo''' rather than '''name'''.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 16:26, 27 February 2016 (EST)

: Again a random and quick choice :) What about '''provider'''? Though SF is not the provider of everything FG related, so something along the lines of '''main...''' might be good. I have no real preference - this is the default value of the ex-'''mode''' parameter, so you wouldn't normally use it when transcluding anyway.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 16:44, 27 February 2016 (EST)

=== Slight variation of the current architecture ===
This might make for a slightly more complex template, but consider this:

{{obr}}project infrastructure|''infrastructure''|''attribute''{{cbr}}

All parameters would be optional optional. If none is given it could e.g. default to the URL of the project page at SourceForge.

:; infrastructure: Name of the infrastucture, e.g. '''forum''', '''wiki''', '''main-repo''', '''scenedb''' or '''website'''. Could e.g. default to '''main-repo'''
:; attribute: One of several attributes associated with the infrastructure, e.g. '''name''', '''abbreviation''', '''url''', '''host''' etc. Could e.g. default to '''url'''

I think the template would be slightly more flexible this way.

It could be implemented with two levels of <code><nowiki>{{#switch: }}</nowiki></code> parser functions and use the <code><nowiki>#default =</nowiki></code> case to catch most errors. Something like:

<nowiki>{{#switch: {{{1|main-repo}}}
| wiki = {{#switch: {{{2|url}}}
| name = FlightGear wiki
| short-name = wiki
| url = http://wiki.flightgear.org
| #default = {{error|Attribute '''{{{2}}}''' invalid for infrastructure '''wiki'''|project infrastructure}}
}}
| main-repo = {{#switch: {{{2|url}}}
| name = Main FlightGear repository
| short-name = main repo
| host-name = SourceForge
| host-short-name = SF
| host-url = http://www.sourceforge.com
| url = http://sourceforge.net/projects/flightgear/
| #default = {{error|Attribute '''{{{2}}}''' invalid for infrastructure '''main-repo'''|project infrastructure}}
}}
| #default = {{error|Invalid '''infrastructure''' parameter|project infrastructure}}
}}</nowiki>

The template documentation should probably be complemented by a table of available infrastructure and attribute combinations.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 16:26, 27 February 2016 (EST)

: Please feel free to change :) This all sounds great. My focus is on recursive transclusion for simply pulling out '''sf''', so we can pragmatically change the behaviour of templates. I can quickly adapt all usage of this template to match. For example {{tl|flightgear source}} uses it to completely avoid the SourceForge reference, to then pass it into the now very powerful {{tl|repo link}} template. The table idea is good as well. It could replace the examples section by absorbing the examples. I just have some suggestions:

:* A '''code''' value for the second option (replacing '''abbrev'''). This would return '''sf'''. This would be used as a simple internal wiki code for programmatically changing template behaviour.
:* Alphabetical ordering of values in the switches, in case this becomes quite big.
:* '''url''' return values of <nowiki>[http://wiki.flightgear.org FlightGear wiki]</nowiki>.
:* '''main-repo''' name as "Main FlightGear infrastructure", as this is a collection of repositories, plus a lot of other FG infrastructure. Maybe '''main-infrastructure''' would be better for a value, though it is a little long. What about just '''main'''?

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 17:02, 27 February 2016 (EST)

:: Is that ok for you? Only after I posted the above I saw how many places this template touches already. Though still I would like to have it done.

::* I am not sure I understand your first point. Is this for a switch in the templates?
::* Good point about alphabetical ordering of the attributes/values of the switches.
::* I would rather expect '''url''' to return a clean and somewhat more reusable url like <nowiki>http://wiki.flightgear.org</nowiki>. How about a '''link''' attribute to return the external link like <nowiki>[http://wiki.flightgear.org FlightGear wiki]</nowiki>.
::* I am ok with '''main''' (even though I find it a slight bit ambiguous ;-) ).
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 18:35, 27 February 2016 (EST)

:: I think I have a better grip on what you and Hooray are aiming for now. You basically want to be able to get a link (with optional custom label), a name and the possibility to add an "URN" (not really an URN per see though ;-) ).
:: An early draft can be found at [[User:Johan G/project infrastructure]].
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 20:29, 27 February 2016 (EST)

::: For the first point, it would be a switch. It would be used for auto-content generation within other templates, the {{tl|repo link}} template being the prime example. For such an internal code, an ideal would be for the code to be returned by default, so that {{obr}}project infrastructure{{cbr}} returns '''sf'''. These could be two letter codes. I'll make a proper table when I'm not on a mobile device. E.g. sf=SourceForge, gh=GitHub, gl=GitLab, go=Gitorious, gs=Gnu Savannah, ga=Gna!, etc.

::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 05:57, 28 February 2016 (EST)

::: Something like this, for maybe placing into {{tl|project infrastructure/doc internal codes}} (for transclusion into templates that use the internal codes):

::: {| class="wikitable"
!Open source infrastructure
!Internal code
|-
| [https://sourceforge.net/ SourceForge]
| style="text-align:center;" | '''sf'''
|-
| [https://github.com/ GitHub]
| style="text-align:center;" | '''gh'''
|-
| [https://gitlab.com/ GitLab]
| style="text-align:center;" | '''gl'''
|-
| [https://gitorious.org/ Gitorious]
| style="text-align:center;" | '''go'''
|-
| [https://savannah.gnu.org/ GNU Savannah]
| style="text-align:center;" | '''gs'''
|-
| [http://gna.org/ Gna!]
| style="text-align:center;" | '''ga'''
|}

::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 07:39, 28 February 2016 (EST)

::: I intend that switching between these internal codes solely within this template will fully switch the entire wiki from one open source infrastructure to another ;) Obviously this will take a lot of work, and a number references to old Gitorious infrastructure must stay (until the repository is migrated by the original author elsewhere). But I hope that searches for gitorious.org, sourceforge.net, etc. will return only a handful of hits on the wiki in the future. Anyway, I really like the double switch design. That is far more flexible and will allow for far better abstraction of the entire wiki contents. And, from a practical sense, it is very easy to expand on.

::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:10, 28 February 2016 (EST)

:: I agree with bugman's goals - just look at the recently announced sale of Sourceforge/Slashdot and what that may /possibly/ mean for the project (and our wiki) sometime in the future, so it is better to "isolate" ourselves from these kinds of changes (external factors), so that the project can more easily adapt itself under such circumstances, helping lower the amount of work necessary to maintain/update the wiki accordingly is a very good idea in my opinion - and I would prefer that we review other parts of the wiki (and other project infrastructure) accordingly.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:25, 28 February 2016 (EST)

::::: Having looked through how the template actually is used and what its purpose really is some days ago I noted that (at least as of now) the only real gain from my suggestion is an ever so slight bit more consistency and flexibility and a little less typing, but for the price of touching all the pages the template is used on. I wonder if it would worth it. If not, sorry for the noise.
::::: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 14:33, 4 March 2016 (EST)

:::::: This is an illusion from transclusion ;) The number of articles using this is actually quite low. I have used it for all of the {{tl|repo link}} subtemplates, so any page that uses one of these subtemplates will appear in a [[Special:WhatLinksHere]] search. I think your idea is great for improving this as a general framework. It allows wiki text to be written in a way that would remain relevant when, in the distant future, another major infrastructure change is required. It would extend its usefulness for abstracting away the infrastructure information so that old wiki pages can remain relevant for the decades to come.

:::::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 18:23, 4 March 2016 (EST)

:::::: Actually, its only used for the FlightGear specific subset. Also, most of those hits correspond to old Gitorious links that had been dead links for over a year now, and that I have recently fixed in the last few days using the {{tl|repo link}} subtemplates.

:::::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 18:54, 4 March 2016 (EST)

::::::: Ok then. :-) How about [[User:Johan G/project infrastructure|this]] ([http://wiki.flightgear.org/index.php?title=User:Johan_G/project_infrastructure&oldid=95141 perm])?
::::::: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:27, 8 March 2016 (EST)

:::::::: This looks great :) It's much more flexible for extending the template functionality, and much better organised. From my side, only the FlightGear specific templates listed at [[Template:Repo_link/doc_related]] would need updating. I think Hooray has a few too.

::::::::[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 02:57, 8 March 2016 (EST)

:::::::: Johan, I think it is time to convert this template to your new design ;) There will be a few breakages, but the {{tl|repo link}} family of templates are safe.

:::::::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 18:57, 14 May 2016 (EDT)

=== Unified search handling ===

* Idea: [[Template:Search]]
* Motvation: [[Skydiving#Related]]

Depending on what we come up with, this may either be integrated with the main template or refactored to be useful elsewhere.
--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:11, 17 April 2016 (EDT)

== Abstraction of internal design changes using subtemplates ==
I was thinking that we could avoid disruptions to the {{tl|repo link}} family of subtemplates and anything else that uses {{tl|project infrastructure}} by using subtemplates. For the internal codes used by other templates to switch between SourceForge, GitHub, GitLab, Gitorious, etc., we could have {{tl|project infrastructure/code}} that simply returns the 2 letter code via {{tl|project infrastructure}}. This could be used as an abstraction mechanism so that all design changes to {{tl|project infrastructure}} would simply require the subtemplates to be updated. Any other wiki pages using the subtemplates will be unaffected.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:32, 7 March 2016 (EST)

: I have created a temporary {{tl|project infrastructure/code}} subtemplate, and all of the {{tl|repo link}} templates now use this instead of {{tl|project infrastructure}} directly. Therefore changing this template will not disrupt any pages that transclude the {{tl|repo link}} subtemplates. The following templates might also need a similar strategy, or they are updated simultaneously. Hooray, could you maybe help complete this list?

: '''Templates and pages directly dependent on {{tl|project infrastructure}}''':
:* {{tl|project infrastructure/code}}
:* {{tl|forum}}

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 11:04, 15 March 2016 (EDT)

:: Sorry, I completely missed that you asked me to help with something - if that's still an issue, what exactly should I help complete ? --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:38, 17 May 2016 (EDT)

::: Nope, that was just to help Johan make the transition to the newer and more flexible design. When he makes the change, the {{tl|repo link}} templates will not be affected. Then I'll switch the {{tl|project infrastructure/code}} subtemplate to use this template, or revert {{tl|repo link}} to use it directly.

::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 10:50, 17 May 2016 (EDT)

== Related mailing list templates ==

See:
* http://wiki.flightgear.org/Template:Mailing_list_e-mail_address
* http://wiki.flightgear.org/Template:Mailing_list_subscription_link
* http://wiki.flightgear.org/Template:Mailing_list_archive
* [[Template:Gmaneref]]

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:12, 5 May 2016 (EDT)

FlightGear wiki:Village pump

2016-05-23T18:11:38Z

Elgaton: /* Reorganizing the Git articles */ Screenshot templates

{{Archives|[[/Archive 2012|2012]]|[[/Archive 2013|2013]]|[[/Archive 2014|2014]]|[[/Archive 2015|2015]]}}
{{shortcut|FGW:VP}}
Welcome to the '''Village Pump'''. This page is used to discuss the technical issues, operations and guidelines of the [[FlightGear wiki]].

Please <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit&section=new}} add new topics]</span> to the '''bottom''' of this page.

Old discussion should be moved to a [[FlightGear wiki:Village pump/Archive YEAR]]. These discussions can then be moved to a relevant talk page if appropriate.

== Welcome template? ==
I have been thinking about suggesting a welcome template, for example named {{obr}}welcome{{cbr}}, to place on top of (at least) new users user discussion pages.

It should welcome the (new) user

In addition, it should probably mention and/or link to pages mentioning:
* The introduction page/tutorial (Hmm, I do not think I did finish that one. See [[Help talk:Tutorial]] ([http://wiki.flightgear.org/index.php?title=Help_talk:Tutorial&oldid=70843 perm])).
* Help pages
* How to use categories (in particular not like #tags, ;-) but also that image and article categories should be separate, but link to each other)
* The portals
* The style manual
* Discussion pages and where to discuss what:
** How to use discussion pages
** The wiki in general: The village pump (this page)
** Wiki articles: Article discussion pages
** Wiki user actions: User discussion pages

Maybe it should also mention that FGAddon aircraft, effects, other features etc. (except for their articles) and their bugs should be discussed on the forum, unless developers say otherwise, and that core features should be discussed on the developer mailing list and core bugs on the bug tracker.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 20:31, 30 January 2016 (EST)

: I think this is a great idea. A nice concise summary with links to help a new user navigate the FlightGear jungle would be a great addition. It should however remain very short with simple sentences - while being complete - as many users are not native speakers. So maybe there should be translations of the template with manually added links at the bottom for easy access to all the translations?

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:35, 12 February 2016 (EST)

:: Regarding an introduction article, I have come to the conclusion that a complete but long article is probably not as helpful as short but specific help pages. In essence the latter would be easier to navigate and absorb. I have therefore started to slowly split up some of the help pages and have added one more section to [[Help:Contents]].
:: I think that a welcome phrase, a link to that page and the [[FlightGear wiki:Manual of Style|style manual]] might actually suffice for a welcome template for now. It is at least better than what we currently have (i.e. more or less nothing).
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 14:47, 4 March 2016 (EST)

:: I now consider
::* A Welcome message
::* A link to this page
::* A link to the help pages
::* A link to the manual of style
::* Some final welcoming words

:: A welcome template should probably also very briefly mention a pet peeve of mine: the categories.
:: Many (if not most) image uploaders seem to treat them like tags, but if say all screenshots of aircraft (probably >2000) would end up at [[:Category:Aircraft]] (instead of under a subcategory to [[:Category:Screenshots of aircraft]]), of what use would that page be when looking for a specific one? If people would like to be able to search for an aircraft, a concise but comprehensive image description is very hard to beat.
:: How do I convey all that in a way that is, short, to the point and easy to absorb (and act by)? And where is the best place?
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:46, 8 March 2016 (EST)

:: An early draft is now at [[User:Johan G/Template:Welcome to the wiki]]
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:52, 18 April 2016 (EDT)

::: Some comments on the draft:
::: * I'm not fully sure about using a prominent box - I think it stands out a bit too much. Wikipedia {{wikipedia|Template:Welcome|uses a simple thread on the Talk page}}; as an alternative, we could use lighter colors.
::: * I've also expanded the text a bit. My proposal would be (I've put it in a box, but I'm for the "thread" solution):
<div style="background: #fff; border: 1px #585858 solid; padding: 12px; margin: 12px">
[[Image:Example.png|left]] '''Welcome to the FlightGear wiki, {{#if: {{{name|}}} | {{{name}}} | {{BASEPAGENAME}}}}'''! We hope you will enjoy your stay!

See [[Help:Contents#Reading|Reading]] to learn how wikis work. You can also [[Special:CategoryTree/Root category|browse the existing page categories]].

Should you wish to create or edit some articles, ''do so''! Here are some resources to get you started:
* [[Help:Contents#Editing|How to edit pages]]
* [[Help:Discussion pages|Discussion pages]], where we discuss and agree on potential improvements
* [[FlightGear wiki:Manual of Style|The Manual of Style]], a set of guidelines to help editors maintain a consistent style and formatting (please follow them)
* [[Help:Contents|Wiki help page]]

If you have any questions, just start a topic on the [[FlightGear wiki:Village pump|''Discuss!'' page]]. Again, welcome!
</div>
::: ...where the image on the left is an appropriately chosen icon.
::: Finally, we could use the {{mediawiki|Extension:NewUserMessage|NewUserMessage extension}} to have the wiki software automatically post the message to the new user's talk page.
::: ---- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:30, 1 May 2016 (EDT)

== Permanently removing spam bots ==
For permanently removing spam bots, has the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] Mediawiki extension been considered? I use that regularly on [http://wiki.nmr-relax.com my own wiki], though there we have also reverted to communicating to the person via email before manually granting access (probably not an option here), as all of the Mediawiki captcha methods were recently cracked.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:15, 12 February 2016 (EST)

: Oh, for the extension, we simply have a user called 'Spam bot' in a blocked state, and merge the spam bot accounts into this one, deleting the old account.
: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:20, 12 February 2016 (EST)

:: I'd use the [https://www.mediawiki.org/wiki/Extension:AbuseFilter abuse filter extension] instead (much more powerful and automated) - other users have also proposed different remedies, see [http://forum.flightgear.org/viewtopic.php?f=42&t=28734 this forum thread]. Anyway, Gijs is going to upgrade MediaWiki shortly and review the current anti-spam measures.
:: -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:26, 13 February 2016 (EST)

::: A lot of the spam bots are using their name as advertising nowadays, so the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] extension is the only one I know which will allow a user and associated name to be permanently deleted.

::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:04, 14 February 2016 (EST)

:::: The problem now is that they're also adding the information to the page title, so that it will still show up in the deletion logs [http://wiki.flightgear.org/Special:Log/delete] in other words, there's still some SEO juice associated with deleted entries ... Another idea would be to allow admins to temporarily disable wiki registrations/article creation, e.g. if more than 2 admins agree, this could be done to protect the wiki from spam attacks.

::::: Hooray, you should sign your posts ;) The bots don't target the deletion logs, as that's a little pointless. It's a Special:* page, and the default Mediawiki robots.txt file tells all search engines to not index these pages. User pages, page histories, etc. are however normally indexed.

::::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:36, 19 February 2016 (EST)

:: The point was not what the bots are targeting, but what shows up in the logs - i.e. SEO-wise - Gijs' article blacklist stuff should help with that hopefully. PS: I could not find the signature button on the mobile device I am using, and I am not too good at remembering the correct number of tildes ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:04, 19 February 2016 (EST)

== WIP vs. Under construction ==
I have been beginning to miss the under construction template[http://wiki.flightgear.org/index.php?title=Template:Under_Construction&direction=prev&oldid=46229] more and more (though I could it definitively could be improved).

I have begun to appreciate the need to differentiate between letting readers that a page is to be considered a yet to be finished construction site (though we in a way have that through the {{tl|incomplete}} template) and letting the reader (and other editors) that a page will receive a large amount of work for some hours or even days, usually the use for {{tl|WIP}}.

In summary i miss templates giving a clear distinction between conditions akin to "Under construction" and "Caution - Wet floors", rather than "being worked on" and "could need more work".

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 10:11, 17 February 2016 (EST)

== [[Fr/Pilote automatique]] ==
Bonjour,

Je viens de créer la page de traduction en français de l'article original en anglais [[Autopilot]]. Vu mes faibles compétences en matière de pilotage, vu que je n'ai pas sur ma version téléchargée d'avion avec un pilote automatique, la traduction doit souffrir quelques approximations, si ce n'est des contresens plus ennuyeux. Si quelques bonnes âmes plus qualifiées pouvaient me faire la grâce d'une relecture... merci d'avance.

Cordialement, et Hop ! --[[User:F-WTSS|F-WTSS]] ([[User talk:F-WTSS|talk]]) 15:30, 18 February 2016 (EST)

== MediaWiki updated to 1.26.2 ==
I've updated MediaWiki to the latest stable release (1.26.2) today. I've still got to update some of the extensions, so there may be regressions for now. Please report bugs if you find any. For a list of changes, see https://www.mediawiki.org/wiki/Release_notes/1.26

[[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 10:47, 19 February 2016 (EST)

: Cheers! I was hoping that it would solve the uneditable Chinese, Russian, and other non-latin character-based pages (Polish strangely as well), but unfortunately [[FlightGear_wiki:Village_pump/Archive_2015#UTF-8_language_pages_cannot_be_edited|that issue remains]].

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 10:54, 19 February 2016 (EST)

:: Hm, looks that will require quite some attention indeed. I'm afraid that'll has to wait for now.
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

=== Nasal Syntaxhighlighting ===
: Thanks for your efforts, btw: Nasal syntax highlighting is gone again.
: {{unsigned|17:22, 19 February 2016‎|Hooray}}

:: Unfortunately this time it isn't me forgetting to copy a file. The SyntaxHighlight extension no longer uses GeSHi, but has switched to Pygments. This means our Nasal mapping no longer works and has to be re-written. If anyone is interested, be my guest. See http://pygments.org/docs/lexerdevelopment/
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

::: Hi Gijs,
::: I'm interested in making a Pygments Nasal lexer, but unfortunately I won't be able to work on it until the end of March at the earliest.
::: [[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:59, 23 February 2016 (EST)

:::: Unless Gijs is facing any problems, I don't think it's necessarily needed, see my comment/suggestion in this revision: [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=93166] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:20, 23 February 2016 (EST)

:::Hi Gijs,
:::Here's the code for a Nasal lexer. Be warned, it's thoroughly untested, but has the following features:
:::* Full support for all three string types (backtick, single quote, and double quote), including escapes and formatting strings (e.g., for {{func link|sprintf}}).
:::* All kinds of numbers, including numbers in scientific notation and octal and hex numbers.
:::* All global functions and variables as of FG v2016.1.1.
:::* Some of the commonly-used <code>props.Node</code> methods.
:::* All the other things that can be expected (keywords, punctuation, etc.).
:::I have also created a lexer based on the XML lexer for XML with embedded Nasal, which I thought would be useful.
:::Regards,
:::[[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:35, 2 April 2016 (EDT)

:::http://pygments.org/docs/lexerdevelopment/#adding-and-testing-a-new-lexer
:::<syntaxhighlight lang="python" enclose="div">
# -*- coding: utf-8 -*-
"""
Lexer for Nasal.
"""

from pygments.lexer import RegexLexer, words, include, inherit, bygroups, using
from pygments.token import Text, Keyword, Name, String, Number, Operator, Punctuation, Comment
from pygments.lexers.html import XmlLexer

__all__ = ['NasalLexer', 'XMLNasalLexer']

class NasalLexer(RegexLexer):

name = 'Nasal'
aliases = ['nasal']
filenames = ['*.nas']

tokens = {
'formatters': [
(r'%[-#0 +]*(?:[0-9]+)?(?:\.[0-9]+)?[dis%couxXeEfFgG]', String.Interpol),
],
'backtick': [
(r'`', String.Backtick, '#pop'),
(r'[^`\\]+', String.Backtick),
(r'\\n|\\r|\\t|\\`|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
],
'sqstring': [
(r"'", String.Single, '#pop'),
(r"[^'\\%]+", String.Single),
(r"\\'", String.Escape),
include('formatters'),
],
'dqstring': [
(r'"', String.Double, '#pop'),
(r'[^"\\%]+', String.Double),
(r'\\n|\\r|\\t|\\"|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
include('formatters'),
],
'root': [
(r'\s+', Text),
(r'#.*?$'m, Comment.Single),
(r':|\?|[!=<>+\-*\/~&|^]=?', Operator),
(words(('or', 'and'), suffix=r'\b'), Operator.Word),
(r'[{(\[})\]\.;,]', Punctuation),
(words(('for', 'foreach', 'forindex', 'while', 'break', 'return', 'continue', 'if', 'else', 'elsif'), suffix=r'\b'), Keyword),
(words(('var', 'func'), suffix=r'\b'), Keyword.Declaration),
(words(('nil'), suffix=r'\b'), Keyword.Constant),
(words(('me', 'arg'), suffix=r'\b'), Name.Builtin.Pseudo),
(words(('new', 'del', 'getNode', 'getParent', 'getChild', 'getChildren', 'removeChild', 'removeChildren', 'removeAllChildren', 'getName', 'getIndex', 'getType', 'getAttribute', 'setAttribute', 'getValue', 'setValue', 'setIntValue', 'setBoolValue', 'setDoubleValue', 'unalias', 'alias', 'getPath', 'getBoolValue', 'remove', 'setValues', 'getValues', 'initNode'), suffix=r'\b'), Keyword.Pseudo),
(r'0o[0-7]+', Number.Oct),
(r'0x[0-9a-fA-F]+', Number.Hex),
(r'\d*(?:\.\d*)?[eE][+-]?\d+', Number.Float),
(r'\d*\.\d*', Number.Float),
(r'\b[0-9]+\b', Number.Integer),
(words(('D2R', 'R2D', 'FT2M', 'M2FT', 'IN2M', 'M2IN', 'NM2M', 'M2NM', 'KT2MPS', 'MPS2KT', 'FPS2KT', 'KT2FPS', 'LB2KG', 'KG2LB', 'GAL2L', 'L2GAL'), suffix=r'\b'), Name.Variable.Global),
(words(('abort', 'abs', 'addcommand', 'airportinfo', 'airwaysRoute', 'assert', 'carttogeod', 'cmdarg', 'courseAndDistance', 'createViaTo', 'createDiscontinuity', 'createWP', 'createWPFrom', 'defined', 'directory', 'fgcommand', 'findAirportsByICAO', 'findAirportsWithinRange', 'findFixesByID', 'findNavaidByFrequency', 'findNavaidsByFrequency', 'findNavaidsByID', 'findNavaidsWithinRange', 'finddata', 'flightplan', 'geodinfo', 'geodtocart', 'getprop', 'greatCircleMove', 'interpolate', 'isa', 'logprint', 'magvar', 'maketimer', 'md5', 'navinfo', 'parse_markdown', 'parsexml', 'print', 'printf', 'printlog', 'rand', 'registerFlightPlanDelegate', 'removecommand', 'removelistener', 'resolvepath', 'setlistener', 'setprop', 'settimer', 'srand', 'systime', 'thisfunc', 'tileIndex', 'tilePath', 'values'), suffix=r'\b'), Name.Builtin),
(words(('append', 'bind', 'call', 'caller', 'chr', 'closure', 'cmp', 'compile', 'contains', 'delete', 'die', 'find', 'ghosttype', 'id', 'int', 'keys', 'left', 'num', 'pop', 'right', 'setsize', 'size', 'sort', 'split', 'sprintf', 'streq', 'substr', 'subvec', 'typeof'), suffix=r'\b'), Name.Builtin),
(words(('_createCondition', '_fgcommand', '_interpolate', '_setlistener'), suffix=r'\b'), Keyword.Reserved),
(r'`', String.Backtick, 'backtick'),
(r"'", String.Single, 'sqstring'),
(r'"', String.Double 'dqstring'),
(r'\b_\w*?\b', Keyword.Reserved),
#(r'\b\w*?\b', Name),
]
}

class XMLNasalLexer(XmlLexer):
"""
For Nasal code embedded in XML files.
"""

name = 'XML-Nasal'
aliases = ['xml-nasal', 'xml-ns']

tokens = {
'root': [
(r'(<(?:load|unload|script)>)(<!\[CDATA\[)?(.*?)(]]>)?(</(?:load|unload|script)>)', bygroups(Name.Tag, Comment.Preproc, using(NasalLexer), Comment.Preproc, Name.Tag),
inherit,
],
}
</syntaxhighlight>

:: We can use the ECMAScript/JavaScript lexer[http://pygments.org/docs/lexers/#lexers-for-javascript-and-related-languages] for now, my suggestion would be to copy that over to a file so that we can work on a custom Nasal lexer (Syntax is almost identical, with a few different keywords, and many others being irrelevant). What is missing/different can be obtained from other lexers that are similar, e.g. [http://pygments.org/docs/lexers/#lexers-for-other-c-like-languages] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:45, 19 February 2016 (EST)

:: Okay, here's the better/quick&easy way: We have Nasal support for some fairly popular editors, like [http://wiki.flightgear.org/Howto:Syntax_highlighting_for_Nasal#Vim|vim](originally created by Melchior<ref>https://sourceforge.net/p/flightgear/flightgear/ci/next/tree/scripts/syntax/nasal.vim</ref>), listed at [[Howto:Syntax_highlighting_for_Nasal]] - there are various free converters available that will read such a syntaxhighlighting file and convert it to a pygments class, e.g. see: https://github.com/honza/vim2pygments [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:00, 19 February 2016 (EST)

==== References ====
<references />

== The repository link templates ==
=== Complete overhaul of the repository link templates ===

I have now performed a complete overhaul of the repository link templates (see {{tl|repo link/doc related}}). This was motivated by the incomplete state of these templates, the lack of standardisation, the lack of SourceForge git repository support for {{tl|repo link}}, web-interface only support, etc. I have used a lot of recursive transclusion for standardisation, so that there is a single point for updating for any FlightGear infrastructure changes. This is the master {{tl|repo link}} template. All the other templates are subtemplates which recursively transclude from this master template. I have also created a number of documentation templates for simplifying template maintenance (see {{tl|repo link/doc related‎}}, {{tl|repo link/doc specific file git‎‎}}, {{tl|repo link/doc git clone‎‎}}, and {{tl|repo link/doc commit}}). The changes were constrained to maintain backwards compatibility as much as possible. However I would like to break this to allow the following templates to be updated to transclude from the master {{tl|repo link}} template:

* {{tl|flightgear file}},
* {{tl|simgear file}},
* {{tl|fgdata file}},
* {{tl|fgaddon file}}.

If no one objects, I would like to completely break these and expand and rename the parameter set to match the other <nowiki>{{* file}}</nowiki> repository templates (e.g. {{tl|terragear file}}). My overhaul currently does not include Hooray's ideas for non command line usages, i.e. different GUIs, but it enables it to be easily added via the master template and the addition of a single parameter to any subtemplates.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 15:05, 25 February 2016 (EST)

: I don't have any objections myself, I appreciate all the work you are putting into this, and would like to thank you for helping us clean up all that mess by doing such unglamorous work ;-) I also appreciate that your changes would facilitate adding a non-CLI mode to the corresponding templates. However, I would suggest to wait for Gijs' feedback, because he's ultimately the most likely person to veto something around here ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:31, 25 February 2016 (EST)

:: Johan seems to be the one who did a lot of the initial work on these <nowiki>{{* file}}</nowiki> templates, and Red Leader with the {{tl|repo link}} template. And they were involved in the general discussions ([[http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=87148#Repository_link_templates perm]). But I know Gijs was also involved in the design.

:: For the non-CLI mode, that will need -a lot- more planning. For example a definitive list of all these modes would be useful. Should this use an optional Mediawiki pop up extension showing a link to a general page that describes the action for all different GUIs, CLI, etc.? Should we have a switch box so that the reader can switch in-text between CLI, and the numerous GUIs? Are we going to have a large set of screenshots for each GUI? If so, I would strongly recommend the [https://www.mediawiki.org/wiki/Extension:Labeled_Section_Transclusion labelled section transclusion extension] for creating a single page for one GUI with everything for that GUI, as a tutorial. Here is [http://wiki.nmr-relax.com/Relax_4.0.1 an external example where I have used this], to fragment the base release page to create [http://wiki.nmr-relax.com/Relax_release_descriptions this meta page], as well as many other meta pages.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:14, 26 February 2016 (EST)

I am also thinking of changing the name of the <nowiki>{{* file}}</nowiki> templates, as I hope to make the scope of the templates far more general. The name <nowiki>{{* source}}</nowiki> or <nowiki>{{* repo}}</nowiki> might be better. For example these will allow the repository commit, tree view, log view (and maybe rss feed), with or without a file/directory path. And I would like to generalise this to handle both the SF web-interface and non-web net protocols (git://, ssh://, svn://, etc.). It will allow for CLI instructions to be built up and embedded in <nowiki>{{#tag:source|<content>|lang=sh}}</nowiki> tags. And I will defer all infrastructure decisions in the subtemplates to the single point of {{tl|project infrastructure}}, so that if there are changes in the future, then only this single template needs to be updated to update the entire wiki.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:22, 26 February 2016 (EST)

: The {{tl|project infrastructure}} template as a single point provider of various project infrastructure names and URL pairs seem like a great idea. If it work out well it will really lessen the maintenance by having less places needing updates, while allowing the various repository templates to be simple to use, in essence by having comprehensible names and no boiler plate parameters for their users.
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 15:15, 27 February 2016 (EST)

==== Repository link update ====
For those following, I have massively expanded the capabilities of the {{tl|repo link}} template:
* The SourceForge URLs are now comprehensive.
* Full support for the new query-based URLs for the Gitorious archives.
* Functional GitLab URLs.
* Generic repository support (used to create the {{tl|openscenegraph co}} template).
* Detailed documentation and extensive examples for checking the implementation (if you find any non-supported links, please add these as examples).
* Isolation of the '''cmd''' parameter from the CLI options — this is to enable future support for non-CLI instructions based on the value of '''cmd'''.

I have also completed a large set of subtemplates of {{tl|repo link}}, see the list at {{tl|repo link/doc related}}. This includes a full set of <nowiki>{{* source}}</nowiki> templates. I have left the original <nowiki>{{* file}}</nowiki> templates, rather than renaming and modifying them, so these are now redundant. All of the <nowiki>{{* source}}</nowiki>, <nowiki>{{* commit}}</nowiki>, <nowiki>{{* clone}}</nowiki>, and <nowiki>{{* co}}</nowiki> templates transclude from the master {{tl|repo link}} template to do all of the work.

One important template is {{tl|gitorious source}}. The support for the new query-based URLs for the Gitorious archives is now quite comprehensive in {{tl|repo link}}. Therefore I have converted almost every single FlightGear wiki link to https://gitorious.org to use {{tl|gitorious source}} instead. This fixes a lot of broken links and broken git instructions. I have reduced the number of hits for gitorious.org on the wiki (searching just for "gitorious") to 22 hits. This includes 2 very outdated articles ([[FlightGear Git: aircraft authors]], [[Fr/FlightGear et Git]]), 15 locked newsletters, 1 with no longer existent Gitorious merge request links, and 4 base URL links for Hangars. This way we can maintain the Gitorious web interface links and git command instructions in a functional state by simply updating the single source of {{tl|repo link}}.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 11:38, 29 February 2016 (EST)

: I just remembered [[Special:LinkSearch]], so make that 184 broken gitorious.org links remaining. Lots more work to do :)

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:46, 29 February 2016 (EST)

For some of these templates, e.g. {{tl|repo link/doc usage}}, I'm trying to implement some logic for automatic whitespace padding for documentation formatting, but the <code><nowiki>{{#len:string}}</nowiki></code> function is not enabled. According to {{mediawiki|Wikitext_parser/Core_parser_functions#.23len}} and {{mediawiki|Extension:StringFunctions}}, the option <code>$wgPFEnableStringFunctions = true;</code> should be set (in <code>LocalSettings.php</code>). Unless there is a reason for not using this, I was wondering if someone could enable this? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 09:53, 8 March 2016 (EST)

=== Archived newsletters and dead links? ===

Do we have a policy for the dead links in the FlightGear newsletters? It is obviously good to preserve the historic state. But there are many Gitorious links that could be made functional again using the {{tl|gitorious source}} template to point to the historic Gitorious archives (including the official FlightGear repositories, rather than using {{tl|fgdata source}}, for example). The https://gitorious.org links have been converted from URL/path based to query based, so absolutely all of the old links are broken. I am steadily converting all Gitorious links to use the [[Template:repo link/doc related|{{obr}}repo link{{cbr}} family of templates]], with the exception of the newsletters.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 04:52, 8 March 2016 (EST)

: I think it could be a good idea to try update old links in those newsletters. I sometimes look back at things and tend to think that I probably are not the only one doing that.
: I wonder if the rotten links should be replaced or stricken, but I think they could just as well be replaced. The key thing is that they go to the same resource or content, not weather they have been updated or not (also, the change will be visible in the revision history after all).
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 07:11, 8 March 2016 (EST)

:: I should add that I'm using [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=http%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] and [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>]. And I am also not touching the <code>User*</code> pages, <code>*talk*</code> pages, or pages tagged as out of date or up for deletion. For the newsletters I might look at these later when the broken Gitorious links are fixed in the rest of the wiki but, as these are locked, someone else might have make the switch to {{tl|gitorious source}}, {{tl|gitorious url}}, {{tl|gitorious clone}}, and {{tl|gitorious merge request}}.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 02:53, 9 March 2016 (EST)

::: I will temporarily add a table here for the templates in the newsletters and will slowly fix them one by one together with any other admin.
{{navbox
| title = Click "show" to show -->
| state = collapsed
| navbar = plain
| list1 =
http:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!}} No equivalent link for the Gitorious archive - project pages are dead. Maybe just use http://gitorious.org/?
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!}} Functional link, equivalent to {{gitorious url|fg|flightgear|commit=5c6fe952598053fa63631fc0161d666f22a50f51}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/headtrack

http://gitorious.org/arduinocockpit
{{!}} Project pages are dead, switched to {{gitorious url|headtrack|headtrack}}

{{gitorious url|arduinocockpit|arduinocockpit}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/arduinocockpi

http://gitorious.org/headtrack
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Missing project - i.e. {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra|text=migrated to GitLab}}. Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2011]]
{{!}} http://gitorious.org/flightgear-aircraft
{{!}} Switched to {{gitorious source}} and rephrased text slightly to help readers find the repositories.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} http://gitorious.org/anders-hangar/mtb_20m/trees/master
{{!}} Switch to {{gitorious url|proj=anders-hangar|repo=mtb_20m}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} http://gitorious.org/fg/flightgear/blobs/next/scripts/java/FGClient/src/FGFSDemo.java
{{!}} Switched to {{gitorious url|proj=fg|repo=flightgear|path=scripts/java/FGClient/src/FGFSDemo.java}}. This points to the old Gitorious repository to protect against path changes in the future.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2014]]
{{!}} http://gitorious.org/nasal-support/nasal-npp
{{!}} Switched to {{gitorious url|nasal-support|nasal-npp}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2015]]
{{!}} http://gitorious.org
{{!}} Switched to {{tl|gitorious source}} without parameters for the Gitorious base URL, to future-protect it.
{{!}}}

https:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/papillon81/flightgear-custom-scenery/

https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery

https://gitorious.org/papillon81/flightgear-custom-scenery/
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter December 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Fr/Nouvelles du projet FlightGear - décembre 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2012]]
{{!}} https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/README

https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/doc/doc-en.htm
{{!}} Switched to {{fgdata source|path=Aircraft/Instruments-3d/garmin196/README|full=1}} and {{fgdata source|path=Aircraft/Instruments-3d/garmin196/doc/doc-en.htm|full=1}} to point to the current FGData locations and removed the name "Gitorious" to make the text of the Garmin 196 GPS section still relevant
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter August 2012]]
{{!}} https://gitorious.org/mil-mi-6
{{!}} Switched to {{gitorious url|proj=mil-mi-6|repo=mi6dev}}, and changed from the non-existent project page to the main repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} https://gitorious.org/fgradar
{{!}} Switched from the project page to the direct repository {{gitorious url|fgradar|fgradar}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} https://gitorious.org/fg/flightgear/commit/913727239d6776c0508d206f395e16c265413ec3

https://gitorious.org/fg/flightgear/commit/eba03b5e469824ee8f1494723fcddbbc56155a08
{{!}} Switched to {{flightgear url|commit=913727239d6776c0508d206f395e16c265413ec3}} and {{flightgear url|commit=eba03b5e469824ee8f1494723fcddbbc56155a08}}. This deliberately points to the current repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2013]]
{{!}} https://gitorious.org/fg-radi/osm2city

https://gitorious.org/scenery-france-850
{{!}} Switched to the new GitLab repository {{gitlab source|proj=fg-radi|repo=osm2city|full=1}}

and removed the no longer existent scenery-france-850 repository, replacing it with "<s>Scenery repository (Gitorious)</s>".
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Switched to {{gitorious source|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console/repl.nas|line=708}}

{{gitorious url|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console|view=tree}}

{{fgdata-old url|commit=eaaf816b772649d5b0826a1d0bdd166dbc5b968f}}

{{flightgear commit|34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353}}

{{gitorious merge request|mr=54}}

{{gitorious merge request|mr=26}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Changes match the English article.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} https://gitorious.org/fg/fgdata/flightgear?p=fg/fgdata:flightgear.git;a=blob;f=keyboard.xml

https://gitorious.org/fg/fgdata?p=fg:fgdata.git;a=commit;h=f8c56dcc52ffd3d6dfca1d39dc4a72b6b3478368

https://gitorious.org/fg/hoorays-flightgear?p=fg:hoorays-flightgear.git;a=shortlog;h=refs/heads/topics/cppbind-fgprotocol
{{!}} This first link was the broken {{tl|git link}} template (see the table below). The other two links are not in the article?!
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter June 2014]]
{{!}} https://gitorious.org/eddp-custom-scenery/eddp-custom-scenery/
{{!}} Switched to {{tl|gitorious clone}} to provide functional '''git clone''' instructions.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2014]]
{{!}} https://gitorious.org/fg/hoorays-fgdata/source/2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876:Nasal/ai/aim9/aim9.fdm#L9
{{!}} Switch to {{gitorious url|proj=fg|repo=hoorays-fgdata|commit=2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876|path=Nasal/ai/aim9/aim9.fdm|line=9}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2015]]
{{!}} https://gitorious.org/fg/canvas-hackers-fgdata/source/f59c42134a5a77e343981dcff8278c3e2f094e87
{{!}} Switch to {{gitorious url|proj=fg|repo=canvas-hackers-fgdata|commit=f59c42134a5a77e343981dcff8278c3e2f094e87|view=summary}}
{{!}}}

Broken templates:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Template !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} {{tlx|Git link|gitorious|fg/fgdata|master|keyboard.xml|pre=$FG_ROOT/}}
{{!}} Switched to {{fgdata source|path=keyboard.xml|pre=$FG_ROOT}} to fix the Gitorious link created by the broken and depreciated {{tl|git link}} template.
{{!}}}

}}

::: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 12:06, 9 March 2016 (EST)

:::: I've added a '''notes''' column to help a little.

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:30, 9 March 2016 (EST)

=== Elimination of the dead Gitorious links ===
Thanks largely to the diversity and flexibility of the [[:Category:Repository link templates|{{obr}}repo link{{cbr}} family of templates]], I have now managed to eliminate almost every last dead Gitorious link in the FlightGear wiki! The locked Newsletter articles, user pages, and talk pages are the only exceptions. The page counts from the (Main) namespace are:
* [http://wiki.flightgear.org/index.php?target=http%3A%2F%2Fgitorious.org&namespace=0&title=Special%3ALinkSearch <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] — 37. Of these, 17 are for the front page with the news of the Gitorious to SourceForge migration, and the rest are Newsletters.
* [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org&namespace=0 <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>] — 166. Most of these links are valid and created by the {{obr}}gitorious *{{cbr}} subtemplates of {{tl|repo link}}. The remaining broken links are all in the locked Newsletters.
The Howto:* pages are not in the (Main) wiki namespace, but I've knocked those out too.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:54, 10 March 2016 (EST)

: thanks for doing all this unglamorous work - I am sorry that Gijs was apparently too busy to follow up on my suggestion to either provide you with admin access around here, or at least to help you run a Python script to do all this work in an automated, rather than manual, fashion. Hopefully, things will work out better next time. Again, thank you. Like I said, I think you should definitely be given admin access on the wiki, especially given your recent contributions - and I would gladly have my wiki status downgraded accordingly. In fact, if I was able to directly promote accounts accordingly, I would have done so months ago - however, it seems that Gijs is the only one to have those privileges, and he mentioned off-list that he's kinda busy with RL/exams etc, so it is to be expected that he's going to become a bottleneck more often - hopefully, this will be recongized as an actual issue, so that there will be more people able to promote new wiki admins. Sorry that things didn't work out better this time, and thanks so much for doing all this stuff manually. -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:49, 10 March 2016 (EST)

:: No problems! As for automating this, that would not have been possible. If you look at the changes, you'll see that each one is different <sup>[http://wiki.flightgear.org/index.php?title=Special:RecentChanges&to=20160310210655&limit=500]</sup>. I had to check each one, and update the link as required.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 16:08, 10 March 2016 (EST)

::: There's three of us actually (Curt, Simon and myself), no need to wait on me. See http://wiki.flightgear.org/index.php?title=Special%3AListUsers&username=&group=bureaucrat&limit=100 (Sek is inactive nowadays) ;-)
::: Please note that forum pms are really not the best way to contact me. I very much prefer email over forum pms as it's a lot easier to filter out the huge amounts of nonsense I'm receiving from stuff requiring actual attention.
::: Anyhow I've just promoted Bugman so he can edit locked articles.
::: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 05:06, 11 March 2016 (EST)

:::: Thank you. I'll try to preserve the original intent of the Newsletters while fixing the broken links (maybe even preserving any original URLs as Mediawiki link text, while pointing to the new URL). I will use the {{obr}}gitorious *{{cbr}} templates to point to the historical sources, and will probably use this for all of the Gitorious URLs so that we have full control over any future URL breakages via the single location of {{tl|repo link}}. For example, if they change the gitorious.org domain name to a https://archive.org subdomain (i.e. gitorious.archive.org).

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 06:40, 11 March 2016 (EST)

=== Regex parsing of template parameters? ===

For the {{tl|repo link}} template, I am currently trying to work out what to do for git branches and tags on the SourceForge infrastructure. The problem is that the presence of the character <code>/</code> within a branch or tag name requires the text <code>/~</code> to be appended to that name in the URL, for example:

* Tag <code>version/2016.1.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/version/2016.1.1/~/tree/simgear/ephemeris/ephemeris.cxx
* Branch <code>release/2016.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/release/2016.1/~/tree/simgear/ephemeris/ephemeris.cxx

I haven't found out a way to use regex to parse the <code>tag</code> or <code>branch</code> template parameters to automate this, hence I am thinking of just giving the instruction for the template user to append this text to the <code>tag</code> or <code>branch</code> parameter text themselves. However this is not ideal - a change of this behaviour on the SourceForge side requires end pages with SourceForge URLs to be updated, rather than just updating {{tl|repo link}}. I was wondering about possibility of installing the extension:

* [https://www.mediawiki.org/wiki/Extension:RegexParserFunctions Extension:RegexParserFunctions]

Though I'm not 100% sure if that will work. Or does someone else know an alternative? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:09, 22 April 2016 (EDT)

: not a solution, just a potential workaround would be checking for the most common prefix strings used in tags/branches (e.g. version, release, topic, topics) and explicitly rewrite the URL accordingly to append the /~ suffix -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 22 April 2016 (EDT)

:: That might be a solution. But I don't know how to do that without regex ;) We really only have #ifeq statements, but that has to match the whole string.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:44, 22 April 2016 (EDT)

As a temporary workaround, I'll update the SourceForge {{tl|repo link}} template instructions to tell the user to append <code>/~</code> to the branch or tag name, if the <code>/</code> character is present.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 10:31, 20 May 2016 (EDT)

== Discussion about quotes on the wiki ==
{{usr|Hooray}} have started a page now at [[FlightGear wiki:Quoting Guidelines]] ([http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Quoting_Guidelines&oldid=96104 perm]) for a discussion regarding guidelines for the use of quotes on the wiki. Join the discussion.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 18:17, 21 March 2016 (EDT)

In slight relation to this I have tried to make the wiki more consistently use the most common spelling and case, "Instant-Cquotes" and have changed the automatic categorization accordingly. All articles using the {{tl|FGCquote}} template can now be found in [[:Category:Articles containing Instant-Cquotes]] (currently some ~250 articles).

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 08:21, 23 March 2016 (EDT)

== Reorganizing the Git articles ==
I've noticed that the [[Category:Git|Git articles]] suffer from duplication and are in part obsolete (especially with regard to the instructions for running Git on Windows). Thus, I propose the following reorganization:
* [[Development workflow]]: reorganization to explain how the patch submission process is organized from a high-level point of view (forking the repository from SourceForge, developing, pushing the commits to the personal fork, submitting a merge request/sending a patch to the mailing list);
* [[FlightGear Git]]: leave as is;
* '''Installing and configuring Git''' - new article about installing Git and configuring it (setting the username/e-mail address); merge the contents of [[FlightGear Git on Windows]] and [[Resources WRT running git on Win32]] here;
* [[FlightGear Git for laymen]] - make it follow [[FGW:MOS]], merge the contents of [[Howto:Start using git]] here;
* [[FlightGear Git: core developers]] and [[FlightGear Git: data developers]] - I'm uncertain about what I should do with them: the only piece information that would not be written in other articles is the list of alternative methods for cloning FGData;
* [[FlightGear Git: gitiquette]] and [[FlightGear Git: tips]] - make them follow [[FGW:MOS]].
Any comments? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:11, 13 May 2016 (EDT)

: This is sorely needed! For [[FlightGear Git: core developers]] and [[FlightGear Git: data developers]], maybe these can be merged into something like [[FlightGear Git: working with the repositories]]? The only real difference is the URL, but that is a minor difference with the [[:Category:Repository link templates]]. This could be generalised into a set of instructions for working with all git repositories for the core infrastructure, including forking and merge requests, with a current focus on the SourceForge web and non-web interfaces.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 08:17, 13 May 2016 (EDT)

:: Yes, I was thinking about a similar solution as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:16, 13 May 2016 (EDT)

: For the reorganisation of the articles, it would be good to make a lot of use of the {{tl|Project infrastructure}} template. This will abstract away the SourceForge infrastructure (well some instructions will be 100% SourceForge specific, so it won't be perfect). I would like to however have [[Template talk:Project infrastructure#Slight variation of the current architecture|Johan's design]] implemented first, as it would be quite beneficial.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 18:43, 14 May 2016 (EDT)
:: Thanks, didn't know it existed. Right now I'm fixing some last-minute bugs before the release, but I'll have a look at this. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:05, 15 May 2016 (EDT)

::: And while we're at it, we also have a handful of git related templates to abstract away UI-specifics, which would allow us/me to upload screenshots for different interfaces (CLI, tortoisegit etc), so that we only need to update the templates, and not touch any of those articles. OTOH, I cannot seem to find a recent discussion of the idea, only http://wiki.flightgear.org/Talk:Development_workflow and that has not been updated in 3 years. Any opinions ? -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 20:52, 15 May 2016 (EDT)
:::: I'm not fully sold on this one. I see the point of creating templates (for example, the Git commands mentioned in [[Talk:Development workflow]] can be used in aircraft pages to explain how to checkout a development version from a private repository), but, in my opinion, screenshots are a bit "heavy" to be reused in other articles (beside the Git ones). Did you plan to use them in other pages and, if yes, how? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 14:11, 23 May 2016 (EDT)

== UTF-8 language pages cannot be edited ==

This is a continuation of [[FlightGear wiki:Village pump/Archive 2015#UTF-8 language pages cannot be edited]]. I can see that wiki editors are [[Zh/FlightGear Wiki|forced to create workarounds]], as the [[Main page]] in Chinese [http://wiki.flightgear.org/index.php?title=Zh/%E9%A6%96%E9%A1%B5&action=edit cannot be edited]. I think it is quite important to solve this ''"A database query error has occurred. This may indicate a bug in the software"'' issue. As the fix is quite dangerous (see {{mediawiki|Topic:S1q54kosfdkhz6w1}}), do we have a backup system? Do we have regular mysql and ftp dumps that can be backed up locally using rsync?

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 05:16, 15 May 2016 (EDT)

== Making wiki specific templates available via editor ? ==
We now have an increasing number of wiki specific templates that should be more widely used, so that it would make sense to integrate those with the default mediawiki editor - e.g. the URL encapsulating templates. -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:12, 16 May 2016 (EDT)

FlightGear wiki talk:Instant-Refs

2016-05-21T21:34:50Z

Elgaton: /* Code beautifier ? */ JSLint

== more sources ==

at some point, we may also want to add support for other sources, such as:
* old forum URLs, i.e. not yet using the subdomain format (should be easy, it's just a different/additional URL after all)
* thread.gmane.org/gmane.games.flightgear.devel/
* jsbsim devel list
* github tickets
* the new SF.net issue tracker
* SF.net commit logs http://gitorious.org/fg/
* http://www.mail-archive.com/flightgear-devel@flightgear.org/ (until 2005)
* http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/maillist.html (until 10/2013)

that should cover all important sources. And it would allow us to also use the same script to help populate [[FlightGear Newsletter]] & [[Changelog 3.2|changelogs]], but also [[Release plan/Lessons learned]]. So this could be a real time-saver. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:40, 1 June 2014 (UTC)

== Automatic update of script and old quotes ==
Thanks for the heads-up. Now, that makes me wonder if I can adapt the script to automatically parse existing wiki articles and update cquotes there automatically by re-opening the URL and re-running the extraction logic :) BTW: That reminds me: I was going to investigate adopting the '''downloadURL''' attribute[http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating] so that scripts can auto-update --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:51, 11 June 2014 (UTC)

:: if we should continue to see this widely used, having a good way to re-download and re-run the script on pages with existing cquotes would be a good way to automatically update quotes. For that, we would want to encode certain meta info in each template, e.g.:
* script version
* quoting date/time
* quote URL
* selection offsets
* quoting settings (format)

We can hook into form submission to update arbitrary quotes/contents using this: http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Developer_Tools#Intercept_and_Modify_Form_Submissions

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:19, 15 November 2015 (EST)

=== Hosting ===
The script seems to be about to become sufficiently complex to deserve actual hosting:
* http://wiki.greasespot.net/User_Script_Hosting
* https://openuserjs.org/

(that would allow updating the script automatically)

: Hi, is there any progress being made on this? I think the best way to host it would be to put in in a SourceForge repository under the FlightGear project (I don't know if it allows direct downloads, though, and we would need to relicense the script because [https://opensource.org/faq#public-domain public domain licenses are not OSI-approved]); otherwise, I can submit it to [https://greasyfork.org/ GreasyFork] (OpenUserJS is unsuitable as [https://openuserjs.org/about/Terms-of-Service public domain licenses are not allowed]). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 03:58, 1 May 2016 (EDT)

:: I don't think anybody has looked into this recently - however, relicensing should be a no-brainer, given that all the code is in the public domain anyway. I am not sure if it's worth the hassle to put up under sourceforge/FlightGear; we also need to keep in mind that this is not exactly the most popular "tool" around here. So, before this becomes even better accessible, it might be a good idea to comply with some of the requests made, e.g. by adding support for a different output mode (without using the FGCquote template, just the copied text, plus the ref part), so that quote-heavy pages don't look that obnoxious.
:: Regarding hosting in general, I still think it may be a good idea, but we would probably need to make sure that some requirements are met, e.g. having a revision history, and to provide other contributors with access-alternatively, we should maintain a copy of the script in the wiki, and add a note saying that changes to it will be reviewed/integrated with the hosted script by one of us (if you'd volunteer to help with that, I'd suggest to just go ahead and set up a public repository).
:: Admittedly, this is going to remain a fairly FG specific script, it would need quite a bit of work to become useful for other purposes (even though other OSS projects may be easy to support). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 06:33, 1 May 2016 (EDT)

::: OK, I think we can leave the script here and host it on GreasyFork (it allows public domain scripts) - I'll put the page on my watchlist to make sure I update the script there every time there's a version bump. Does that look good to you and the other contributors? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:26, 1 May 2016 (EDT)

:::: Sounds good to me, given how the script has evolved over time, we've probably hit a natural limit already, i.e. being able to use multiple files easily, and update scripts automatically sounds like a useful thing to me. I don't know if greasyfork supports "teams" of contributors for better collaboration ? It might also be a good idea to generalize the script so that it supports arbitrary phpBB installations and mailing list archives other than just sourceforge (think gmane) - and maybe output formats other than just wikimedia markup, that way, the script may become more useful over time.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:46, 1 May 2016 (EDT)

::::: It doesn't as it only offers a user script downloading facility (source code repositories like GitHub and SourceForge are better suited for the kind of work you mention). I'll wait a bit in case Red Leader, Philosopher or bigstones have any objections/remarks, then I'll upload the script there. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:14, 1 May 2016 (EDT)

:: do they support extensions spread across multiple files ? That is something that would help us quite a bit cleaning up the current code, which has become a bit convoluted over time. Apart from that, nothing wrong with github et al - I am just not sure if they're suitable for automatically propagating updated changes.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:12, 2 May 2016 (EDT)

::: No, not that I know of (generally speaking, all user scripts are made of a single .user.js file). We could "hack" it by splitting the current script in multiple files and requiring them from a main one as libraries via the <tt>@include</tt> directive, but that would rule out most hosting solutions (many providers only allow GreaseMonkey scripts which include additional files only from a handful of trusted domains/CDNs, for safety reasons).
::: As for propagating changes on GitHub and other code repository, the update URL must remain constant throughout the lifetime of the script. I'm sure this can be done on GitHub by publishing updates not as releases (where the addresses change), but on GitHub Pages (a user script I use does exactly this); on SourceForge, the usual download hosting could do the trick, but I'd need to perform a test first. (I'd prefer SF to keep the script "inside" the FG project hierarchy, if possible). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:50, 2 May 2016 (EDT)

: actually, user scripts can be compromised of multiple files, e.g. via the require directive [http://stackoverflow.com/questions/8695459/is-it-possible-to-split-greasemonkey-user-scripts-into-multiple-files]. Personally, I would like to make use of that - we are already using that to include jQuery stuff, and it would help us organize the script a little better. I am not oposed to seeing the script hosted as some part of FG/SF, but I just don't think it's going to be a very popular idea - so far, everything worked out without major hinderance, so I would rather use an independent hosting solution, or continue to use the wiki to ensure that the barrier to entry/contributing isn't raised, e.g. by going through merge requests etc. Major contributions to the script like those from bigstones or Red Leader were simply "dropped" here directly, so this seems to have worked out really well.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:26, 2 May 2016 (EDT)

:: I've checked the [https://greasyfork.org/it/help/external-scripts GreasyFork external script policy]: as long as all the files are hosted on/uploaded to GreasyFork, it's not a problem. (Also, sorry about the typo, I wrote <tt>@include</tt> instead of <tt>@require</tt> by mistake). I guess I can proceed with the upload now? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 12:22, 2 May 2016 (EDT)

: sure, why not - it's in the public domain after all - feel free to make any changes to the script to have it auto-update. We can review everything once we have gathered a little more experience with this kind of scheme. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:27, 2 May 2016 (EDT)

:: {{done}} - I'm updating the installation instructions in the main page. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:52, 2 May 2016 (EDT)

::: Script at: https://greasyfork.org/en/scripts/19331-instant-cquotes
--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:18, 2 May 2016 (EDT)

:::: Regarding updates, bumping the version number is fine - I'll take the script at the wiki revision where the version is bumped and upload it. (Note that I will not perform any prior testing, so be extra careful - maybe I should add this in the note above the script?). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:08, 2 May 2016 (EDT)

:: sounds good, I will be sure to stop updating the version number without prior testing, we could also add some tests to the code to spot the more obvious mistakes - in fact, there is already an OpenLink helper that could be used to download a few postings and try to extract the corresponding fields, so that we would only bump the version number if that succeeds. BTW: Thanks for handling the hosting part, much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:25, 2 May 2016 (EDT)

== Issues ==
=== too greedy non-greedy regexes ===
The problem described in the previous section regarding regexes that eat up half messages seems to be related to my [http://blog.liip.ch/archive/2009/07/24/the-greedyness-of-non-greedy-regular-expressions.html misunderstanding of the non-greediness]. So, I managed to fix it for this one case, but this means that using .*? to match everything until you meet the following character (as I currently do pretty much everywhere) is dangerous and prone to failure. Any occurrence of that should be changed as I did in [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Instant-Cquotes&oldid=72839 this edit] and that's clearly cumbersome, not to say that it can still be incorrect: say I have
<nowiki><a someprop="href" href="http://www.link.org" ... ></nowiki>
If I want to mach anything between a and href, I use <tt><nowiki>[^(?:href)]*</nowiki></tt>, but that would match only up to the text inside someprop, so I'd have to check that it's not inside doublequotes... Well, I guess this is getting too complicated for handling it [http://blog.codinghorror.com/parsing-html-the-cthulhu-way/ the Chtulu way].

So my approach would be: fix this whenever the problem comes up, but don't overdo because we're already moving in dangerous ground. Or, rewrite it all using ''only'' xpaths *sobs*.
--[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 16:49, 17 June 2014 (UTC)

=== regex vectors ===

When testing things I realized that you are right: there are some scenarios where the regex may fail depending on how "complete" the selection is, because we obviously have hard-coded assumptions here. I'll see if it's feasible to also support vectors for regexes to extract the corresponding fields and try each regex in order to get a certain field, or if that doesn't make any sense... But quoting with/without author (anonymous quote) would be a valid test case here.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

: Probably going to look into this sooner or later because this could be a simple solution to also support PM quoting - without having to parse the actual URL, we'd just try different regexes in order and use the one that succeeds. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

=== Syntaxhighlighting ===
Need to investigate what needs to be updated to support quoting code sections, as per [http://forum.flightgear.org/viewtopic.php?f=66&t=21855&p=212585#p212581] --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:33, 14 June 2014 (UTC)

=== Postings that break our script for some reason ===
* http://forum.flightgear.org/viewtopic.php?f=19&t=23365

== Misc notes ==

=== Detecting failed XPaths ===
you've got a point, we should probably check if xpath/regexes succeed or fail, and show a warning so that we know that the scripts needs to be updated because some xpath/regex may have changed.

=== Paragraphs / br (trailing slash) ===
There are some minor issues now, i.e. newline2br will no longer contain the trailing forward slash, so there's probably some JavaScript/regex oddity involved here, maybe slashes just need to be escaped. Will be testing the code with a few different forum postings and check the resulting cquote
: {{done}}. That's because newline2br wasn't used at all in html mode. I added addNewlines which puts newlines after br's and list related tags, if there are more newlines to be added that should be the place.
: --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 14:03, 17 June 2014 (UTC)

=== support/ignore highlighted keywords/smilies ===
see [[Understanding Forward Compatibility]] for examples
: {{done}} --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 15:13, 17 June 2014 (UTC)

== Beyond just cquotes (newsletter/changelog) ==

Gijs has recently revamped the newsletter template rather significantly, see: [[FlightGear_Newsletter_June_2014]], and [[User_talk:Gijs#06.2F2014_newsletter:_too_much_of_a_]] - basically, we could extend the script to support another output FORMAT to directly create markup for the newsletter/changelog. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 20:40, 30 June 2014 (UTC)

== more styles/output formats ==

looking at some of the cleanup done by Red Leader recently, we could also directly support other styles/output formats to directly provide a format that looks well enough without requiring tons of manual editing. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:11, 13 February 2015 (EST)

== token matching for keywords/variables ==

seems like it might make sense to match common keywords/acronyms and variables, such as e.g.:
* FG_ROOT => [[$FG_ROOT]]
* FG_HOME => [[$FG_HOME]]
* FG_SRC => [[$FG_SRC]]

file names with a known prefix like $FG_ROOT could even be pattern-matched using git link: $FG_ROOT/Nasal/canvas/MapStructure.nas would become [[$FG_ROOT]]{{Git link|gitorious|fg/fgdata|master|Nasal/canvas/MapStructure.nass|text=/Nasal/canvas/MapStructure.nas}}

Equally, we could match common property paths to use code tags, e.g.: /sim/rendering would become <code>/sim/rendering</code>
Ultimately, it might be a good idea to get in touch with Johan_G, Gijs and Red Leader to see what kind of format they'd prefer, especially because this could then be directly used for creating newsletter contents. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:19, 13 February 2015 (EST)

== matching repository references using git link template ==

Most of us commonly refer to repository files using either the $FG_* references, or relative paths in the form of <code>src/Main/fg_init.cxx:line number</code>, we could automatically convert such references using the git/repo link template, e.g.:

{{FGCquote
|Further investigation found that the launcher *is* trying to add this directory to fg-aircraft (src/GUI/QtLauncher.cxx:772), but that this doesn't work because this option is processed before the launcher is run (intentionally, to allow the launcher to find aircraft in fg-aircraft: '''src/Main/main.cxx:448''').
|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33686356/
|title=<nowiki>Re: [Flightgear-devel] Launcher issues on Linux</nowiki>
|author=<nowiki>Rebecca N. Palmer</nowiki>
|date=<nowiki>2015-04-01</nowiki>
}}
}}

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:48, 1 April 2015 (EDT)

== chrome specific port ==

Hi Red Leader, when/if you do come up with a chrome specific version of the script, I would suggest to refactor existing APIs accordingly, so that we can come up with a common library of general purpose/utility helpers, so that both scripts can co-exist and use a common/shared file (think all the extraction/transformation logic), by referencing an external .js/JavaScript file that will be maintained/updated and hosted separately. I think this could be accomplished easily using jsfiddle. So basically, I am suggesting to come up with a shared back-end for both versions of the script. Given the complexity we're reaching meanwhile, as well as the number of edits and contributors, it may also make sense to consider using github for this at some point. One of the main advantages being that we could easily distribute updates automatically to all people who've installed the script, without them having to do anything manually.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 08:38, 23 June 2015 (EDT)

== Development resources ==

* https://www.youtube.com/watch?v=xpXNDT0SxM0
* http://wiki.greasespot.net/GM_getResourceText
* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script

== Future focus/development and priorities (De-quoting) ==

Given that most people involved in maintaining the wiki don't seem to particularly appreciate the nature of articles consisting mainly of quotes, and that we don't seem to have any other good way to populate new articles quickly, I was thinking of changing the focus of the script to dynamically create articles using quotes (with proper refs), that would be merely copy-edited, i.e. using the process we are currently using to "de-quote" such articles by 1) categorizing related quotes, 2) coming up with headers/sub-headers, 3) re-writing/merging certain quotes, 4) attributing them - linking back to the quotes archives.
Should we decide to pursue this, the script would be turned into a "wizard" where we can topics and sub-topics (wiki headings) and then add arbitrary text using the existing approach, but without using cquotes - i.e. the focus would be on extracting relevant contents, distilling them down and adding plenty of refs, including a references section at the bottom. Some tokens/words could be changed dynamically, but some kind of proof-reading/copy-editing would still need to be done afterwards, because people tend to use first person speech in their announcements/postings, which we would need to convert to 3rd person semi-automagically. Thoughts/ideas ?--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:11, 15 November 2015 (EST)

== changing and automating regex/xpath handling ==
{{See also|#Genetic_Expression_solver}}

We have currently hard-coded handling of different websites, regexes and xpath expressions so that things are a bit fragile at the moment, and once a website changes its style/template, our script would break immediately. However, we could change the way the script works by using a very simple NN (neural network) to come up with matching regex/xpath expressions automatically. The way this could work would be "supervised" training, where we would replace/adapt our existing CONFIG hash with a vector of URLs and contents to be extracted (date, time, title, posting). This kind of data would suffice entirely for a neural network to self-train itself and "learn" how to come up with regex/xpath expressions to extract the relevant contents, including not only hard-coded websites like sourceforge, but even completely different websites (think gmane) - because the "learning" routine would self-adapt by looking at how to get its contents, and never contain any hard-coded regex/xpath expressions anymore. The CONFIG hash would end up being a vector with "training data" for different websites to be supported. And whenever an expression fails, it could re-train itself accordingly.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:33, 15 November 2015 (EST)

== nested quotes and AJAX for thread titles ==

{{FGCquote
|1= http://sourceforge.net/p/flightgear/mailman/message/33451055/
{{cquote|As we move forward with FlightGear development and future versions, we will be expanding the "in app" aircraft center. This dialog inside flightgear lets you select, download, and switch to any of the aircraft in the library.|Curt}}
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=259879#p259879
| title = <nowiki>Re: New Canvas GUI</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Oct 7th, 2015
}}
}}

== AJAX mode/testing ==

We should probably add a dialog to store credentials that we can use for accessing the wiki, which would need to be shown after installing the script, i.e. first-time use

* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script
* http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Getting_Started#During_Installation
* https://www.safaribooksonline.com/library/view/greasemonkey-hacks/0596101651/ch01s06.html

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 20 November 2015 (EST)

== libraries ==

Referring to the [[#Hosting]] section, and my comment on wanting to use additional libs (like jQuery), I am primarily thinking about using a wizard-framework (e.g. jQuery steps) and a framework for creating wikimedia editor plugins (actions):

* http://mstratman.github.io/jQuery-Smart-Wizard/
* http://www.jquery-steps.com/
* http://www.jqueryrain.com/demo/jquery-step-form-wizard/
* https://www.mediawiki.org/wiki/Extension:WikiEditor

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:07, 2 May 2016 (EDT)

== About dequoting the script's article ==

Thanks for doing this, but I am frankly not sure if it's worth the effort - there are much more popular/important articles using tons of quotes than this one, and given the reputation of the script, having quotes in this article may actually be a useful thing to make the case for having quotes in the first place - thus, I would frankly not spend much time going through this particular article - in fact, I'd be very surprised if the greasyfork download stats showed more than 3-5 people actually downloading, and using, the script - so this is really just a niche tool, and we probably better spend our time doing other things, and reviewing other wiki articles, than the script's article - at the very least, I would suggest to retain the references to the original discussions revolving these quotes (just my 2c). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 19:00, 2 May 2016 (EDT)

: {{done}} I've added back the quotes as references. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:53, 3 May 2016 (EDT)

== Script configuration (persistence) ==

* https://wiki.greasespot.net/GM_config
* https://github.com/sizzlemctwizzle/GM_config/wiki
* https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API

== Work in progress ==

We have now several more or less related development efforts going on, and the code is also growing because of that - so it seems to make sense to summarize what's been going on recently. In general, all changes were made in response to the collection of feature requests and ideas we have accumulated over time - specifically, that means that the following roadmap is in the process of being implemented:

* establish unit testing, and add a few self-tests, so that the script can be more easily tested, updated/reviewed in the future
* rework the script to more easily support other sources (think gmane)
* make it much easier to update modified xpath/regex expressions (i.e. provide a UI for that)
* support persistence for script-specific settings
* make it easier for people to port/maintain the script by encapsulating platform specifics
* support asynchronous fetching of postings (AJAX), e.g. to fetch posting titles, attachments etc
* prepare the groundwork for supporting template-based output formats (think newsletter, changelog, articles)
* review what's necessary to allow the script to update fgcquote-based quotes automagically

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:47, 4 May 2016 (EDT)

== External genetic/neural network libraries ==
While uploading the latest version of the script, I noticed that the Genetic and Synaptic libraries are hosted on sites not on [https://greasyfork.org/en/help/external-scripts the approved GreasyFork list]. Shall I ask them to host them? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:28, 11 May 2016 (EDT)

: Thanks for pointing that out, I missed that completely, because everything is working correctly here - but obviously, I rarely get to actually download/install the latest version via greasyfork. Those libs should be safe to be added to the list, i.e. they're fairly established/popular, lest I'd not be using them. For now, this is just an experiment anyway. The idea is to update the xpath/regex code to evolve if/when the underlying website (theme) changes. But if there is a problem, we could use other libs - the code is just used for testing ATM. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:41, 11 May 2016 (EDT)

* https://github.com/subprotocol/genetic-js
* https://github.com/cazala/synaptic

:: {{ongoing}} I have submitted the libraries to the JSDelivr CDN; once they are up, I'll change the source URLs in the script and update it on GreasyFork as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:32, 17 May 2016 (EDT)

::: Hi Elgaton, thank you for taking care of this, it's very much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:55, 17 May 2016 (EDT)

:::: You're welcome! My merge requests for the CDN were approved (this took a bit longer than expected because I had made a small mistake - I forgot to include a file required by the Genetic.js library). The libraries should be up in a day or two, at which point I'll update the URLs in the script and submit the new version to GreasyFork. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:59, 20 May 2016 (EDT)

::::: {{done}} Everything should be fine now. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:16, 20 May 2016 (EDT)

:: Thank you for all the help with this, and also for updating the greasyfork info/screenshots ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:16, 21 May 2016 (EDT)

== Genetic Expression solver ==
[[File:Instant-cquotes-genetic-regex-solving.png|thumb|Screenshot showing the instant cquotes script with integrated regex solving support using genetic algorithms.]]

The genetic-js framework has been integrated, it is intended to help solve xpath/regex expressions procedurally using genetic algorithms/programming.

The idea is to provide a set of desired outputs (needles), available input data (haystack), and use existing (possibly outdated) regex/xpath expressions to seed a pool with potential solutions for retrieving the desired output. For now, this is just proof-of-concept, i.e. just an experiment.

For example, let's consider the typical format of a from header for any sourceforge posting:
<syntaxhighlight lang="javascript">
var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];
</syntaxhighlight>

The basic idea is to run a fitness function and score regex expressions based on not throwing an exception (which makes them valid), and by checking if the desired tokens are part of the output string, and evolve (mutate/cross-over) the "fittest" expressions - i.e. those that satisfy at least /some/ of the heuristics.

Some of the metrics that can be used by the fitness function to determine if an expression is "fit", are:
* valid expression
* relative offset/excess bytes in matches string
* number of examples it can successfully extract
* length of the expression
* runtime of the expression

The search space, and runtime, can be significantly reduced by looking at similarities between all examples and coming up with a subset string that contains all identical components (e.g. the <code>From:</code> part in the author regex) and use that for seeding the initial generations.

Ultimately, this would allow the script to self-update its regex/xpath expressions if/when the underlying website (themes) change, but it would also allow to add support for new websites, without ever manually adding the required xpath/regex expressions, i.e. all that is needed is a sufficiently large number of example datasets to obtain the author, date and title information, and a URL for the script to download the HTML markup of the posting in question:

{{Note|The date field won't work as is, because it's actually post-processed using a transformation function, so we'd need to undo the transformation or use the actual date string instead}}
<syntaxhighlight lang="javascript"> // vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
</syntaxhighlight>

Note how this no longer contains any hard-coded xpath/regex expressions - instead, the script can refer to the website specific defaults, and try those first, and if they fail, use those to seed new generations and evolve them procedurally until all tests succeed.

For a regex to be valid, it must work for all tests/examples.

Once the regex solver is working correctly, the code can be further generalized to also evolve xpath expressions (NOTE: the DOMParser API is /not/ available to webworkers ...) and chain those two components together.

* http://regex.inginf.units.it/how.html
* http://www.i-programmer.info/programming/perl/9503-automatically-generating-regular-expressions-with-genetic-programming.html
* http://jkff.info/articles/ire/
* http://www.networkworld.com/article/2955126/software/genetic-programming-meets-regular-expressions.html
* https://handcraftsman.wordpress.com/2012/04/11/evolving-a-regular-expression-with-go/
* http://stackoverflow.com/questions/4880402/how-to-auto-generate-regex-from-given-list-of-strings
* http://regex.inginf.units.it/
* http://www.genetic-programming.org/hc2014/Bartoli-Paper.pdf

== Hierarchical Clustering ==

Been tinkering with a JavaScript module to automatically cluster postings based on certain keywords in the topic/title or posting (e.g. Nasal, Canvas, 2D API, rendering): https://harthur.github.io/clusterfck/

Note that in conjunction with processing article sections and/or whole articles, this could help automatically come up with matching postings for articles and vice versa.

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:11, 19 May 2016 (EDT)

== Upcoming dependencies ==

The script is now using [http://markitup.jaysalvat.com/home/ markitup] to create the template editor. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:18, 21 May 2016 (EDT)

: I've [https://github.com/jsdelivr/jsdelivr/pull/11757 submitted a pull request] for the library to be distributed by jsDelivr. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 16:08, 21 May 2016 (EDT)

== Code beautifier ? ==

I still had, and have, pending changes that would need to go through the same beautifier you're using, or they'd be lost - so for now, I have just overwritten your beautified code, hope that you didn't do this manually (there really are tons of automated and configurable beautifiers out there). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:59, 21 May 2016 (EDT)

: Of course not - let me know when you've incorporated all changes so that I can beautify the script again. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 16:31, 21 May 2016 (EDT)

:: I have been using some web-based JavaScript syntax checking tools, too (e.g. www.jshint.com), so if it's a website, too - let's just share/document these tools here.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:34, 21 May 2016 (EDT)

::: I use [http://www.jslint.com JSLint] plus a bit of manual editing (if needed). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:34, 21 May 2016 (EDT)

FlightGear wiki talk:Instant-Refs

2016-05-21T20:32:02Z

Elgaton: /* Code beautifier ? */ Reply

== more sources ==

at some point, we may also want to add support for other sources, such as:
* old forum URLs, i.e. not yet using the subdomain format (should be easy, it's just a different/additional URL after all)
* thread.gmane.org/gmane.games.flightgear.devel/
* jsbsim devel list
* github tickets
* the new SF.net issue tracker
* SF.net commit logs http://gitorious.org/fg/
* http://www.mail-archive.com/flightgear-devel@flightgear.org/ (until 2005)
* http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/maillist.html (until 10/2013)

that should cover all important sources. And it would allow us to also use the same script to help populate [[FlightGear Newsletter]] & [[Changelog 3.2|changelogs]], but also [[Release plan/Lessons learned]]. So this could be a real time-saver. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:40, 1 June 2014 (UTC)

== Automatic update of script and old quotes ==
Thanks for the heads-up. Now, that makes me wonder if I can adapt the script to automatically parse existing wiki articles and update cquotes there automatically by re-opening the URL and re-running the extraction logic :) BTW: That reminds me: I was going to investigate adopting the '''downloadURL''' attribute[http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating] so that scripts can auto-update --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:51, 11 June 2014 (UTC)

:: if we should continue to see this widely used, having a good way to re-download and re-run the script on pages with existing cquotes would be a good way to automatically update quotes. For that, we would want to encode certain meta info in each template, e.g.:
* script version
* quoting date/time
* quote URL
* selection offsets
* quoting settings (format)

We can hook into form submission to update arbitrary quotes/contents using this: http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Developer_Tools#Intercept_and_Modify_Form_Submissions

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:19, 15 November 2015 (EST)

=== Hosting ===
The script seems to be about to become sufficiently complex to deserve actual hosting:
* http://wiki.greasespot.net/User_Script_Hosting
* https://openuserjs.org/

(that would allow updating the script automatically)

: Hi, is there any progress being made on this? I think the best way to host it would be to put in in a SourceForge repository under the FlightGear project (I don't know if it allows direct downloads, though, and we would need to relicense the script because [https://opensource.org/faq#public-domain public domain licenses are not OSI-approved]); otherwise, I can submit it to [https://greasyfork.org/ GreasyFork] (OpenUserJS is unsuitable as [https://openuserjs.org/about/Terms-of-Service public domain licenses are not allowed]). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 03:58, 1 May 2016 (EDT)

:: I don't think anybody has looked into this recently - however, relicensing should be a no-brainer, given that all the code is in the public domain anyway. I am not sure if it's worth the hassle to put up under sourceforge/FlightGear; we also need to keep in mind that this is not exactly the most popular "tool" around here. So, before this becomes even better accessible, it might be a good idea to comply with some of the requests made, e.g. by adding support for a different output mode (without using the FGCquote template, just the copied text, plus the ref part), so that quote-heavy pages don't look that obnoxious.
:: Regarding hosting in general, I still think it may be a good idea, but we would probably need to make sure that some requirements are met, e.g. having a revision history, and to provide other contributors with access-alternatively, we should maintain a copy of the script in the wiki, and add a note saying that changes to it will be reviewed/integrated with the hosted script by one of us (if you'd volunteer to help with that, I'd suggest to just go ahead and set up a public repository).
:: Admittedly, this is going to remain a fairly FG specific script, it would need quite a bit of work to become useful for other purposes (even though other OSS projects may be easy to support). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 06:33, 1 May 2016 (EDT)

::: OK, I think we can leave the script here and host it on GreasyFork (it allows public domain scripts) - I'll put the page on my watchlist to make sure I update the script there every time there's a version bump. Does that look good to you and the other contributors? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:26, 1 May 2016 (EDT)

:::: Sounds good to me, given how the script has evolved over time, we've probably hit a natural limit already, i.e. being able to use multiple files easily, and update scripts automatically sounds like a useful thing to me. I don't know if greasyfork supports "teams" of contributors for better collaboration ? It might also be a good idea to generalize the script so that it supports arbitrary phpBB installations and mailing list archives other than just sourceforge (think gmane) - and maybe output formats other than just wikimedia markup, that way, the script may become more useful over time.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:46, 1 May 2016 (EDT)

::::: It doesn't as it only offers a user script downloading facility (source code repositories like GitHub and SourceForge are better suited for the kind of work you mention). I'll wait a bit in case Red Leader, Philosopher or bigstones have any objections/remarks, then I'll upload the script there. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:14, 1 May 2016 (EDT)

:: do they support extensions spread across multiple files ? That is something that would help us quite a bit cleaning up the current code, which has become a bit convoluted over time. Apart from that, nothing wrong with github et al - I am just not sure if they're suitable for automatically propagating updated changes.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:12, 2 May 2016 (EDT)

::: No, not that I know of (generally speaking, all user scripts are made of a single .user.js file). We could "hack" it by splitting the current script in multiple files and requiring them from a main one as libraries via the <tt>@include</tt> directive, but that would rule out most hosting solutions (many providers only allow GreaseMonkey scripts which include additional files only from a handful of trusted domains/CDNs, for safety reasons).
::: As for propagating changes on GitHub and other code repository, the update URL must remain constant throughout the lifetime of the script. I'm sure this can be done on GitHub by publishing updates not as releases (where the addresses change), but on GitHub Pages (a user script I use does exactly this); on SourceForge, the usual download hosting could do the trick, but I'd need to perform a test first. (I'd prefer SF to keep the script "inside" the FG project hierarchy, if possible). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:50, 2 May 2016 (EDT)

: actually, user scripts can be compromised of multiple files, e.g. via the require directive [http://stackoverflow.com/questions/8695459/is-it-possible-to-split-greasemonkey-user-scripts-into-multiple-files]. Personally, I would like to make use of that - we are already using that to include jQuery stuff, and it would help us organize the script a little better. I am not oposed to seeing the script hosted as some part of FG/SF, but I just don't think it's going to be a very popular idea - so far, everything worked out without major hinderance, so I would rather use an independent hosting solution, or continue to use the wiki to ensure that the barrier to entry/contributing isn't raised, e.g. by going through merge requests etc. Major contributions to the script like those from bigstones or Red Leader were simply "dropped" here directly, so this seems to have worked out really well.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:26, 2 May 2016 (EDT)

:: I've checked the [https://greasyfork.org/it/help/external-scripts GreasyFork external script policy]: as long as all the files are hosted on/uploaded to GreasyFork, it's not a problem. (Also, sorry about the typo, I wrote <tt>@include</tt> instead of <tt>@require</tt> by mistake). I guess I can proceed with the upload now? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 12:22, 2 May 2016 (EDT)

: sure, why not - it's in the public domain after all - feel free to make any changes to the script to have it auto-update. We can review everything once we have gathered a little more experience with this kind of scheme. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:27, 2 May 2016 (EDT)

:: {{done}} - I'm updating the installation instructions in the main page. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:52, 2 May 2016 (EDT)

::: Script at: https://greasyfork.org/en/scripts/19331-instant-cquotes
--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:18, 2 May 2016 (EDT)

:::: Regarding updates, bumping the version number is fine - I'll take the script at the wiki revision where the version is bumped and upload it. (Note that I will not perform any prior testing, so be extra careful - maybe I should add this in the note above the script?). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:08, 2 May 2016 (EDT)

:: sounds good, I will be sure to stop updating the version number without prior testing, we could also add some tests to the code to spot the more obvious mistakes - in fact, there is already an OpenLink helper that could be used to download a few postings and try to extract the corresponding fields, so that we would only bump the version number if that succeeds. BTW: Thanks for handling the hosting part, much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:25, 2 May 2016 (EDT)

== Issues ==
=== too greedy non-greedy regexes ===
The problem described in the previous section regarding regexes that eat up half messages seems to be related to my [http://blog.liip.ch/archive/2009/07/24/the-greedyness-of-non-greedy-regular-expressions.html misunderstanding of the non-greediness]. So, I managed to fix it for this one case, but this means that using .*? to match everything until you meet the following character (as I currently do pretty much everywhere) is dangerous and prone to failure. Any occurrence of that should be changed as I did in [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Instant-Cquotes&oldid=72839 this edit] and that's clearly cumbersome, not to say that it can still be incorrect: say I have
<nowiki><a someprop="href" href="http://www.link.org" ... ></nowiki>
If I want to mach anything between a and href, I use <tt><nowiki>[^(?:href)]*</nowiki></tt>, but that would match only up to the text inside someprop, so I'd have to check that it's not inside doublequotes... Well, I guess this is getting too complicated for handling it [http://blog.codinghorror.com/parsing-html-the-cthulhu-way/ the Chtulu way].

So my approach would be: fix this whenever the problem comes up, but don't overdo because we're already moving in dangerous ground. Or, rewrite it all using ''only'' xpaths *sobs*.
--[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 16:49, 17 June 2014 (UTC)

=== regex vectors ===

When testing things I realized that you are right: there are some scenarios where the regex may fail depending on how "complete" the selection is, because we obviously have hard-coded assumptions here. I'll see if it's feasible to also support vectors for regexes to extract the corresponding fields and try each regex in order to get a certain field, or if that doesn't make any sense... But quoting with/without author (anonymous quote) would be a valid test case here.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

: Probably going to look into this sooner or later because this could be a simple solution to also support PM quoting - without having to parse the actual URL, we'd just try different regexes in order and use the one that succeeds. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

=== Syntaxhighlighting ===
Need to investigate what needs to be updated to support quoting code sections, as per [http://forum.flightgear.org/viewtopic.php?f=66&t=21855&p=212585#p212581] --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:33, 14 June 2014 (UTC)

=== Postings that break our script for some reason ===
* http://forum.flightgear.org/viewtopic.php?f=19&t=23365

== Misc notes ==

=== Detecting failed XPaths ===
you've got a point, we should probably check if xpath/regexes succeed or fail, and show a warning so that we know that the scripts needs to be updated because some xpath/regex may have changed.

=== Paragraphs / br (trailing slash) ===
There are some minor issues now, i.e. newline2br will no longer contain the trailing forward slash, so there's probably some JavaScript/regex oddity involved here, maybe slashes just need to be escaped. Will be testing the code with a few different forum postings and check the resulting cquote
: {{done}}. That's because newline2br wasn't used at all in html mode. I added addNewlines which puts newlines after br's and list related tags, if there are more newlines to be added that should be the place.
: --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 14:03, 17 June 2014 (UTC)

=== support/ignore highlighted keywords/smilies ===
see [[Understanding Forward Compatibility]] for examples
: {{done}} --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 15:13, 17 June 2014 (UTC)

== Beyond just cquotes (newsletter/changelog) ==

Gijs has recently revamped the newsletter template rather significantly, see: [[FlightGear_Newsletter_June_2014]], and [[User_talk:Gijs#06.2F2014_newsletter:_too_much_of_a_]] - basically, we could extend the script to support another output FORMAT to directly create markup for the newsletter/changelog. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 20:40, 30 June 2014 (UTC)

== more styles/output formats ==

looking at some of the cleanup done by Red Leader recently, we could also directly support other styles/output formats to directly provide a format that looks well enough without requiring tons of manual editing. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:11, 13 February 2015 (EST)

== token matching for keywords/variables ==

seems like it might make sense to match common keywords/acronyms and variables, such as e.g.:
* FG_ROOT => [[$FG_ROOT]]
* FG_HOME => [[$FG_HOME]]
* FG_SRC => [[$FG_SRC]]

file names with a known prefix like $FG_ROOT could even be pattern-matched using git link: $FG_ROOT/Nasal/canvas/MapStructure.nas would become [[$FG_ROOT]]{{Git link|gitorious|fg/fgdata|master|Nasal/canvas/MapStructure.nass|text=/Nasal/canvas/MapStructure.nas}}

Equally, we could match common property paths to use code tags, e.g.: /sim/rendering would become <code>/sim/rendering</code>
Ultimately, it might be a good idea to get in touch with Johan_G, Gijs and Red Leader to see what kind of format they'd prefer, especially because this could then be directly used for creating newsletter contents. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:19, 13 February 2015 (EST)

== matching repository references using git link template ==

Most of us commonly refer to repository files using either the $FG_* references, or relative paths in the form of <code>src/Main/fg_init.cxx:line number</code>, we could automatically convert such references using the git/repo link template, e.g.:

{{FGCquote
|Further investigation found that the launcher *is* trying to add this directory to fg-aircraft (src/GUI/QtLauncher.cxx:772), but that this doesn't work because this option is processed before the launcher is run (intentionally, to allow the launcher to find aircraft in fg-aircraft: '''src/Main/main.cxx:448''').
|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33686356/
|title=<nowiki>Re: [Flightgear-devel] Launcher issues on Linux</nowiki>
|author=<nowiki>Rebecca N. Palmer</nowiki>
|date=<nowiki>2015-04-01</nowiki>
}}
}}

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:48, 1 April 2015 (EDT)

== chrome specific port ==

Hi Red Leader, when/if you do come up with a chrome specific version of the script, I would suggest to refactor existing APIs accordingly, so that we can come up with a common library of general purpose/utility helpers, so that both scripts can co-exist and use a common/shared file (think all the extraction/transformation logic), by referencing an external .js/JavaScript file that will be maintained/updated and hosted separately. I think this could be accomplished easily using jsfiddle. So basically, I am suggesting to come up with a shared back-end for both versions of the script. Given the complexity we're reaching meanwhile, as well as the number of edits and contributors, it may also make sense to consider using github for this at some point. One of the main advantages being that we could easily distribute updates automatically to all people who've installed the script, without them having to do anything manually.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 08:38, 23 June 2015 (EDT)

== Development resources ==

* https://www.youtube.com/watch?v=xpXNDT0SxM0
* http://wiki.greasespot.net/GM_getResourceText
* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script

== Future focus/development and priorities (De-quoting) ==

Given that most people involved in maintaining the wiki don't seem to particularly appreciate the nature of articles consisting mainly of quotes, and that we don't seem to have any other good way to populate new articles quickly, I was thinking of changing the focus of the script to dynamically create articles using quotes (with proper refs), that would be merely copy-edited, i.e. using the process we are currently using to "de-quote" such articles by 1) categorizing related quotes, 2) coming up with headers/sub-headers, 3) re-writing/merging certain quotes, 4) attributing them - linking back to the quotes archives.
Should we decide to pursue this, the script would be turned into a "wizard" where we can topics and sub-topics (wiki headings) and then add arbitrary text using the existing approach, but without using cquotes - i.e. the focus would be on extracting relevant contents, distilling them down and adding plenty of refs, including a references section at the bottom. Some tokens/words could be changed dynamically, but some kind of proof-reading/copy-editing would still need to be done afterwards, because people tend to use first person speech in their announcements/postings, which we would need to convert to 3rd person semi-automagically. Thoughts/ideas ?--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:11, 15 November 2015 (EST)

== changing and automating regex/xpath handling ==
{{See also|#Genetic_Expression_solver}}

We have currently hard-coded handling of different websites, regexes and xpath expressions so that things are a bit fragile at the moment, and once a website changes its style/template, our script would break immediately. However, we could change the way the script works by using a very simple NN (neural network) to come up with matching regex/xpath expressions automatically. The way this could work would be "supervised" training, where we would replace/adapt our existing CONFIG hash with a vector of URLs and contents to be extracted (date, time, title, posting). This kind of data would suffice entirely for a neural network to self-train itself and "learn" how to come up with regex/xpath expressions to extract the relevant contents, including not only hard-coded websites like sourceforge, but even completely different websites (think gmane) - because the "learning" routine would self-adapt by looking at how to get its contents, and never contain any hard-coded regex/xpath expressions anymore. The CONFIG hash would end up being a vector with "training data" for different websites to be supported. And whenever an expression fails, it could re-train itself accordingly.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:33, 15 November 2015 (EST)

== nested quotes and AJAX for thread titles ==

{{FGCquote
|1= http://sourceforge.net/p/flightgear/mailman/message/33451055/
{{cquote|As we move forward with FlightGear development and future versions, we will be expanding the "in app" aircraft center. This dialog inside flightgear lets you select, download, and switch to any of the aircraft in the library.|Curt}}
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=259879#p259879
| title = <nowiki>Re: New Canvas GUI</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Oct 7th, 2015
}}
}}

== AJAX mode/testing ==

We should probably add a dialog to store credentials that we can use for accessing the wiki, which would need to be shown after installing the script, i.e. first-time use

* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script
* http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Getting_Started#During_Installation
* https://www.safaribooksonline.com/library/view/greasemonkey-hacks/0596101651/ch01s06.html

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 20 November 2015 (EST)

== libraries ==

Referring to the [[#Hosting]] section, and my comment on wanting to use additional libs (like jQuery), I am primarily thinking about using a wizard-framework (e.g. jQuery steps) and a framework for creating wikimedia editor plugins (actions):

* http://mstratman.github.io/jQuery-Smart-Wizard/
* http://www.jquery-steps.com/
* http://www.jqueryrain.com/demo/jquery-step-form-wizard/
* https://www.mediawiki.org/wiki/Extension:WikiEditor

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:07, 2 May 2016 (EDT)

== About dequoting the script's article ==

Thanks for doing this, but I am frankly not sure if it's worth the effort - there are much more popular/important articles using tons of quotes than this one, and given the reputation of the script, having quotes in this article may actually be a useful thing to make the case for having quotes in the first place - thus, I would frankly not spend much time going through this particular article - in fact, I'd be very surprised if the greasyfork download stats showed more than 3-5 people actually downloading, and using, the script - so this is really just a niche tool, and we probably better spend our time doing other things, and reviewing other wiki articles, than the script's article - at the very least, I would suggest to retain the references to the original discussions revolving these quotes (just my 2c). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 19:00, 2 May 2016 (EDT)

: {{done}} I've added back the quotes as references. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:53, 3 May 2016 (EDT)

== Script configuration (persistence) ==

* https://wiki.greasespot.net/GM_config
* https://github.com/sizzlemctwizzle/GM_config/wiki
* https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API

== Work in progress ==

We have now several more or less related development efforts going on, and the code is also growing because of that - so it seems to make sense to summarize what's been going on recently. In general, all changes were made in response to the collection of feature requests and ideas we have accumulated over time - specifically, that means that the following roadmap is in the process of being implemented:

* establish unit testing, and add a few self-tests, so that the script can be more easily tested, updated/reviewed in the future
* rework the script to more easily support other sources (think gmane)
* make it much easier to update modified xpath/regex expressions (i.e. provide a UI for that)
* support persistence for script-specific settings
* make it easier for people to port/maintain the script by encapsulating platform specifics
* support asynchronous fetching of postings (AJAX), e.g. to fetch posting titles, attachments etc
* prepare the groundwork for supporting template-based output formats (think newsletter, changelog, articles)
* review what's necessary to allow the script to update fgcquote-based quotes automagically

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:47, 4 May 2016 (EDT)

== External genetic/neural network libraries ==
While uploading the latest version of the script, I noticed that the Genetic and Synaptic libraries are hosted on sites not on [https://greasyfork.org/en/help/external-scripts the approved GreasyFork list]. Shall I ask them to host them? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:28, 11 May 2016 (EDT)

: Thanks for pointing that out, I missed that completely, because everything is working correctly here - but obviously, I rarely get to actually download/install the latest version via greasyfork. Those libs should be safe to be added to the list, i.e. they're fairly established/popular, lest I'd not be using them. For now, this is just an experiment anyway. The idea is to update the xpath/regex code to evolve if/when the underlying website (theme) changes. But if there is a problem, we could use other libs - the code is just used for testing ATM. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:41, 11 May 2016 (EDT)

* https://github.com/subprotocol/genetic-js
* https://github.com/cazala/synaptic

:: {{ongoing}} I have submitted the libraries to the JSDelivr CDN; once they are up, I'll change the source URLs in the script and update it on GreasyFork as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:32, 17 May 2016 (EDT)

::: Hi Elgaton, thank you for taking care of this, it's very much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:55, 17 May 2016 (EDT)

:::: You're welcome! My merge requests for the CDN were approved (this took a bit longer than expected because I had made a small mistake - I forgot to include a file required by the Genetic.js library). The libraries should be up in a day or two, at which point I'll update the URLs in the script and submit the new version to GreasyFork. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:59, 20 May 2016 (EDT)

::::: {{done}} Everything should be fine now. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:16, 20 May 2016 (EDT)

:: Thank you for all the help with this, and also for updating the greasyfork info/screenshots ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:16, 21 May 2016 (EDT)

== Genetic Expression solver ==
[[File:Instant-cquotes-genetic-regex-solving.png|thumb|Screenshot showing the instant cquotes script with integrated regex solving support using genetic algorithms.]]

The genetic-js framework has been integrated, it is intended to help solve xpath/regex expressions procedurally using genetic algorithms/programming.

The idea is to provide a set of desired outputs (needles), available input data (haystack), and use existing (possibly outdated) regex/xpath expressions to seed a pool with potential solutions for retrieving the desired output. For now, this is just proof-of-concept, i.e. just an experiment.

For example, let's consider the typical format of a from header for any sourceforge posting:
<syntaxhighlight lang="javascript">
var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];
</syntaxhighlight>

The basic idea is to run a fitness function and score regex expressions based on not throwing an exception (which makes them valid), and by checking if the desired tokens are part of the output string, and evolve (mutate/cross-over) the "fittest" expressions - i.e. those that satisfy at least /some/ of the heuristics.

Some of the metrics that can be used by the fitness function to determine if an expression is "fit", are:
* valid expression
* relative offset/excess bytes in matches string
* number of examples it can successfully extract
* length of the expression
* runtime of the expression

The search space, and runtime, can be significantly reduced by looking at similarities between all examples and coming up with a subset string that contains all identical components (e.g. the <code>From:</code> part in the author regex) and use that for seeding the initial generations.

Ultimately, this would allow the script to self-update its regex/xpath expressions if/when the underlying website (themes) change, but it would also allow to add support for new websites, without ever manually adding the required xpath/regex expressions, i.e. all that is needed is a sufficiently large number of example datasets to obtain the author, date and title information, and a URL for the script to download the HTML markup of the posting in question:

{{Note|The date field won't work as is, because it's actually post-processed using a transformation function, so we'd need to undo the transformation or use the actual date string instead}}
<syntaxhighlight lang="javascript"> // vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
</syntaxhighlight>

Note how this no longer contains any hard-coded xpath/regex expressions - instead, the script can refer to the website specific defaults, and try those first, and if they fail, use those to seed new generations and evolve them procedurally until all tests succeed.

For a regex to be valid, it must work for all tests/examples.

Once the regex solver is working correctly, the code can be further generalized to also evolve xpath expressions (NOTE: the DOMParser API is /not/ available to webworkers ...) and chain those two components together.

* http://regex.inginf.units.it/how.html
* http://www.i-programmer.info/programming/perl/9503-automatically-generating-regular-expressions-with-genetic-programming.html
* http://jkff.info/articles/ire/
* http://www.networkworld.com/article/2955126/software/genetic-programming-meets-regular-expressions.html
* https://handcraftsman.wordpress.com/2012/04/11/evolving-a-regular-expression-with-go/
* http://stackoverflow.com/questions/4880402/how-to-auto-generate-regex-from-given-list-of-strings
* http://regex.inginf.units.it/
* http://www.genetic-programming.org/hc2014/Bartoli-Paper.pdf

== Hierarchical Clustering ==

Been tinkering with a JavaScript module to automatically cluster postings based on certain keywords in the topic/title or posting (e.g. Nasal, Canvas, 2D API, rendering): https://harthur.github.io/clusterfck/

Note that in conjunction with processing article sections and/or whole articles, this could help automatically come up with matching postings for articles and vice versa.

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:11, 19 May 2016 (EDT)

== Upcoming dependencies ==

The script is now using [http://markitup.jaysalvat.com/home/ markitup] to create the template editor. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:18, 21 May 2016 (EDT)

: I've [https://github.com/jsdelivr/jsdelivr/pull/11757 submitted a pull request] for the library to be distributed by jsDelivr. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 16:08, 21 May 2016 (EDT)

== Code beautifier ? ==

I still had, and have, pending changes that would need to go through the same beautifier you're using, or they'd be lost - so for now, I have just overwritten your beautified code, hope that you didn't do this manually (there really are tons of automated and configurable beautifiers out there). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:59, 21 May 2016 (EDT)

: Of course not - let me know when you've incorporated all changes so that I can beautify the script again. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 16:31, 21 May 2016 (EDT)

Talk:FlightGear Git: splitting fgdata

2016-05-21T20:13:40Z

Elgaton: Elgaton moved page Talk:FlightGear Git: splitting fgdata to Talk:FlightGear Git: splitting FGData: Capitalization fix

#REDIRECT [[Talk:FlightGear Git: splitting FGData]]

Talk:FlightGear Git: splitting FGData

2016-05-21T20:13:40Z

Elgaton: Elgaton moved page Talk:FlightGear Git: splitting fgdata to Talk:FlightGear Git: splitting FGData: Capitalization fix

Moved some text that was clearly part of a plan that is currently not very likely to be continued into the discussion page:

== Starting new aircraft ==
New aircraft should not be commited to fgdata. A separate repository should be created instead. Contact a FlightGear Aircraft admin to get your repository included in the FlightGear Aircraft project. You, as author, will get commit rights for that repository.

The current fgdata developers will have access to every single aircraft repository. In order to maintain aircraft that no longer have an active author, fix global bugs etc. Other users can create merge requests to get their fixes/improvements commited.

== Step 1: Split aircraft into separate repositories (DONE) ==
Aircraft are split into "private" repositories, under the [https://gitorious.org/flightgear-aircraft FlightGear Aircraft project]. Repositories for all aircraft in current fgdata have been created as of 17 October. Repository names equal directory-names (with the exceptions of dots (.) and capitals (ABC), as those are not supported by Gitorious.

There are two workflows that both do the trick:

=== Method 1 ===
'''Note:''' the split branch (<tt>737-300-split</tt> in this example) must NOT exist beforehand.

cd $FG_ROOT
git subtree split -P Aircraft/737-300 -b 737-300-split
mkdir -p ../split-aircraft/737-300
cd ../split-aircraft/737-300
git init
git fetch $FG_ROOT 737-300-split
git checkout -b master FETCH_HEAD
git push git@gitorious.org:flightgear-aircraft/737-300.git master

=== Method 2 ===
(need to check this one)
cd fgdata
git clone --no-hardlinks /fgdata /737-300
git filter-branch --subdirectory-filter Aircraft/737-300 HEAD -- --all
git reset --hard
rm -rf .git/refs/original/
git reflog expire --expire=now --all
git gc --aggressive --prune=now

Then all aircraft should be pushed to their new repositories. A script will take care of that.

== Step 2: Remove all aircraft from fgdata ==
A new fgdata repository without any aircraft is created, pushed to gitorious and tested.

== Step 3: Write/update manuals ==
Since the aircraft development flow will be different, we should teach our developers how to use the new system.

'''To be written:'''
* [[FlightGear Git: aircraft authors]]

'''To be updated:'''
* [[FlightGear and Git]]
* [[FlightGear Git on Mac OS X]]
* [[FlightGear Git on Windows]]

== Step 4: Switch fgdata ==
Once tests show that the new repository is working fine and no data has been lost, the repositories will be switched.
The exisiting repository is renamed, and the new repository takes its place and access to the new repository is setup.
The historic fgdata is kept but stays frozen, at least until we're sure everything is safe. It may also be a good idea to keep the existing repo, since it contains release branches - which are not part of the new repository and would be lost otherwise.

== Step 5: Inform the crowd ==
Post an announcement at the mailing list, forum, Facebook (?) and in the [[FlightGear Newsletter October 2011|upcoming newsletter edition]]. Link to the respective wiki articles (see [[#Step 3: Write/update manuals|Step 3]]) that contain details on how to work with the new system.

== Questions ==
* What to do with Aircraft/UIUC should it be placed like "one" aircraft in a aircraft-repository? Or each individual?
** An flightgear-aircraft/UIUC repo has been created, we can delete it if needed later on.
* Gitorious does not support dots in repository names.
** For now we just skipped dots, so Supermarine-S.6B has a repo called <tt>supermarine-s6b</tt> (note that Gitorious also does not distinct capitals. This does not seem to be a problem though, since git clone uses the original directory name).
* What rights should aircraft authors get?
** Commit/review might be best. If they are granted admin rights, they can delete the repo and remove the fgdata-developers as collaborators. When they do the later, there's no way we can regain control over the repo. We won't even be able to delete it from the FlightGear Aircraft project.
* Should we support multiple licenses under the FlightGear Aircraft project?
** Possible, but then the Aircraft Downloadpage would maybe need an update. Better create one Place for GNU-GPL and one for other licences.
*How long should we test? FGData is increasing again as new aircraft are continuously added again.

--[[User:Durk|Durk]] 17:48, 16 November 2011 (EST)

== Keeping the page though it is soon outdated ==

As the split has begun and the aircraft have copied the aircraft to SourceForge (see [[FlightGear Newsletter September 2014#Aircraft moved to SVN]]), this page could soon be considered obsolete.

As the split has been discussed for some time and is a bit of a watershed I feel that it could be a good idea to maybe add links to relevant developer mailing list treads and forum topics and keep this page for historical reference.

I have added a messagebox template, {{tl|historical}}, for this and similar purposes (here filled in for this page):
{{historical
| reason = This split had been discussed for years and finally begun in September 2014. See [[FlightGear Newsletter September 2014#Aircraft moved to SVN]].
| talk = Talk:FlightGear Git: splitting fgdata#Keeping the page though it is soon outdated
| date = 27 December 2014
| nocat = 1 
}}
—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 11:01, 27 December 2014 (UTC)

: I am putting this awesome messagebox at the top of the article to avoid confusion! [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 16:40, 22 September 2015 (EDT)

FlightGear Git: splitting fgdata

2016-05-21T20:13:40Z

Elgaton: Elgaton moved page FlightGear Git: splitting fgdata to FlightGear Git: splitting FGData: Capitalization fix

#REDIRECT [[FlightGear Git: splitting FGData]]

FlightGear Git: splitting FGData

2016-05-21T20:13:40Z

Elgaton: Elgaton moved page FlightGear Git: splitting fgdata to FlightGear Git: splitting FGData: Capitalization fix

{{historical
| reason = This split had been discussed for many years and finally begun in September 2014. See [[FlightGear Newsletter September 2014#Aircraft moved to SVN]]. The new repositories after the split are called [[FGData]] and [[FGAddon]].
| talk = Talk:FlightGear Git: splitting fgdata#Keeping the page though it is soon outdated
| date = 27 December 2014
| nocat = 1 
}}

{{Project Issues}}
After much discussion on the mailing list, it was decided to put the existing attempt to split FGdata on hold until further notice. The main reason for postponing the split was that, while it was considered a well intended initiative, the end result of the splitting process itself left the FlightGear fgdata project in a less than desirable state. For this reason, before another splitting attempt is to be undertaken, the pro's and con's of each step should be carefully evaluated. This article discusses some of our options and will formulate a plan of approach that can be presented to -and discussed in further depth- on the developers mailing list. Several reasons have been put forth to split fgdata:

== News / Status (03/2015) ==
{{FGCquote
|I am going to commence reducing FGDATA this weekend. The reasons for that<br/>
action have been discussed here and on the forum in epic detail, so I won't<br/>
repeat them.<br/>
<br/>
The result will be a new and much smaller git repository and it will only<br/>
have the c172p and the ufo remaining.<br/>
<br/>
To avoid any unnecessary extra work, I will temporarily remove all<br/>
contributors with write access except 2 or three admins on Friday afternoon<br/>
(Central European Time Zone).<br/>

|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33546900/
|title=<nowiki>[Flightgear-devel] FGData size reduction</nowiki>
|author=<nowiki>Torsten Dreyer</nowiki>
|date=<nowiki>2015-03-05</nowiki>
}}
}}

{{FGCquote
|Next, I'll do a initial commit of the base package aircraft to fgaddon/svn.<br/>
Following that, I create a new git repo for a smaller git fgdata and push<br/>
it to sourceforge.<br/>
Finally, we re-add contributors with push permission.<br/>
<br/>
If anything goes wrong, the original fgdata will remain intact and can<br/>
serve as a fallback.
|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33546900/
|title=<nowiki>[Flightgear-devel] FGData size reduction</nowiki>
|author=<nowiki>Torsten Dreyer</nowiki>
|date=<nowiki>2015-03-05</nowiki>
}}
}}

{{FGCquote
|Following a fairly lengthy discussion, here is what we now intending to do with FGData:
* create a new FGData Git repo, with aircraft stripped out, hosted by Gitorious
* Move the Models/ files in this repo under Scenery/ and make it as clear as possible that they should not be touched by anyone other than Martin
|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33548331/
|title=<nowiki>Re: [Flightgear-devel] FGData size reduction</nowiki>
|author=<nowiki>James Turner</nowiki>
|date=<nowiki>2015-03-05</nowiki>
}}
}}

== Reasons to split fgdata ==
=== Advantages ===
** Aircraft authors can get commit access to their own aircraft, without granting them global fgdata access.
** When pulling fgdata, one won't have to download several gigs of aircraft data. People will have to pull the base package, but any additional aircraft will be optional.
** It will be easier for aircraft authors to check the history of their aircraft.
** Commiting will go faster, because Git will no longer have to check those thousands of files to see whether they were edited. NOTE: Can't reproduce even on really old, slow (7.2k SATA) disks.
** fgdata size decreases from 5,6 GB to 1 GB (see statistics below).

=== Disadvantages ===
It should also be noted, however, that a split is not without potential problems:

** It will be harder to keep a local up to date copy of all aircraft. No more "git pull" to fetch all the latest updates.
*** Might be fixed by using Git submodules.<ref>[http://book.git-scm.com/5_submodules.html Git Community Book: Submoduldes]</ref>
** How to deal with licences? Until now there was a COPYING file in fgdata. When aircraft are split in separate repositories, they'll likely need to include a license reference themselves.
** Need a concept for release management, maintaining version numbers, release branches, release tags et. al.
** Quite a few unmaintained aircraft got adopted after one of the developers accidentially tripped over them. Need a plan how this would be supposed to work with split aircraft repositories, otherwise the project would axe one of the substantial principles which contributed to its success.
*** One of the main reasons for running a community owned (aircraft or source) repository, and the reason why people have "donated" (aircraft or sources) to the common repository, is to guarantee that any contributed work lives on - for as long as the (FG) project itself exists. Private repositories, even hangars run by a small number of people, are likely to become unmaintained and even lost eventually, since people's interests and hobbies change over time. Few (FG) contributors are active for more than 5-10 years. Hence, a common and well maintained community repository is essential to every open source project.
** Need an idea about how to subsitute the the previous "starter" package which was offered via HTTP for those who'd like to have the entire repository.

One of the most prominent reasons brought forth in favor of splitting fgdata is related to the relatively large size of the initial clone of the git repository, the relatively slow download size of gitorious, and the observation that interrupted downloads cannot be resumed. Before discussing possible alternatives to this problem, a few observations should be made with respect to the actual size of the downloaded git package:

=== Statistics ===
To obtain proper GIT repository size statistics, make sure to only check the size of the ".git" folder - which contains the history that belongs to the archive and needs to be downloaded. Once you check out a branch as a "working copy" locally, the total size of your actual file system folder increases (likely doubles), since the check-out creates a working ''copy'' of all files by ''extracting'' data from the ''compressed'' archive.
* Size of original fgdata GIT repository: 5.6GB
* Size of fgdata core GIT repository without aircraft: 1GB
* Total size of all aircraft repositories: 3.1GB
* Number of aircraft: 385

It should be noted that interrupted downloads are a potential problem; however there are a number of viable workarounds for these:
* Download an initial clone using a more robust download system, such as a bittorrent
* Download a snapshot without full project history.
* Clone the repository from a faster mirror, such as the mapserver.

It should further be noticed that git's merging and update algoritms are sufficiently efficient to deal with our ever increasing repository, so no immediate problems are to be expected in this area. Given these considerations, it appears that there are sufficient alternatives to circumvent the initial clone problem, and that the size of the git repository as such poses no immediate problem. That said, there are a number of additional reasons that make it desireable to split the fgdata repository in smaller, more manageable chunks.

== Options ==
Splitting off the aircraft directory from the rest is a logical first step, and the main question is how to proceed with this. There are a number of possible options:
* Split off all aircraft and keep them all in a single, but separate repository.
* Move each aircraft to its own repository
* Organize aircraft by logical units.
Here are the advantages and disadvantages of each option:

=== Single repository ===
* '''Advantages'''
** The current fgdata-developers team can access any single aircraft, for easy/quick fixes. For example when something is found to be wrong and copied among several aircraft (which happens due to copy&paste). Or when something about the sim itself changes and aircraft msut be adapted to run on an upcoming release.
** When an aircraft developers decides to leave, the aircraft can easily be taken over by other developers.
** It allows us to use [http://flightgear-bugs.googlecode.com the bug tracker] for aircraft. Most developers won't clone aircraft repos from all kind of places, just to help fixing bugs.
* '''Disadvantages'''
** Authors won't be able to choose their own license.
** The aircraft/ directory makes up the largest part of the current repository. A single aircraft repository would make contributing to the base package easier, but it won't have much effect on aircraft developers.

=== Per-aircraft repository, single project ===
Each aircraft would get a repository under a "FGAircraft" project at Gitorious.
* '''Advantages'''
** The current fgdata-developers team can access any single aircraft, for easy/quick fixes. For example when something is found to be wrong and copied among several aircraft (which happens due to copy&paste). Or when something about the sim itself changes and aircraft msut be adapted to run on an upcoming release.
** When an aircraft developers decides to leave, the repo can easily be taken over by other developers. If the author set up his own repository, we'd have to create a new repository (and thus change all references/links).
** It allows us to use [http://flightgear-bugs.googlecode.com the bug tracker] for aircraft. Most developers won't clone aircraft repos from all kind of places, just to help fixing bugs.
** Authors can choose their own license.
*** The FlightGear Aircraft project can be set to "License: Other/Multiple". This allows (in theory, we first need to agree on this) any aircraft author to add whatever license file to his/her aircraft and still put it under the project.
*** However, the use of a ''common'' license for all ''community aircraft'' has many advantages and has also contributed to the success of the FG project (new aircraft can be easily based on existing aircraft, can copy elements from other aircraft without triggering a complicated mixed license situation), and specifically the GPL has many advantages for the FG project (see [[Changing the FlightGear License]] for details why FG wants to stick to the GPL). Authors preferring an other license can of course already (and continue to) do so - except that their aircraft is not in the community repository.

=== Per-aircraft project ===
* '''Advantages'''
** Each aircraft developer can get admin rights to his or her own project.
* '''Disadvantages'''
** It will become increasingly difficult to maintain abandoned aircraft, or conduct maintanance
** With over 500 individual repositories it will become increasingly difficult to keep track of new developments.

=== Organizing aircraft by logical units ===
* '''Advantages'''
** Logical ordering units remain manageble both in terms of the number of them as well as their size
* '''Disadvantages'''
** It is difficult to come up with a good set of criteria to define the aircraft categories.

== Considerations ==
Given these considerations, it can be concluded that it is desirable to separate the aircraft from the main repository. It should also be pointed out that seperating out the aircraft, and moving them all into a single repository is the sole action addressing the most urgent reason for the split, namely giving the opportunity to be more liberal in granting aircraft developers commit rights, without having to consider the integrity of the base package as such. It should furthermore be noticed that while it is technically possible to remove an entire subdirectory from a project without losing its history, it is undesirable to do so. Every split done in this manner would force every user to reclone the entire repository in question. Additionally, it is considerably more difficult to combine repositories again once they have been split. Therefore, we should be cautious in performing split operations. For this reason, the most feasible action appears to be to just separate the aircraft directory from fgdata and move this in it's entirety to a new subproject. There it can live until a new and agreed upon classification scheme for separate repositories has been developed.

Finally, the following considerations should be taken into account.
* FlightGear's release distributions are steadily increasing in size. With the proposed fgdata split, we should consider removing all aircraft, except the default cessna 172p from the base package. All others can simply be downloaded from the website. Considering that the c172p is and integral part of FlightGear, it should remain the ONLY aircraft that remains in the base package, and wich is is not moved to the new fgaircraft repository.
* It should be emphasized that GIT is a distributed revision control system, and that our current use of git is insufficient.Aircraft developers should be encouraged to set up their own personal clone on gitorious, and we should encourage aircraft developers to post more merge requests.
* As more and more people gain commit rights, some rules and guidelines are in order. We currently have a largely unwritten code of conduct that has proven to work well. With new people entering the scene, it will become necessary to put them in writing however.

== A new plan for splitting fgdata ==

# Create a new git repository: fgaircraft. This repository will -for the time being- contain all current and new FlightGear aircraft except the default c172p.
# Provide images of the git repository, to alleviate the initial clone problem. Preferably, this should be done using bittorrent, or another interruptable download source, so that people with limited bandwidth, can monitor their data consumption more flexibly.
# After a few days of testing, remove all aircraft from the main fgdata repository.
# Formalize the status of the new aircraft repositories by formalizing our existing, but unwritten, code of conduct and granting new aircraft authors who agree to this code of conduct commit rights.
# Because the new system can allow us to grant a potentially large number of aircraft developers commit access, we deem it desireabe to formulate an explicit set of rules with regard to the contributor's rights and obligations. It should be noted that the following rules are not really new, but merely formalizations of our existing code of conduct. By explicitly formulating them, our main goal is to avoid misunderstanding, and to provide clear guidelines in the unlikely event of misuse of commit rights.
# Post these rule on a relatively prominent location on the main FlightGear.org website.
# Formulate and discuss plans for further separation into logical categories.
# Once a consensus has been reached further split operations can be conducted.

The rules describing the rights and obligations of committers are as follows:
# Authors who obtain commit rights to fgaircraft retain the rights to handle their own work.
# The FlightGear fgaircraft administrators are allowed to update aircraft files, but only
## to enable the use of new FlightGear features (such as adding a necessary include file or set a few property switches),
## to fix small and obvious bugs (such as fixing a misspelled property or file name), or
## to apply changes necessary to keep aircraft compatible with an upcoming FlightGear release.
# The FlightGear fgaircraft repository maintainers reserve the right to revoke commit access of an individual committer. They can only exercise their right after consensus has been reached among the maintainers, and only in cases of
## misuse of commit rights by the offending developer, or
## prolonged inactivity of the committer (more than a year of inactivity)
# Aircraft that have not been maintained by the prime committer for a prolonged period of time are considered to have been abandoned and may be assigned to a different committer. The obvious exception to this rule is formed by aircraft that have a high level of completeness that are maintained by committers who are still very active in other areas of FlightGear's development.
# Commit rights will be given after the authors have shown a reasonable level of competence in both aircraft development and GIT usage. While the aircraft developer is still in the process of obtaining the required skills, he or she can seek a mentor who will handle any merge requests.
# If the aircraft developer is uncomfortable in working with GIT he or she can also opt to choose a "mentor" who will handle the merge requests for them.
# In addition to these rules, anybody contributing to the FlightGear project is encouraged to work with personal clones and submit merge requests.

=== Comments on the new plan ===

(HHS comments)
That sounds like the situation we already have - the only difference: the aircraft are just splitted from FGData, and the maintainer of an Aircraft-project can get the rights to commit without any magic.
But with that there are lot of rules with exceptions. From my daily real life job I do know, that many rules with exceptions may make things more complicated and provoke discussions and conflicts.
So my question is: How can we see that "a reasonable level of competence in both aircraft development and GIT usage" is there? Does he has to be checked? Which level of competence is needed for making an aircraft?

(some answers from TorstenD)
I'd define "reasonable level of competence" for GIT as "be able be familiar with the basic everyday GIT workflow". If [https://www.kernel.org/pub/software/scm/git/docs/everyday.html everyday git] is understandable, I'd say OK.
And for aircraft development: Be able to stay in your sandbox, don't mess with other's files, be able to reuse existing (common) files, create reasonable file sizes, accept naming conventions etc. Most important: nobody is perfect, but be able to fix what you broke ;-)

--[[User:ThorstenB|ThorstenB]] 17:57, 11 December 2011 (EST): It's a huge improvement to split aircraft from the main fgdata repo. Any change to an aircraft will only affect a single aircraft. But changes to the rest of fgdata (the central Nasal, Shader, GUI directories etc) can have a massive impact: on all other aircraft, on the simulator core, or on the design/direction/structure of core parts. So, it's good to have these things separated. And I think we can allow a lot more people direct commit access once aircraft are separated - even if they all share a repo. I don't think we would see many (or any) cases of authors messing with other people's work.
And I think the rules are fine and simple enough - actually almost "common sense" when working in a collaborative environment.

--[[User:Durk|Durk]] 05:02, 12 December 2011 (EST) I would also like to mention that we don't consider the initial split to be the final stage. Additional splits are possible, but we need to carefully evaluate how we should do that. Once we do have a decent plan we can continue with phase b) of the operation. I will add that to the plan later.

--[[User:Durk|Durk]] 05:22, 12 December 2011 (EST) Oh, and before I forget: James Turner is working on providing the infrastructure for aircraft meta-data. Once this in place, we would be much more flexible in splitting, but I would be cautious to not step beyond the initial stage before James is finished with that.

(hvengel comments)
Having well defined rules it a good thing. Some (perhaps many) of the aircraft devs have little or no experience with normal software development work flows and they will need well defined rules to help them do the right thing. Reading through the proposed rules I don't see too much room for things to be incorrectly used. However because the level of experience with software work flows will be all over the place (IE. some aircraft devs are also experienced software developers/engineers and some have absolutely no experience with this type of thing) the rules should be a simple and as clear and complete as possible. Nothing should be open to interpretation.

I don't see the concern over determining GIT and/or aircraft development competence to be a significant issue. I am sure that there are a significant number of aircraft devs who are currently using merge requests who would be given commit rights right from the get go. Newer aircraft devs can work with a mentor with commit rights while they are learning GIT and aircraft development and the mentor can determine when they are ready for commit rights. However I think having a documented process for this might be a good idea.

(HHS comments)
It is good to see that the existing rules are finally formalized, so we get a clear guideline.
It is also good to see that people should be more encouraged to submit merge requests. But this also means that those with commit rights should be more encouraged to review those merge requests and commit them!

--[[User:T3r|T3r]] 15:06, 11 December 2011 (EST): Absolutely - however: as most commiters are as lazy as I am, they do not regularly check for merge requests. Picking your most trustworthy commiter from the list and asking him to handle the requests for you is probably a good idea. Reminders by PM are always welcome.

--[[User:Durk|Durk]] 05:02, 12 December 2011 (EST) Which is actually why we introduced the notion of a mentor. The primary purpose is that more one-to-one work relations between committers and contributers will be established. This will certainly benefit the overall workflow.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 17:32, 24 September 2012 (EDT) The UFO should probably have the same status as proposed for the C172, but I do not know weather it resides with the aircraft or already with the rest of FlightGear.

== New Splitting Concept ==
see [[FGAddon]] for new concept

{{Appendix}}

[[Category:Developer Plans]]

FlightGear wiki talk:Instant-Refs

2016-05-21T20:09:17Z

Elgaton: /* Upcoming dependencies */ Merge request submitted to jsDelivr

== more sources ==

at some point, we may also want to add support for other sources, such as:
* old forum URLs, i.e. not yet using the subdomain format (should be easy, it's just a different/additional URL after all)
* thread.gmane.org/gmane.games.flightgear.devel/
* jsbsim devel list
* github tickets
* the new SF.net issue tracker
* SF.net commit logs http://gitorious.org/fg/
* http://www.mail-archive.com/flightgear-devel@flightgear.org/ (until 2005)
* http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/maillist.html (until 10/2013)

that should cover all important sources. And it would allow us to also use the same script to help populate [[FlightGear Newsletter]] & [[Changelog 3.2|changelogs]], but also [[Release plan/Lessons learned]]. So this could be a real time-saver. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:40, 1 June 2014 (UTC)

== Automatic update of script and old quotes ==
Thanks for the heads-up. Now, that makes me wonder if I can adapt the script to automatically parse existing wiki articles and update cquotes there automatically by re-opening the URL and re-running the extraction logic :) BTW: That reminds me: I was going to investigate adopting the '''downloadURL''' attribute[http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating] so that scripts can auto-update --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:51, 11 June 2014 (UTC)

:: if we should continue to see this widely used, having a good way to re-download and re-run the script on pages with existing cquotes would be a good way to automatically update quotes. For that, we would want to encode certain meta info in each template, e.g.:
* script version
* quoting date/time
* quote URL
* selection offsets
* quoting settings (format)

We can hook into form submission to update arbitrary quotes/contents using this: http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Developer_Tools#Intercept_and_Modify_Form_Submissions

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:19, 15 November 2015 (EST)

=== Hosting ===
The script seems to be about to become sufficiently complex to deserve actual hosting:
* http://wiki.greasespot.net/User_Script_Hosting
* https://openuserjs.org/

(that would allow updating the script automatically)

: Hi, is there any progress being made on this? I think the best way to host it would be to put in in a SourceForge repository under the FlightGear project (I don't know if it allows direct downloads, though, and we would need to relicense the script because [https://opensource.org/faq#public-domain public domain licenses are not OSI-approved]); otherwise, I can submit it to [https://greasyfork.org/ GreasyFork] (OpenUserJS is unsuitable as [https://openuserjs.org/about/Terms-of-Service public domain licenses are not allowed]). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 03:58, 1 May 2016 (EDT)

:: I don't think anybody has looked into this recently - however, relicensing should be a no-brainer, given that all the code is in the public domain anyway. I am not sure if it's worth the hassle to put up under sourceforge/FlightGear; we also need to keep in mind that this is not exactly the most popular "tool" around here. So, before this becomes even better accessible, it might be a good idea to comply with some of the requests made, e.g. by adding support for a different output mode (without using the FGCquote template, just the copied text, plus the ref part), so that quote-heavy pages don't look that obnoxious.
:: Regarding hosting in general, I still think it may be a good idea, but we would probably need to make sure that some requirements are met, e.g. having a revision history, and to provide other contributors with access-alternatively, we should maintain a copy of the script in the wiki, and add a note saying that changes to it will be reviewed/integrated with the hosted script by one of us (if you'd volunteer to help with that, I'd suggest to just go ahead and set up a public repository).
:: Admittedly, this is going to remain a fairly FG specific script, it would need quite a bit of work to become useful for other purposes (even though other OSS projects may be easy to support). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 06:33, 1 May 2016 (EDT)

::: OK, I think we can leave the script here and host it on GreasyFork (it allows public domain scripts) - I'll put the page on my watchlist to make sure I update the script there every time there's a version bump. Does that look good to you and the other contributors? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:26, 1 May 2016 (EDT)

:::: Sounds good to me, given how the script has evolved over time, we've probably hit a natural limit already, i.e. being able to use multiple files easily, and update scripts automatically sounds like a useful thing to me. I don't know if greasyfork supports "teams" of contributors for better collaboration ? It might also be a good idea to generalize the script so that it supports arbitrary phpBB installations and mailing list archives other than just sourceforge (think gmane) - and maybe output formats other than just wikimedia markup, that way, the script may become more useful over time.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:46, 1 May 2016 (EDT)

::::: It doesn't as it only offers a user script downloading facility (source code repositories like GitHub and SourceForge are better suited for the kind of work you mention). I'll wait a bit in case Red Leader, Philosopher or bigstones have any objections/remarks, then I'll upload the script there. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:14, 1 May 2016 (EDT)

:: do they support extensions spread across multiple files ? That is something that would help us quite a bit cleaning up the current code, which has become a bit convoluted over time. Apart from that, nothing wrong with github et al - I am just not sure if they're suitable for automatically propagating updated changes.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:12, 2 May 2016 (EDT)

::: No, not that I know of (generally speaking, all user scripts are made of a single .user.js file). We could "hack" it by splitting the current script in multiple files and requiring them from a main one as libraries via the <tt>@include</tt> directive, but that would rule out most hosting solutions (many providers only allow GreaseMonkey scripts which include additional files only from a handful of trusted domains/CDNs, for safety reasons).
::: As for propagating changes on GitHub and other code repository, the update URL must remain constant throughout the lifetime of the script. I'm sure this can be done on GitHub by publishing updates not as releases (where the addresses change), but on GitHub Pages (a user script I use does exactly this); on SourceForge, the usual download hosting could do the trick, but I'd need to perform a test first. (I'd prefer SF to keep the script "inside" the FG project hierarchy, if possible). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:50, 2 May 2016 (EDT)

: actually, user scripts can be compromised of multiple files, e.g. via the require directive [http://stackoverflow.com/questions/8695459/is-it-possible-to-split-greasemonkey-user-scripts-into-multiple-files]. Personally, I would like to make use of that - we are already using that to include jQuery stuff, and it would help us organize the script a little better. I am not oposed to seeing the script hosted as some part of FG/SF, but I just don't think it's going to be a very popular idea - so far, everything worked out without major hinderance, so I would rather use an independent hosting solution, or continue to use the wiki to ensure that the barrier to entry/contributing isn't raised, e.g. by going through merge requests etc. Major contributions to the script like those from bigstones or Red Leader were simply "dropped" here directly, so this seems to have worked out really well.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:26, 2 May 2016 (EDT)

:: I've checked the [https://greasyfork.org/it/help/external-scripts GreasyFork external script policy]: as long as all the files are hosted on/uploaded to GreasyFork, it's not a problem. (Also, sorry about the typo, I wrote <tt>@include</tt> instead of <tt>@require</tt> by mistake). I guess I can proceed with the upload now? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 12:22, 2 May 2016 (EDT)

: sure, why not - it's in the public domain after all - feel free to make any changes to the script to have it auto-update. We can review everything once we have gathered a little more experience with this kind of scheme. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:27, 2 May 2016 (EDT)

:: {{done}} - I'm updating the installation instructions in the main page. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:52, 2 May 2016 (EDT)

::: Script at: https://greasyfork.org/en/scripts/19331-instant-cquotes
--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:18, 2 May 2016 (EDT)

:::: Regarding updates, bumping the version number is fine - I'll take the script at the wiki revision where the version is bumped and upload it. (Note that I will not perform any prior testing, so be extra careful - maybe I should add this in the note above the script?). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:08, 2 May 2016 (EDT)

:: sounds good, I will be sure to stop updating the version number without prior testing, we could also add some tests to the code to spot the more obvious mistakes - in fact, there is already an OpenLink helper that could be used to download a few postings and try to extract the corresponding fields, so that we would only bump the version number if that succeeds. BTW: Thanks for handling the hosting part, much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:25, 2 May 2016 (EDT)

== Issues ==
=== too greedy non-greedy regexes ===
The problem described in the previous section regarding regexes that eat up half messages seems to be related to my [http://blog.liip.ch/archive/2009/07/24/the-greedyness-of-non-greedy-regular-expressions.html misunderstanding of the non-greediness]. So, I managed to fix it for this one case, but this means that using .*? to match everything until you meet the following character (as I currently do pretty much everywhere) is dangerous and prone to failure. Any occurrence of that should be changed as I did in [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Instant-Cquotes&oldid=72839 this edit] and that's clearly cumbersome, not to say that it can still be incorrect: say I have
<nowiki><a someprop="href" href="http://www.link.org" ... ></nowiki>
If I want to mach anything between a and href, I use <tt><nowiki>[^(?:href)]*</nowiki></tt>, but that would match only up to the text inside someprop, so I'd have to check that it's not inside doublequotes... Well, I guess this is getting too complicated for handling it [http://blog.codinghorror.com/parsing-html-the-cthulhu-way/ the Chtulu way].

So my approach would be: fix this whenever the problem comes up, but don't overdo because we're already moving in dangerous ground. Or, rewrite it all using ''only'' xpaths *sobs*.
--[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 16:49, 17 June 2014 (UTC)

=== regex vectors ===

When testing things I realized that you are right: there are some scenarios where the regex may fail depending on how "complete" the selection is, because we obviously have hard-coded assumptions here. I'll see if it's feasible to also support vectors for regexes to extract the corresponding fields and try each regex in order to get a certain field, or if that doesn't make any sense... But quoting with/without author (anonymous quote) would be a valid test case here.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

: Probably going to look into this sooner or later because this could be a simple solution to also support PM quoting - without having to parse the actual URL, we'd just try different regexes in order and use the one that succeeds. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

=== Syntaxhighlighting ===
Need to investigate what needs to be updated to support quoting code sections, as per [http://forum.flightgear.org/viewtopic.php?f=66&t=21855&p=212585#p212581] --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:33, 14 June 2014 (UTC)

=== Postings that break our script for some reason ===
* http://forum.flightgear.org/viewtopic.php?f=19&t=23365

== Misc notes ==

=== Detecting failed XPaths ===
you've got a point, we should probably check if xpath/regexes succeed or fail, and show a warning so that we know that the scripts needs to be updated because some xpath/regex may have changed.

=== Paragraphs / br (trailing slash) ===
There are some minor issues now, i.e. newline2br will no longer contain the trailing forward slash, so there's probably some JavaScript/regex oddity involved here, maybe slashes just need to be escaped. Will be testing the code with a few different forum postings and check the resulting cquote
: {{done}}. That's because newline2br wasn't used at all in html mode. I added addNewlines which puts newlines after br's and list related tags, if there are more newlines to be added that should be the place.
: --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 14:03, 17 June 2014 (UTC)

=== support/ignore highlighted keywords/smilies ===
see [[Understanding Forward Compatibility]] for examples
: {{done}} --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 15:13, 17 June 2014 (UTC)

== Beyond just cquotes (newsletter/changelog) ==

Gijs has recently revamped the newsletter template rather significantly, see: [[FlightGear_Newsletter_June_2014]], and [[User_talk:Gijs#06.2F2014_newsletter:_too_much_of_a_]] - basically, we could extend the script to support another output FORMAT to directly create markup for the newsletter/changelog. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 20:40, 30 June 2014 (UTC)

== more styles/output formats ==

looking at some of the cleanup done by Red Leader recently, we could also directly support other styles/output formats to directly provide a format that looks well enough without requiring tons of manual editing. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:11, 13 February 2015 (EST)

== token matching for keywords/variables ==

seems like it might make sense to match common keywords/acronyms and variables, such as e.g.:
* FG_ROOT => [[$FG_ROOT]]
* FG_HOME => [[$FG_HOME]]
* FG_SRC => [[$FG_SRC]]

file names with a known prefix like $FG_ROOT could even be pattern-matched using git link: $FG_ROOT/Nasal/canvas/MapStructure.nas would become [[$FG_ROOT]]{{Git link|gitorious|fg/fgdata|master|Nasal/canvas/MapStructure.nass|text=/Nasal/canvas/MapStructure.nas}}

Equally, we could match common property paths to use code tags, e.g.: /sim/rendering would become <code>/sim/rendering</code>
Ultimately, it might be a good idea to get in touch with Johan_G, Gijs and Red Leader to see what kind of format they'd prefer, especially because this could then be directly used for creating newsletter contents. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:19, 13 February 2015 (EST)

== matching repository references using git link template ==

Most of us commonly refer to repository files using either the $FG_* references, or relative paths in the form of <code>src/Main/fg_init.cxx:line number</code>, we could automatically convert such references using the git/repo link template, e.g.:

{{FGCquote
|Further investigation found that the launcher *is* trying to add this directory to fg-aircraft (src/GUI/QtLauncher.cxx:772), but that this doesn't work because this option is processed before the launcher is run (intentionally, to allow the launcher to find aircraft in fg-aircraft: '''src/Main/main.cxx:448''').
|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33686356/
|title=<nowiki>Re: [Flightgear-devel] Launcher issues on Linux</nowiki>
|author=<nowiki>Rebecca N. Palmer</nowiki>
|date=<nowiki>2015-04-01</nowiki>
}}
}}

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:48, 1 April 2015 (EDT)

== chrome specific port ==

Hi Red Leader, when/if you do come up with a chrome specific version of the script, I would suggest to refactor existing APIs accordingly, so that we can come up with a common library of general purpose/utility helpers, so that both scripts can co-exist and use a common/shared file (think all the extraction/transformation logic), by referencing an external .js/JavaScript file that will be maintained/updated and hosted separately. I think this could be accomplished easily using jsfiddle. So basically, I am suggesting to come up with a shared back-end for both versions of the script. Given the complexity we're reaching meanwhile, as well as the number of edits and contributors, it may also make sense to consider using github for this at some point. One of the main advantages being that we could easily distribute updates automatically to all people who've installed the script, without them having to do anything manually.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 08:38, 23 June 2015 (EDT)

== Development resources ==

* https://www.youtube.com/watch?v=xpXNDT0SxM0
* http://wiki.greasespot.net/GM_getResourceText
* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script

== Future focus/development and priorities (De-quoting) ==

Given that most people involved in maintaining the wiki don't seem to particularly appreciate the nature of articles consisting mainly of quotes, and that we don't seem to have any other good way to populate new articles quickly, I was thinking of changing the focus of the script to dynamically create articles using quotes (with proper refs), that would be merely copy-edited, i.e. using the process we are currently using to "de-quote" such articles by 1) categorizing related quotes, 2) coming up with headers/sub-headers, 3) re-writing/merging certain quotes, 4) attributing them - linking back to the quotes archives.
Should we decide to pursue this, the script would be turned into a "wizard" where we can topics and sub-topics (wiki headings) and then add arbitrary text using the existing approach, but without using cquotes - i.e. the focus would be on extracting relevant contents, distilling them down and adding plenty of refs, including a references section at the bottom. Some tokens/words could be changed dynamically, but some kind of proof-reading/copy-editing would still need to be done afterwards, because people tend to use first person speech in their announcements/postings, which we would need to convert to 3rd person semi-automagically. Thoughts/ideas ?--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:11, 15 November 2015 (EST)

== changing and automating regex/xpath handling ==
{{See also|#Genetic_Expression_solver}}

We have currently hard-coded handling of different websites, regexes and xpath expressions so that things are a bit fragile at the moment, and once a website changes its style/template, our script would break immediately. However, we could change the way the script works by using a very simple NN (neural network) to come up with matching regex/xpath expressions automatically. The way this could work would be "supervised" training, where we would replace/adapt our existing CONFIG hash with a vector of URLs and contents to be extracted (date, time, title, posting). This kind of data would suffice entirely for a neural network to self-train itself and "learn" how to come up with regex/xpath expressions to extract the relevant contents, including not only hard-coded websites like sourceforge, but even completely different websites (think gmane) - because the "learning" routine would self-adapt by looking at how to get its contents, and never contain any hard-coded regex/xpath expressions anymore. The CONFIG hash would end up being a vector with "training data" for different websites to be supported. And whenever an expression fails, it could re-train itself accordingly.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:33, 15 November 2015 (EST)

== nested quotes and AJAX for thread titles ==

{{FGCquote
|1= http://sourceforge.net/p/flightgear/mailman/message/33451055/
{{cquote|As we move forward with FlightGear development and future versions, we will be expanding the "in app" aircraft center. This dialog inside flightgear lets you select, download, and switch to any of the aircraft in the library.|Curt}}
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=259879#p259879
| title = <nowiki>Re: New Canvas GUI</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Oct 7th, 2015
}}
}}

== AJAX mode/testing ==

We should probably add a dialog to store credentials that we can use for accessing the wiki, which would need to be shown after installing the script, i.e. first-time use

* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script
* http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Getting_Started#During_Installation
* https://www.safaribooksonline.com/library/view/greasemonkey-hacks/0596101651/ch01s06.html

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 20 November 2015 (EST)

== libraries ==

Referring to the [[#Hosting]] section, and my comment on wanting to use additional libs (like jQuery), I am primarily thinking about using a wizard-framework (e.g. jQuery steps) and a framework for creating wikimedia editor plugins (actions):

* http://mstratman.github.io/jQuery-Smart-Wizard/
* http://www.jquery-steps.com/
* http://www.jqueryrain.com/demo/jquery-step-form-wizard/
* https://www.mediawiki.org/wiki/Extension:WikiEditor

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:07, 2 May 2016 (EDT)

== About dequoting the script's article ==

Thanks for doing this, but I am frankly not sure if it's worth the effort - there are much more popular/important articles using tons of quotes than this one, and given the reputation of the script, having quotes in this article may actually be a useful thing to make the case for having quotes in the first place - thus, I would frankly not spend much time going through this particular article - in fact, I'd be very surprised if the greasyfork download stats showed more than 3-5 people actually downloading, and using, the script - so this is really just a niche tool, and we probably better spend our time doing other things, and reviewing other wiki articles, than the script's article - at the very least, I would suggest to retain the references to the original discussions revolving these quotes (just my 2c). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 19:00, 2 May 2016 (EDT)

: {{done}} I've added back the quotes as references. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:53, 3 May 2016 (EDT)

== Script configuration (persistence) ==

* https://wiki.greasespot.net/GM_config
* https://github.com/sizzlemctwizzle/GM_config/wiki
* https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API

== Work in progress ==

We have now several more or less related development efforts going on, and the code is also growing because of that - so it seems to make sense to summarize what's been going on recently. In general, all changes were made in response to the collection of feature requests and ideas we have accumulated over time - specifically, that means that the following roadmap is in the process of being implemented:

* establish unit testing, and add a few self-tests, so that the script can be more easily tested, updated/reviewed in the future
* rework the script to more easily support other sources (think gmane)
* make it much easier to update modified xpath/regex expressions (i.e. provide a UI for that)
* support persistence for script-specific settings
* make it easier for people to port/maintain the script by encapsulating platform specifics
* support asynchronous fetching of postings (AJAX), e.g. to fetch posting titles, attachments etc
* prepare the groundwork for supporting template-based output formats (think newsletter, changelog, articles)
* review what's necessary to allow the script to update fgcquote-based quotes automagically

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:47, 4 May 2016 (EDT)

== External genetic/neural network libraries ==
While uploading the latest version of the script, I noticed that the Genetic and Synaptic libraries are hosted on sites not on [https://greasyfork.org/en/help/external-scripts the approved GreasyFork list]. Shall I ask them to host them? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:28, 11 May 2016 (EDT)

: Thanks for pointing that out, I missed that completely, because everything is working correctly here - but obviously, I rarely get to actually download/install the latest version via greasyfork. Those libs should be safe to be added to the list, i.e. they're fairly established/popular, lest I'd not be using them. For now, this is just an experiment anyway. The idea is to update the xpath/regex code to evolve if/when the underlying website (theme) changes. But if there is a problem, we could use other libs - the code is just used for testing ATM. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:41, 11 May 2016 (EDT)

* https://github.com/subprotocol/genetic-js
* https://github.com/cazala/synaptic

:: {{ongoing}} I have submitted the libraries to the JSDelivr CDN; once they are up, I'll change the source URLs in the script and update it on GreasyFork as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:32, 17 May 2016 (EDT)

::: Hi Elgaton, thank you for taking care of this, it's very much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:55, 17 May 2016 (EDT)

:::: You're welcome! My merge requests for the CDN were approved (this took a bit longer than expected because I had made a small mistake - I forgot to include a file required by the Genetic.js library). The libraries should be up in a day or two, at which point I'll update the URLs in the script and submit the new version to GreasyFork. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:59, 20 May 2016 (EDT)

::::: {{done}} Everything should be fine now. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:16, 20 May 2016 (EDT)

:: Thank you for all the help with this, and also for updating the greasyfork info/screenshots ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:16, 21 May 2016 (EDT)

== Genetic Expression solver ==
[[File:Instant-cquotes-genetic-regex-solving.png|thumb|Screenshot showing the instant cquotes script with integrated regex solving support using genetic algorithms.]]

The genetic-js framework has been integrated, it is intended to help solve xpath/regex expressions procedurally using genetic algorithms/programming.

The idea is to provide a set of desired outputs (needles), available input data (haystack), and use existing (possibly outdated) regex/xpath expressions to seed a pool with potential solutions for retrieving the desired output. For now, this is just proof-of-concept, i.e. just an experiment.

For example, let's consider the typical format of a from header for any sourceforge posting:
<syntaxhighlight lang="javascript">
var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];
</syntaxhighlight>

The basic idea is to run a fitness function and score regex expressions based on not throwing an exception (which makes them valid), and by checking if the desired tokens are part of the output string, and evolve (mutate/cross-over) the "fittest" expressions - i.e. those that satisfy at least /some/ of the heuristics.

Some of the metrics that can be used by the fitness function to determine if an expression is "fit", are:
* valid expression
* relative offset/excess bytes in matches string
* number of examples it can successfully extract
* length of the expression
* runtime of the expression

The search space, and runtime, can be significantly reduced by looking at similarities between all examples and coming up with a subset string that contains all identical components (e.g. the <code>From:</code> part in the author regex) and use that for seeding the initial generations.

Ultimately, this would allow the script to self-update its regex/xpath expressions if/when the underlying website (themes) change, but it would also allow to add support for new websites, without ever manually adding the required xpath/regex expressions, i.e. all that is needed is a sufficiently large number of example datasets to obtain the author, date and title information, and a URL for the script to download the HTML markup of the posting in question:

{{Note|The date field won't work as is, because it's actually post-processed using a transformation function, so we'd need to undo the transformation or use the actual date string instead}}
<syntaxhighlight lang="javascript"> // vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
</syntaxhighlight>

Note how this no longer contains any hard-coded xpath/regex expressions - instead, the script can refer to the website specific defaults, and try those first, and if they fail, use those to seed new generations and evolve them procedurally until all tests succeed.

For a regex to be valid, it must work for all tests/examples.

Once the regex solver is working correctly, the code can be further generalized to also evolve xpath expressions (NOTE: the DOMParser API is /not/ available to webworkers ...) and chain those two components together.

* http://regex.inginf.units.it/how.html
* http://www.i-programmer.info/programming/perl/9503-automatically-generating-regular-expressions-with-genetic-programming.html
* http://jkff.info/articles/ire/
* http://www.networkworld.com/article/2955126/software/genetic-programming-meets-regular-expressions.html
* https://handcraftsman.wordpress.com/2012/04/11/evolving-a-regular-expression-with-go/
* http://stackoverflow.com/questions/4880402/how-to-auto-generate-regex-from-given-list-of-strings
* http://regex.inginf.units.it/
* http://www.genetic-programming.org/hc2014/Bartoli-Paper.pdf

== Hierarchical Clustering ==

Been tinkering with a JavaScript module to automatically cluster postings based on certain keywords in the topic/title or posting (e.g. Nasal, Canvas, 2D API, rendering): https://harthur.github.io/clusterfck/

Note that in conjunction with processing article sections and/or whole articles, this could help automatically come up with matching postings for articles and vice versa.

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:11, 19 May 2016 (EDT)

== Upcoming dependencies ==

The script is now using [http://markitup.jaysalvat.com/home/ markitup] to create the template editor. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:18, 21 May 2016 (EDT)

: I've [https://github.com/jsdelivr/jsdelivr/pull/11757 submitted a pull request] for the library to be distributed by jsDelivr. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 16:08, 21 May 2016 (EDT)

== Code beautifier ? ==

I still had, and have, pending changes that would need to go through the same beautifier you're using, or they'd be lost - so for now, I have just overwritten your beautified code, hope that you didn't do this manually (there really are tons of automated and configurable beautifiers out there). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:59, 21 May 2016 (EDT)

Talk:FlightGear Git

2016-05-21T12:01:49Z

Elgaton: /* Repository link templates */ Good idea, not sure on MacLauncher though

= Questions =

== forum posting ==
Feel free to add or link to this: http://flightgear.org/forums/viewtopic.php?f=22&t=8270&p=93371#p93371
--[[User:Hooray|Hooray]] 20:31, 1 December 2010 (UTC)

== mob access ==
If this experiment is meant to become a community experience, for both developers and users, how about enabling mob access, too [http://repo.or.cz/mob.html]? There are often people that are neither core developers, nor aspire to become one, but who are technical users who'd like to more easily submit patches.
While most long-term FlightGear users know about the fact that "FlightGear life" takes places on the mailing lists, many others often just end up sharing patches via the forums, sf.net patch trackers or even via IRC.
So, this would be an extremely easy way for potential contributors to more easily share local modifications with fellow users, without having any effect on any of the trusted main branches or organizational burden on the project lead, so it would sort of become a "sandbox" environment with "wild" code. Core developers could more easily keep track of patches submitted this way, too.--[[User:MILSTD|MILSTD]] 07:29, 4 February 2009 (EST)

The mob branch idea is intriguing, but it is so easy for anyone to set up their own forked flightgear repositories, especially on repo.or.cz, that I don't think it's necessary to enable the mob branch. It's really more useful to be able to say "pull the foo branch in my repository" than "pull my cool commit out of the mob branch."--[[User:Timoore|Timoore]] 05:24, 5 February 2009 (EST)

== Repository link templates ==

Hi Elgaton, I was wondering if you think it is worth creating [[:Category:Repository link templates|repository link templates]] for the Windows-3rd-party, FGCom, terrafs, and MacLauncher git repositories for use in the table? I haven't seen any need anywhere else in the wiki for these yet.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:01, 20 May 2016 (EDT)

: ''Yes'' for the Windows-3rd-party/FGCom/TerraFS repositories; I'm ''not so sure'' for the MacLauncher one (the code has not seen an update in years). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 08:01, 21 May 2016 (EDT)

FlightGear wiki talk:Instant-Refs

2016-05-20T13:16:14Z

Elgaton: /* External genetic/neural network libraries */ Scripts uploaded to CDN

== more sources ==

at some point, we may also want to add support for other sources, such as:
* old forum URLs, i.e. not yet using the subdomain format (should be easy, it's just a different/additional URL after all)
* thread.gmane.org/gmane.games.flightgear.devel/
* jsbsim devel list
* github tickets
* the new SF.net issue tracker
* SF.net commit logs http://gitorious.org/fg/
* http://www.mail-archive.com/flightgear-devel@flightgear.org/ (until 2005)
* http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/maillist.html (until 10/2013)

that should cover all important sources. And it would allow us to also use the same script to help populate [[FlightGear Newsletter]] & [[Changelog 3.2|changelogs]], but also [[Release plan/Lessons learned]]. So this could be a real time-saver. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:40, 1 June 2014 (UTC)

== Automatic update of script and old quotes ==
Thanks for the heads-up. Now, that makes me wonder if I can adapt the script to automatically parse existing wiki articles and update cquotes there automatically by re-opening the URL and re-running the extraction logic :) BTW: That reminds me: I was going to investigate adopting the '''downloadURL''' attribute[http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating] so that scripts can auto-update --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:51, 11 June 2014 (UTC)

:: if we should continue to see this widely used, having a good way to re-download and re-run the script on pages with existing cquotes would be a good way to automatically update quotes. For that, we would want to encode certain meta info in each template, e.g.:
* script version
* quoting date/time
* quote URL
* selection offsets
* quoting settings (format)

We can hook into form submission to update arbitrary quotes/contents using this: http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Developer_Tools#Intercept_and_Modify_Form_Submissions

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:19, 15 November 2015 (EST)

=== Hosting ===
The script seems to be about to become sufficiently complex to deserve actual hosting:
* http://wiki.greasespot.net/User_Script_Hosting
* https://openuserjs.org/

(that would allow updating the script automatically)

: Hi, is there any progress being made on this? I think the best way to host it would be to put in in a SourceForge repository under the FlightGear project (I don't know if it allows direct downloads, though, and we would need to relicense the script because [https://opensource.org/faq#public-domain public domain licenses are not OSI-approved]); otherwise, I can submit it to [https://greasyfork.org/ GreasyFork] (OpenUserJS is unsuitable as [https://openuserjs.org/about/Terms-of-Service public domain licenses are not allowed]). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 03:58, 1 May 2016 (EDT)

:: I don't think anybody has looked into this recently - however, relicensing should be a no-brainer, given that all the code is in the public domain anyway. I am not sure if it's worth the hassle to put up under sourceforge/FlightGear; we also need to keep in mind that this is not exactly the most popular "tool" around here. So, before this becomes even better accessible, it might be a good idea to comply with some of the requests made, e.g. by adding support for a different output mode (without using the FGCquote template, just the copied text, plus the ref part), so that quote-heavy pages don't look that obnoxious.
:: Regarding hosting in general, I still think it may be a good idea, but we would probably need to make sure that some requirements are met, e.g. having a revision history, and to provide other contributors with access-alternatively, we should maintain a copy of the script in the wiki, and add a note saying that changes to it will be reviewed/integrated with the hosted script by one of us (if you'd volunteer to help with that, I'd suggest to just go ahead and set up a public repository).
:: Admittedly, this is going to remain a fairly FG specific script, it would need quite a bit of work to become useful for other purposes (even though other OSS projects may be easy to support). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 06:33, 1 May 2016 (EDT)

::: OK, I think we can leave the script here and host it on GreasyFork (it allows public domain scripts) - I'll put the page on my watchlist to make sure I update the script there every time there's a version bump. Does that look good to you and the other contributors? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:26, 1 May 2016 (EDT)

:::: Sounds good to me, given how the script has evolved over time, we've probably hit a natural limit already, i.e. being able to use multiple files easily, and update scripts automatically sounds like a useful thing to me. I don't know if greasyfork supports "teams" of contributors for better collaboration ? It might also be a good idea to generalize the script so that it supports arbitrary phpBB installations and mailing list archives other than just sourceforge (think gmane) - and maybe output formats other than just wikimedia markup, that way, the script may become more useful over time.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:46, 1 May 2016 (EDT)

::::: It doesn't as it only offers a user script downloading facility (source code repositories like GitHub and SourceForge are better suited for the kind of work you mention). I'll wait a bit in case Red Leader, Philosopher or bigstones have any objections/remarks, then I'll upload the script there. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:14, 1 May 2016 (EDT)

:: do they support extensions spread across multiple files ? That is something that would help us quite a bit cleaning up the current code, which has become a bit convoluted over time. Apart from that, nothing wrong with github et al - I am just not sure if they're suitable for automatically propagating updated changes.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:12, 2 May 2016 (EDT)

::: No, not that I know of (generally speaking, all user scripts are made of a single .user.js file). We could "hack" it by splitting the current script in multiple files and requiring them from a main one as libraries via the <tt>@include</tt> directive, but that would rule out most hosting solutions (many providers only allow GreaseMonkey scripts which include additional files only from a handful of trusted domains/CDNs, for safety reasons).
::: As for propagating changes on GitHub and other code repository, the update URL must remain constant throughout the lifetime of the script. I'm sure this can be done on GitHub by publishing updates not as releases (where the addresses change), but on GitHub Pages (a user script I use does exactly this); on SourceForge, the usual download hosting could do the trick, but I'd need to perform a test first. (I'd prefer SF to keep the script "inside" the FG project hierarchy, if possible). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:50, 2 May 2016 (EDT)

: actually, user scripts can be compromised of multiple files, e.g. via the require directive [http://stackoverflow.com/questions/8695459/is-it-possible-to-split-greasemonkey-user-scripts-into-multiple-files]. Personally, I would like to make use of that - we are already using that to include jQuery stuff, and it would help us organize the script a little better. I am not oposed to seeing the script hosted as some part of FG/SF, but I just don't think it's going to be a very popular idea - so far, everything worked out without major hinderance, so I would rather use an independent hosting solution, or continue to use the wiki to ensure that the barrier to entry/contributing isn't raised, e.g. by going through merge requests etc. Major contributions to the script like those from bigstones or Red Leader were simply "dropped" here directly, so this seems to have worked out really well.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:26, 2 May 2016 (EDT)

:: I've checked the [https://greasyfork.org/it/help/external-scripts GreasyFork external script policy]: as long as all the files are hosted on/uploaded to GreasyFork, it's not a problem. (Also, sorry about the typo, I wrote <tt>@include</tt> instead of <tt>@require</tt> by mistake). I guess I can proceed with the upload now? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 12:22, 2 May 2016 (EDT)

: sure, why not - it's in the public domain after all - feel free to make any changes to the script to have it auto-update. We can review everything once we have gathered a little more experience with this kind of scheme. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:27, 2 May 2016 (EDT)

:: {{done}} - I'm updating the installation instructions in the main page. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:52, 2 May 2016 (EDT)

::: Script at: https://greasyfork.org/en/scripts/19331-instant-cquotes
--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:18, 2 May 2016 (EDT)

:::: Regarding updates, bumping the version number is fine - I'll take the script at the wiki revision where the version is bumped and upload it. (Note that I will not perform any prior testing, so be extra careful - maybe I should add this in the note above the script?). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:08, 2 May 2016 (EDT)

:: sounds good, I will be sure to stop updating the version number without prior testing, we could also add some tests to the code to spot the more obvious mistakes - in fact, there is already an OpenLink helper that could be used to download a few postings and try to extract the corresponding fields, so that we would only bump the version number if that succeeds. BTW: Thanks for handling the hosting part, much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:25, 2 May 2016 (EDT)

== Issues ==
=== too greedy non-greedy regexes ===
The problem described in the previous section regarding regexes that eat up half messages seems to be related to my [http://blog.liip.ch/archive/2009/07/24/the-greedyness-of-non-greedy-regular-expressions.html misunderstanding of the non-greediness]. So, I managed to fix it for this one case, but this means that using .*? to match everything until you meet the following character (as I currently do pretty much everywhere) is dangerous and prone to failure. Any occurrence of that should be changed as I did in [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Instant-Cquotes&oldid=72839 this edit] and that's clearly cumbersome, not to say that it can still be incorrect: say I have
<nowiki><a someprop="href" href="http://www.link.org" ... ></nowiki>
If I want to mach anything between a and href, I use <tt><nowiki>[^(?:href)]*</nowiki></tt>, but that would match only up to the text inside someprop, so I'd have to check that it's not inside doublequotes... Well, I guess this is getting too complicated for handling it [http://blog.codinghorror.com/parsing-html-the-cthulhu-way/ the Chtulu way].

So my approach would be: fix this whenever the problem comes up, but don't overdo because we're already moving in dangerous ground. Or, rewrite it all using ''only'' xpaths *sobs*.
--[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 16:49, 17 June 2014 (UTC)

=== regex vectors ===

When testing things I realized that you are right: there are some scenarios where the regex may fail depending on how "complete" the selection is, because we obviously have hard-coded assumptions here. I'll see if it's feasible to also support vectors for regexes to extract the corresponding fields and try each regex in order to get a certain field, or if that doesn't make any sense... But quoting with/without author (anonymous quote) would be a valid test case here.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

: Probably going to look into this sooner or later because this could be a simple solution to also support PM quoting - without having to parse the actual URL, we'd just try different regexes in order and use the one that succeeds. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

=== Syntaxhighlighting ===
Need to investigate what needs to be updated to support quoting code sections, as per [http://forum.flightgear.org/viewtopic.php?f=66&t=21855&p=212585#p212581] --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:33, 14 June 2014 (UTC)

=== Postings that break our script for some reason ===
* http://forum.flightgear.org/viewtopic.php?f=19&t=23365

== Misc notes ==

=== Detecting failed XPaths ===
you've got a point, we should probably check if xpath/regexes succeed or fail, and show a warning so that we know that the scripts needs to be updated because some xpath/regex may have changed.

=== Paragraphs / br (trailing slash) ===
There are some minor issues now, i.e. newline2br will no longer contain the trailing forward slash, so there's probably some JavaScript/regex oddity involved here, maybe slashes just need to be escaped. Will be testing the code with a few different forum postings and check the resulting cquote
: {{done}}. That's because newline2br wasn't used at all in html mode. I added addNewlines which puts newlines after br's and list related tags, if there are more newlines to be added that should be the place.
: --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 14:03, 17 June 2014 (UTC)

=== support/ignore highlighted keywords/smilies ===
see [[Understanding Forward Compatibility]] for examples
: {{done}} --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 15:13, 17 June 2014 (UTC)

== Beyond just cquotes (newsletter/changelog) ==

Gijs has recently revamped the newsletter template rather significantly, see: [[FlightGear_Newsletter_June_2014]], and [[User_talk:Gijs#06.2F2014_newsletter:_too_much_of_a_]] - basically, we could extend the script to support another output FORMAT to directly create markup for the newsletter/changelog. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 20:40, 30 June 2014 (UTC)

== more styles/output formats ==

looking at some of the cleanup done by Red Leader recently, we could also directly support other styles/output formats to directly provide a format that looks well enough without requiring tons of manual editing. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:11, 13 February 2015 (EST)

== token matching for keywords/variables ==

seems like it might make sense to match common keywords/acronyms and variables, such as e.g.:
* FG_ROOT => [[$FG_ROOT]]
* FG_HOME => [[$FG_HOME]]
* FG_SRC => [[$FG_SRC]]

file names with a known prefix like $FG_ROOT could even be pattern-matched using git link: $FG_ROOT/Nasal/canvas/MapStructure.nas would become [[$FG_ROOT]]{{Git link|gitorious|fg/fgdata|master|Nasal/canvas/MapStructure.nass|text=/Nasal/canvas/MapStructure.nas}}

Equally, we could match common property paths to use code tags, e.g.: /sim/rendering would become <code>/sim/rendering</code>
Ultimately, it might be a good idea to get in touch with Johan_G, Gijs and Red Leader to see what kind of format they'd prefer, especially because this could then be directly used for creating newsletter contents. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:19, 13 February 2015 (EST)

== matching repository references using git link template ==

Most of us commonly refer to repository files using either the $FG_* references, or relative paths in the form of <code>src/Main/fg_init.cxx:line number</code>, we could automatically convert such references using the git/repo link template, e.g.:

{{FGCquote
|Further investigation found that the launcher *is* trying to add this directory to fg-aircraft (src/GUI/QtLauncher.cxx:772), but that this doesn't work because this option is processed before the launcher is run (intentionally, to allow the launcher to find aircraft in fg-aircraft: '''src/Main/main.cxx:448''').
|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33686356/
|title=<nowiki>Re: [Flightgear-devel] Launcher issues on Linux</nowiki>
|author=<nowiki>Rebecca N. Palmer</nowiki>
|date=<nowiki>2015-04-01</nowiki>
}}
}}

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:48, 1 April 2015 (EDT)

== chrome specific port ==

Hi Red Leader, when/if you do come up with a chrome specific version of the script, I would suggest to refactor existing APIs accordingly, so that we can come up with a common library of general purpose/utility helpers, so that both scripts can co-exist and use a common/shared file (think all the extraction/transformation logic), by referencing an external .js/JavaScript file that will be maintained/updated and hosted separately. I think this could be accomplished easily using jsfiddle. So basically, I am suggesting to come up with a shared back-end for both versions of the script. Given the complexity we're reaching meanwhile, as well as the number of edits and contributors, it may also make sense to consider using github for this at some point. One of the main advantages being that we could easily distribute updates automatically to all people who've installed the script, without them having to do anything manually.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 08:38, 23 June 2015 (EDT)

== Development resources ==

* https://www.youtube.com/watch?v=xpXNDT0SxM0
* http://wiki.greasespot.net/GM_getResourceText
* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script

== Future focus/development and priorities (De-quoting) ==

Given that most people involved in maintaining the wiki don't seem to particularly appreciate the nature of articles consisting mainly of quotes, and that we don't seem to have any other good way to populate new articles quickly, I was thinking of changing the focus of the script to dynamically create articles using quotes (with proper refs), that would be merely copy-edited, i.e. using the process we are currently using to "de-quote" such articles by 1) categorizing related quotes, 2) coming up with headers/sub-headers, 3) re-writing/merging certain quotes, 4) attributing them - linking back to the quotes archives.
Should we decide to pursue this, the script would be turned into a "wizard" where we can topics and sub-topics (wiki headings) and then add arbitrary text using the existing approach, but without using cquotes - i.e. the focus would be on extracting relevant contents, distilling them down and adding plenty of refs, including a references section at the bottom. Some tokens/words could be changed dynamically, but some kind of proof-reading/copy-editing would still need to be done afterwards, because people tend to use first person speech in their announcements/postings, which we would need to convert to 3rd person semi-automagically. Thoughts/ideas ?--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:11, 15 November 2015 (EST)

== changing and automating regex/xpath handling ==
{{See also|#Genetic_Expression_solver}}

We have currently hard-coded handling of different websites, regexes and xpath expressions so that things are a bit fragile at the moment, and once a website changes its style/template, our script would break immediately. However, we could change the way the script works by using a very simple NN (neural network) to come up with matching regex/xpath expressions automatically. The way this could work would be "supervised" training, where we would replace/adapt our existing CONFIG hash with a vector of URLs and contents to be extracted (date, time, title, posting). This kind of data would suffice entirely for a neural network to self-train itself and "learn" how to come up with regex/xpath expressions to extract the relevant contents, including not only hard-coded websites like sourceforge, but even completely different websites (think gmane) - because the "learning" routine would self-adapt by looking at how to get its contents, and never contain any hard-coded regex/xpath expressions anymore. The CONFIG hash would end up being a vector with "training data" for different websites to be supported. And whenever an expression fails, it could re-train itself accordingly.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:33, 15 November 2015 (EST)

== nested quotes and AJAX for thread titles ==

{{FGCquote
|1= http://sourceforge.net/p/flightgear/mailman/message/33451055/
{{cquote|As we move forward with FlightGear development and future versions, we will be expanding the "in app" aircraft center. This dialog inside flightgear lets you select, download, and switch to any of the aircraft in the library.|Curt}}
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=259879#p259879
| title = <nowiki>Re: New Canvas GUI</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Oct 7th, 2015
}}
}}

== AJAX mode/testing ==

We should probably add a dialog to store credentials that we can use for accessing the wiki, which would need to be shown after installing the script, i.e. first-time use

* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script
* http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Getting_Started#During_Installation
* https://www.safaribooksonline.com/library/view/greasemonkey-hacks/0596101651/ch01s06.html

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 20 November 2015 (EST)

== libraries ==

Referring to the [[#Hosting]] section, and my comment on wanting to use additional libs (like jQuery), I am primarily thinking about using a wizard-framework (e.g. jQuery steps) and a framework for creating wikimedia editor plugins (actions):

* http://mstratman.github.io/jQuery-Smart-Wizard/
* http://www.jquery-steps.com/
* http://www.jqueryrain.com/demo/jquery-step-form-wizard/
* https://www.mediawiki.org/wiki/Extension:WikiEditor

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:07, 2 May 2016 (EDT)

== About dequoting the script's article ==

Thanks for doing this, but I am frankly not sure if it's worth the effort - there are much more popular/important articles using tons of quotes than this one, and given the reputation of the script, having quotes in this article may actually be a useful thing to make the case for having quotes in the first place - thus, I would frankly not spend much time going through this particular article - in fact, I'd be very surprised if the greasyfork download stats showed more than 3-5 people actually downloading, and using, the script - so this is really just a niche tool, and we probably better spend our time doing other things, and reviewing other wiki articles, than the script's article - at the very least, I would suggest to retain the references to the original discussions revolving these quotes (just my 2c). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 19:00, 2 May 2016 (EDT)

: {{done}} I've added back the quotes as references. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:53, 3 May 2016 (EDT)

== Script configuration (persistence) ==

* https://wiki.greasespot.net/GM_config
* https://github.com/sizzlemctwizzle/GM_config/wiki
* https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API

== Work in progress ==

We have now several more or less related development efforts going on, and the code is also growing because of that - so it seems to make sense to summarize what's been going on recently. In general, all changes were made in response to the collection of feature requests and ideas we have accumulated over time - specifically, that means that the following roadmap is in the process of being implemented:

* establish unit testing, and add a few self-tests, so that the script can be more easily tested, updated/reviewed in the future
* rework the script to more easily support other sources (think gmane)
* make it much easier to update modified xpath/regex expressions (i.e. provide a UI for that)
* support persistence for script-specific settings
* make it easier for people to port/maintain the script by encapsulating platform specifics
* support asynchronous fetching of postings (AJAX), e.g. to fetch posting titles, attachments etc
* prepare the groundwork for supporting template-based output formats (think newsletter, changelog, articles)
* review what's necessary to allow the script to update fgcquote-based quotes automagically

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:47, 4 May 2016 (EDT)

== External genetic/neural network libraries ==
While uploading the latest version of the script, I noticed that the Genetic and Synaptic libraries are hosted on sites not on [https://greasyfork.org/en/help/external-scripts the approved GreasyFork list]. Shall I ask them to host them? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:28, 11 May 2016 (EDT)

: Thanks for pointing that out, I missed that completely, because everything is working correctly here - but obviously, I rarely get to actually download/install the latest version via greasyfork. Those libs should be safe to be added to the list, i.e. they're fairly established/popular, lest I'd not be using them. For now, this is just an experiment anyway. The idea is to update the xpath/regex code to evolve if/when the underlying website (theme) changes. But if there is a problem, we could use other libs - the code is just used for testing ATM. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:41, 11 May 2016 (EDT)

* https://github.com/subprotocol/genetic-js
* https://github.com/cazala/synaptic

:: {{ongoing}} I have submitted the libraries to the JSDelivr CDN; once they are up, I'll change the source URLs in the script and update it on GreasyFork as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:32, 17 May 2016 (EDT)

::: Hi Elgaton, thank you for taking care of this, it's very much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:55, 17 May 2016 (EDT)

:::: You're welcome! My merge requests for the CDN were approved (this took a bit longer than expected because I had made a small mistake - I forgot to include a file required by the Genetic.js library). The libraries should be up in a day or two, at which point I'll update the URLs in the script and submit the new version to GreasyFork. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:59, 20 May 2016 (EDT)

::::: {{done}} Everything should be fine now. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:16, 20 May 2016 (EDT)

== Genetic Expression solver ==
[[File:Instant-cquotes-genetic-regex-solving.png|thumb|Screenshot showing the instant cquotes script with integrated regex solving support using genetic algorithms.]]

The genetic-js framework has been integrated, it is intended to help solve xpath/regex expressions procedurally using genetic algorithms/programming.

The idea is to provide a set of desired outputs (needles), available input data (haystack), and use existing (possibly outdated) regex/xpath expressions to seed a pool with potential solutions for retrieving the desired output. For now, this is just proof-of-concept, i.e. just an experiment.

For example, let's consider the typical format of a from header for any sourceforge posting:
<syntaxhighlight lang="javascript">
var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];
</syntaxhighlight>

The basic idea is to run a fitness function and score regex expressions based on not throwing an exception (which makes them valid), and by checking if the desired tokens are part of the output string, and evolve (mutate/cross-over) the "fittest" expressions - i.e. those that satisfy at least /some/ of the heuristics.

Some of the metrics that can be used by the fitness function to determine if an expression is "fit", are:
* valid expression
* relative offset/excess bytes in matches string
* number of examples it can successfully extract
* length of the expression
* runtime of the expression

The search space, and runtime, can be significantly reduced by looking at similarities between all examples and coming up with a subset string that contains all identical components (e.g. the <code>From:</code> part in the author regex) and use that for seeding the initial generations.

Ultimately, this would allow the script to self-update its regex/xpath expressions if/when the underlying website (themes) change, but it would also allow to add support for new websites, without ever manually adding the required xpath/regex expressions, i.e. all that is needed is a sufficiently large number of example datasets to obtain the author, date and title information, and a URL for the script to download the HTML markup of the posting in question:

{{Note|The date field won't work as is, because it's actually post-processed using a transformation function, so we'd need to undo the transformation or use the actual date string instead}}
<syntaxhighlight lang="javascript"> // vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
</syntaxhighlight>

Note how this no longer contains any hard-coded xpath/regex expressions - instead, the script can refer to the website specific defaults, and try those first, and if they fail, use those to seed new generations and evolve them procedurally until all tests succeed.

For a regex to be valid, it must work for all tests/examples.

Once the regex solver is working correctly, the code can be further generalized to also evolve xpath expressions (NOTE: the DOMParser API is /not/ available to webworkers ...) and chain those two components together.

* http://regex.inginf.units.it/how.html
* http://www.i-programmer.info/programming/perl/9503-automatically-generating-regular-expressions-with-genetic-programming.html
* http://jkff.info/articles/ire/
* http://www.networkworld.com/article/2955126/software/genetic-programming-meets-regular-expressions.html
* https://handcraftsman.wordpress.com/2012/04/11/evolving-a-regular-expression-with-go/
* http://stackoverflow.com/questions/4880402/how-to-auto-generate-regex-from-given-list-of-strings
* http://regex.inginf.units.it/
* http://www.genetic-programming.org/hc2014/Bartoli-Paper.pdf

== Hierarchical Clustering ==

Been tinkering with a JavaScript module to automatically cluster postings based on certain keywords in the topic/title or posting (e.g. Nasal, Canvas, 2D API, rendering): https://harthur.github.io/clusterfck/

Note that in conjunction with processing article sections and/or whole articles, this could help automatically come up with matching postings for articles and vice versa.

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:11, 19 May 2016 (EDT)

FlightGear wiki:Instant-Refs

2016-05-20T13:12:39Z

Elgaton: /* The script */ The date should be bumped as well

[[File:Quotes-logo-200x200.png|thumb]]
[[File:Instant-cquotes-firefox.png|thumb|Instant-Cquotes script in Firefox]]

[[File:Ref-only-quotes.png|thumb|Instant-Cquotes screenshot prototyping runtime format selection]]

The '''Instant-Cquotes''' script is a browser addon (user script) implemented in JavaScript in order to convert excerpts (created via copy&paste) from FlightGear forum or [[mailing list]] postings into MediaWiki markup/quotes to be used on the FlightGear wiki. It is supported by Firefox, Google Chrome/Chromium, Opera and Safari. It is being developed and maintained by a group of volunteers involved in maintaining the wiki and in trying to provide more up-to-date information to end-users who may not be as involved in the various FlightGear-related communication channels.

== Background and motivation ==
FlightGear's development is, at best, "self-coordinated", meaning that contributors discuss ideas and make proposals to contribute in a certain fashion and then team up to implement certain features and building blocks, often just temporarily.

Unfortunately, due to a lack of development manpower, many ideas are not implemented immediately; it is, thus, important to know their pros and cons, as well as who originally proposed them and/or might help with their implementation, even after a long time, preferably with links to the original discussions so that new contributors can decide whether to get involved in some effort or not. The project documentation, however, is in great need of improvement<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/15444440/
| title = <nowiki>[Flightgear-devel] development process (was: chaos...)</nowiki>
| author = <nowiki>John Denker</nowiki>
| date = Jul 16th, 2007
| added = Jul 16th, 2007
| script_version = 0.23
}}</ref> and usually significantly lacking behind:<ref name="OlsonStateThingsFG">{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861667/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Curtis Olson</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> many core developers update it seldomly, if not anymore, as it takes time to write it, as well as an understanding of the inner workings of a complex system such as FlightGear. Furthermore, this task might not be attractive due to its short term impact on the project,<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861562/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Hal V. Engel</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> and it is overwhelming to think about creating documentation that would address the needs of many different kinds of contributors with different backgrounds, experience levels and goals.<ref name="OlsonStateThingsFG" />

Forum and mailing lists discussions have therefore become the only up-to-date (albeit difficult to filter)<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=280058#p280058
| title = <nowiki>Re: quoting on the wiki</nowiki>
| author = <nowiki>Thorsten</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> source of information about recent development progress; this makes it tricky to know what is going on, what needs fixing, what were the decisions taken by the developers.<ref>{{cite web
| url = https://www.mail-archive.com/flightgear-devel%40lists.sourceforge.net/msg17198.html
| title = <nowiki>[Flightgear-devel] Project tracking</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mon, 28 Jul 2008 10:06:05 -0700
}}</ref>

The aim of the Instant-Cquotes script is to help wiki editors to copy relevant excerpts from such sources, formatting them as proper [[Template:Cquote|quotations]], and bootstrap new articles collecting them until a dedicated rewrite is made. It can also be used to reuse announcements to update the changelogs, [[Next newsletter|newsletter]] or the [[Release plan/Lessons learned]] page.

After being away from the wiki system for some time it becomes more of an effort to re-learn how to start a new file and figure out how to format it , with what headings, etc. Sometimes it is almost too much to do the original write up of the original post and all the work of that layout and effort to have to also duplicate it in a wiki article. If I was a little more current and affluent with the wiki editor, I might not be so hesitant to create the work there instead of the forum.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=284698#p284698
|title = <nowiki> Re: Breaking down NLCD raster image </nowiki>
|author = <nowiki> wlbragg </nowiki>
|date = May 9th, 2016
|added = May 9th, 2016
|script_version = 0.38
}}</ref>

In a few cases, such collections of quotes helped not only create bootstrap new articles, but even actual features.

In other cases, quotes have been used to update documentation of features (e.g. [[Rembrandt]]) whose maintainers may not be actively involved in FlightGear, to help document discussions that are taking place in the meantime, and provide some background information for people interested in the corresponding feature.

== Installation ==
# Install a user script manager. On Firefox, you can use [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey]; on Chrome/Chromium, Opera or Safari, you can use [https://tampermonkey.net/ Tampermonkey] (download links: [https://tampermonkey.net/index.php?ext=dhdg&browser=chrome Chrome/Chromium], [https://tampermonkey.net/index.php?ext=dhdg&browser=opera Opera], [https://tampermonkey.net/index.php?ext=dhdg&browser=safari Safari]).
# Visit [https://greasyfork.org/en/scripts/19331-instant-cquotes the Instant-Cquotes page on GreasyFork] and click on {{button|Install this script}} (green button). If Greasemonkey/Tampermonkey prompts you to confirm the installation, agree to do so.

[[File:Howto-install-instant-cquotes.png|thumb|Click the green button to install the script]]

=== Manual installation ===
{{note|This will install the most recent development version of the script, which might contain bugs. Also, GreaseMonkey/TamperMonkey will not update it automatically whenever a new version is released.}}

* '''Firefox'''
# Install Greasemonkey.
# Save [[#The Script|the script]] below as <code>instant_cquotes.user.js</code>, then drag-and-drop it into Firefox.
[[File:Greasemonkey-setup-on-firefox.png|thumb|Screenshot showing the Greasemonkey setup dialog (on Firefox)]]

* '''Chrome/Chromium''', '''Opera''', or '''Safari'''
# Install Tampermonkey.
# Navigate to '''Add a new Script'''.
# Copy and paste [[#The Script|the script]] below into the editing window.
# Click the {{button|Save}} button (just above the {{button|Search}} button).

=== Mobile installation ===
As of May 2016, there is no separate version available for mobile use. Your best chance is installing a userscript addon on Android, like one of those:
* [https://play.google.com/store/apps/details?id=net.biniok.tampermonkey Tampermonkey (Google Play Store)]
* [http://oilcan.jsharkey.org/ OilCan: Greasemonkey on steroids for Android]

For installation instructions, refer to [https://openuserjs.org/about/Tampermonkey-for-Android Tampermonkey for Android] or [http://www.blogtechnika.com/how-to-access-greasemonkey-scripts-on-android-phones/ How To Access Greasemonkey Scripts on Android Phones].

Testing/feedback would obviously be appreciated - if in doubt, feel free to just edit the wiki page to add your findings/questions.

=== Configuration ===
[[File:User-script-menu.png|thumb|GreaseMonkey menu shown in FireFox with instanct cquotes menu items]]

[[File:Config-dialog-instant-cquotes.png|thumb|The configuration dialog for the Instant-Cquotes script]]

As of version 0.30, a dedicated configuration dialog is in the process of being added, so that certain script features can be dynamically configured, without having to edit the script. For now, this is merely a placeholder that provides a checkbox to easily enable/disable the debug mode. In the future, we are hoping to also expose other features this way.

== Usage ==
[[File:Updated-cquotes-script-by-redleader.png|thumb|Instant-Cquotes script, with updates contributed by Red Leader]]

[[File:New-cquotes.png|thumb|Screenshot showing Instant-Cquotes 0.30 at work]]

# Go to some [[mailing list]] archive URL, for example [http://sourceforge.net/p/flightgear/mailman/message/32400727/] or any forum message, such as {{forumref|title=Re: Get objects to show up on Map/Radar|t=23299|label=p212558|f=71}}.
# Select the relevant portion of text.
# When you release the mouse button, a box will appear containing the converted text (for now, mainly properly-referenced quotes for the wiki).
# The text will be automatically selected and copied to the clipboard.
# Paste the text into the desired wiki page.

For example, by selecting part of the forum post in the link above you can get the following quotation:

{{FGCquote
|1= The upcoming FlightGear version (3.2) will contain a canvas-based map dialog, including a modular "plugin" system for creating custom map layers and charts with roughly ~50 lines of code, most of it boilerplate.
This is entirely XML/Nasal based (scripted) - symbols can be pretty much anything, raster or vector images (png or svg), but even animated. Styling can be customied, too.
For more info, I suggest to check out:
[[MapStructure#Porting the map dialog]]

[[File:MapStructureDialog.png|250px]]
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=212558#p212558
| title = <nowiki>Re: Get objects to show up on Map/Radar</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Jun 14th, 2014
}}
}}

=== On quoting ===
{{Main article|FlightGear wiki:Quoting Guidelines}}

Using the Instant-Cquotes script is a good way to bootstrap and write some preliminary notes; however, while quotes might be useful to understand how undocumented subsystems and features work and are definitely better than nothing, they are not meant to replace proper, structured and well-written wiki articles.<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=282800#p282800
| title = <nowiki>Re: What is the QT launcher?</nowiki>
| author = <nowiki>bugman</nowiki>
| date = Apr 17th, 2016
| added = Apr 17th, 2016
| script_version = 0.25
}}</ref>

One way to convert pages bootstrapped using quotes is to extract relevant information from them and keep citations only as references; in case important details are missing, they can be asked for on the [[Mailing lists|mailing lists]] (on the forum, the chance to get a complete answer might be lower).<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34954385/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> Another option might be moving the quotes to the Talk page for each entry, which would preserve the sources without clogging up the articles.<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34948989/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>Stuart Buchanan</nowiki>
| date = Mar 19th, 2016
| added = Mar 19th, 2016
| script_version = 0.25
}}</ref>

As a matter of fact, the whole paragraph above was assembled using this approach; to see for yourself, look up the references at the end of this page. For another example, see [[TerraSync#News]].

== Development ==
{{Note|A Chrome/Chromium-specific extension that will not need Tampermonkey installed is under development.}}

=== Resources ===
* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/API:Edit

=== Adding sources ===

Adding a new source is pretty straightforward if you understand how xpath and regexes work - basically, you only need an archive (e.g. gmane), and then determine the xpath of each relevant field, as well as the regular expression to process the extracted fields (optional).

The basic steps are these:
# open the user script in an editor
# navigate to the meta header of the user script
# add a new URL to the top of the script, e.g. by copying/adapting an existing line like this:
<syntaxhighlight lang="javascript">
// @match https://sourceforge.net/p/flightgear/mailman/*
</syntaxhighlight>

Once copied, add the new URL:

<syntaxhighlight lang="javascript">
// @match http://thread.gmane.org/gmane.games.flightgear.devel/*
</syntaxhighlight>

Next, you need to navigate to the configuration hash to add a new website to it.

Again, it makes sense to simply take an existing configuration hash and adapt it as needed (ignore/omit the tests vector for now by keeping it empty):

{{Caution|the following example may meanwhile be outdated, so be sure to look at the actual code instead}}

<syntaxhighlight lang="javascript">
'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()',
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [] // vector with transformation callbacks
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()'
transform: []
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
</syntaxhighlight>

Now, we need to review/adapt the profile according to the new archive we'd like to see supported.

for starters, that means:
* changing the name of the profile, e.g. to read gmane (instead of sourceforge)
* change the '''url_reg''' field to the gmane URL (this can be a regular expression)

Next, it makes sense to use an [https://addons.mozilla.org/de/firefox/addon/xpath-checker/ XPath checker], so that we can look up the xpath expression for various HTML elements, and add those to the configuration hash above.

For testing purposes, you will probably go to the setup dialog and enable the DEBUG mode, and use your browser's console to see what is going on.

=== Getting involved ===
While having some experience with JavaScript/HTML and jQuery will definitely be useful, JavaScript is close enough to FlightGear scripting ([[Nasal]]), so that people can get involved pretty easily.

Most maintenance work will typically involve reviewing/maintaining a few configuration hashes, that contain meta information for each supported archive (mailing list/forum).

Usually, each hash contains a combination of xpath/regex expressions to look up the relevant information, as well as vector of optional transformations that are applied (in order) to convert contents to a different format (e.g. dates).

In addition, there is growing library of utility functions, a handful wrappers for useful stuff, for example:

* <code>Host.dbLog(message_string)</code> - log a message to the console if the DEBUG flag is set
* <code>Host.download(url, callback, method='GET')</code> - will download the URL and pass the downloaded content to the callback specified
* <code>Host.downloadPosting(url, callback)</code> - will download the posting URL and pass the extracted and transformed author/content and date fields in a hash to the callback specified, the URL must be one supported in the CONFIG hash (i.e. forum/sourceforge for now)
* <code>Host.make_doc(string, type="text/html")</code> - will turn a string/blob into a DOM that can be queried
* <code>Host.eval_xpath(document, xpath_expression, type=XPathResult.STRING_TYPE)</code> - will apply the xpath expression to the document specified, returning the requested type (defaulted to string)
* <code>Host.set_persistent(key,value)</code> - stores a key/value pair
* <code>Host.get_persistent(key,default_value)</code> - retrieves a values using the key specified, falling back to the default value

=== Porting ===
[[File:Instant-cquote-firefox-addon-mode.png|thumb|Prototyping a dedicated instant-cquote mode for use as a firefox addon]]

Porting the script to support other browsers/script engines is greatly appreciated. Typically, this should be pretty self-contained, because all main APIs are intended to be encapsulated in a so called "Environment" hash, where APIs that are specific to a particular browser/script engine should be provided with a wrapper. As of mid 2016, most APIs are now kept inside such an Environment hash (look at the GreaseMonkey hash for reference/details), so that it is now even possible to turn the script into a standalone FireFox addon without having to change much of the underlying code.

=== Self checks (unit testing) ===
For regression testing purposes, there's a dedicated "self check" dialog that will be extended over time. For now it will download a few profile/website specific postings using a vector called "tests" and then log the posting's title, author and date to the console.

The next step will be actually showing that information in the dialog itself - there's a separate helper function to accomplish that, so that the corresponding div layer can be updated with the results.

[[File:Sanity-check-cquotes-dialog.png|thumb|automatically executed sanity checks]]

=== Debug mode ===
[[File:Instant-cquotes-debug-mode.png|thumb|Instant-Cquotes debug mode]]

=== AJAX (live page editing) ===
{{WIP}}

* http://wiki.flightgear.org/api.php
* http://wiki.flightgear.org/api.php?action=parse&page=Frequently%20asked%20questions&prop=sections

For now, the setup dialog will try to obtain a login token for the wiki and show a message if successful.

In addition, the profile/website hash also contains a new wiki entry for the FlightGear wiki, whose '''event_handler''' callback will be invoked once the FG wiki is visited - the console/log will show a greeting, so that is where other code can be added - e.g. to help clean up/rewrite FGCquote-based articles automatically etc.

There is a vector of "modes", whose members are a hash containing trigger/handler fields, linked to two callbacks - the trigger callback can be used to check some condition, while the handler will be invoked if the trigger returns true.

This can be used to support an arbitrary number of modes, whose triggers are evaluated during page load - all triggers that return true, will have their handlers invoked, which is how the following snippet works to rewrite/augment wiki edit handles:

<syntaxhighlight lang="javascript>
'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile
</syntaxhighlight>

See [[User:Red Leader/Sandbox/AJAX test]]

* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/Extension:VisualEditor
* https://en.wikipedia.org/wiki/Wikipedia:Creating_a_bot

=== Mobile edition ===
{{Note|As of 02/2016, Hooray is contemplating to make this available as an addon for Android phones.}}

=== Issues/limitations ===
==== Bugs ====
* It's eating characters, apparently related to regex/xpath handling - e.g. words like "analyzing" are turned into "analying" [http://forum.flightgear.org/viewtopic.php?f=6&t=28378&p=270735&hilit=analyzing#p270735]
==== Non working URLs ====
* image matching/extraction: http://forum.flightgear.org/viewtopic.php?p=276221#p276221
* http://sourceforge.net/p/flightgear/mailman/message/34754961/
* http://forum.flightgear.org/viewtopic.php?f=18&t=27054&start=90#p273972 → selecting from “As promised, two sample installation sessions on Linux” to “That's it.” towards the end of the message causes Iceweasel (Firefox) 44.0.2 to display a dialog box reading “A script on this page may be busy, or it may have stopped responding. You can stop the script now, open the script in the debugger, or let the script continue.” The line below reads “Script: chrome://greasemonkey-modules/...quotes/instant_cquotes.user.js:544”. Choosing ''Continue'' doesn't help: the same message reappears a few seconds afterwards.

=== Feature requests & ideas ===
* try to recognize list items [https://sourceforge.net/p/flightgear/mailman/message/35095319/] (heuristics: look for colon/asterisk, dashes and CR/LF)
* should add [[Template:News]] to the article dropdown for announcements [http://wiki.flightgear.org/index.php?title=Template:News&oldid=98266]
* add a mode that will download screenshots from forum postings and automatically upload/categorize them, see [[Birds]]
* split the article dropdown into sections, and also populate it with the user's watchlist [https://www.mediawiki.org/wiki/API:Watchlist] {{Progressbar|60}}
* mailing list templates, listed at [http://wiki.flightgear.org/Template_talk:Project_infrastructure#Related_mailing_list_templates]
* expose the cquote/ref markup via the UI so that it can be edited/customized and treated like a template {{Done}} (0.36+)
* identify common/repeated links and automatically create [[Template:Project infrastructure|link/infrastructure templates]] and use those (should be straightforward using the AJAX mode) [http://wiki.flightgear.org/index.php?title=Mailing_lists&curid=2038&diff=97876&oldid=85252]
* add a devel/maintainer mode where it will return the xpath for a selection [http://stackoverflow.com/questions/361130/get-selected-text-and-selected-nodes-on-a-page] [http://stackoverflow.com/questions/12485334/get-surrounding-dom-node-of-selection]
* move openlink,dblog helpers to Environment hash {{Done}}
* identify CLI arguments like --aircraft=c172p and wrap them in between code tags <code>--aircraft=c172p</code> [https://sourceforge.net/p/flightgear/mailman/message/35063277/] (note that we can simply download [https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml options.xml] via openlink() and use that, which is kinda of neat...) {{Progressbar|60}} (see downloadOptionsXML() in the code)
* introduce "layouts" (templates) for different purposes: newsletter, changelog, wiki article, [[The Manual]] (LaTex) ? {{Progressbar|40}}
* use wikipedia template if possible [https://sourceforge.net/p/flightgear/mailman/message/35057670/]
* the new '''tests''' vector could also contain vectors for tests to test the extract/transform* utilities, see Environment.APITests {{Progressbar|50}}
* move environment specific APIs (browser, script host etc) into some kind of Environment hash to encapsulate things (Red Leader was working on a pure Chrome-only version at some point IIRC) {{Progressbar|80}}
* encode script settings in created markup, for future processing/updating of quotes
* look up <code>[x]</code> references and replace with the corresponding link (titled) [https://sourceforge.net/p/flightgear/mailman/message/35055331/] [https://sourceforge.net/p/flightgear/mailman/message/35062598/]
** convert footnotes into Abbr templates [http://article.gmane.org/gmane.games.flightgear.devel/78971]
* support named refs for combining identical refs [http://wiki.flightgear.org/index.php?title=FlightGear_Qt_launcher&curid=13693&diff=97562&oldid=97551]
* adopt [[Template:Forumref]]
* implement a less obnoxious quoting mode, without quotes, where only the ref part would be added, e.g. see the example at [[Graphics Card Profiles]] (it's still 99% quotes, but much less annoying) {{Done}}
* attachment support: identify attachments and link to them: [https://sourceforge.net/p/flightgear/mailman/message/11683451/] [https://sourceforge.net/p/flightgear/mailman/message/23906620/] [https://sourceforge.net/p/flightgear/mailman/message/35059842/] [https://sourceforge.net/p/flightgear/mailman/message/35067087/]
* bulletin points: if there is a colon (:) followed by at least two dashes (-), split up everything after the colon to turn each dash into an asterisk (wiki markup for bulletin points), followed by a newline [http://sourceforge.net/p/flightgear/mailman/message/34760165/]
* generic URL/template matching, e.g. for for sourceforge commit IDs
* make filters/conversions configurable via checkboxes (nowiki, wrap in alert/note boxes)
* make syntax highlighting configurable (language, mode) ?
* consider using something like the Roles template to turn contributor names into tooltips where contributor roles are shown (core dev, fgdata committer etc)
* introduce support for tag clouds to help categorize/classify related quotes
* consider making transformations optional/configurable using check boxes in the jQuery dialog
* add new input method, for quotes that need to be updated/converted (added script version specifically for this purpose), should also add extraction/processing date
* investigate why not all mailing list archives/postings are supported correctly: http://sourceforge.net/p/flightgear/mailman/message/8090479/ (problem traced to <code>getPostID()</code>)
* explore having a ref-only mode without using cquotes, i.e. just copy/paste quotes with proper ref tags and a references section, to rewrite the whole thing (possibly with templates for different purposes, e.g. newsletter/changelog) {{Done}}
* should use Template:Forumref (category:link templates)
* should be updated to use the new repo/flightgear file templates created by Johan & RedLeader {{Not done}}
* resolve links to forum threads to look up the title for the topic/posting, so that the posting's title can be used for those links, instead of just the URL - we can probably do that by making an AJAX call to open URLs asynchronously and extract the title for the thread/posting to come up with something like <code>[http://forum.flightgear.org/viewtopic.php?f=4&t=24421 A call to developers-Lockheed -L188 Electra]</code> ([http://forum.flightgear.org/viewtopic.php?f=4&t=26562&p=247325&hilit=links#p247347]) {{Progressbar|50}}
* convert quoted bug tracker URLs to use the issue template on the wiki {{not done}}
* do regex/xpath validation, and display any errors (e.g. template/theme changes on the forum would currently break the script) {{Progressbar|60}}
* increased focus on supporting different output formats, maybe using a simple [http://www.jquery-steps.com/ jQuery based wizard] (wiki, forum, newsletter, changelog) {{Not done}}
* token matching for keywords/acronyms to link to the corresponding wiki articles (e.g. Nasal, Canvas, FG_ROOT, FG_HOME etc) {{Not done}}
* Add support for [http://sourceforge.net/p/flightgear/codetickets/ tickets], merge requests comments and [http://www.fguk.eu/index.php/forum/index FGUK forum]. (also see [[FlightGear wiki talk:Instant-Cquotes#more sources]])
* GET-encoded SID arguments should be stripped from forum URLs. {{Not done}}
* Links to repositories should be converted to use wiki templates. {{Not done}}
* The {{Abbr|regexes|regular expressions}} used may fail if the HTML DOM of the source changes (e.g., phpBB/theme update)
** Show a warning when that's the case. {{Progressbar|70}} (see the self-check dialog)
** Try multiple regexes in order. {{Progressbar|30}} (see the self-check dialog)
* Use the script to update previously created Cquotes automatically
** Instead of using the <code>getSelection()</code> helper, we could register a match for <tt>wiki.flightgear.org</tt> with <code>action=edit</code> set, so that we can directly process all text of an edited page, using AJAX calls to open the URL in the background. {{Progressbar|40}} (see the self-check dialog, available via the greasemonkey menu)
** See [https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax MW:API:Edit § Editing via Ajax]

=== Changelog ===
{{Note|Contributors are invited to document their changes here, please also add your wiki handle so that others can more easily get in touch.}}

* first stab at implementing unit tests by adding a vector with URLS to be downloaded and fields to be matched (WIP), shown in a jQuery dialog
* support for persistent settings and a jQuery setup dialog with persistence
* hosting is moved, to allow auto-updates [http://www.greasespot.net/2012/02/automatic-script-updates-come-to.html] [https://wiki.greasespot.net/Metadata_Block#.40updateURL] [http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating]
* changed to ref-only quotes for now, not using the FGCquote template anymore, due to its obnoxious appearance on quote-heavy pages (should probably become a runtime option instead)
* updated to use https for forum postings
* add version info to each created quote, i.e. for future updates
* add helper for opening websites asynchronously using AJAX (also via GM helper API)
* display version number in output dialog
* begin using the GreaseMonkey API for setting clipboard content

== The script ==
<gallery mode=packed widths=230px heights=230px>
Instant-cquotes-revamped.png|Instant cquotes: Revamped user interface exposes script internals to make the script better configurable at runtime
Instant-cquotes-template-editor.png|Instant cquotes now features a simple built-in template editor with support for variable substitution, so that wiki templates can be more easily customized
Instant-cquotes-with-wikimedia-API-integration.png|Screenshot showing instant-cquotes with wikimedia API integration to fetch articles/sections and populate dropdown menus accordingly
Instant-cquotes-on-steroids-with-watchlist-support.png|Screenshot showing the JQuery-mode of the instant cquotes script with built-in support for fetching a user's wiki/watchlist to edit/update articles in a semi-automated fashion
</gallery>
{{PD-author|FlightGear contributors}}

{{Note|Anybody interested in contributing to the code is invited to directly edit this wiki article. From 05/2016, the script is hosted on GreasyFork to allow automatic updates. If you'd like to see your changes applied, please bump the version number and the date and [[User:Elgaton|Elgaton]] will upload it in the state it was when the version number was bumped. ''Make sure to perform thorough testing'' before the bump to prevent unexpected breakage; it is generally a good idea to validate your changes using an online syntax checker, e.g.:
* http://jshint.com/
* http://esprima.org/demo/validate.html
* http://codebeautify.org/jsvalidate
<p/>Thank you!}}

Changes that should be mentioned in the changelog, should be added below (and moved to the [[#Changelog]] section subsequently:

* preparations for adding support to download fgdata related files like options.xml to automatically regex known CLI commands
* preparatory work for adding a speech-rewrite engine to assist in converting 1st person speech to 3rd person
* framework for encapsulating userscript specifics in an environment hash to provide better updating/porting support

<syntaxhighlight lang="javascript" enclose="div">// ==UserScript==
// @name Instant-Cquotes
// @name:it Instant-Cquotes
// @license public domain
// @version 0.39
// @date 2016-05-20
// @description Automatically converts selected FlightGear mailing list and forum quotes into post-processed MediaWiki markup (i.e. cquotes).
// @description:it Converte automaticamente citazioni dalla mailing list e dal forum di FlightGear in marcatori MediaWiki (cquote).
// @author Hooray, bigstones, Philosopher, Red Leader & Elgaton (2013-2016)
// @supportURL http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @icon http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @match https://sourceforge.net/p/flightgear/mailman/*
// @match http://sourceforge.net/p/flightgear/mailman/*
// @match https://forum.flightgear.org/*
// @match http://wiki.flightgear.org/*
// @namespace http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @run-at document-start
// @require https://code.jquery.com/jquery-1.10.2.js
// @require https://code.jquery.com/ui/1.11.4/jquery-ui.js
// @require https://cdn.jsdelivr.net/genetic.js/0.1.14/genetic.js
// @require https://cdn.jsdelivr.net/synaptic/1.0.4/synaptic.min.js
// @resource jQUI_CSS https://code.jquery.com/ui/1.11.4/themes/smoothness/jquery-ui.css
// @resource myLogo http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @grant GM_registerMenuCommand
// @grant GM_setValue
// @grant GM_getValue
// @grant GM_addStyle
// @grant GM_getResourceText
// @grant GM_getResourceURL
// @grant GM_setClipboard
// @grant GM_xmlhttpRequest
// @noframes
// ==/UserScript==

// This work has been released into the public domain by their authors. This
// applies worldwide.
// In some countries this may not be legally possible; if so:
// The authors grant anyone the right to use this work for any purpose, without
// any conditions, unless such conditions are required by law.

// This script has a number of dependencies that are implicitly satisfied when
// run as a user script via GreaseMonkey/TamperMonkey; however, these need to
// be explicitly handled when using a different mode (e.g. Firefox/Android):
//
// - jQuery - user interface (REQUIRED)
// - genetic-js - genetic programming (OPTIONAL/EXPERIMENTAL)
// - synaptic - neural networks (OPTIONAL/EXPERIMENTAL)

/* Here are some TODOs
* - support RSS feeds http://dir.gmane.org/gmane.games.flightgear.devel/
* - move event handling/processing to the CONFIG hash
* - use try/catch more widely
* - wrap function calls in try/call for better debugging/diagnostics
* - add helpers for [].forEach.call, map, apply and call
* - replace for/in, for/of, let statements for better compatibility (dont require ES6)
* - for the same reason, replace use of functions with default params
* - isolate UI (e.g. JQUERY) code in UserInterface hash
* - expose regex/transformations via the UI
*/

/*jslint
devel
*/

'use strict';

// prevent conflicts with jQuery used on webpages:
// https://wiki.greasespot.net/Third-Party_Libraries#jQuery
// http://stackoverflow.com/a/5014220
// TODO: move to GreaseMonkey/UI host
this.$ = this.jQuery = jQuery.noConflict(true);

// this hash is just intended to help isolate UI specifics so that we don't
// need to maintain/port tons of code
var UserInterface = {
get: function () {
return UserInterface.DEFAULT;
},

CONSOLE: {
}, // CONSOLE (shell, mainly useful for testing)

DEFAULT: {
alert: function (msg) {
return window.alert(msg);
},
prompt: function (msg) {
return window.prompt(msg);
},
confirm: function (msg) {
return window.confirm(msg);
},
dialog: null,
selection: null,
populateWatchlist: function () {
},
populateEditSections: function () {
}
}, // default UI mapping (Browser/User script)

JQUERY: {
} // JQUERY
}; // UserInterface

var UI = UserInterface.get(); // DEFAULT for now

// This hash is intended to help encapsulate platform specifics (browser/
// scripting host). Ideally, all APIs that are platform specific should be
// kept here. This should make it much easier to update/port and maintain the
// script in the future.
var Environment = {
getHost: function (xpi = false) {

if (xpi) {
Environment.scriptEngine = 'firefox addon';
console.log('in firefox xpi/addon mode');
return Environment.FirefoxAddon; // HACK for testing the xpi mode (firefox addon)
}

// This will determine the script engine in use: http://stackoverflow.com/questions/27487828/how-to-detect-if-a-userscript-is-installed-from-the-chrome-store
if (typeof (GM_info) === 'undefined') {
Environment.scriptEngine =
"plain Chrome (Or Opera, or scriptish, or Safari, or rarer)";
// See http://stackoverflow.com/a/2401861/331508 for optional browser sniffing code.
} else {
Environment.scriptEngine = GM_info.scriptHandler ||
"Greasemonkey";
}
console.log('Instant cquotes is running on ' + Environment.scriptEngine +
'.');

// console.log("not in firefox addon mode...");
// See also: https://wiki.greasespot.net/Cross-browser_userscripting
return Environment.GreaseMonkey; // return the only/default host (for now)
},

validate: function (host) {
if (host.get_persistent('startup.disable_validation', false))
return;

if (Environment.scriptEngine !== "Greasemonkey")
console.log(
"NOTE: This script has not been tested with script engines"
+ " other than GreaseMonkey recently!"
);

var dependencies = [{
name: 'jQuery',
test: function () {}
}, {
name: 'genetic.js',
test: function () {}
}, {
name: 'synaptic',
test: function () {}
}, ];

[].forEach.call(dependencies, function (dep) {
console.log("Checking for dependency:" + dep.name);
var status = false;
try {
dep.test.call(undefined);
status = true;
} catch (e) {
status = false;
} finally {
var success = (status) ? '==> success' :
'==> failed';
console.log(success);
return status;
}
});
}, // validate

// this contains unit tests for checking crucial APIs that must work for
// the script to work correctly
// for the time being, most of these are stubs waiting to be filled in
// for a working example, refer to the JSON test at the end
// TODO: add jQuery tests
APITests: [{
name: 'download',
test: function (recipient) {
recipient(true);
}
}, {
name: 'make_doc',
test: function (recipient) {
recipient(true);
}
}, {
name: 'eval_xpath',
test: function (recipient) {
recipient(true);
}
}, {
name: 'JSON de/serialization',
test: function (recipient) {
//console.log("running json test");
var identifier = 'unit_tests.json_serialization';
var hash1 = {
x: 1,
y: 2,
z: 3
};
Host.set_persistent(identifier, hash1, true);
var hash2 = Host.get_persistent(identifier, null,
true);

recipient(JSON.stringify(hash1) === JSON.stringify(
hash2));
} // callback
},

// downloads a posting and tries to transform it to 3rd person speech ...
// TODO: add another test to check forum postings
{
name: 'text/speech transformation',
test: function (recipient) {

// the posting we want to download
var url =
'https://sourceforge.net/p/flightgear/mailman/message/35066974/';
Host.downloadPosting(url, function (result) {

// only process the first sentence by using comma/dot as
// delimiter
var firstSentence = result.content.substring(
result.content.indexOf(',') + 1,
result.content.indexOf('.'));

var transformed = transformSpeech(
firstSentence, result.author,
null, speechTransformations);
console.log(
"3rd person speech transformation:\n" +
transformed);

recipient(true);
}); // downloadPosting()

} // test()
}, // end of speech transform test
{
name: "download $FG_ROOT/options.xml",
test: function (recipient) {
downloadOptionsXML();
recipient(true);
} // test
}

], // end of APITests

runAPITests: function (host, recipient) {
console.log("Running API tests");
for (let test of Environment.APITests) {
//var test = Environment.APITests[t];
// invoke the callback passed, with the hash containing the test
// specs, so that the console/log or a div can be updated showing
// the test results
recipient.call(undefined, test);

} // foreach test
}, // runAPITests

/*
* ========================================================================
*/

// NOTE: This mode/environment is WIP and highly experimental ...
// To see this working, you need to package up the whole file as a Firefox
// XPI using "jpm xpi" and then start the whole thing via "jpm run", to do
// that, you also need a matching package.json (i.e. via jpm init)
// ALSO: you will have to explicitly install any dependencies using jpm
FirefoxAddon: {
init: function () {
console.log("Firefox addon mode ...");
},
getScriptVersion: function () {
return '0.36'; // FIXME
},
dbLog: function (msg) {
console.log(msg);
},
addEventListener: function (ev, cb) {

require("sdk/tabs").on("ready", logURL);

function logURL(tab) {
console.log("URL loaded:" + tab.url);
}
},

registerConfigurationOption: function (name, callback, hook) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
console.log("config menu support n/a in firefox mode");
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Using_third-party_modules_%28jpm%29
var menuitems = require("menuitem");
var menuitem = menuitems.Menuitem({
id: "clickme",
menuid: "menu_ToolsPopup",
label: name,
onCommand: function () {
console.log("menuitem clicked:");
callback();
},
insertbefore: "menu_pageInfo"
});
},

registerTrigger: function () {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/context-menu#Item%28options%29
var contextMenu = require("sdk/context-menu");
var menuItem = contextMenu.Item({
label: "Instant Cquote",
context: contextMenu.SelectionContext(),
// https://developer.mozilla.org/en/Add-ons/SDK/Guides/Two_Types_of_Scripts
// https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts
contentScript: 'self.on("click", function () {' +
' var text = window.getSelection().toString();' +
' self.postMessage(text);' +
'});',
onMessage: function (selectionText) {
console.log(selectionText);
instantCquote(selectionText);
}
});

// for selection handling stuff, see: https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/selection

function myListener() {
console.log("A selection has been made.");
}
var selection = require("sdk/selection");
selection.on('select', myListener);

}, //registerTrigger

get_persistent: function (key, default_value) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/simple-storage
var ss = require("sdk/simple-storage");

console.log(
"firefox mode does not yet have persistence support"
);
return default_value;
},
set_persistent: function (key, value) {
console.log("firefox persistence stubs not yet filled in !");
},
set_clipboard: function (content) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/clipboard

//console.log('clipboard stub not yet filled in ...');
var clipboard = require("sdk/clipboard");
clipboard.set(content);
} //set_cliipboard

}, // end of FireFox addon config

// placeholder for now ...
Android: {
// NOP
}, // Android

///////////////////////////////////////
// supported script engines:
///////////////////////////////////////

GreaseMonkey: {
// TODO: move environment specific initialization code here
init: function () {
// Check if Greasemonkey/Tampermonkey is available
try {
// TODO: add version check for clipboard API and check for TamperMonkey/Scriptish equivalents?
GM_addStyle(GM_getResourceText('jQUI_CSS'));
} // try
catch (error) {
console.log(
'Could not add style or determine script version'
);
} // catch

var commands = [{
name: 'Setup quotes',
callback: setupDialog,
hook: 'S'
}, {
name: 'Check quotes',
callback: selfCheckDialog,
hook: 'C'
}];

for (let c of commands) {
this.registerConfigurationOption(c.name, c.callback, c.hook);
}

}, // init()

getScriptVersion: function () {
return GM_info.script.version;
},

dbLog: function (message) {
if (Boolean(DEBUG)) {
console.log('Instant cquotes:' + message);
}
}, // dbLog()

registerConfigurationOption: function (name, callback, hook) {
// https://wiki.greasespot.net/GM_registerMenuCommand
// https://wiki.greasespot.net/Greasemonkey_Manual:Monkey_Menu#The_Menu
GM_registerMenuCommand(name, callback, hook);
}, //registerMenuCommand()

registerTrigger: function () {

// TODO: we can use the following callback non-interactively, i.e. to trigger background tasks
// http://javascript.info/tutorial/onload-ondomcontentloaded
document.addEventListener("DOMContentLoaded", function (
event) {
console.log(
"Instant Cquotes: DOM fully loaded and parsed"
);
});

window.addEventListener('load', init); // page fully loaded
Host.dbLog('Instant Cquotes: page load handler registered');

// Initialize (matching page loaded)
function init() {
console.log(
'Instant Cquotes: page load handler invoked');
var profile = getProfile();

Host.dbLog("Profile type is:" + profile.type);

// Dispatch to correct event handler (depending on website/URL)
// TODO: this stuff could/should be moved into the config hash itself

if (profile.type == 'wiki') {
profile.event_handler(); // just for testing
return;
}

Host.dbLog('using default mode');
document.onmouseup = instantCquote;
// HACK: preparations for moving the the event/handler logic also into the profile hash, so that the wiki (edit mode) can be handled equally
//eval(profile.event+"=instantCquote");

} // init()

}, // registerTrigger

download: function (url, callback, method = 'GET') {
// http://wiki.greasespot.net/GM_xmlhttpRequest
try {
GM_xmlhttpRequest({
method: method,
url: url,
onload: callback
});
} catch (e) {
console.log("download did not work");
}
}, // download()

// is only intended to work with archives supported by the hash
downloadPosting: function (url, EventHandler) {

Host.download(url, function (response) {
var profile = getProfile(url);
var blob = response.responseText;
var doc = Host.make_doc(blob, 'text/html');
var result = {}; // hash to be returned

[].forEach.call(['author', 'date', 'title',
'content'
], function (field) {
var xpath_query = '//' + profile[
field].xpath;
try {
var value = Host.eval_xpath(doc,
xpath_query).stringValue;
//UI.alert("extracted field value:"+value);

// now apply all transformations, if any
value = applyTransformations(
value, profile[field].transform
);

result[field] = value; // store the extracted/transormed value in the hash that we pass on
} // try
catch (e) {
UI.alert(
"downloadPosting failed:\n" +
e.message);
} // catch
}); // forEach field

EventHandler(result); // pass the result to the handler
}); // call to Host.download()

}, // downloadPosting()

// TODO: add makeAJAXCall, and makeWikiCall here

// turn a string/text blob into a DOM tree that can be queried (e.g. for xpath expressions)
// FIXME: this is browser specific not GM specific ...
make_doc: function (text, type = 'text/html') {
// to support other browsers, see: https://developer.mozilla.org/en/docs/Web/API/DOMParser
return new DOMParser().parseFromString(text, type);
}, // make DOM document

// xpath handling may be handled separately depending on browser/platform, so better encapsulate this
// FIXME: this is browser specific not GM specific ...
eval_xpath: function (doc, xpath, type = XPathResult.STRING_TYPE) {
return doc.evaluate(xpath, doc, null, type, null);
}, // eval_xpath

set_persistent: function (key, value, json = false) {
// transparently stringify to json
if (json) {
// http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
value = JSON.stringify(value);
}

// https://wiki.greasespot.net/GM_setValue
GM_setValue(key, value);
//UI.alert('Saved value for key\n'+key+':'+value);
}, // set_persistent

get_persistent: function (key, default_value, json = false) {
// https://wiki.greasespot.net/GM_getValue

var value = GM_getValue(key, default_value);
// transparently support JSON: http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
if (json) {
value = JSON.parse(value) || {};
}
return value;
}, // get_persistent

setClipboard: function (msg) {
// this being a greasemonkey user-script, we are not
// subject to usual browser restrictions
// http://wiki.greasespot.net/GM_setClipboard
GM_setClipboard(msg);
}, // setClipboard()

getTemplate: function () {

// hard-coded default template
var template = '$CONTENT<ref>{{cite web\n' +
' |url = $URL \n' +
' |title = <nowiki> $TITLE </nowiki> \n' +
' |author = <nowiki> $AUTHOR </nowiki> \n' +
' |date = $DATE \n' +
' |added = $ADDED \n' +
' |script_version = $SCRIPT_VERSION \n' +
' }}</ref>\n';

// return a saved template if found, fall back to hard-coded one above otherwise
return Host.get_persistent('default_template', template);

} // getTemplate

} // end of GreaseMonkey environment, add other environments below

}; // Environment hash - intended to help encapsulate host specific stuff (APIs)

// the first thing we need to do is to determine what APIs are available
// and store everything in a Host hash, which is subsequently used for API lookups
// the Host hash contains all platform/browser-specific APIs
var Host = Environment.getHost();
Environment.validate(Host); // this checks the obtained host to see if all required dependencies are available
Host.init(); // run environment specific initialization code (e.g. logic for GreaseMonkey setup)

// move DEBUG handling to a persistent configuration flag so that we can
// configure this using a jQuery dialog (defaulted to false)
// TODO: move DEBUG variable to Environment hash / init() routine
var DEBUG = Host.get_persistent('debug_mode_enabled', false);
Host.dbLog("Debug mode is:" + DEBUG);

function DEBUG_mode() {
// reset script invocation counter for testing purposes
Host.dbLog('Resetting script invocation counter');
Host.set_persistent(GM_info.script.version, 0);
}

if (DEBUG)
DEBUG_mode();

// hash with supported websites/URLs, includes xpath and regex expressions to
// extract certain fields, and a vector with optional transformations for
// post-processing each field

var CONFIG = {
// WIP: the first entry is special, i.e. it's not an actual list archive (source), but only added here so that the same script can be used
// for editing the FlightGear wiki

'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
// TODO: move downloadWatchlist() etc here
event_handler: function () {
console.log(
'FlightGear wiki handler active (waiting to be populated)'
);
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function (
mode) {
//dbLog("Checking trigger:"+mode.name);
if (mode.trigger()) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [{
name: 'process-editSections',
trigger: function () {
return true;
}, // match URL regex - return true for always match

// the code implementing the mode
handler: function () {

var editSections = document.getElementsByClassName(
'mw-editsection');
console.log(
'FlightGear wiki article, number of edit sections: ' +
editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(
' (instant-cquotes is lurking) '
)
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile

'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()', // NOTE this is only used by the downloadPosting helper to retrieve the posting without having a selection (TODO:add content xpath to forum hash)
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [],
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
}, {
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
}, {
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
}, {
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()',
transform: []
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
// next website/URL (forum)
'FlightGear forum': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler (not used atm)
event_handler: null, // the event handler to be invoked (not used atm)
url_reg: /https:\/\/forum\.flightgear\.org\/.*/,
content: {
xpath: '', //TODO: this must be added for downloadPosting() to work, or it cannot extract contents
selection: getSelectedHtml,
idStyle: /p[0-9]{6}/,
parentTag: [
'className',
'content',
'postbody'
],
transform: [
removeComments,
forum_quote2cquote,
forum_smilies2text,
forum_fontstyle2wikistyle,
forum_code2syntaxhighlight,
img2link,
a2wikilink,
vid2wiki,
list2wiki,
forum_br2newline
]
},
// vector with tests to be executed for sanity checks (unit testing)
// postings will be downloaded using the URL specified, and then the author/title
// fields extracted using the outer regex and matched against what is expected
// NOTE: forum postings can be edited, so that these tests would fail - thus, it makes sense to pick locked topics/postings for such tests
tests: [{
url: 'https://forum.flightgear.org/viewtopic.php?f=18&p=284108#p284108',
author: 'mickybadia',
date: 'May 3rd, 2016',
title: 'OSM still PNG maps'
}, {
url: 'https://forum.flightgear.org/viewtopic.php?f=19&p=284120#p284120',
author: 'Thorsten',
date: 'May 3rd, 2016',
title: 'Re: FlightGear\'s Screenshot Of The Month MAY 2016'
}, {
url: 'https://forum.flightgear.org/viewtopic.php?f=71&t=29279&p=283455#p283446',
author: 'Hooray',
date: 'Apr 25th, 2016',
title: 'Re: Best way to learn Canvas?'
}, {
url: 'https://forum.flightgear.org/viewtopic.php?f=4&t=1460&p=283994#p283994',
author: 'bugman',
date: 'May 2nd, 2016',
title: 'Re: eurofighter typhoon'
} // add other tests below

], // end of vector with self-tests
author: {
xpath: 'div/div[1]/p/strong/a/text()',
transform: [] // no transformations applied
},
title: {
xpath: 'div/div[1]/h3/a/text()',
transform: [] // no transformations applied
},
date: {
xpath: 'div/div[1]/p/text()[2]',
transform: [extract(/» (.*?[0-9]{4})/)]
},
url: {
xpath: 'div/div[1]/p/a/@href',
transform: [
extract(/\.(.*)/),
prepend('https://forum.flightgear.org')
] // transform vector
} // url
} // forum
}; // CONFIG has

// hash to map URLs (wiki article, issue tracker, sourceforge link, forum thread etc) to existing wiki templates
var MatchURL2Templates = [
// placeholder for now
{
name: 'rewrite sourceforge code links',
url_reg: '',
handler: function () {

} // handler

} // add other templates below

]; // MatchURL2Templates

// output methods (alert and jQuery for now)
var OUTPUT = {
// Shows a window.prompt() message box
msgbox: function (msg) {
UI.prompt('Copy to clipboard ' + Host.getScriptVersion(), msg);
Host.setClipboard(msg);
}, // msgbox

// this is currently work-in-progress, and will need to be refactored sooner or later
// for now, functionality matters more than elegant design/code :)
jQueryTabbed: function (msg, original) {
// FIXME: using backtics here makes the whole thing require ES6 ....
var markup = $(
`<div id="tabs">
<ul>
<li><a href="#selection">Selection</a></li>
<li><a href="#articles">Articles</a></li>
<li><a href="#templates">Templates</a></li>
<li><a href="#development">Development</a></li>
<li><a href="#settings">Settings</a></li>
<li><a href="#help">Help</a></li>
<li><a href="#about">About</a></li>
</ul>
<div id="selection">This tab contains your extracted and post-processed selection, converted to proper wikimedia markup, including proper attribution.
<div id="content">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="options">
<b>Note this is work-in-progress, i.e. not yet fully functional</b><br/>
<label for="article_select">Select an article to update</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="release" label="Release"/>
<optgroup id="develop" label="Development"/>
<optgroup id="watchlist" label="Watchlist"/>
</select>
<p/>
<label for="section_select">Select section:</label>
<select name="section_select" id="section_select">
</select>
</div>
</div>
<div id="articles">This tab contains articles that you can directly access/edit using the mediawiki API<br/>
Note: The watchlist is retrieved dynamically, so does not need to be edited here<br/>
<label for="article_select">Select an article</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="develop" label="Development"/>
<optgroup id="release" label="Release"/>

</select>

<button id="article_new">New</button>
<button id="article_remove">Remove</button>

<div id="edit_article">
<label for="article_name">Article</label>
<input type="text" id="article_name" name="article_name"><br/>

<label for="article_url">Link</label>
<input type="text" id="article_url" name="article_url"><br/>

<button id="article_save">Save</button>
</div>

</div>
<div id="templates">This tab contains templates for different types of articles (newsletter, changelog, release plan etc)<p/>
For now, this is WIP - in the future, there will be a dropdown menu added and all templates will be editable.<p/>
<div id="template_header">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="template_area"/>
<div id="template_controls">
<button id="template_save">Save</button>
</div>
</div>
<div id="development">This tab is a placeholder for features currently under development<p/>
<button id="evolve_regex">Evolve regex</button><p/>
<button id="test_perceptron">Test Perceptron</button><p/>
<div id="output">

<table id="results">
<thead>
<tr>
<th>Generation</th>
<th>Fitness</th>
<th>Expression</th>
<th>Result</th>
</tr>
</thead>
<tbody>
</tbody>
</table>


</div>
</div>

<div id="settings">This tab will contain script specific settings
</div>
<div id="help">One day, this tab may contain help....<p/><button id="helpButton">Instant Cquotes</button>
</div>
<div id="about">show some script related information here
</div>
</div>`
); // tabs div

var evolve_regex = $('div#development button#evolve_regex',
markup);
evolve_regex.click(function () {
//alert("Evolve regex");
evolve_expression_test();
});

var test_perceptron = $(
'div#development button#test_perceptron', markup);
test_perceptron.click(function () {
alert("Test perceptron");
});

// add dynamic elements to each tab

// NOTE: this affects all template selectors, on all tabs
$('select#template_select', markup).change(function () {
UI.alert(
"Sorry, templates are not yet fully implemented (WIP)"
);
});

var help = $('#helpButton', markup);
help.button();
help.click(function () {
window.open(
"http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes"
);
});

// rows="10"cols="80" style=" width: 420px; height: 350px"
var textarea = $(
'<textarea id="quotedtext" rows="20" cols="70"/>');
textarea.val(msg);
$('#selection #content', markup).append(textarea);

var templateArea = $(
'<textarea id="template-edit" rows="20" cols="70"/>');
templateArea.val(Host.getTemplate());
$('div#templates div#template_area', markup).append(
templateArea);

//$('#templates', markup).append($('<button>'));
$('div#templates div#template_controls button#template_save',
markup).button().click(function () {
//UI.alert("Saving template:\n"+templateArea.val() );

Host.set_persistent('default_template',
templateArea.val());
}); // save template

// TODO: Currently, this is hard-coded, but should be made customizable via the "articles" tab at some point ...
var articles = [
// NOTE: category must match an existing <optgroup> above, title must match an existing wiki article
{
category: 'support',
name: 'Frequently asked questions',
url: ''
}, {
category: 'support',
name: 'Asking for help',
url: ''
}, {
category: 'news',
name: 'Next newsletter',
url: ''
}, {
category: 'news',
name: 'Next changelog',
url: ''
}, {
category: 'release',
name: 'Release plan/Lessons learned',
url: ''
}, // TODO: use wikimedia template
{
category: 'develop',
name: 'Nasal library',
url: ''
}, {
category: 'develop',
name: 'Canvas Snippets',
url: ''
},

];

// TODO: this should be moved elsewhere
function updateArticleList(selector) {
$.each(articles, function (i, article) {
$(selector + ' optgroup#' + article.category,
markup).append($('<option>', {
value: article.name, // FIXME: just a placeholder for now
text: article.name
})); //append option
}); // foreach
} // updateArticleList

// add the article list to the corresponding dropdown menus
updateArticleList('select#article_select');

// populate watchlist (prototype for now)
// TODO: generalize & refactor: url, format

// https://www.mediawiki.org/wiki/API:Watchlist
// http://wiki.flightgear.org/api.php?action=query&list=watchlist
var watchlist_url =
'http://wiki.flightgear.org/api.php?action=query&list=watchlist&format=json';
Host.download(watchlist_url, function (response) {
try {
var watchlist = JSON.parse(response.responseText);

//$('div#options select#section_select', markup).empty(); // delete all sections

$.each(watchlist.query.watchlist, function (i,
article) {
$(
'div#options select#article_select optgroup#watchlist',
markup).append($('<option>', {
value: article.title, //FIXME just a placeholder for now
text: article.title
}));
}); //foreach section

} catch (e) {
UI.alert(e.message);
}
}); // download & populate watchlist

// register an event handler for the main tab, so that article specific sections can be retrieved
$('div#options select#article_select', markup).change(function () {
var article = this.value;

// HACK: try to get a login token (actually not needed just for reading ...)
Host.download(
'http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page',
function (response) {
var message =
'FlightGear wiki login status (AJAX):';
var status = response.statusText;

// populate dropdown menu with article sections
if (status === 'OK') {

// Resolve redirects: https://www.mediawiki.org/wiki/API:Query#Resolving_redirects
var section_url =
'http://wiki.flightgear.org/api.php?action=parse&page=' +
encodeURIComponent(article) +
'&prop=sections&format=json&redirects';
Host.download(section_url, function (
response) {
try {
var sections = JSON
.parse(response
.responseText
);

$(
'div#options select#section_select',
markup).empty(); // delete all sections

$.each(sections.parse
.sections,
function (i,
section
) {
$(
'div#options select#section_select',
markup
).append(
$(
'<option>', {
value: section
.line, //FIXME just a placeholder for now
text: section
.line
}
)
);
}); //foreach section

} catch (e) {
UI.alert(e.message);
}

}); //download sections

} // login status is OK

}); // Host.download() call, i.e. we have a login token

}); // on select change

// init the tab stuff
markup.tabs();

var diagParam = {
title: 'Instant Cquotes ' + Host.getScriptVersion(),
modal: true,
width: 700,
buttons: [{
text: 'reported speech',
click: function () {
textarea.val(createCquote(original,
true));
}
},

{
text: 'Copy',
click: function () {
Host.setClipboard(msg);
$(this).dialog('close');
}
}

]
};

// actually show our tabbed dialog using the params above
markup.dialog(diagParam);

} // jQueryTabbed()

}; // output methods

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// TODO: we can use an online API to help with some of this: http://www.eslnow.org/reported-speech-converter/
// See also: http://blog.mashape.com/list-of-25-natural-language-processing-apis/
// http://text-processing.com/docs/phrases.html
// http://www.alchemyapi.com/
// https://words.bighugelabs.com/api.php
// https://www.wordsapi.com/
// http://www.dictionaryapi.com/
// https://www.textrazor.com/
// http://www.programmableweb.com/news/how-5-natural-language-processing-apis-stack/analysis/2014/07/28

var speechTransformations = [
// TODO: support aliasing using vectors: would/should
// ordering is crucial here (most specific first, least specific/most generic last)

// first, we start off by expanding short forms: http://www.learnenglish.de/grammar/shortforms.html
// http://www.macmillandictionary.com/thesaurus-category/british/short-forms

{
query: /couldn\'t/gi,
replacement: 'could not'
}, {
query: /I could not/gi,
replacement: '$author could not'
},

{
query: /I\'m/gi,
replacement: 'I am'
}, {
query: /I am/gi,
replacement: '$author is'
},

{
query: /I\'ve/,
replacement: 'I have'
}, {
query: /I have had/,
replacement: '$author had'
},

{
query: /can(\'|\’)t/gi,
replacement: 'cannot'
},

{
query: /I(\'|\’)ll/gi,
replacement: '$author will'
}, {
query: /I(\'|\’)d/gi,
replacement: '$author would'
},

{
query: /I have done/gi,
replacement: '$author has done'
}, {
query: /I\'ve done/gi,
replacement: '$author has done'
}, //FIXME. queries should really be vectors ...

{
query: /I believe/gi,
replacement: '$author suggested'
}, {
query: /I think/gi,
replacement: '$author suggested'
}, {
query: /I guess/gi,
replacement: '$author believes'
},

{
query: /I can see that/gi,
replacement: '$author suggested that'
},

{
query: /I have got/gi,
replacement: '$author has got'
}, {
query: /I\'ve got/gi,
replacement: '$author has got'
},

{
query: /I\'d suggest/gi,
replacement: '$author would suggest'
},

{
query: /I\’m prototyping/gi,
replacement: '$author is prototyping'
},

{
query: /I myself/gi,
replacement: '$author himself'
}, {
query: /I am/gi,
replacement: ' $author is'
},

{
query: /I can see/gi,
replacement: '$author can see'
}, {
query: /I can/gi,
replacement: '$author can'
}, {
query: /I have/gi,
replacement: '$author has'
}, {
query: /I should/g,
replacement: '$author should'
}, {
query: /I shall/gi,
replacement: '$author shall'
}, {
query: /I may/gi,
replacement: '$author may'
}, {
query: /I will/gi,
replacement: '$author will'
}, {
query: /I would/gi,
replacement: '$author would'
}, {
query: /by myself/gi,
replacement: 'by $author'
}, {
query: /and I/gi,
replacement: 'and $author'
}, {
query: /and me/gi,
replacement: 'and $author'
}, {
query: /and myself/gi,
replacement: 'and $author'
}

// least specific stuff last (broad/generic stuff is kept as is, with author clarification added in parentheses)
/*
{query:/I/, replacement:'I ($author)'},
{query:/me/, replacement:'me ($author)'},
{query:/my/, replacement:'my ($author)'},
{query:/myself/, replacement:'myself ($author)'},
{query:/mine/, replacement:'$author'}
*/
];

// try to assist in transforming speech using the transformation vector passed in
// still needs to be exposed via the UI
function transformSpeech(text, author, gender, transformations) {
// WIP: foreach transformation in vector, replace the search pattern with the matched string (replacing author/gender as applicable)
//alert("text to be transformed:\n"+text);
for (var i = 0; i < transformations.length; i++) {
var token = transformations[i];
// patch the replacement string using the correct author name
var replacement = token.replacement.replace(/\$author/gi, author);
text = text.replace(token.query, replacement);
} // end of token transformation
console.log("transformed text is:" + text);
return text;
} // transformSpeech

// run a self-test

(function () {
var author = "John Doe";
var transformed = transformSpeech(
"I have decided to commit a new feature", author, null,
speechTransformations);
if (transformed !== author + " has decided to commit a new feature")
Host.dbLog(
"FIXME: Speech transformations are not working correctly");
})();
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

var MONTHS = [
'Jan',
'Feb',
'Mar',
'Apr',
'May',
'Jun',
'Jul',
'Aug',
'Sep',
'Oct',
'Nov',
'Dec'
];
// Conversion for forum emoticons
var EMOTICONS = [
[/:shock:/g,
'O_O'
],
[
/:lol:/g,
'(lol)'
],
[
/:oops:/g,
':$'
],
[
/:cry:/g,
';('
],
[
/:evil:/g,
'>:)'
],
[
/:twisted:/g,
'3:)'
],
[
/:roll:/g,
'(eye roll)'
],
[
/:wink:/g,
';)'
],
[
/:!:/g,
'(!)'
],
[
/:\?:/g,
'(?)'
],
[
/:idea:/g,
'(idea)'
],
[
/:arrow:/g,
'(->)'
],
[
/:mrgreen:/g,
'xD'
]
];
// ##################
// # Main functions #
// ##################

// the required trigger is host specific (userscript vs. addon vs. android etc)
// for now, this merely wraps window.load mapping to the instantCquote callback
// below
Host.registerTrigger();

// FIXME: function is currently referenced in CONFIG hash - event_handler, so
// cannot be easily moved across
// The main function
// TODO: split up, so that we can reuse the code elsewhere
function instantCquote(sel) {
var profile = getProfile();

// TODO: use config hash here
var selection = document.getSelection(),
post_id = 0;

try {
post_id = getPostId(selection, profile);
} catch (error) {
Host.dbLog('Failed extracting post id\nProfile:' + profile);
return;
}
if (selection.toString() === '') {
Host.dbLog('No text is selected, aborting function');
return;
}
if (!checkValid(selection, profile)) {
Host.dbLog('Selection is not valid, aborting function');
return;
}
try {
transformationLoop(profile, post_id);
} catch (e) {
UI.alert("Transformation loop:\n" + e.message);
}
} // instantCquote

// TODO: this needs to be refactored so that it can be also reused by the async/AJAX mode
// to extract fields in the background (i.e. move to a separate function)
function transformationLoop(profile, post_id) {
var output = {},
field;
Host.dbLog("Starting extraction/transformation loop");
for (field in profile) {
if (field === 'name') continue;
if (field === 'type' || field === 'event' || field === 'event_handler')
continue; // skip fields that don't contain xpath expressions
Host.dbLog("Extracting field using field id:" + post_id);
var fieldData = extractFieldInfo(profile, post_id, field);
var transform = profile[field].transform;
if (transform !== undefined) {
Host.dbLog('Field \'' + field + '\' before transformation:\n\'' +
fieldData + '\'');
fieldData = applyTransformations(fieldData, transform);
Host.dbLog('Field \'' + field + '\' after transformation:\n\'' +
fieldData + '\'');
}
output[field] = fieldData;
} // extract and transform all fields for the current profile (website)
Host.dbLog("extraction and transformation loop finished");
output.content = stripWhitespace(output.content);

var outputPlain = createCquote(output);
outputText(outputPlain, output);
} // transformationLoop()

/// #############

function runProfileTests() {

for (var profile in CONFIG) {
if (CONFIG[profile].type != 'archive' || !CONFIG[profile].enabled)
continue; // skip the wiki entry, because it's not an actual archive that we need to test
// should be really moved to downloadPostign
if (CONFIG[profile].content.xpath === '') console.log(
"xpath for content extraction is empty, cannot procedurally extract contents"
);
for (var test in CONFIG[profile].tests) {
var required_data = CONFIG[profile].tests[test];
var title = required_data.title;
//dbLog('Running test for posting titled:' + title);
// fetch posting via getPostingDataAJAX() and compare to the fields we are looking for (author, title, date)
//getPostingDataAJAX(profile, required_data.url);
//alert("required title:"+title);
} // foreach test

} // foreach profile (website)

} //runProfileTests

function selfCheckDialog() {
var sections = '<h3>Important APIs:</h3><div id="api_checks"></div>';

try {
runProfileTests.call(undefined); // check website profiles
} catch (e) {
UI.alert(e.message);
}

for (var profile in CONFIG) {
// TODO: also check if enabled or not
if (CONFIG[profile].type != 'archive') continue; // skip the wiki entry, because it's not an actual archive that we need to test
var test_results = '';
for (var test in CONFIG[profile].tests) {
// var fieldData = extractFieldInfo(profile, post_id, 'author');
test_results += CONFIG[profile].tests[test].title + '<p/>';
}
sections += '<h3>' + profile + ':<font color="blue">' + CONFIG[profile]
.url_reg + '</font></h3><div><p>' + test_results + '</p></div>\n';
} // https://jqueryui.com/accordion/

var checkDlg = $(
'<div id="selfCheck" title="Self Check dialog"><p><div id="accordion">' +
sections + '</div></p></div>');

// run all API tests, invoke the callback to obtain the status
Environment.runAPITests(Host, function (meta) {

//console.log('Running API test '+meta.name);

meta.test(function (result) {
var status = (result) ? 'success' : 'fail';
var test = $("<p></p>").text('Running API test ' +
meta.name + ':' + status);
$('#api_checks', checkDlg).append(test);
}); // update tests results

}); // runAPITests

/*
[].forEach.call(CONFIG, function(profile) {
alert("profile is:"+profile);
[].forEach.call(CONFIG[profile].tests, function(test) {

//UI.alert(test.url);
Host.downloadPosting(test.url, function(downloaded) {
alert("downloaded:");
//if (test.title == downloaded.title) alert("titles match:"+test.title);
}); //downloadPosting
}); //forEach test
}); //forEach profile
*/

//$('#accordion',checkDlg).accordion();
checkDlg.dialog({
width: 700,
height: 500,
open: function () {
// http://stackoverflow.com/questions/2929487/putting-a-jquery-ui-accordion-in-a-jquery-ui-dialog
$('#accordion').accordion({
autoHeight: true
});
}
}); // show dialog
} // selfCheckDialog

// show a simple configuration dialog (WIP)
function setupDialog() {
//alert("configuration dialog is not yet implemented");
var checked = (Host.get_persistent('debug_mode_enabled', false) === true) ?
'checked' : '';
//dbLog("value is:"+get_persistent("debug_mode_enabled"));
//dbLog("persistent debug flag is:"+checked);
var setupDiv = $(
'<div id="setupDialog" title="Setup dialog">NOTE: this configuration dialog is still work-in-progress</p><label><input id="debugcb" type="checkbox"' +
checked +
'>Enable Debug mode</label><p/><div id="progressbar"></div></div>');
setupDiv.click(function () {
//alert("changing persistent debug state");
Host.set_persistent('debug_mode_enabled', $('#debugcb').is(
':checked'));
});
//MediaWiki editing stub, based on: https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax
//only added here to show some status info in the setup dialog
Host.download(
'http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page',
function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;
var color = (status == 'OK') ? 'green' : 'red';
Host.dbLog(message + status);
var statusDiv = $('<p>' + message + status + '</p>').css(
'color', color);
setupDiv.append(statusDiv);
});
setupDiv.dialog();
} // setupDialog

// this can be used to download/cache $FG_ROOT/options.xml so that fgfs CLI arguments can be recognized and post-processed automatically
// which can help transforming postings correctly
function downloadOptionsXML() {

// download $FG_ROOT/options.xml
Host.download(
"https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml?format=raw",
function (response) {
var xml = response.responseText;
var doc = Host.make_doc(xml, 'text/xml');
// https://developer.mozilla.org/en-US/docs/Web/API/XPathResult
var options = Host.eval_xpath(doc, '//*/option', XPathResult.ORDERED_NODE_SNAPSHOT_TYPE);

// http://help.dottoro.com/ljgnejkp.php
Host.dbLog("Number of options found in options.xml:" + options.snapshotLength);

// http://help.dottoro.com/ljtfvvpx.php

// https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml

}); // end of options.xml download

} // downloadOptionsXML

function getProfile(url = undefined) {

if (url === undefined)
url = window.location.href;
else
url = url;

Host.dbLog("getProfile call URL is:" + url);

for (var profile in CONFIG) {
if (url.match(CONFIG[profile].url_reg) !== null) {
Host.dbLog('Matching website profile found');
var invocations = Host.get_persistent(Host.getScriptVersion(), 0);
Host.dbLog('Number of script invocations for version ' + Host.getScriptVersion() +
' is:' + invocations);

// determine if we want to show a config dialog
if (invocations === 0) {
Host.dbLog("ask for config dialog to be shown");
var response = UI.confirm(
'This is your first time running version ' + Host.getScriptVersion() +
'\nConfigure now?');
if (response) {

// show configuration dialog (jQuery)
setupDialog();
} else {} // don't configure

}

// increment number of invocations, use the script's version number as the key, to prevent the config dialog from showing up again (except for updated scripts)
// FIXME: this is triggered/incremented by each click ...
Host.dbLog("increment number of script invocations");
Host.set_persistent(Host.getScriptVersion(), invocations + 1);
return CONFIG[profile];
} // matched website profile
Host.dbLog('Could not find matching URL in getProfile() call!');
} // for each profile
} // Get the HTML code that is selected

function getSelectedHtml() {
// From http://stackoverflow.com/a/6668159
var html = '',
selection = document.getSelection();
if (selection.rangeCount) {
var container = document.createElement('div');
for (var i = 0; i < selection.rangeCount; i++) {
container.appendChild(selection.getRangeAt(i).cloneContents());
}
html = container.innerHTML;
}
Host.dbLog('instantCquote(): Unprocessed HTML\n\'' + html + '\'');
return html;
} // Gets the selected text

function getSelectedText() {
return document.getSelection().toString();
} // Get the ID of the post
// (this needs some work so that it can be used by the AJAX mode, without an actual selection)

function getPostId(selection, profile, focus) {
if (focus !== undefined) {
Host.dbLog("Trying to get PostId with defined focus");
selection = selection.focusNode.parentNode;
} else {
Host.dbLog("Trying to get PostId with undefined focus");
selection = selection.anchorNode.parentNode;
}
while (selection.id.match(profile.content.idStyle) === null) {
selection = selection.parentNode;
}
Host.dbLog("Selection id is:" + selection.id);
return selection.id;
}

// Checks that the selection is valid
function checkValid(selection, profile) {
var ret = true,
selection_cp = {},
tags = profile.content.parentTag;
for (var n = 0; n < 2; n++) {
if (n === 0) {
selection_cp = selection.anchorNode.parentNode;
} else {
selection_cp = selection.focusNode.parentNode;
}
while (true) {
if (selection_cp.tagName === 'BODY') {
ret = false;
break;
} else {
var cont = false;
for (var i = 0; i < tags.length; i++) {
if (selection_cp[tags[0]] === tags[i]) {
cont = true;
break;
}
}
if (cont) {
break;
} else {
selection_cp = selection_cp.parentNode;
}
}
}
}
ret = ret && (getPostId(selection, profile) === getPostId(selection,
profile, 1));
return ret;
} // Extracts the raw text from a certain place, using an XPath

function extractFieldInfo(profile, id, field) {

if (field === 'content') {
Host.dbLog("Returning content (selection)");
return profile[field].selection();
} else {
Host.dbLog("Extracting field via xpath:" + field);
var xpath = '//*[@id="' + id + '"]/' + profile[field].xpath;
return Host.eval_xpath(document, xpath).stringValue; // document.evaluate(xpath, document, null, XPathResult.STRING_TYPE, null).stringValue;
}
} // Change the text using specified transformations

function applyTransformations(fieldInfo, trans) {
for (var i = 0; i < trans.length; i++) {
fieldInfo = trans[i](fieldInfo);
Host.dbLog(
'applyTransformations(): Multiple transformation, transformation after loop #' +
(i + 1) + ':\n\'' + fieldInfo + '\'');
}
return fieldInfo;

} //applyTransformations

// Formats the quote

function createCquote(data, indirect_speech = false) {
if (!indirect_speech)
return nonQuotedRef(data); // conventional/verbatim selection
else {
// pattern match the content using a vector of regexes
data.content = transformSpeech(data.content, data.author, null,
speechTransformations);
return nonQuotedRef(data);
}
}

function nonQuotedRef(data) { //TODO: rename
var template = Host.getTemplate();

var substituted = template
.replace('$CONTENT', data.content)
.replace('$URL', data.url)
.replace('$TITLE', data.title)
.replace('$AUTHOR', data.author)
.replace('$DATE', datef(data.date))
.replace('$ADDED', datef(data.date))
.replace('$SCRIPT_VERSION', Host.getScriptVersion());

return substituted;
} //

// Output the text.
// Tries the jQuery dialog, and falls back to window.prompt()

function outputText(msg, original) {
try {
OUTPUT.jQueryTabbed(msg, original);
} catch (err) {
msg = msg.replace(/<\/syntaxhighligh(.)>/g, '</syntaxhighligh$1');
OUTPUT.msgbox(msg);
}
}

// #############
// # Utilities #
// #############

function extract(regex) {
return function (text) {
return text.match(regex)[1];
};
}

function prepend(prefix) {
return function (text) {
return prefix + text;
};
}

function removeComments(html) {
return html.replace(//g, '');
} // Not currently used (as of June 2015), but kept just in case

// currently unused
function escapePipes(html) {
html = html.replace(/\|\|/g, '{{!!}n}');
html = html.replace(/\|\-/g, '{{!-}}');
return html.replace(/\|/g, '{{!}}');
} // Converts HTML <a href="...">...</a> tags to wiki links, internal if possible.

function a2wikilink(html) {
// Links to wiki images, because
// they need special treatment, or else they get displayed.
html = html.replace(
/<a.*?href="http:\/\/wiki\.flightgear\.org\/File:(.*?)".*?>(.*?)<\/a>/g,
'[[Media:$1|$2]]');
// Wiki links without custom text.
html = html.replace(
/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>http:\/\/wiki\.flightgear\.org\/.*?<\/a>/g,
'[[$1]]');
// Links to the wiki with custom text
html = html.replace(
/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>(.*?)<\/a>/g,
'[[$1|$2]]');
// Remove underscores from all wiki links
var list = html.match(/\[\[.*?\]\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], underscore2Space(list[i]));
}
} // Convert non-wiki links
// TODO: identify forum/devel list links, and use the AJAX/Host.download helper to get a title/subject for unnamed links (using the existing xpath/regex helpers for that)

html = html.replace(/<a.*?href="(.*?)".*?>(.*?)<\/a>/g, '[$1 $2]');
// Remove triple dots from external links.
// Replace with raw URL (MediaWiki converts it to a link).
list = html.match(/\[.*?(\.\.\.).*?\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], list[i].match(/\[(.*?) .*?\]/)[1]);
}
}
return html;
} // Converts images, including images in <a> links

function img2link(html) {
html = html.replace(
/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?><\/a>/g,
'[[File:$2|250px|link=$1]]');
html = html.replace(
/<img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?>/g,
'[[File:$1|250px]]');
html = html.replace(
/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="(.*?)".*?><\/a>/g,
'(see [$2 image], links to [$1 here])');
return html.replace(/<img.*?src="(.*?)".*?>/g,
'(see the [$1 linked image])');
} // Converts smilies

function forum_smilies2text(html) {
html = html.replace(
/<img src="\.\/images\/smilies\/icon_.*?\.gif" alt="(.*?)".*?>/g,
'$1');
for (var i = 0; i < EMOTICONS.length; i++) {
html = html.replace(EMOTICONS[i][0], EMOTICONS[i][1]);
}
return html;
} // Converts font formatting

function forum_fontstyle2wikistyle(html) {
html = html.replace(/<span style="font-weight: bold">(.*?)<\/span>/g,
'\'\'\'$1\'\'\'');
html = html.replace(
/<span style="text-decoration: underline">(.*?)<\/span>/g,
'<u>$1</u>');
html = html.replace(/<span style="font-style: italic">(.*?)<\/span>/g,
'\'\'$1\'\'');
return html.replace(/<span class="posthilit">(.*?)<\/span>/g, '$1');
} // Converts code blocks

function forum_code2syntaxhighlight(html) {
var list = html.match(
/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/g),
data = [];
if (list === null) return html;
for (var n = 0; n < list.length; n++) {
data = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/);
html = html.replace(data[0], processCode(data));
}
return html;
} // Strips any whitespace from the beginning and end of a string

function stripWhitespace(html) {
html = html.replace(/^\s*?(\S)/, '$1');
return html.replace(/(\S)\s*?\z/, '$1');
} // Process code, including basic detection of language

function processCode(data) {
var lang = '',
code = data[1];
code = code.replace(/ /g, ' ');
if (code.match(/=?.*?$?.*?$?;/) !== null) lang = 'nasal';
if (code.match(/<.*?>.*?<\/.*?>/) !== null || code.match(
//) !== null) lang = 'xml';
code = code.replace(/<br\/?>/g, '\n');
return '<syntaxhighlight lang="' + lang + '" enclose="div">\n' + code +
'\n</syntaxhighlight>';
} // Converts quote blocks to Cquotes

function forum_quote2cquote(html) {
html = html.replace(
/<blockquote class="uncited"><div>(.*?)<\/div><\/blockquote>/g,
'{{cquote|$1}}');
if (html.match(/<blockquote>/g) === null) return html;
var numQuotes = html.match(/<blockquote>/g).length;
for (var n = 0; n < numQuotes; n++) {
html = html.replace(
/<blockquote><div><cite>(.*?) wrote.*?:<\/cite>(.*?)<\/div><\/blockquote>/,
'{{cquote|$2|$1}}');
}
return html;
} // Converts videos to wiki style

function vid2wiki(html) {
// YouTube
html = html.replace(
/<div class="video-wrapper">\s.*?<div class="video-container">\s*?<iframe class="youtube-player".*?width="(.*?)" height="(.*?)" src="http:\/\/www\.youtube\.com\/embed\/(.*?)".*?><\/iframe>\s*?<\/div>\s*?<\/div>/g,
'{{#ev:youtube|$3|$1x$2}}');
// Vimeo
html = html.replace(
/<iframe src="http:\/\/player\.vimeo\.com\/video\/(.*?)\?.*?" width="(.*?)" height="(.*?)".*?>.*?<\/iframe>/g,
'{{#ev:vimeo|$1|$2x$3}}');
return html.replace(/\[.*? Watch on Vimeo\]/g, '');
} // Not currently used (as of June 2015), but kept just in case

// currently unused
function escapeEquals(html) {
return html.replace(/=/g, '{{=}}');
} // <br> to newline.

function forum_br2newline(html) {
html = html.replace(/<br\/?><br\/?>/g, '\n');
return html.replace(/<br\/?>/g, '\n\n');
} // Forum list to wiki style

function list2wiki(html) {
var list = html.match(/<ul>(.*?)<\/ul>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '* $1\n');
}
}
list = html.match(/<ol.*?>(.*?)<\/ol>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '# $1\n');
}
}
html = html.replace(/<\/?[uo]l>/g, '');
return html;
}

function nowiki(text) {
return '<nowiki>' + text + '</nowiki>';
} // Returns the correct ordinal adjective

function ordAdj(date) {
date = date.toString();
if (date == '11' || date == '12' || date == '13') {
return 'th';
} else if (date.substr(1) == '1' || date == '1') {
return 'st';
} else if (date.substr(1) == '2' || date == '2') {
return 'nd';
} else if (date.substr(1) == '3' || date == '3') {
return 'rd';
} else {
return 'th';
}
}

// Formats the date to this format: Apr 26th, 2015
function datef(text) {
var date = new Date(text);
return MONTHS[date.getMonth()] + ' ' + date.getDate() + ordAdj(date.getDate()) +
', ' + date.getFullYear();
}

function underscore2Space(str) {
return str.replace(/_/g, ' ');
}

// IGNORE EVERYTHING THAT FOLLOWS:
// This is an experiment to use GA/GP (genetic programming) to help procedurally evolve xpath and regex expressions if/when the underlying websites change
// so that we don't have to manually update/edit the script accordingly (this would also work for mobile themes etc)
// For now, this is heavily based on the genetic.js framework/examples: http://subprotocol.com/system/genetic-hello-world.html
// The idea is to evolve the xpath/regex expression by evaluating its return value against the expected/desired value
// the most important thing here is having a suitable fitness function
//

function evolve_expression_test() {

try {
var genetic = Genetic.create();

// TODO: use minimizer: redundant_bytes + duration_msec + xpath.length
genetic.optimize = Genetic.Optimize.Maximize;
genetic.select1 = Genetic.Select1.Tournament2;
genetic.select2 = Genetic.Select2.Tournament2;

genetic.seed = function () {

function randomString(len) {
var text = "";
var charset =
"\\abcdefghijklmnopqrstuvwxyz0123456789[] ()<>*.,";
for (var i = 0; i < len; i++)
text += charset.charAt(Math.floor(Math.random() *
charset.length));

return text;
}

// create random strings that are equal in length to solution
return randomString(this.userData["solution"].length);
};

genetic.mutate = function (entity) {

function replaceAt(str, index, character) {
return str.substr(0, index) + character + str.substr(index +
character.length);
}

// chromosomal drift
var i = Math.floor(Math.random() * entity.length);
return replaceAt(entity, i, String.fromCharCode(entity.charCodeAt(
i) + (Math.floor(Math.random() * 2) ? 1 : -1)));
};

genetic.crossover = function (mother, father) {

// two-point crossover
var len = mother.length;
var ca = Math.floor(Math.random() * len);
var cb = Math.floor(Math.random() * len);
if (ca > cb) {
var tmp = cb;
cb = ca;
ca = tmp;
}

var son = father.substr(0, ca) + mother.substr(ca, cb - ca) +
father.substr(cb);
var daughter = mother.substr(0, ca) + father.substr(ca, cb - ca) +
mother.substr(cb);

return [son, daughter];
};

genetic.determineExcessBytes = function (text, needle) {
return text.length - needle.length;
};

genetic.containsText = function (text, needle) {
return text.search(needle);
};

genetic.isValid = function (exp) {

};

/* myFitness:
* - must be a valid xpath/regex expression (try/call)
* - must containsText the needle
* - low relative offset in text (begin/end)
* - excessBytes
* - short expression (expression length)
* - expression footprint (runtime)
*/

// TODO: the fitness function should validate each xpath/regex first

genetic.fitness = function (entity) {
var fitness = 0;
var result;
var validExp = 0.1;
var hasToken = 0.1;

var t = this.userData.tests[0].haystack;
//var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness

if (0)
try {
var regex = new RegExp(entity);
var output = t.search(regex);
validExp = 10;
}
catch (e) {
validExp = 2;
}

var i;
for (i = 0; i < entity.length; ++i) {
// increase fitness for each character that matches
if (entity[i] == this.userData["solution"][i])
fitness += 1;

// award fractions of a point as we get warmer
fitness += (127 - Math.abs(entity.charCodeAt(i) - this.userData[
"solution"].charCodeAt(i))) / 50;
}

return fitness; // + (1*validExp + 1* hasToken);
};

genetic.generation = function (pop, generation, stats) {
// stop running once we've reached the solution
return pop[0].entity != this.userData["solution"];
};

genetic.notification = function (pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b - a) * p;
}

var value = pop[0].entity;
this.last = this.last || value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i = 0; i < value.length; ++i) {
var diff = value.charCodeAt(i) - this.last.charCodeAt(i);
var style = "background: transparent;";
if (diff > 0) {
style = "background: rgb(0,200,50); color: #fff;";
} else if (diff < 0) {
style = "background: rgb(0,100,50); color: #fff;";
}

solution.push("<span style=\"" + style + "\">" + value[i] +
"</span>");
}

var t = this.userData.tests[0].haystack;
//console.log("haystack is:"+t);
// "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"}, /From: (.*) <.*@.*>/
var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness
var output = t.search(new RegExp(value));

var buf = "";
buf += "<tr>";
buf += "<td>" + generation + "</td>";
buf += "<td>" + pop[0].fitness.toPrecision(5) + "</td>";
buf += "<td>" + solution.join("") + "</td>";
buf += "<td>" + output + "</td>";
buf += "</tr>";
$("#results tbody").prepend(buf);

this.last = value;
};

/*
genetic.notification2 = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {

solution.push(value[i]);
}
console.log("Generation:"+ generation + " Fitness:" + pop[0].fitness.toPrecision(5) + " Solution:" + solution.join(""));

this.last = value;
};
*/

var config = {
"iterations": 4000,
"size": 250,
"crossover": 0.3,
"mutation": 0.4,
"skip": 30 // notifications
//, "webWorkers": false
};

/*
var profile = CONFIG['Sourceforge Mailing list'];
var posting = profile.tests[0];
var author_xpath = profile.title.xpath;
*/

var regexTests = [{
haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03",
needle: "John Doe"
}, {
haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03",
needle: "Marc Twain"
}, {
haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13",
needle: "George W. Bush"
}];

// the regex we want to evolve
var solution = "From: (.*) <.*@.*>";

// let's assume, we'd like to evolve a regex expression like this one
var userData = {
solution: solution,
tests: regexTests
};

genetic.evolve(config, userData);

//console.log("genetic.js is loaded and working, but disabled for now");

} // try
catch (e) {
console.log("genetic.js error:\n" + e.message);
} // catch

} // evolveExpression_test()

if (0) //TODO: expose via development tab
try {
// https://github.com/cazala/synaptic
var Neuron = synaptic.Neuron,
Layer = synaptic.Layer,
Network = synaptic.Network,
Trainer = synaptic.Trainer,
Architect = synaptic.Architect;

function Perceptron(input, hidden, output) {
// create the layers
var inputLayer = new Layer(input);
var hiddenLayer = new Layer(hidden);
var outputLayer = new Layer(output);

// connect the layers
inputLayer.project(hiddenLayer);
hiddenLayer.project(outputLayer);

// set the layers
this.set({
input: inputLayer,
hidden: [hiddenLayer],
output: outputLayer
});
}

// extend the prototype chain
Perceptron.prototype = new Network();
Perceptron.prototype.constructor = Perceptron;

var myPerceptron = new Perceptron(2, 3, 1);
var myTrainer = new Trainer(myPerceptron);

myTrainer.XOR(); // { error: 0.004998819355993572, iterations: 21871, time: 356 }

myPerceptron.activate([0, 0]); // 0.0268581547421616
myPerceptron.activate([1, 0]); // 0.9829673642853368
myPerceptron.activate([0, 1]); // 0.9831714267395621
myPerceptron.activate([1, 1]); // 0.02128894618097928

console.log("Syntaptic loaded");
} catch (e) {
UI.alert(e.message);
}
</syntaxhighlight>

{{Appendix}}

FlightGear wiki:Instant-Refs

2016-05-20T13:10:33Z

Elgaton: /* The script */ Script beautified

[[File:Quotes-logo-200x200.png|thumb]]
[[File:Instant-cquotes-firefox.png|thumb|Instant-Cquotes script in Firefox]]

[[File:Ref-only-quotes.png|thumb|Instant-Cquotes screenshot prototyping runtime format selection]]

The '''Instant-Cquotes''' script is a browser addon (user script) implemented in JavaScript in order to convert excerpts (created via copy&paste) from FlightGear forum or [[mailing list]] postings into MediaWiki markup/quotes to be used on the FlightGear wiki. It is supported by Firefox, Google Chrome/Chromium, Opera and Safari. It is being developed and maintained by a group of volunteers involved in maintaining the wiki and in trying to provide more up-to-date information to end-users who may not be as involved in the various FlightGear-related communication channels.

== Background and motivation ==
FlightGear's development is, at best, "self-coordinated", meaning that contributors discuss ideas and make proposals to contribute in a certain fashion and then team up to implement certain features and building blocks, often just temporarily.

Unfortunately, due to a lack of development manpower, many ideas are not implemented immediately; it is, thus, important to know their pros and cons, as well as who originally proposed them and/or might help with their implementation, even after a long time, preferably with links to the original discussions so that new contributors can decide whether to get involved in some effort or not. The project documentation, however, is in great need of improvement<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/15444440/
| title = <nowiki>[Flightgear-devel] development process (was: chaos...)</nowiki>
| author = <nowiki>John Denker</nowiki>
| date = Jul 16th, 2007
| added = Jul 16th, 2007
| script_version = 0.23
}}</ref> and usually significantly lacking behind:<ref name="OlsonStateThingsFG">{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861667/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Curtis Olson</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> many core developers update it seldomly, if not anymore, as it takes time to write it, as well as an understanding of the inner workings of a complex system such as FlightGear. Furthermore, this task might not be attractive due to its short term impact on the project,<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861562/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Hal V. Engel</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> and it is overwhelming to think about creating documentation that would address the needs of many different kinds of contributors with different backgrounds, experience levels and goals.<ref name="OlsonStateThingsFG" />

Forum and mailing lists discussions have therefore become the only up-to-date (albeit difficult to filter)<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=280058#p280058
| title = <nowiki>Re: quoting on the wiki</nowiki>
| author = <nowiki>Thorsten</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> source of information about recent development progress; this makes it tricky to know what is going on, what needs fixing, what were the decisions taken by the developers.<ref>{{cite web
| url = https://www.mail-archive.com/flightgear-devel%40lists.sourceforge.net/msg17198.html
| title = <nowiki>[Flightgear-devel] Project tracking</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mon, 28 Jul 2008 10:06:05 -0700
}}</ref>

The aim of the Instant-Cquotes script is to help wiki editors to copy relevant excerpts from such sources, formatting them as proper [[Template:Cquote|quotations]], and bootstrap new articles collecting them until a dedicated rewrite is made. It can also be used to reuse announcements to update the changelogs, [[Next newsletter|newsletter]] or the [[Release plan/Lessons learned]] page.

After being away from the wiki system for some time it becomes more of an effort to re-learn how to start a new file and figure out how to format it , with what headings, etc. Sometimes it is almost too much to do the original write up of the original post and all the work of that layout and effort to have to also duplicate it in a wiki article. If I was a little more current and affluent with the wiki editor, I might not be so hesitant to create the work there instead of the forum.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=284698#p284698
|title = <nowiki> Re: Breaking down NLCD raster image </nowiki>
|author = <nowiki> wlbragg </nowiki>
|date = May 9th, 2016
|added = May 9th, 2016
|script_version = 0.38
}}</ref>

In a few cases, such collections of quotes helped not only create bootstrap new articles, but even actual features.

In other cases, quotes have been used to update documentation of features (e.g. [[Rembrandt]]) whose maintainers may not be actively involved in FlightGear, to help document discussions that are taking place in the meantime, and provide some background information for people interested in the corresponding feature.

== Installation ==
# Install a user script manager. On Firefox, you can use [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey]; on Chrome/Chromium, Opera or Safari, you can use [https://tampermonkey.net/ Tampermonkey] (download links: [https://tampermonkey.net/index.php?ext=dhdg&browser=chrome Chrome/Chromium], [https://tampermonkey.net/index.php?ext=dhdg&browser=opera Opera], [https://tampermonkey.net/index.php?ext=dhdg&browser=safari Safari]).
# Visit [https://greasyfork.org/en/scripts/19331-instant-cquotes the Instant-Cquotes page on GreasyFork] and click on {{button|Install this script}} (green button). If Greasemonkey/Tampermonkey prompts you to confirm the installation, agree to do so.

[[File:Howto-install-instant-cquotes.png|thumb|Click the green button to install the script]]

=== Manual installation ===
{{note|This will install the most recent development version of the script, which might contain bugs. Also, GreaseMonkey/TamperMonkey will not update it automatically whenever a new version is released.}}

* '''Firefox'''
# Install Greasemonkey.
# Save [[#The Script|the script]] below as <code>instant_cquotes.user.js</code>, then drag-and-drop it into Firefox.
[[File:Greasemonkey-setup-on-firefox.png|thumb|Screenshot showing the Greasemonkey setup dialog (on Firefox)]]

* '''Chrome/Chromium''', '''Opera''', or '''Safari'''
# Install Tampermonkey.
# Navigate to '''Add a new Script'''.
# Copy and paste [[#The Script|the script]] below into the editing window.
# Click the {{button|Save}} button (just above the {{button|Search}} button).

=== Mobile installation ===
As of May 2016, there is no separate version available for mobile use. Your best chance is installing a userscript addon on Android, like one of those:
* [https://play.google.com/store/apps/details?id=net.biniok.tampermonkey Tampermonkey (Google Play Store)]
* [http://oilcan.jsharkey.org/ OilCan: Greasemonkey on steroids for Android]

For installation instructions, refer to [https://openuserjs.org/about/Tampermonkey-for-Android Tampermonkey for Android] or [http://www.blogtechnika.com/how-to-access-greasemonkey-scripts-on-android-phones/ How To Access Greasemonkey Scripts on Android Phones].

Testing/feedback would obviously be appreciated - if in doubt, feel free to just edit the wiki page to add your findings/questions.

=== Configuration ===
[[File:User-script-menu.png|thumb|GreaseMonkey menu shown in FireFox with instanct cquotes menu items]]

[[File:Config-dialog-instant-cquotes.png|thumb|The configuration dialog for the Instant-Cquotes script]]

As of version 0.30, a dedicated configuration dialog is in the process of being added, so that certain script features can be dynamically configured, without having to edit the script. For now, this is merely a placeholder that provides a checkbox to easily enable/disable the debug mode. In the future, we are hoping to also expose other features this way.

== Usage ==
[[File:Updated-cquotes-script-by-redleader.png|thumb|Instant-Cquotes script, with updates contributed by Red Leader]]

[[File:New-cquotes.png|thumb|Screenshot showing Instant-Cquotes 0.30 at work]]

# Go to some [[mailing list]] archive URL, for example [http://sourceforge.net/p/flightgear/mailman/message/32400727/] or any forum message, such as {{forumref|title=Re: Get objects to show up on Map/Radar|t=23299|label=p212558|f=71}}.
# Select the relevant portion of text.
# When you release the mouse button, a box will appear containing the converted text (for now, mainly properly-referenced quotes for the wiki).
# The text will be automatically selected and copied to the clipboard.
# Paste the text into the desired wiki page.

For example, by selecting part of the forum post in the link above you can get the following quotation:

{{FGCquote
|1= The upcoming FlightGear version (3.2) will contain a canvas-based map dialog, including a modular "plugin" system for creating custom map layers and charts with roughly ~50 lines of code, most of it boilerplate.
This is entirely XML/Nasal based (scripted) - symbols can be pretty much anything, raster or vector images (png or svg), but even animated. Styling can be customied, too.
For more info, I suggest to check out:
[[MapStructure#Porting the map dialog]]

[[File:MapStructureDialog.png|250px]]
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=212558#p212558
| title = <nowiki>Re: Get objects to show up on Map/Radar</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Jun 14th, 2014
}}
}}

=== On quoting ===
{{Main article|FlightGear wiki:Quoting Guidelines}}

Using the Instant-Cquotes script is a good way to bootstrap and write some preliminary notes; however, while quotes might be useful to understand how undocumented subsystems and features work and are definitely better than nothing, they are not meant to replace proper, structured and well-written wiki articles.<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=282800#p282800
| title = <nowiki>Re: What is the QT launcher?</nowiki>
| author = <nowiki>bugman</nowiki>
| date = Apr 17th, 2016
| added = Apr 17th, 2016
| script_version = 0.25
}}</ref>

One way to convert pages bootstrapped using quotes is to extract relevant information from them and keep citations only as references; in case important details are missing, they can be asked for on the [[Mailing lists|mailing lists]] (on the forum, the chance to get a complete answer might be lower).<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34954385/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> Another option might be moving the quotes to the Talk page for each entry, which would preserve the sources without clogging up the articles.<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34948989/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>Stuart Buchanan</nowiki>
| date = Mar 19th, 2016
| added = Mar 19th, 2016
| script_version = 0.25
}}</ref>

As a matter of fact, the whole paragraph above was assembled using this approach; to see for yourself, look up the references at the end of this page. For another example, see [[TerraSync#News]].

== Development ==
{{Note|A Chrome/Chromium-specific extension that will not need Tampermonkey installed is under development.}}

=== Resources ===
* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/API:Edit

=== Adding sources ===

Adding a new source is pretty straightforward if you understand how xpath and regexes work - basically, you only need an archive (e.g. gmane), and then determine the xpath of each relevant field, as well as the regular expression to process the extracted fields (optional).

The basic steps are these:
# open the user script in an editor
# navigate to the meta header of the user script
# add a new URL to the top of the script, e.g. by copying/adapting an existing line like this:
<syntaxhighlight lang="javascript">
// @match https://sourceforge.net/p/flightgear/mailman/*
</syntaxhighlight>

Once copied, add the new URL:

<syntaxhighlight lang="javascript">
// @match http://thread.gmane.org/gmane.games.flightgear.devel/*
</syntaxhighlight>

Next, you need to navigate to the configuration hash to add a new website to it.

Again, it makes sense to simply take an existing configuration hash and adapt it as needed (ignore/omit the tests vector for now by keeping it empty):

{{Caution|the following example may meanwhile be outdated, so be sure to look at the actual code instead}}

<syntaxhighlight lang="javascript">
'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()',
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [] // vector with transformation callbacks
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()'
transform: []
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
</syntaxhighlight>

Now, we need to review/adapt the profile according to the new archive we'd like to see supported.

for starters, that means:
* changing the name of the profile, e.g. to read gmane (instead of sourceforge)
* change the '''url_reg''' field to the gmane URL (this can be a regular expression)

Next, it makes sense to use an [https://addons.mozilla.org/de/firefox/addon/xpath-checker/ XPath checker], so that we can look up the xpath expression for various HTML elements, and add those to the configuration hash above.

For testing purposes, you will probably go to the setup dialog and enable the DEBUG mode, and use your browser's console to see what is going on.

=== Getting involved ===
While having some experience with JavaScript/HTML and jQuery will definitely be useful, JavaScript is close enough to FlightGear scripting ([[Nasal]]), so that people can get involved pretty easily.

Most maintenance work will typically involve reviewing/maintaining a few configuration hashes, that contain meta information for each supported archive (mailing list/forum).

Usually, each hash contains a combination of xpath/regex expressions to look up the relevant information, as well as vector of optional transformations that are applied (in order) to convert contents to a different format (e.g. dates).

In addition, there is growing library of utility functions, a handful wrappers for useful stuff, for example:

* <code>Host.dbLog(message_string)</code> - log a message to the console if the DEBUG flag is set
* <code>Host.download(url, callback, method='GET')</code> - will download the URL and pass the downloaded content to the callback specified
* <code>Host.downloadPosting(url, callback)</code> - will download the posting URL and pass the extracted and transformed author/content and date fields in a hash to the callback specified, the URL must be one supported in the CONFIG hash (i.e. forum/sourceforge for now)
* <code>Host.make_doc(string, type="text/html")</code> - will turn a string/blob into a DOM that can be queried
* <code>Host.eval_xpath(document, xpath_expression, type=XPathResult.STRING_TYPE)</code> - will apply the xpath expression to the document specified, returning the requested type (defaulted to string)
* <code>Host.set_persistent(key,value)</code> - stores a key/value pair
* <code>Host.get_persistent(key,default_value)</code> - retrieves a values using the key specified, falling back to the default value

=== Porting ===
[[File:Instant-cquote-firefox-addon-mode.png|thumb|Prototyping a dedicated instant-cquote mode for use as a firefox addon]]

Porting the script to support other browsers/script engines is greatly appreciated. Typically, this should be pretty self-contained, because all main APIs are intended to be encapsulated in a so called "Environment" hash, where APIs that are specific to a particular browser/script engine should be provided with a wrapper. As of mid 2016, most APIs are now kept inside such an Environment hash (look at the GreaseMonkey hash for reference/details), so that it is now even possible to turn the script into a standalone FireFox addon without having to change much of the underlying code.

=== Self checks (unit testing) ===
For regression testing purposes, there's a dedicated "self check" dialog that will be extended over time. For now it will download a few profile/website specific postings using a vector called "tests" and then log the posting's title, author and date to the console.

The next step will be actually showing that information in the dialog itself - there's a separate helper function to accomplish that, so that the corresponding div layer can be updated with the results.

[[File:Sanity-check-cquotes-dialog.png|thumb|automatically executed sanity checks]]

=== Debug mode ===
[[File:Instant-cquotes-debug-mode.png|thumb|Instant-Cquotes debug mode]]

=== AJAX (live page editing) ===
{{WIP}}

* http://wiki.flightgear.org/api.php
* http://wiki.flightgear.org/api.php?action=parse&page=Frequently%20asked%20questions&prop=sections

For now, the setup dialog will try to obtain a login token for the wiki and show a message if successful.

In addition, the profile/website hash also contains a new wiki entry for the FlightGear wiki, whose '''event_handler''' callback will be invoked once the FG wiki is visited - the console/log will show a greeting, so that is where other code can be added - e.g. to help clean up/rewrite FGCquote-based articles automatically etc.

There is a vector of "modes", whose members are a hash containing trigger/handler fields, linked to two callbacks - the trigger callback can be used to check some condition, while the handler will be invoked if the trigger returns true.

This can be used to support an arbitrary number of modes, whose triggers are evaluated during page load - all triggers that return true, will have their handlers invoked, which is how the following snippet works to rewrite/augment wiki edit handles:

<syntaxhighlight lang="javascript>
'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile
</syntaxhighlight>

See [[User:Red Leader/Sandbox/AJAX test]]

* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/Extension:VisualEditor
* https://en.wikipedia.org/wiki/Wikipedia:Creating_a_bot

=== Mobile edition ===
{{Note|As of 02/2016, Hooray is contemplating to make this available as an addon for Android phones.}}

=== Issues/limitations ===
==== Bugs ====
* It's eating characters, apparently related to regex/xpath handling - e.g. words like "analyzing" are turned into "analying" [http://forum.flightgear.org/viewtopic.php?f=6&t=28378&p=270735&hilit=analyzing#p270735]
==== Non working URLs ====
* image matching/extraction: http://forum.flightgear.org/viewtopic.php?p=276221#p276221
* http://sourceforge.net/p/flightgear/mailman/message/34754961/
* http://forum.flightgear.org/viewtopic.php?f=18&t=27054&start=90#p273972 → selecting from “As promised, two sample installation sessions on Linux” to “That's it.” towards the end of the message causes Iceweasel (Firefox) 44.0.2 to display a dialog box reading “A script on this page may be busy, or it may have stopped responding. You can stop the script now, open the script in the debugger, or let the script continue.” The line below reads “Script: chrome://greasemonkey-modules/...quotes/instant_cquotes.user.js:544”. Choosing ''Continue'' doesn't help: the same message reappears a few seconds afterwards.

=== Feature requests & ideas ===
* try to recognize list items [https://sourceforge.net/p/flightgear/mailman/message/35095319/] (heuristics: look for colon/asterisk, dashes and CR/LF)
* should add [[Template:News]] to the article dropdown for announcements [http://wiki.flightgear.org/index.php?title=Template:News&oldid=98266]
* add a mode that will download screenshots from forum postings and automatically upload/categorize them, see [[Birds]]
* split the article dropdown into sections, and also populate it with the user's watchlist [https://www.mediawiki.org/wiki/API:Watchlist] {{Progressbar|60}}
* mailing list templates, listed at [http://wiki.flightgear.org/Template_talk:Project_infrastructure#Related_mailing_list_templates]
* expose the cquote/ref markup via the UI so that it can be edited/customized and treated like a template {{Done}} (0.36+)
* identify common/repeated links and automatically create [[Template:Project infrastructure|link/infrastructure templates]] and use those (should be straightforward using the AJAX mode) [http://wiki.flightgear.org/index.php?title=Mailing_lists&curid=2038&diff=97876&oldid=85252]
* add a devel/maintainer mode where it will return the xpath for a selection [http://stackoverflow.com/questions/361130/get-selected-text-and-selected-nodes-on-a-page] [http://stackoverflow.com/questions/12485334/get-surrounding-dom-node-of-selection]
* move openlink,dblog helpers to Environment hash {{Done}}
* identify CLI arguments like --aircraft=c172p and wrap them in between code tags <code>--aircraft=c172p</code> [https://sourceforge.net/p/flightgear/mailman/message/35063277/] (note that we can simply download [https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml options.xml] via openlink() and use that, which is kinda of neat...) {{Progressbar|60}} (see downloadOptionsXML() in the code)
* introduce "layouts" (templates) for different purposes: newsletter, changelog, wiki article, [[The Manual]] (LaTex) ? {{Progressbar|40}}
* use wikipedia template if possible [https://sourceforge.net/p/flightgear/mailman/message/35057670/]
* the new '''tests''' vector could also contain vectors for tests to test the extract/transform* utilities, see Environment.APITests {{Progressbar|50}}
* move environment specific APIs (browser, script host etc) into some kind of Environment hash to encapsulate things (Red Leader was working on a pure Chrome-only version at some point IIRC) {{Progressbar|80}}
* encode script settings in created markup, for future processing/updating of quotes
* look up <code>[x]</code> references and replace with the corresponding link (titled) [https://sourceforge.net/p/flightgear/mailman/message/35055331/] [https://sourceforge.net/p/flightgear/mailman/message/35062598/]
** convert footnotes into Abbr templates [http://article.gmane.org/gmane.games.flightgear.devel/78971]
* support named refs for combining identical refs [http://wiki.flightgear.org/index.php?title=FlightGear_Qt_launcher&curid=13693&diff=97562&oldid=97551]
* adopt [[Template:Forumref]]
* implement a less obnoxious quoting mode, without quotes, where only the ref part would be added, e.g. see the example at [[Graphics Card Profiles]] (it's still 99% quotes, but much less annoying) {{Done}}
* attachment support: identify attachments and link to them: [https://sourceforge.net/p/flightgear/mailman/message/11683451/] [https://sourceforge.net/p/flightgear/mailman/message/23906620/] [https://sourceforge.net/p/flightgear/mailman/message/35059842/] [https://sourceforge.net/p/flightgear/mailman/message/35067087/]
* bulletin points: if there is a colon (:) followed by at least two dashes (-), split up everything after the colon to turn each dash into an asterisk (wiki markup for bulletin points), followed by a newline [http://sourceforge.net/p/flightgear/mailman/message/34760165/]
* generic URL/template matching, e.g. for for sourceforge commit IDs
* make filters/conversions configurable via checkboxes (nowiki, wrap in alert/note boxes)
* make syntax highlighting configurable (language, mode) ?
* consider using something like the Roles template to turn contributor names into tooltips where contributor roles are shown (core dev, fgdata committer etc)
* introduce support for tag clouds to help categorize/classify related quotes
* consider making transformations optional/configurable using check boxes in the jQuery dialog
* add new input method, for quotes that need to be updated/converted (added script version specifically for this purpose), should also add extraction/processing date
* investigate why not all mailing list archives/postings are supported correctly: http://sourceforge.net/p/flightgear/mailman/message/8090479/ (problem traced to <code>getPostID()</code>)
* explore having a ref-only mode without using cquotes, i.e. just copy/paste quotes with proper ref tags and a references section, to rewrite the whole thing (possibly with templates for different purposes, e.g. newsletter/changelog) {{Done}}
* should use Template:Forumref (category:link templates)
* should be updated to use the new repo/flightgear file templates created by Johan & RedLeader {{Not done}}
* resolve links to forum threads to look up the title for the topic/posting, so that the posting's title can be used for those links, instead of just the URL - we can probably do that by making an AJAX call to open URLs asynchronously and extract the title for the thread/posting to come up with something like <code>[http://forum.flightgear.org/viewtopic.php?f=4&t=24421 A call to developers-Lockheed -L188 Electra]</code> ([http://forum.flightgear.org/viewtopic.php?f=4&t=26562&p=247325&hilit=links#p247347]) {{Progressbar|50}}
* convert quoted bug tracker URLs to use the issue template on the wiki {{not done}}
* do regex/xpath validation, and display any errors (e.g. template/theme changes on the forum would currently break the script) {{Progressbar|60}}
* increased focus on supporting different output formats, maybe using a simple [http://www.jquery-steps.com/ jQuery based wizard] (wiki, forum, newsletter, changelog) {{Not done}}
* token matching for keywords/acronyms to link to the corresponding wiki articles (e.g. Nasal, Canvas, FG_ROOT, FG_HOME etc) {{Not done}}
* Add support for [http://sourceforge.net/p/flightgear/codetickets/ tickets], merge requests comments and [http://www.fguk.eu/index.php/forum/index FGUK forum]. (also see [[FlightGear wiki talk:Instant-Cquotes#more sources]])
* GET-encoded SID arguments should be stripped from forum URLs. {{Not done}}
* Links to repositories should be converted to use wiki templates. {{Not done}}
* The {{Abbr|regexes|regular expressions}} used may fail if the HTML DOM of the source changes (e.g., phpBB/theme update)
** Show a warning when that's the case. {{Progressbar|70}} (see the self-check dialog)
** Try multiple regexes in order. {{Progressbar|30}} (see the self-check dialog)
* Use the script to update previously created Cquotes automatically
** Instead of using the <code>getSelection()</code> helper, we could register a match for <tt>wiki.flightgear.org</tt> with <code>action=edit</code> set, so that we can directly process all text of an edited page, using AJAX calls to open the URL in the background. {{Progressbar|40}} (see the self-check dialog, available via the greasemonkey menu)
** See [https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax MW:API:Edit § Editing via Ajax]

=== Changelog ===
{{Note|Contributors are invited to document their changes here, please also add your wiki handle so that others can more easily get in touch.}}

* first stab at implementing unit tests by adding a vector with URLS to be downloaded and fields to be matched (WIP), shown in a jQuery dialog
* support for persistent settings and a jQuery setup dialog with persistence
* hosting is moved, to allow auto-updates [http://www.greasespot.net/2012/02/automatic-script-updates-come-to.html] [https://wiki.greasespot.net/Metadata_Block#.40updateURL] [http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating]
* changed to ref-only quotes for now, not using the FGCquote template anymore, due to its obnoxious appearance on quote-heavy pages (should probably become a runtime option instead)
* updated to use https for forum postings
* add version info to each created quote, i.e. for future updates
* add helper for opening websites asynchronously using AJAX (also via GM helper API)
* display version number in output dialog
* begin using the GreaseMonkey API for setting clipboard content

== The script ==
<gallery mode=packed widths=230px heights=230px>
Instant-cquotes-revamped.png|Instant cquotes: Revamped user interface exposes script internals to make the script better configurable at runtime
Instant-cquotes-template-editor.png|Instant cquotes now features a simple built-in template editor with support for variable substitution, so that wiki templates can be more easily customized
Instant-cquotes-with-wikimedia-API-integration.png|Screenshot showing instant-cquotes with wikimedia API integration to fetch articles/sections and populate dropdown menus accordingly
Instant-cquotes-on-steroids-with-watchlist-support.png|Screenshot showing the JQuery-mode of the instant cquotes script with built-in support for fetching a user's wiki/watchlist to edit/update articles in a semi-automated fashion
</gallery>
{{PD-author|FlightGear contributors}}

{{Note|Anybody interested in contributing to the code is invited to directly edit this wiki article. From 05/2016, the script is hosted on GreasyFork to allow automatic updates. If you'd like to see your changes applied, please bump the version number and [[User:Elgaton|Elgaton]] will upload it in the state it was when the version number was bumped. ''Make sure to perform thorough testing'' before the bump to prevent unexpected breakage; it is generally a good idea to validate your changes using an online syntax checker, e.g.:
* http://jshint.com/
* http://esprima.org/demo/validate.html
* http://codebeautify.org/jsvalidate
<p/>Thank you!}}

Changes that should be mentioned in the changelog, should be added below (and moved to the [[#Changelog]] section subsequently:

* preparations for adding support to download fgdata related files like options.xml to automatically regex known CLI commands
* preparatory work for adding a speech-rewrite engine to assist in converting 1st person speech to 3rd person
* framework for encapsulating userscript specifics in an environment hash to provide better updating/porting support

<syntaxhighlight lang="javascript" enclose="div">// ==UserScript==
// @name Instant-Cquotes
// @name:it Instant-Cquotes
// @license public domain
// @version 0.39
// @date 2016-05-20
// @description Automatically converts selected FlightGear mailing list and forum quotes into post-processed MediaWiki markup (i.e. cquotes).
// @description:it Converte automaticamente citazioni dalla mailing list e dal forum di FlightGear in marcatori MediaWiki (cquote).
// @author Hooray, bigstones, Philosopher, Red Leader & Elgaton (2013-2016)
// @supportURL http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @icon http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @match https://sourceforge.net/p/flightgear/mailman/*
// @match http://sourceforge.net/p/flightgear/mailman/*
// @match https://forum.flightgear.org/*
// @match http://wiki.flightgear.org/*
// @namespace http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @run-at document-start
// @require https://code.jquery.com/jquery-1.10.2.js
// @require https://code.jquery.com/ui/1.11.4/jquery-ui.js
// @require https://cdn.jsdelivr.net/genetic.js/0.1.14/genetic.js
// @require https://cdn.jsdelivr.net/synaptic/1.0.4/synaptic.min.js
// @resource jQUI_CSS https://code.jquery.com/ui/1.11.4/themes/smoothness/jquery-ui.css
// @resource myLogo http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @grant GM_registerMenuCommand
// @grant GM_setValue
// @grant GM_getValue
// @grant GM_addStyle
// @grant GM_getResourceText
// @grant GM_getResourceURL
// @grant GM_setClipboard
// @grant GM_xmlhttpRequest
// @noframes
// ==/UserScript==

// This work has been released into the public domain by their authors. This
// applies worldwide.
// In some countries this may not be legally possible; if so:
// The authors grant anyone the right to use this work for any purpose, without
// any conditions, unless such conditions are required by law.

// This script has a number of dependencies that are implicitly satisfied when
// run as a user script via GreaseMonkey/TamperMonkey; however, these need to
// be explicitly handled when using a different mode (e.g. Firefox/Android):
//
// - jQuery - user interface (REQUIRED)
// - genetic-js - genetic programming (OPTIONAL/EXPERIMENTAL)
// - synaptic - neural networks (OPTIONAL/EXPERIMENTAL)

/* Here are some TODOs
* - support RSS feeds http://dir.gmane.org/gmane.games.flightgear.devel/
* - move event handling/processing to the CONFIG hash
* - use try/catch more widely
* - wrap function calls in try/call for better debugging/diagnostics
* - add helpers for [].forEach.call, map, apply and call
* - replace for/in, for/of, let statements for better compatibility (dont require ES6)
* - for the same reason, replace use of functions with default params
* - isolate UI (e.g. JQUERY) code in UserInterface hash
* - expose regex/transformations via the UI
*/

/*jslint
devel
*/

'use strict';

// prevent conflicts with jQuery used on webpages:
// https://wiki.greasespot.net/Third-Party_Libraries#jQuery
// http://stackoverflow.com/a/5014220
// TODO: move to GreaseMonkey/UI host
this.$ = this.jQuery = jQuery.noConflict(true);

// this hash is just intended to help isolate UI specifics so that we don't
// need to maintain/port tons of code
var UserInterface = {
get: function () {
return UserInterface.DEFAULT;
},

CONSOLE: {
}, // CONSOLE (shell, mainly useful for testing)

DEFAULT: {
alert: function (msg) {
return window.alert(msg);
},
prompt: function (msg) {
return window.prompt(msg);
},
confirm: function (msg) {
return window.confirm(msg);
},
dialog: null,
selection: null,
populateWatchlist: function () {
},
populateEditSections: function () {
}
}, // default UI mapping (Browser/User script)

JQUERY: {
} // JQUERY
}; // UserInterface

var UI = UserInterface.get(); // DEFAULT for now

// This hash is intended to help encapsulate platform specifics (browser/
// scripting host). Ideally, all APIs that are platform specific should be
// kept here. This should make it much easier to update/port and maintain the
// script in the future.
var Environment = {
getHost: function (xpi = false) {

if (xpi) {
Environment.scriptEngine = 'firefox addon';
console.log('in firefox xpi/addon mode');
return Environment.FirefoxAddon; // HACK for testing the xpi mode (firefox addon)
}

// This will determine the script engine in use: http://stackoverflow.com/questions/27487828/how-to-detect-if-a-userscript-is-installed-from-the-chrome-store
if (typeof (GM_info) === 'undefined') {
Environment.scriptEngine =
"plain Chrome (Or Opera, or scriptish, or Safari, or rarer)";
// See http://stackoverflow.com/a/2401861/331508 for optional browser sniffing code.
} else {
Environment.scriptEngine = GM_info.scriptHandler ||
"Greasemonkey";
}
console.log('Instant cquotes is running on ' + Environment.scriptEngine +
'.');

// console.log("not in firefox addon mode...");
// See also: https://wiki.greasespot.net/Cross-browser_userscripting
return Environment.GreaseMonkey; // return the only/default host (for now)
},

validate: function (host) {
if (host.get_persistent('startup.disable_validation', false))
return;

if (Environment.scriptEngine !== "Greasemonkey")
console.log(
"NOTE: This script has not been tested with script engines"
+ " other than GreaseMonkey recently!"
);

var dependencies = [{
name: 'jQuery',
test: function () {}
}, {
name: 'genetic.js',
test: function () {}
}, {
name: 'synaptic',
test: function () {}
}, ];

[].forEach.call(dependencies, function (dep) {
console.log("Checking for dependency:" + dep.name);
var status = false;
try {
dep.test.call(undefined);
status = true;
} catch (e) {
status = false;
} finally {
var success = (status) ? '==> success' :
'==> failed';
console.log(success);
return status;
}
});
}, // validate

// this contains unit tests for checking crucial APIs that must work for
// the script to work correctly
// for the time being, most of these are stubs waiting to be filled in
// for a working example, refer to the JSON test at the end
// TODO: add jQuery tests
APITests: [{
name: 'download',
test: function (recipient) {
recipient(true);
}
}, {
name: 'make_doc',
test: function (recipient) {
recipient(true);
}
}, {
name: 'eval_xpath',
test: function (recipient) {
recipient(true);
}
}, {
name: 'JSON de/serialization',
test: function (recipient) {
//console.log("running json test");
var identifier = 'unit_tests.json_serialization';
var hash1 = {
x: 1,
y: 2,
z: 3
};
Host.set_persistent(identifier, hash1, true);
var hash2 = Host.get_persistent(identifier, null,
true);

recipient(JSON.stringify(hash1) === JSON.stringify(
hash2));
} // callback
},

// downloads a posting and tries to transform it to 3rd person speech ...
// TODO: add another test to check forum postings
{
name: 'text/speech transformation',
test: function (recipient) {

// the posting we want to download
var url =
'https://sourceforge.net/p/flightgear/mailman/message/35066974/';
Host.downloadPosting(url, function (result) {

// only process the first sentence by using comma/dot as
// delimiter
var firstSentence = result.content.substring(
result.content.indexOf(',') + 1,
result.content.indexOf('.'));

var transformed = transformSpeech(
firstSentence, result.author,
null, speechTransformations);
console.log(
"3rd person speech transformation:\n" +
transformed);

recipient(true);
}); // downloadPosting()

} // test()
}, // end of speech transform test
{
name: "download $FG_ROOT/options.xml",
test: function (recipient) {
downloadOptionsXML();
recipient(true);
} // test
}

], // end of APITests

runAPITests: function (host, recipient) {
console.log("Running API tests");
for (let test of Environment.APITests) {
//var test = Environment.APITests[t];
// invoke the callback passed, with the hash containing the test
// specs, so that the console/log or a div can be updated showing
// the test results
recipient.call(undefined, test);

} // foreach test
}, // runAPITests

/*
* ========================================================================
*/

// NOTE: This mode/environment is WIP and highly experimental ...
// To see this working, you need to package up the whole file as a Firefox
// XPI using "jpm xpi" and then start the whole thing via "jpm run", to do
// that, you also need a matching package.json (i.e. via jpm init)
// ALSO: you will have to explicitly install any dependencies using jpm
FirefoxAddon: {
init: function () {
console.log("Firefox addon mode ...");
},
getScriptVersion: function () {
return '0.36'; // FIXME
},
dbLog: function (msg) {
console.log(msg);
},
addEventListener: function (ev, cb) {

require("sdk/tabs").on("ready", logURL);

function logURL(tab) {
console.log("URL loaded:" + tab.url);
}
},

registerConfigurationOption: function (name, callback, hook) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
console.log("config menu support n/a in firefox mode");
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Using_third-party_modules_%28jpm%29
var menuitems = require("menuitem");
var menuitem = menuitems.Menuitem({
id: "clickme",
menuid: "menu_ToolsPopup",
label: name,
onCommand: function () {
console.log("menuitem clicked:");
callback();
},
insertbefore: "menu_pageInfo"
});
},

registerTrigger: function () {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/context-menu#Item%28options%29
var contextMenu = require("sdk/context-menu");
var menuItem = contextMenu.Item({
label: "Instant Cquote",
context: contextMenu.SelectionContext(),
// https://developer.mozilla.org/en/Add-ons/SDK/Guides/Two_Types_of_Scripts
// https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts
contentScript: 'self.on("click", function () {' +
' var text = window.getSelection().toString();' +
' self.postMessage(text);' +
'});',
onMessage: function (selectionText) {
console.log(selectionText);
instantCquote(selectionText);
}
});

// for selection handling stuff, see: https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/selection

function myListener() {
console.log("A selection has been made.");
}
var selection = require("sdk/selection");
selection.on('select', myListener);

}, //registerTrigger

get_persistent: function (key, default_value) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/simple-storage
var ss = require("sdk/simple-storage");

console.log(
"firefox mode does not yet have persistence support"
);
return default_value;
},
set_persistent: function (key, value) {
console.log("firefox persistence stubs not yet filled in !");
},
set_clipboard: function (content) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/clipboard

//console.log('clipboard stub not yet filled in ...');
var clipboard = require("sdk/clipboard");
clipboard.set(content);
} //set_cliipboard

}, // end of FireFox addon config

// placeholder for now ...
Android: {
// NOP
}, // Android

///////////////////////////////////////
// supported script engines:
///////////////////////////////////////

GreaseMonkey: {
// TODO: move environment specific initialization code here
init: function () {
// Check if Greasemonkey/Tampermonkey is available
try {
// TODO: add version check for clipboard API and check for TamperMonkey/Scriptish equivalents?
GM_addStyle(GM_getResourceText('jQUI_CSS'));
} // try
catch (error) {
console.log(
'Could not add style or determine script version'
);
} // catch

var commands = [{
name: 'Setup quotes',
callback: setupDialog,
hook: 'S'
}, {
name: 'Check quotes',
callback: selfCheckDialog,
hook: 'C'
}];

for (let c of commands) {
this.registerConfigurationOption(c.name, c.callback, c.hook);
}

}, // init()

getScriptVersion: function () {
return GM_info.script.version;
},

dbLog: function (message) {
if (Boolean(DEBUG)) {
console.log('Instant cquotes:' + message);
}
}, // dbLog()

registerConfigurationOption: function (name, callback, hook) {
// https://wiki.greasespot.net/GM_registerMenuCommand
// https://wiki.greasespot.net/Greasemonkey_Manual:Monkey_Menu#The_Menu
GM_registerMenuCommand(name, callback, hook);
}, //registerMenuCommand()

registerTrigger: function () {

// TODO: we can use the following callback non-interactively, i.e. to trigger background tasks
// http://javascript.info/tutorial/onload-ondomcontentloaded
document.addEventListener("DOMContentLoaded", function (
event) {
console.log(
"Instant Cquotes: DOM fully loaded and parsed"
);
});

window.addEventListener('load', init); // page fully loaded
Host.dbLog('Instant Cquotes: page load handler registered');

// Initialize (matching page loaded)
function init() {
console.log(
'Instant Cquotes: page load handler invoked');
var profile = getProfile();

Host.dbLog("Profile type is:" + profile.type);

// Dispatch to correct event handler (depending on website/URL)
// TODO: this stuff could/should be moved into the config hash itself

if (profile.type == 'wiki') {
profile.event_handler(); // just for testing
return;
}

Host.dbLog('using default mode');
document.onmouseup = instantCquote;
// HACK: preparations for moving the the event/handler logic also into the profile hash, so that the wiki (edit mode) can be handled equally
//eval(profile.event+"=instantCquote");

} // init()

}, // registerTrigger

download: function (url, callback, method = 'GET') {
// http://wiki.greasespot.net/GM_xmlhttpRequest
try {
GM_xmlhttpRequest({
method: method,
url: url,
onload: callback
});
} catch (e) {
console.log("download did not work");
}
}, // download()

// is only intended to work with archives supported by the hash
downloadPosting: function (url, EventHandler) {

Host.download(url, function (response) {
var profile = getProfile(url);
var blob = response.responseText;
var doc = Host.make_doc(blob, 'text/html');
var result = {}; // hash to be returned

[].forEach.call(['author', 'date', 'title',
'content'
], function (field) {
var xpath_query = '//' + profile[
field].xpath;
try {
var value = Host.eval_xpath(doc,
xpath_query).stringValue;
//UI.alert("extracted field value:"+value);

// now apply all transformations, if any
value = applyTransformations(
value, profile[field].transform
);

result[field] = value; // store the extracted/transormed value in the hash that we pass on
} // try
catch (e) {
UI.alert(
"downloadPosting failed:\n" +
e.message);
} // catch
}); // forEach field

EventHandler(result); // pass the result to the handler
}); // call to Host.download()

}, // downloadPosting()

// TODO: add makeAJAXCall, and makeWikiCall here

// turn a string/text blob into a DOM tree that can be queried (e.g. for xpath expressions)
// FIXME: this is browser specific not GM specific ...
make_doc: function (text, type = 'text/html') {
// to support other browsers, see: https://developer.mozilla.org/en/docs/Web/API/DOMParser
return new DOMParser().parseFromString(text, type);
}, // make DOM document

// xpath handling may be handled separately depending on browser/platform, so better encapsulate this
// FIXME: this is browser specific not GM specific ...
eval_xpath: function (doc, xpath, type = XPathResult.STRING_TYPE) {
return doc.evaluate(xpath, doc, null, type, null);
}, // eval_xpath

set_persistent: function (key, value, json = false) {
// transparently stringify to json
if (json) {
// http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
value = JSON.stringify(value);
}

// https://wiki.greasespot.net/GM_setValue
GM_setValue(key, value);
//UI.alert('Saved value for key\n'+key+':'+value);
}, // set_persistent

get_persistent: function (key, default_value, json = false) {
// https://wiki.greasespot.net/GM_getValue

var value = GM_getValue(key, default_value);
// transparently support JSON: http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
if (json) {
value = JSON.parse(value) || {};
}
return value;
}, // get_persistent

setClipboard: function (msg) {
// this being a greasemonkey user-script, we are not
// subject to usual browser restrictions
// http://wiki.greasespot.net/GM_setClipboard
GM_setClipboard(msg);
}, // setClipboard()

getTemplate: function () {

// hard-coded default template
var template = '$CONTENT<ref>{{cite web\n' +
' |url = $URL \n' +
' |title = <nowiki> $TITLE </nowiki> \n' +
' |author = <nowiki> $AUTHOR </nowiki> \n' +
' |date = $DATE \n' +
' |added = $ADDED \n' +
' |script_version = $SCRIPT_VERSION \n' +
' }}</ref>\n';

// return a saved template if found, fall back to hard-coded one above otherwise
return Host.get_persistent('default_template', template);

} // getTemplate

} // end of GreaseMonkey environment, add other environments below

}; // Environment hash - intended to help encapsulate host specific stuff (APIs)

// the first thing we need to do is to determine what APIs are available
// and store everything in a Host hash, which is subsequently used for API lookups
// the Host hash contains all platform/browser-specific APIs
var Host = Environment.getHost();
Environment.validate(Host); // this checks the obtained host to see if all required dependencies are available
Host.init(); // run environment specific initialization code (e.g. logic for GreaseMonkey setup)

// move DEBUG handling to a persistent configuration flag so that we can
// configure this using a jQuery dialog (defaulted to false)
// TODO: move DEBUG variable to Environment hash / init() routine
var DEBUG = Host.get_persistent('debug_mode_enabled', false);
Host.dbLog("Debug mode is:" + DEBUG);

function DEBUG_mode() {
// reset script invocation counter for testing purposes
Host.dbLog('Resetting script invocation counter');
Host.set_persistent(GM_info.script.version, 0);
}

if (DEBUG)
DEBUG_mode();

// hash with supported websites/URLs, includes xpath and regex expressions to
// extract certain fields, and a vector with optional transformations for
// post-processing each field

var CONFIG = {
// WIP: the first entry is special, i.e. it's not an actual list archive (source), but only added here so that the same script can be used
// for editing the FlightGear wiki

'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
// TODO: move downloadWatchlist() etc here
event_handler: function () {
console.log(
'FlightGear wiki handler active (waiting to be populated)'
);
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function (
mode) {
//dbLog("Checking trigger:"+mode.name);
if (mode.trigger()) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [{
name: 'process-editSections',
trigger: function () {
return true;
}, // match URL regex - return true for always match

// the code implementing the mode
handler: function () {

var editSections = document.getElementsByClassName(
'mw-editsection');
console.log(
'FlightGear wiki article, number of edit sections: ' +
editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(
' (instant-cquotes is lurking) '
)
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile

'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()', // NOTE this is only used by the downloadPosting helper to retrieve the posting without having a selection (TODO:add content xpath to forum hash)
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [],
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
}, {
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
}, {
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
}, {
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()',
transform: []
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
// next website/URL (forum)
'FlightGear forum': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler (not used atm)
event_handler: null, // the event handler to be invoked (not used atm)
url_reg: /https:\/\/forum\.flightgear\.org\/.*/,
content: {
xpath: '', //TODO: this must be added for downloadPosting() to work, or it cannot extract contents
selection: getSelectedHtml,
idStyle: /p[0-9]{6}/,
parentTag: [
'className',
'content',
'postbody'
],
transform: [
removeComments,
forum_quote2cquote,
forum_smilies2text,
forum_fontstyle2wikistyle,
forum_code2syntaxhighlight,
img2link,
a2wikilink,
vid2wiki,
list2wiki,
forum_br2newline
]
},
// vector with tests to be executed for sanity checks (unit testing)
// postings will be downloaded using the URL specified, and then the author/title
// fields extracted using the outer regex and matched against what is expected
// NOTE: forum postings can be edited, so that these tests would fail - thus, it makes sense to pick locked topics/postings for such tests
tests: [{
url: 'https://forum.flightgear.org/viewtopic.php?f=18&p=284108#p284108',
author: 'mickybadia',
date: 'May 3rd, 2016',
title: 'OSM still PNG maps'
}, {
url: 'https://forum.flightgear.org/viewtopic.php?f=19&p=284120#p284120',
author: 'Thorsten',
date: 'May 3rd, 2016',
title: 'Re: FlightGear\'s Screenshot Of The Month MAY 2016'
}, {
url: 'https://forum.flightgear.org/viewtopic.php?f=71&t=29279&p=283455#p283446',
author: 'Hooray',
date: 'Apr 25th, 2016',
title: 'Re: Best way to learn Canvas?'
}, {
url: 'https://forum.flightgear.org/viewtopic.php?f=4&t=1460&p=283994#p283994',
author: 'bugman',
date: 'May 2nd, 2016',
title: 'Re: eurofighter typhoon'
} // add other tests below

], // end of vector with self-tests
author: {
xpath: 'div/div[1]/p/strong/a/text()',
transform: [] // no transformations applied
},
title: {
xpath: 'div/div[1]/h3/a/text()',
transform: [] // no transformations applied
},
date: {
xpath: 'div/div[1]/p/text()[2]',
transform: [extract(/» (.*?[0-9]{4})/)]
},
url: {
xpath: 'div/div[1]/p/a/@href',
transform: [
extract(/\.(.*)/),
prepend('https://forum.flightgear.org')
] // transform vector
} // url
} // forum
}; // CONFIG has

// hash to map URLs (wiki article, issue tracker, sourceforge link, forum thread etc) to existing wiki templates
var MatchURL2Templates = [
// placeholder for now
{
name: 'rewrite sourceforge code links',
url_reg: '',
handler: function () {

} // handler

} // add other templates below

]; // MatchURL2Templates

// output methods (alert and jQuery for now)
var OUTPUT = {
// Shows a window.prompt() message box
msgbox: function (msg) {
UI.prompt('Copy to clipboard ' + Host.getScriptVersion(), msg);
Host.setClipboard(msg);
}, // msgbox

// this is currently work-in-progress, and will need to be refactored sooner or later
// for now, functionality matters more than elegant design/code :)
jQueryTabbed: function (msg, original) {
// FIXME: using backtics here makes the whole thing require ES6 ....
var markup = $(
`<div id="tabs">
<ul>
<li><a href="#selection">Selection</a></li>
<li><a href="#articles">Articles</a></li>
<li><a href="#templates">Templates</a></li>
<li><a href="#development">Development</a></li>
<li><a href="#settings">Settings</a></li>
<li><a href="#help">Help</a></li>
<li><a href="#about">About</a></li>
</ul>
<div id="selection">This tab contains your extracted and post-processed selection, converted to proper wikimedia markup, including proper attribution.
<div id="content">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="options">
<b>Note this is work-in-progress, i.e. not yet fully functional</b><br/>
<label for="article_select">Select an article to update</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="release" label="Release"/>
<optgroup id="develop" label="Development"/>
<optgroup id="watchlist" label="Watchlist"/>
</select>
<p/>
<label for="section_select">Select section:</label>
<select name="section_select" id="section_select">
</select>
</div>
</div>
<div id="articles">This tab contains articles that you can directly access/edit using the mediawiki API<br/>
Note: The watchlist is retrieved dynamically, so does not need to be edited here<br/>
<label for="article_select">Select an article</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="develop" label="Development"/>
<optgroup id="release" label="Release"/>

</select>

<button id="article_new">New</button>
<button id="article_remove">Remove</button>

<div id="edit_article">
<label for="article_name">Article</label>
<input type="text" id="article_name" name="article_name"><br/>

<label for="article_url">Link</label>
<input type="text" id="article_url" name="article_url"><br/>

<button id="article_save">Save</button>
</div>

</div>
<div id="templates">This tab contains templates for different types of articles (newsletter, changelog, release plan etc)<p/>
For now, this is WIP - in the future, there will be a dropdown menu added and all templates will be editable.<p/>
<div id="template_header">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="template_area"/>
<div id="template_controls">
<button id="template_save">Save</button>
</div>
</div>
<div id="development">This tab is a placeholder for features currently under development<p/>
<button id="evolve_regex">Evolve regex</button><p/>
<button id="test_perceptron">Test Perceptron</button><p/>
<div id="output">

<table id="results">
<thead>
<tr>
<th>Generation</th>
<th>Fitness</th>
<th>Expression</th>
<th>Result</th>
</tr>
</thead>
<tbody>
</tbody>
</table>


</div>
</div>

<div id="settings">This tab will contain script specific settings
</div>
<div id="help">One day, this tab may contain help....<p/><button id="helpButton">Instant Cquotes</button>
</div>
<div id="about">show some script related information here
</div>
</div>`
); // tabs div

var evolve_regex = $('div#development button#evolve_regex',
markup);
evolve_regex.click(function () {
//alert("Evolve regex");
evolve_expression_test();
});

var test_perceptron = $(
'div#development button#test_perceptron', markup);
test_perceptron.click(function () {
alert("Test perceptron");
});

// add dynamic elements to each tab

// NOTE: this affects all template selectors, on all tabs
$('select#template_select', markup).change(function () {
UI.alert(
"Sorry, templates are not yet fully implemented (WIP)"
);
});

var help = $('#helpButton', markup);
help.button();
help.click(function () {
window.open(
"http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes"
);
});

// rows="10"cols="80" style=" width: 420px; height: 350px"
var textarea = $(
'<textarea id="quotedtext" rows="20" cols="70"/>');
textarea.val(msg);
$('#selection #content', markup).append(textarea);

var templateArea = $(
'<textarea id="template-edit" rows="20" cols="70"/>');
templateArea.val(Host.getTemplate());
$('div#templates div#template_area', markup).append(
templateArea);

//$('#templates', markup).append($('<button>'));
$('div#templates div#template_controls button#template_save',
markup).button().click(function () {
//UI.alert("Saving template:\n"+templateArea.val() );

Host.set_persistent('default_template',
templateArea.val());
}); // save template

// TODO: Currently, this is hard-coded, but should be made customizable via the "articles" tab at some point ...
var articles = [
// NOTE: category must match an existing <optgroup> above, title must match an existing wiki article
{
category: 'support',
name: 'Frequently asked questions',
url: ''
}, {
category: 'support',
name: 'Asking for help',
url: ''
}, {
category: 'news',
name: 'Next newsletter',
url: ''
}, {
category: 'news',
name: 'Next changelog',
url: ''
}, {
category: 'release',
name: 'Release plan/Lessons learned',
url: ''
}, // TODO: use wikimedia template
{
category: 'develop',
name: 'Nasal library',
url: ''
}, {
category: 'develop',
name: 'Canvas Snippets',
url: ''
},

];

// TODO: this should be moved elsewhere
function updateArticleList(selector) {
$.each(articles, function (i, article) {
$(selector + ' optgroup#' + article.category,
markup).append($('<option>', {
value: article.name, // FIXME: just a placeholder for now
text: article.name
})); //append option
}); // foreach
} // updateArticleList

// add the article list to the corresponding dropdown menus
updateArticleList('select#article_select');

// populate watchlist (prototype for now)
// TODO: generalize & refactor: url, format

// https://www.mediawiki.org/wiki/API:Watchlist
// http://wiki.flightgear.org/api.php?action=query&list=watchlist
var watchlist_url =
'http://wiki.flightgear.org/api.php?action=query&list=watchlist&format=json';
Host.download(watchlist_url, function (response) {
try {
var watchlist = JSON.parse(response.responseText);

//$('div#options select#section_select', markup).empty(); // delete all sections

$.each(watchlist.query.watchlist, function (i,
article) {
$(
'div#options select#article_select optgroup#watchlist',
markup).append($('<option>', {
value: article.title, //FIXME just a placeholder for now
text: article.title
}));
}); //foreach section

} catch (e) {
UI.alert(e.message);
}
}); // download & populate watchlist

// register an event handler for the main tab, so that article specific sections can be retrieved
$('div#options select#article_select', markup).change(function () {
var article = this.value;

// HACK: try to get a login token (actually not needed just for reading ...)
Host.download(
'http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page',
function (response) {
var message =
'FlightGear wiki login status (AJAX):';
var status = response.statusText;

// populate dropdown menu with article sections
if (status === 'OK') {

// Resolve redirects: https://www.mediawiki.org/wiki/API:Query#Resolving_redirects
var section_url =
'http://wiki.flightgear.org/api.php?action=parse&page=' +
encodeURIComponent(article) +
'&prop=sections&format=json&redirects';
Host.download(section_url, function (
response) {
try {
var sections = JSON
.parse(response
.responseText
);

$(
'div#options select#section_select',
markup).empty(); // delete all sections

$.each(sections.parse
.sections,
function (i,
section
) {
$(
'div#options select#section_select',
markup
).append(
$(
'<option>', {
value: section
.line, //FIXME just a placeholder for now
text: section
.line
}
)
);
}); //foreach section

} catch (e) {
UI.alert(e.message);
}

}); //download sections

} // login status is OK

}); // Host.download() call, i.e. we have a login token

}); // on select change

// init the tab stuff
markup.tabs();

var diagParam = {
title: 'Instant Cquotes ' + Host.getScriptVersion(),
modal: true,
width: 700,
buttons: [{
text: 'reported speech',
click: function () {
textarea.val(createCquote(original,
true));
}
},

{
text: 'Copy',
click: function () {
Host.setClipboard(msg);
$(this).dialog('close');
}
}

]
};

// actually show our tabbed dialog using the params above
markup.dialog(diagParam);

} // jQueryTabbed()

}; // output methods

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// TODO: we can use an online API to help with some of this: http://www.eslnow.org/reported-speech-converter/
// See also: http://blog.mashape.com/list-of-25-natural-language-processing-apis/
// http://text-processing.com/docs/phrases.html
// http://www.alchemyapi.com/
// https://words.bighugelabs.com/api.php
// https://www.wordsapi.com/
// http://www.dictionaryapi.com/
// https://www.textrazor.com/
// http://www.programmableweb.com/news/how-5-natural-language-processing-apis-stack/analysis/2014/07/28

var speechTransformations = [
// TODO: support aliasing using vectors: would/should
// ordering is crucial here (most specific first, least specific/most generic last)

// first, we start off by expanding short forms: http://www.learnenglish.de/grammar/shortforms.html
// http://www.macmillandictionary.com/thesaurus-category/british/short-forms

{
query: /couldn\'t/gi,
replacement: 'could not'
}, {
query: /I could not/gi,
replacement: '$author could not'
},

{
query: /I\'m/gi,
replacement: 'I am'
}, {
query: /I am/gi,
replacement: '$author is'
},

{
query: /I\'ve/,
replacement: 'I have'
}, {
query: /I have had/,
replacement: '$author had'
},

{
query: /can(\'|\’)t/gi,
replacement: 'cannot'
},

{
query: /I(\'|\’)ll/gi,
replacement: '$author will'
}, {
query: /I(\'|\’)d/gi,
replacement: '$author would'
},

{
query: /I have done/gi,
replacement: '$author has done'
}, {
query: /I\'ve done/gi,
replacement: '$author has done'
}, //FIXME. queries should really be vectors ...

{
query: /I believe/gi,
replacement: '$author suggested'
}, {
query: /I think/gi,
replacement: '$author suggested'
}, {
query: /I guess/gi,
replacement: '$author believes'
},

{
query: /I can see that/gi,
replacement: '$author suggested that'
},

{
query: /I have got/gi,
replacement: '$author has got'
}, {
query: /I\'ve got/gi,
replacement: '$author has got'
},

{
query: /I\'d suggest/gi,
replacement: '$author would suggest'
},

{
query: /I\’m prototyping/gi,
replacement: '$author is prototyping'
},

{
query: /I myself/gi,
replacement: '$author himself'
}, {
query: /I am/gi,
replacement: ' $author is'
},

{
query: /I can see/gi,
replacement: '$author can see'
}, {
query: /I can/gi,
replacement: '$author can'
}, {
query: /I have/gi,
replacement: '$author has'
}, {
query: /I should/g,
replacement: '$author should'
}, {
query: /I shall/gi,
replacement: '$author shall'
}, {
query: /I may/gi,
replacement: '$author may'
}, {
query: /I will/gi,
replacement: '$author will'
}, {
query: /I would/gi,
replacement: '$author would'
}, {
query: /by myself/gi,
replacement: 'by $author'
}, {
query: /and I/gi,
replacement: 'and $author'
}, {
query: /and me/gi,
replacement: 'and $author'
}, {
query: /and myself/gi,
replacement: 'and $author'
}

// least specific stuff last (broad/generic stuff is kept as is, with author clarification added in parentheses)
/*
{query:/I/, replacement:'I ($author)'},
{query:/me/, replacement:'me ($author)'},
{query:/my/, replacement:'my ($author)'},
{query:/myself/, replacement:'myself ($author)'},
{query:/mine/, replacement:'$author'}
*/
];

// try to assist in transforming speech using the transformation vector passed in
// still needs to be exposed via the UI
function transformSpeech(text, author, gender, transformations) {
// WIP: foreach transformation in vector, replace the search pattern with the matched string (replacing author/gender as applicable)
//alert("text to be transformed:\n"+text);
for (var i = 0; i < transformations.length; i++) {
var token = transformations[i];
// patch the replacement string using the correct author name
var replacement = token.replacement.replace(/\$author/gi, author);
text = text.replace(token.query, replacement);
} // end of token transformation
console.log("transformed text is:" + text);
return text;
} // transformSpeech

// run a self-test

(function () {
var author = "John Doe";
var transformed = transformSpeech(
"I have decided to commit a new feature", author, null,
speechTransformations);
if (transformed !== author + " has decided to commit a new feature")
Host.dbLog(
"FIXME: Speech transformations are not working correctly");
})();
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

var MONTHS = [
'Jan',
'Feb',
'Mar',
'Apr',
'May',
'Jun',
'Jul',
'Aug',
'Sep',
'Oct',
'Nov',
'Dec'
];
// Conversion for forum emoticons
var EMOTICONS = [
[/:shock:/g,
'O_O'
],
[
/:lol:/g,
'(lol)'
],
[
/:oops:/g,
':$'
],
[
/:cry:/g,
';('
],
[
/:evil:/g,
'>:)'
],
[
/:twisted:/g,
'3:)'
],
[
/:roll:/g,
'(eye roll)'
],
[
/:wink:/g,
';)'
],
[
/:!:/g,
'(!)'
],
[
/:\?:/g,
'(?)'
],
[
/:idea:/g,
'(idea)'
],
[
/:arrow:/g,
'(->)'
],
[
/:mrgreen:/g,
'xD'
]
];
// ##################
// # Main functions #
// ##################

// the required trigger is host specific (userscript vs. addon vs. android etc)
// for now, this merely wraps window.load mapping to the instantCquote callback
// below
Host.registerTrigger();

// FIXME: function is currently referenced in CONFIG hash - event_handler, so
// cannot be easily moved across
// The main function
// TODO: split up, so that we can reuse the code elsewhere
function instantCquote(sel) {
var profile = getProfile();

// TODO: use config hash here
var selection = document.getSelection(),
post_id = 0;

try {
post_id = getPostId(selection, profile);
} catch (error) {
Host.dbLog('Failed extracting post id\nProfile:' + profile);
return;
}
if (selection.toString() === '') {
Host.dbLog('No text is selected, aborting function');
return;
}
if (!checkValid(selection, profile)) {
Host.dbLog('Selection is not valid, aborting function');
return;
}
try {
transformationLoop(profile, post_id);
} catch (e) {
UI.alert("Transformation loop:\n" + e.message);
}
} // instantCquote

// TODO: this needs to be refactored so that it can be also reused by the async/AJAX mode
// to extract fields in the background (i.e. move to a separate function)
function transformationLoop(profile, post_id) {
var output = {},
field;
Host.dbLog("Starting extraction/transformation loop");
for (field in profile) {
if (field === 'name') continue;
if (field === 'type' || field === 'event' || field === 'event_handler')
continue; // skip fields that don't contain xpath expressions
Host.dbLog("Extracting field using field id:" + post_id);
var fieldData = extractFieldInfo(profile, post_id, field);
var transform = profile[field].transform;
if (transform !== undefined) {
Host.dbLog('Field \'' + field + '\' before transformation:\n\'' +
fieldData + '\'');
fieldData = applyTransformations(fieldData, transform);
Host.dbLog('Field \'' + field + '\' after transformation:\n\'' +
fieldData + '\'');
}
output[field] = fieldData;
} // extract and transform all fields for the current profile (website)
Host.dbLog("extraction and transformation loop finished");
output.content = stripWhitespace(output.content);

var outputPlain = createCquote(output);
outputText(outputPlain, output);
} // transformationLoop()

/// #############

function runProfileTests() {

for (var profile in CONFIG) {
if (CONFIG[profile].type != 'archive' || !CONFIG[profile].enabled)
continue; // skip the wiki entry, because it's not an actual archive that we need to test
// should be really moved to downloadPostign
if (CONFIG[profile].content.xpath === '') console.log(
"xpath for content extraction is empty, cannot procedurally extract contents"
);
for (var test in CONFIG[profile].tests) {
var required_data = CONFIG[profile].tests[test];
var title = required_data.title;
//dbLog('Running test for posting titled:' + title);
// fetch posting via getPostingDataAJAX() and compare to the fields we are looking for (author, title, date)
//getPostingDataAJAX(profile, required_data.url);
//alert("required title:"+title);
} // foreach test

} // foreach profile (website)

} //runProfileTests

function selfCheckDialog() {
var sections = '<h3>Important APIs:</h3><div id="api_checks"></div>';

try {
runProfileTests.call(undefined); // check website profiles
} catch (e) {
UI.alert(e.message);
}

for (var profile in CONFIG) {
// TODO: also check if enabled or not
if (CONFIG[profile].type != 'archive') continue; // skip the wiki entry, because it's not an actual archive that we need to test
var test_results = '';
for (var test in CONFIG[profile].tests) {
// var fieldData = extractFieldInfo(profile, post_id, 'author');
test_results += CONFIG[profile].tests[test].title + '<p/>';
}
sections += '<h3>' + profile + ':<font color="blue">' + CONFIG[profile]
.url_reg + '</font></h3><div><p>' + test_results + '</p></div>\n';
} // https://jqueryui.com/accordion/

var checkDlg = $(
'<div id="selfCheck" title="Self Check dialog"><p><div id="accordion">' +
sections + '</div></p></div>');

// run all API tests, invoke the callback to obtain the status
Environment.runAPITests(Host, function (meta) {

//console.log('Running API test '+meta.name);

meta.test(function (result) {
var status = (result) ? 'success' : 'fail';
var test = $("<p></p>").text('Running API test ' +
meta.name + ':' + status);
$('#api_checks', checkDlg).append(test);
}); // update tests results

}); // runAPITests

/*
[].forEach.call(CONFIG, function(profile) {
alert("profile is:"+profile);
[].forEach.call(CONFIG[profile].tests, function(test) {

//UI.alert(test.url);
Host.downloadPosting(test.url, function(downloaded) {
alert("downloaded:");
//if (test.title == downloaded.title) alert("titles match:"+test.title);
}); //downloadPosting
}); //forEach test
}); //forEach profile
*/

//$('#accordion',checkDlg).accordion();
checkDlg.dialog({
width: 700,
height: 500,
open: function () {
// http://stackoverflow.com/questions/2929487/putting-a-jquery-ui-accordion-in-a-jquery-ui-dialog
$('#accordion').accordion({
autoHeight: true
});
}
}); // show dialog
} // selfCheckDialog

// show a simple configuration dialog (WIP)
function setupDialog() {
//alert("configuration dialog is not yet implemented");
var checked = (Host.get_persistent('debug_mode_enabled', false) === true) ?
'checked' : '';
//dbLog("value is:"+get_persistent("debug_mode_enabled"));
//dbLog("persistent debug flag is:"+checked);
var setupDiv = $(
'<div id="setupDialog" title="Setup dialog">NOTE: this configuration dialog is still work-in-progress</p><label><input id="debugcb" type="checkbox"' +
checked +
'>Enable Debug mode</label><p/><div id="progressbar"></div></div>');
setupDiv.click(function () {
//alert("changing persistent debug state");
Host.set_persistent('debug_mode_enabled', $('#debugcb').is(
':checked'));
});
//MediaWiki editing stub, based on: https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax
//only added here to show some status info in the setup dialog
Host.download(
'http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page',
function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;
var color = (status == 'OK') ? 'green' : 'red';
Host.dbLog(message + status);
var statusDiv = $('<p>' + message + status + '</p>').css(
'color', color);
setupDiv.append(statusDiv);
});
setupDiv.dialog();
} // setupDialog

// this can be used to download/cache $FG_ROOT/options.xml so that fgfs CLI arguments can be recognized and post-processed automatically
// which can help transforming postings correctly
function downloadOptionsXML() {

// download $FG_ROOT/options.xml
Host.download(
"https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml?format=raw",
function (response) {
var xml = response.responseText;
var doc = Host.make_doc(xml, 'text/xml');
// https://developer.mozilla.org/en-US/docs/Web/API/XPathResult
var options = Host.eval_xpath(doc, '//*/option', XPathResult.ORDERED_NODE_SNAPSHOT_TYPE);

// http://help.dottoro.com/ljgnejkp.php
Host.dbLog("Number of options found in options.xml:" + options.snapshotLength);

// http://help.dottoro.com/ljtfvvpx.php

// https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml

}); // end of options.xml download

} // downloadOptionsXML

function getProfile(url = undefined) {

if (url === undefined)
url = window.location.href;
else
url = url;

Host.dbLog("getProfile call URL is:" + url);

for (var profile in CONFIG) {
if (url.match(CONFIG[profile].url_reg) !== null) {
Host.dbLog('Matching website profile found');
var invocations = Host.get_persistent(Host.getScriptVersion(), 0);
Host.dbLog('Number of script invocations for version ' + Host.getScriptVersion() +
' is:' + invocations);

// determine if we want to show a config dialog
if (invocations === 0) {
Host.dbLog("ask for config dialog to be shown");
var response = UI.confirm(
'This is your first time running version ' + Host.getScriptVersion() +
'\nConfigure now?');
if (response) {

// show configuration dialog (jQuery)
setupDialog();
} else {} // don't configure

}

// increment number of invocations, use the script's version number as the key, to prevent the config dialog from showing up again (except for updated scripts)
// FIXME: this is triggered/incremented by each click ...
Host.dbLog("increment number of script invocations");
Host.set_persistent(Host.getScriptVersion(), invocations + 1);
return CONFIG[profile];
} // matched website profile
Host.dbLog('Could not find matching URL in getProfile() call!');
} // for each profile
} // Get the HTML code that is selected

function getSelectedHtml() {
// From http://stackoverflow.com/a/6668159
var html = '',
selection = document.getSelection();
if (selection.rangeCount) {
var container = document.createElement('div');
for (var i = 0; i < selection.rangeCount; i++) {
container.appendChild(selection.getRangeAt(i).cloneContents());
}
html = container.innerHTML;
}
Host.dbLog('instantCquote(): Unprocessed HTML\n\'' + html + '\'');
return html;
} // Gets the selected text

function getSelectedText() {
return document.getSelection().toString();
} // Get the ID of the post
// (this needs some work so that it can be used by the AJAX mode, without an actual selection)

function getPostId(selection, profile, focus) {
if (focus !== undefined) {
Host.dbLog("Trying to get PostId with defined focus");
selection = selection.focusNode.parentNode;
} else {
Host.dbLog("Trying to get PostId with undefined focus");
selection = selection.anchorNode.parentNode;
}
while (selection.id.match(profile.content.idStyle) === null) {
selection = selection.parentNode;
}
Host.dbLog("Selection id is:" + selection.id);
return selection.id;
}

// Checks that the selection is valid
function checkValid(selection, profile) {
var ret = true,
selection_cp = {},
tags = profile.content.parentTag;
for (var n = 0; n < 2; n++) {
if (n === 0) {
selection_cp = selection.anchorNode.parentNode;
} else {
selection_cp = selection.focusNode.parentNode;
}
while (true) {
if (selection_cp.tagName === 'BODY') {
ret = false;
break;
} else {
var cont = false;
for (var i = 0; i < tags.length; i++) {
if (selection_cp[tags[0]] === tags[i]) {
cont = true;
break;
}
}
if (cont) {
break;
} else {
selection_cp = selection_cp.parentNode;
}
}
}
}
ret = ret && (getPostId(selection, profile) === getPostId(selection,
profile, 1));
return ret;
} // Extracts the raw text from a certain place, using an XPath

function extractFieldInfo(profile, id, field) {

if (field === 'content') {
Host.dbLog("Returning content (selection)");
return profile[field].selection();
} else {
Host.dbLog("Extracting field via xpath:" + field);
var xpath = '//*[@id="' + id + '"]/' + profile[field].xpath;
return Host.eval_xpath(document, xpath).stringValue; // document.evaluate(xpath, document, null, XPathResult.STRING_TYPE, null).stringValue;
}
} // Change the text using specified transformations

function applyTransformations(fieldInfo, trans) {
for (var i = 0; i < trans.length; i++) {
fieldInfo = trans[i](fieldInfo);
Host.dbLog(
'applyTransformations(): Multiple transformation, transformation after loop #' +
(i + 1) + ':\n\'' + fieldInfo + '\'');
}
return fieldInfo;

} //applyTransformations

// Formats the quote

function createCquote(data, indirect_speech = false) {
if (!indirect_speech)
return nonQuotedRef(data); // conventional/verbatim selection
else {
// pattern match the content using a vector of regexes
data.content = transformSpeech(data.content, data.author, null,
speechTransformations);
return nonQuotedRef(data);
}
}

function nonQuotedRef(data) { //TODO: rename
var template = Host.getTemplate();

var substituted = template
.replace('$CONTENT', data.content)
.replace('$URL', data.url)
.replace('$TITLE', data.title)
.replace('$AUTHOR', data.author)
.replace('$DATE', datef(data.date))
.replace('$ADDED', datef(data.date))
.replace('$SCRIPT_VERSION', Host.getScriptVersion());

return substituted;
} //

// Output the text.
// Tries the jQuery dialog, and falls back to window.prompt()

function outputText(msg, original) {
try {
OUTPUT.jQueryTabbed(msg, original);
} catch (err) {
msg = msg.replace(/<\/syntaxhighligh(.)>/g, '</syntaxhighligh$1');
OUTPUT.msgbox(msg);
}
}

// #############
// # Utilities #
// #############

function extract(regex) {
return function (text) {
return text.match(regex)[1];
};
}

function prepend(prefix) {
return function (text) {
return prefix + text;
};
}

function removeComments(html) {
return html.replace(//g, '');
} // Not currently used (as of June 2015), but kept just in case

// currently unused
function escapePipes(html) {
html = html.replace(/\|\|/g, '{{!!}n}');
html = html.replace(/\|\-/g, '{{!-}}');
return html.replace(/\|/g, '{{!}}');
} // Converts HTML <a href="...">...</a> tags to wiki links, internal if possible.

function a2wikilink(html) {
// Links to wiki images, because
// they need special treatment, or else they get displayed.
html = html.replace(
/<a.*?href="http:\/\/wiki\.flightgear\.org\/File:(.*?)".*?>(.*?)<\/a>/g,
'[[Media:$1|$2]]');
// Wiki links without custom text.
html = html.replace(
/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>http:\/\/wiki\.flightgear\.org\/.*?<\/a>/g,
'[[$1]]');
// Links to the wiki with custom text
html = html.replace(
/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>(.*?)<\/a>/g,
'[[$1|$2]]');
// Remove underscores from all wiki links
var list = html.match(/\[\[.*?\]\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], underscore2Space(list[i]));
}
} // Convert non-wiki links
// TODO: identify forum/devel list links, and use the AJAX/Host.download helper to get a title/subject for unnamed links (using the existing xpath/regex helpers for that)

html = html.replace(/<a.*?href="(.*?)".*?>(.*?)<\/a>/g, '[$1 $2]');
// Remove triple dots from external links.
// Replace with raw URL (MediaWiki converts it to a link).
list = html.match(/\[.*?(\.\.\.).*?\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], list[i].match(/\[(.*?) .*?\]/)[1]);
}
}
return html;
} // Converts images, including images in <a> links

function img2link(html) {
html = html.replace(
/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?><\/a>/g,
'[[File:$2|250px|link=$1]]');
html = html.replace(
/<img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?>/g,
'[[File:$1|250px]]');
html = html.replace(
/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="(.*?)".*?><\/a>/g,
'(see [$2 image], links to [$1 here])');
return html.replace(/<img.*?src="(.*?)".*?>/g,
'(see the [$1 linked image])');
} // Converts smilies

function forum_smilies2text(html) {
html = html.replace(
/<img src="\.\/images\/smilies\/icon_.*?\.gif" alt="(.*?)".*?>/g,
'$1');
for (var i = 0; i < EMOTICONS.length; i++) {
html = html.replace(EMOTICONS[i][0], EMOTICONS[i][1]);
}
return html;
} // Converts font formatting

function forum_fontstyle2wikistyle(html) {
html = html.replace(/<span style="font-weight: bold">(.*?)<\/span>/g,
'\'\'\'$1\'\'\'');
html = html.replace(
/<span style="text-decoration: underline">(.*?)<\/span>/g,
'<u>$1</u>');
html = html.replace(/<span style="font-style: italic">(.*?)<\/span>/g,
'\'\'$1\'\'');
return html.replace(/<span class="posthilit">(.*?)<\/span>/g, '$1');
} // Converts code blocks

function forum_code2syntaxhighlight(html) {
var list = html.match(
/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/g),
data = [];
if (list === null) return html;
for (var n = 0; n < list.length; n++) {
data = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/);
html = html.replace(data[0], processCode(data));
}
return html;
} // Strips any whitespace from the beginning and end of a string

function stripWhitespace(html) {
html = html.replace(/^\s*?(\S)/, '$1');
return html.replace(/(\S)\s*?\z/, '$1');
} // Process code, including basic detection of language

function processCode(data) {
var lang = '',
code = data[1];
code = code.replace(/ /g, ' ');
if (code.match(/=?.*?$?.*?$?;/) !== null) lang = 'nasal';
if (code.match(/<.*?>.*?<\/.*?>/) !== null || code.match(
//) !== null) lang = 'xml';
code = code.replace(/<br\/?>/g, '\n');
return '<syntaxhighlight lang="' + lang + '" enclose="div">\n' + code +
'\n</syntaxhighlight>';
} // Converts quote blocks to Cquotes

function forum_quote2cquote(html) {
html = html.replace(
/<blockquote class="uncited"><div>(.*?)<\/div><\/blockquote>/g,
'{{cquote|$1}}');
if (html.match(/<blockquote>/g) === null) return html;
var numQuotes = html.match(/<blockquote>/g).length;
for (var n = 0; n < numQuotes; n++) {
html = html.replace(
/<blockquote><div><cite>(.*?) wrote.*?:<\/cite>(.*?)<\/div><\/blockquote>/,
'{{cquote|$2|$1}}');
}
return html;
} // Converts videos to wiki style

function vid2wiki(html) {
// YouTube
html = html.replace(
/<div class="video-wrapper">\s.*?<div class="video-container">\s*?<iframe class="youtube-player".*?width="(.*?)" height="(.*?)" src="http:\/\/www\.youtube\.com\/embed\/(.*?)".*?><\/iframe>\s*?<\/div>\s*?<\/div>/g,
'{{#ev:youtube|$3|$1x$2}}');
// Vimeo
html = html.replace(
/<iframe src="http:\/\/player\.vimeo\.com\/video\/(.*?)\?.*?" width="(.*?)" height="(.*?)".*?>.*?<\/iframe>/g,
'{{#ev:vimeo|$1|$2x$3}}');
return html.replace(/\[.*? Watch on Vimeo\]/g, '');
} // Not currently used (as of June 2015), but kept just in case

// currently unused
function escapeEquals(html) {
return html.replace(/=/g, '{{=}}');
} // <br> to newline.

function forum_br2newline(html) {
html = html.replace(/<br\/?><br\/?>/g, '\n');
return html.replace(/<br\/?>/g, '\n\n');
} // Forum list to wiki style

function list2wiki(html) {
var list = html.match(/<ul>(.*?)<\/ul>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '* $1\n');
}
}
list = html.match(/<ol.*?>(.*?)<\/ol>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '# $1\n');
}
}
html = html.replace(/<\/?[uo]l>/g, '');
return html;
}

function nowiki(text) {
return '<nowiki>' + text + '</nowiki>';
} // Returns the correct ordinal adjective

function ordAdj(date) {
date = date.toString();
if (date == '11' || date == '12' || date == '13') {
return 'th';
} else if (date.substr(1) == '1' || date == '1') {
return 'st';
} else if (date.substr(1) == '2' || date == '2') {
return 'nd';
} else if (date.substr(1) == '3' || date == '3') {
return 'rd';
} else {
return 'th';
}
}

// Formats the date to this format: Apr 26th, 2015
function datef(text) {
var date = new Date(text);
return MONTHS[date.getMonth()] + ' ' + date.getDate() + ordAdj(date.getDate()) +
', ' + date.getFullYear();
}

function underscore2Space(str) {
return str.replace(/_/g, ' ');
}

// IGNORE EVERYTHING THAT FOLLOWS:
// This is an experiment to use GA/GP (genetic programming) to help procedurally evolve xpath and regex expressions if/when the underlying websites change
// so that we don't have to manually update/edit the script accordingly (this would also work for mobile themes etc)
// For now, this is heavily based on the genetic.js framework/examples: http://subprotocol.com/system/genetic-hello-world.html
// The idea is to evolve the xpath/regex expression by evaluating its return value against the expected/desired value
// the most important thing here is having a suitable fitness function
//

function evolve_expression_test() {

try {
var genetic = Genetic.create();

// TODO: use minimizer: redundant_bytes + duration_msec + xpath.length
genetic.optimize = Genetic.Optimize.Maximize;
genetic.select1 = Genetic.Select1.Tournament2;
genetic.select2 = Genetic.Select2.Tournament2;

genetic.seed = function () {

function randomString(len) {
var text = "";
var charset =
"\\abcdefghijklmnopqrstuvwxyz0123456789[] ()<>*.,";
for (var i = 0; i < len; i++)
text += charset.charAt(Math.floor(Math.random() *
charset.length));

return text;
}

// create random strings that are equal in length to solution
return randomString(this.userData["solution"].length);
};

genetic.mutate = function (entity) {

function replaceAt(str, index, character) {
return str.substr(0, index) + character + str.substr(index +
character.length);
}

// chromosomal drift
var i = Math.floor(Math.random() * entity.length);
return replaceAt(entity, i, String.fromCharCode(entity.charCodeAt(
i) + (Math.floor(Math.random() * 2) ? 1 : -1)));
};

genetic.crossover = function (mother, father) {

// two-point crossover
var len = mother.length;
var ca = Math.floor(Math.random() * len);
var cb = Math.floor(Math.random() * len);
if (ca > cb) {
var tmp = cb;
cb = ca;
ca = tmp;
}

var son = father.substr(0, ca) + mother.substr(ca, cb - ca) +
father.substr(cb);
var daughter = mother.substr(0, ca) + father.substr(ca, cb - ca) +
mother.substr(cb);

return [son, daughter];
};

genetic.determineExcessBytes = function (text, needle) {
return text.length - needle.length;
};

genetic.containsText = function (text, needle) {
return text.search(needle);
};

genetic.isValid = function (exp) {

};

/* myFitness:
* - must be a valid xpath/regex expression (try/call)
* - must containsText the needle
* - low relative offset in text (begin/end)
* - excessBytes
* - short expression (expression length)
* - expression footprint (runtime)
*/

// TODO: the fitness function should validate each xpath/regex first

genetic.fitness = function (entity) {
var fitness = 0;
var result;
var validExp = 0.1;
var hasToken = 0.1;

var t = this.userData.tests[0].haystack;
//var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness

if (0)
try {
var regex = new RegExp(entity);
var output = t.search(regex);
validExp = 10;
}
catch (e) {
validExp = 2;
}

var i;
for (i = 0; i < entity.length; ++i) {
// increase fitness for each character that matches
if (entity[i] == this.userData["solution"][i])
fitness += 1;

// award fractions of a point as we get warmer
fitness += (127 - Math.abs(entity.charCodeAt(i) - this.userData[
"solution"].charCodeAt(i))) / 50;
}

return fitness; // + (1*validExp + 1* hasToken);
};

genetic.generation = function (pop, generation, stats) {
// stop running once we've reached the solution
return pop[0].entity != this.userData["solution"];
};

genetic.notification = function (pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b - a) * p;
}

var value = pop[0].entity;
this.last = this.last || value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i = 0; i < value.length; ++i) {
var diff = value.charCodeAt(i) - this.last.charCodeAt(i);
var style = "background: transparent;";
if (diff > 0) {
style = "background: rgb(0,200,50); color: #fff;";
} else if (diff < 0) {
style = "background: rgb(0,100,50); color: #fff;";
}

solution.push("<span style=\"" + style + "\">" + value[i] +
"</span>");
}

var t = this.userData.tests[0].haystack;
//console.log("haystack is:"+t);
// "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"}, /From: (.*) <.*@.*>/
var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness
var output = t.search(new RegExp(value));

var buf = "";
buf += "<tr>";
buf += "<td>" + generation + "</td>";
buf += "<td>" + pop[0].fitness.toPrecision(5) + "</td>";
buf += "<td>" + solution.join("") + "</td>";
buf += "<td>" + output + "</td>";
buf += "</tr>";
$("#results tbody").prepend(buf);

this.last = value;
};

/*
genetic.notification2 = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {

solution.push(value[i]);
}
console.log("Generation:"+ generation + " Fitness:" + pop[0].fitness.toPrecision(5) + " Solution:" + solution.join(""));

this.last = value;
};
*/

var config = {
"iterations": 4000,
"size": 250,
"crossover": 0.3,
"mutation": 0.4,
"skip": 30 // notifications
//, "webWorkers": false
};

/*
var profile = CONFIG['Sourceforge Mailing list'];
var posting = profile.tests[0];
var author_xpath = profile.title.xpath;
*/

var regexTests = [{
haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03",
needle: "John Doe"
}, {
haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03",
needle: "Marc Twain"
}, {
haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13",
needle: "George W. Bush"
}];

// the regex we want to evolve
var solution = "From: (.*) <.*@.*>";

// let's assume, we'd like to evolve a regex expression like this one
var userData = {
solution: solution,
tests: regexTests
};

genetic.evolve(config, userData);

//console.log("genetic.js is loaded and working, but disabled for now");

} // try
catch (e) {
console.log("genetic.js error:\n" + e.message);
} // catch

} // evolveExpression_test()

if (0) //TODO: expose via development tab
try {
// https://github.com/cazala/synaptic
var Neuron = synaptic.Neuron,
Layer = synaptic.Layer,
Network = synaptic.Network,
Trainer = synaptic.Trainer,
Architect = synaptic.Architect;

function Perceptron(input, hidden, output) {
// create the layers
var inputLayer = new Layer(input);
var hiddenLayer = new Layer(hidden);
var outputLayer = new Layer(output);

// connect the layers
inputLayer.project(hiddenLayer);
hiddenLayer.project(outputLayer);

// set the layers
this.set({
input: inputLayer,
hidden: [hiddenLayer],
output: outputLayer
});
}

// extend the prototype chain
Perceptron.prototype = new Network();
Perceptron.prototype.constructor = Perceptron;

var myPerceptron = new Perceptron(2, 3, 1);
var myTrainer = new Trainer(myPerceptron);

myTrainer.XOR(); // { error: 0.004998819355993572, iterations: 21871, time: 356 }

myPerceptron.activate([0, 0]); // 0.0268581547421616
myPerceptron.activate([1, 0]); // 0.9829673642853368
myPerceptron.activate([0, 1]); // 0.9831714267395621
myPerceptron.activate([1, 1]); // 0.02128894618097928

console.log("Syntaptic loaded");
} catch (e) {
UI.alert(e.message);
}
</syntaxhighlight>

{{Appendix}}

FlightGear wiki:Instant-Refs

2016-05-20T12:31:46Z

Elgaton: /* The script */ Use Genetic.js instead of dist.js (which is meant to be used by NPM only)

[[File:Quotes-logo-200x200.png|thumb]]
[[File:Instant-cquotes-firefox.png|thumb|Instant-Cquotes script in Firefox]]

[[File:Ref-only-quotes.png|thumb|Instant-Cquotes screenshot prototyping runtime format selection]]

The '''Instant-Cquotes''' script is a browser addon (user script) implemented in JavaScript in order to convert excerpts (created via copy&paste) from FlightGear forum or [[mailing list]] postings into MediaWiki markup/quotes to be used on the FlightGear wiki. It is supported by Firefox, Google Chrome/Chromium, Opera and Safari. It is being developed and maintained by a group of volunteers involved in maintaining the wiki and in trying to provide more up-to-date information to end-users who may not be as involved in the various FlightGear-related communication channels.

== Background and motivation ==
FlightGear's development is, at best, "self-coordinated", meaning that contributors discuss ideas and make proposals to contribute in a certain fashion and then team up to implement certain features and building blocks, often just temporarily.

Unfortunately, due to a lack of development manpower, many ideas are not implemented immediately; it is, thus, important to know their pros and cons, as well as who originally proposed them and/or might help with their implementation, even after a long time, preferably with links to the original discussions so that new contributors can decide whether to get involved in some effort or not. The project documentation, however, is in great need of improvement<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/15444440/
| title = <nowiki>[Flightgear-devel] development process (was: chaos...)</nowiki>
| author = <nowiki>John Denker</nowiki>
| date = Jul 16th, 2007
| added = Jul 16th, 2007
| script_version = 0.23
}}</ref> and usually significantly lacking behind:<ref name="OlsonStateThingsFG">{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861667/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Curtis Olson</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> many core developers update it seldomly, if not anymore, as it takes time to write it, as well as an understanding of the inner workings of a complex system such as FlightGear. Furthermore, this task might not be attractive due to its short term impact on the project,<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861562/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Hal V. Engel</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> and it is overwhelming to think about creating documentation that would address the needs of many different kinds of contributors with different backgrounds, experience levels and goals.<ref name="OlsonStateThingsFG" />

Forum and mailing lists discussions have therefore become the only up-to-date (albeit difficult to filter)<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=280058#p280058
| title = <nowiki>Re: quoting on the wiki</nowiki>
| author = <nowiki>Thorsten</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> source of information about recent development progress; this makes it tricky to know what is going on, what needs fixing, what were the decisions taken by the developers.<ref>{{cite web
| url = https://www.mail-archive.com/flightgear-devel%40lists.sourceforge.net/msg17198.html
| title = <nowiki>[Flightgear-devel] Project tracking</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mon, 28 Jul 2008 10:06:05 -0700
}}</ref>

The aim of the Instant-Cquotes script is to help wiki editors to copy relevant excerpts from such sources, formatting them as proper [[Template:Cquote|quotations]], and bootstrap new articles collecting them until a dedicated rewrite is made. It can also be used to reuse announcements to update the changelogs, [[Next newsletter|newsletter]] or the [[Release plan/Lessons learned]] page.

After being away from the wiki system for some time it becomes more of an effort to re-learn how to start a new file and figure out how to format it , with what headings, etc. Sometimes it is almost too much to do the original write up of the original post and all the work of that layout and effort to have to also duplicate it in a wiki article. If I was a little more current and affluent with the wiki editor, I might not be so hesitant to create the work there instead of the forum.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=284698#p284698
|title = <nowiki> Re: Breaking down NLCD raster image </nowiki>
|author = <nowiki> wlbragg </nowiki>
|date = May 9th, 2016
|added = May 9th, 2016
|script_version = 0.38
}}</ref>

In a few cases, such collections of quotes helped not only create bootstrap new articles, but even actual features.

In other cases, quotes have been used to update documentation of features (e.g. [[Rembrandt]]) whose maintainers may not be actively involved in FlightGear, to help document discussions that are taking place in the meantime, and provide some background information for people interested in the corresponding feature.

== Installation ==
# Install a user script manager. On Firefox, you can use [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey]; on Chrome/Chromium, Opera or Safari, you can use [https://tampermonkey.net/ Tampermonkey] (download links: [https://tampermonkey.net/index.php?ext=dhdg&browser=chrome Chrome/Chromium], [https://tampermonkey.net/index.php?ext=dhdg&browser=opera Opera], [https://tampermonkey.net/index.php?ext=dhdg&browser=safari Safari]).
# Visit [https://greasyfork.org/en/scripts/19331-instant-cquotes the Instant-Cquotes page on GreasyFork] and click on {{button|Install this script}} (green button). If Greasemonkey/Tampermonkey prompts you to confirm the installation, agree to do so.

[[File:Howto-install-instant-cquotes.png|thumb|Click the green button to install the script]]

=== Manual installation ===
{{note|This will install the most recent development version of the script, which might contain bugs. Also, GreaseMonkey/TamperMonkey will not update it automatically whenever a new version is released.}}

* '''Firefox'''
# Install Greasemonkey.
# Save [[#The Script|the script]] below as <code>instant_cquotes.user.js</code>, then drag-and-drop it into Firefox.
[[File:Greasemonkey-setup-on-firefox.png|thumb|Screenshot showing the Greasemonkey setup dialog (on Firefox)]]

* '''Chrome/Chromium''', '''Opera''', or '''Safari'''
# Install Tampermonkey.
# Navigate to '''Add a new Script'''.
# Copy and paste [[#The Script|the script]] below into the editing window.
# Click the {{button|Save}} button (just above the {{button|Search}} button).

=== Mobile installation ===
As of May 2016, there is no separate version available for mobile use. Your best chance is installing a userscript addon on Android, like one of those:
* [https://play.google.com/store/apps/details?id=net.biniok.tampermonkey Tampermonkey (Google Play Store)]
* [http://oilcan.jsharkey.org/ OilCan: Greasemonkey on steroids for Android]

For installation instructions, refer to [https://openuserjs.org/about/Tampermonkey-for-Android Tampermonkey for Android] or [http://www.blogtechnika.com/how-to-access-greasemonkey-scripts-on-android-phones/ How To Access Greasemonkey Scripts on Android Phones].

Testing/feedback would obviously be appreciated - if in doubt, feel free to just edit the wiki page to add your findings/questions.

=== Configuration ===
[[File:User-script-menu.png|thumb|GreaseMonkey menu shown in FireFox with instanct cquotes menu items]]

[[File:Config-dialog-instant-cquotes.png|thumb|The configuration dialog for the Instant-Cquotes script]]

As of version 0.30, a dedicated configuration dialog is in the process of being added, so that certain script features can be dynamically configured, without having to edit the script. For now, this is merely a placeholder that provides a checkbox to easily enable/disable the debug mode. In the future, we are hoping to also expose other features this way.

== Usage ==
[[File:Updated-cquotes-script-by-redleader.png|thumb|Instant-Cquotes script, with updates contributed by Red Leader]]

[[File:New-cquotes.png|thumb|Screenshot showing Instant-Cquotes 0.30 at work]]

# Go to some [[mailing list]] archive URL, for example [http://sourceforge.net/p/flightgear/mailman/message/32400727/] or any forum message, such as {{forumref|title=Re: Get objects to show up on Map/Radar|t=23299|label=p212558|f=71}}.
# Select the relevant portion of text.
# When you release the mouse button, a box will appear containing the converted text (for now, mainly properly-referenced quotes for the wiki).
# The text will be automatically selected and copied to the clipboard.
# Paste the text into the desired wiki page.

For example, by selecting part of the forum post in the link above you can get the following quotation:

{{FGCquote
|1= The upcoming FlightGear version (3.2) will contain a canvas-based map dialog, including a modular "plugin" system for creating custom map layers and charts with roughly ~50 lines of code, most of it boilerplate.
This is entirely XML/Nasal based (scripted) - symbols can be pretty much anything, raster or vector images (png or svg), but even animated. Styling can be customied, too.
For more info, I suggest to check out:
[[MapStructure#Porting the map dialog]]

[[File:MapStructureDialog.png|250px]]
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=212558#p212558
| title = <nowiki>Re: Get objects to show up on Map/Radar</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Jun 14th, 2014
}}
}}

=== On quoting ===
{{Main article|FlightGear wiki:Quoting Guidelines}}

Using the Instant-Cquotes script is a good way to bootstrap and write some preliminary notes; however, while quotes might be useful to understand how undocumented subsystems and features work and are definitely better than nothing, they are not meant to replace proper, structured and well-written wiki articles.<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=282800#p282800
| title = <nowiki>Re: What is the QT launcher?</nowiki>
| author = <nowiki>bugman</nowiki>
| date = Apr 17th, 2016
| added = Apr 17th, 2016
| script_version = 0.25
}}</ref>

One way to convert pages bootstrapped using quotes is to extract relevant information from them and keep citations only as references; in case important details are missing, they can be asked for on the [[Mailing lists|mailing lists]] (on the forum, the chance to get a complete answer might be lower).<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34954385/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> Another option might be moving the quotes to the Talk page for each entry, which would preserve the sources without clogging up the articles.<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34948989/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>Stuart Buchanan</nowiki>
| date = Mar 19th, 2016
| added = Mar 19th, 2016
| script_version = 0.25
}}</ref>

As a matter of fact, the whole paragraph above was assembled using this approach; to see for yourself, look up the references at the end of this page. For another example, see [[TerraSync#News]].

== Development ==
{{Note|A Chrome/Chromium-specific extension that will not need Tampermonkey installed is under development.}}

=== Resources ===
* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/API:Edit

=== Adding sources ===

Adding a new source is pretty straightforward if you understand how xpath and regexes work - basically, you only need an archive (e.g. gmane), and then determine the xpath of each relevant field, as well as the regular expression to process the extracted fields (optional).

The basic steps are these:
# open the user script in an editor
# navigate to the meta header of the user script
# add a new URL to the top of the script, e.g. by copying/adapting an existing line like this:
<syntaxhighlight lang="javascript">
// @match https://sourceforge.net/p/flightgear/mailman/*
</syntaxhighlight>

Once copied, add the new URL:

<syntaxhighlight lang="javascript">
// @match http://thread.gmane.org/gmane.games.flightgear.devel/*
</syntaxhighlight>

Next, you need to navigate to the configuration hash to add a new website to it.

Again, it makes sense to simply take an existing configuration hash and adapt it as needed (ignore/omit the tests vector for now by keeping it empty):

{{Caution|the following example may meanwhile be outdated, so be sure to look at the actual code instead}}

<syntaxhighlight lang="javascript">
'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()',
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [] // vector with transformation callbacks
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()'
transform: []
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
</syntaxhighlight>

Now, we need to review/adapt the profile according to the new archive we'd like to see supported.

for starters, that means:
* changing the name of the profile, e.g. to read gmane (instead of sourceforge)
* change the '''url_reg''' field to the gmane URL (this can be a regular expression)

Next, it makes sense to use an [https://addons.mozilla.org/de/firefox/addon/xpath-checker/ XPath checker], so that we can look up the xpath expression for various HTML elements, and add those to the configuration hash above.

For testing purposes, you will probably go to the setup dialog and enable the DEBUG mode, and use your browser's console to see what is going on.

=== Getting involved ===
While having some experience with JavaScript/HTML and jQuery will definitely be useful, JavaScript is close enough to FlightGear scripting ([[Nasal]]), so that people can get involved pretty easily.

Most maintenance work will typically involve reviewing/maintaining a few configuration hashes, that contain meta information for each supported archive (mailing list/forum).

Usually, each hash contains a combination of xpath/regex expressions to look up the relevant information, as well as vector of optional transformations that are applied (in order) to convert contents to a different format (e.g. dates).

In addition, there is growing library of utility functions, a handful wrappers for useful stuff, for example:

* <code>Host.dbLog(message_string)</code> - log a message to the console if the DEBUG flag is set
* <code>Host.download(url, callback, method='GET')</code> - will download the URL and pass the downloaded content to the callback specified
* <code>Host.downloadPosting(url, callback)</code> - will download the posting URL and pass the extracted and transformed author/content and date fields in a hash to the callback specified, the URL must be one supported in the CONFIG hash (i.e. forum/sourceforge for now)
* <code>Host.make_doc(string, type="text/html")</code> - will turn a string/blob into a DOM that can be queried
* <code>Host.eval_xpath(document, xpath_expression, type=XPathResult.STRING_TYPE)</code> - will apply the xpath expression to the document specified, returning the requested type (defaulted to string)
* <code>Host.set_persistent(key,value)</code> - stores a key/value pair
* <code>Host.get_persistent(key,default_value)</code> - retrieves a values using the key specified, falling back to the default value

=== Porting ===
[[File:Instant-cquote-firefox-addon-mode.png|thumb|Prototyping a dedicated instant-cquote mode for use as a firefox addon]]

Porting the script to support other browsers/script engines is greatly appreciated. Typically, this should be pretty self-contained, because all main APIs are intended to be encapsulated in a so called "Environment" hash, where APIs that are specific to a particular browser/script engine should be provided with a wrapper. As of mid 2016, most APIs are now kept inside such an Environment hash (look at the GreaseMonkey hash for reference/details), so that it is now even possible to turn the script into a standalone FireFox addon without having to change much of the underlying code.

=== Self checks (unit testing) ===
For regression testing purposes, there's a dedicated "self check" dialog that will be extended over time. For now it will download a few profile/website specific postings using a vector called "tests" and then log the posting's title, author and date to the console.

The next step will be actually showing that information in the dialog itself - there's a separate helper function to accomplish that, so that the corresponding div layer can be updated with the results.

[[File:Sanity-check-cquotes-dialog.png|thumb|automatically executed sanity checks]]

=== Debug mode ===
[[File:Instant-cquotes-debug-mode.png|thumb|Instant-Cquotes debug mode]]

=== AJAX (live page editing) ===
{{WIP}}

* http://wiki.flightgear.org/api.php
* http://wiki.flightgear.org/api.php?action=parse&page=Frequently%20asked%20questions&prop=sections

For now, the setup dialog will try to obtain a login token for the wiki and show a message if successful.

In addition, the profile/website hash also contains a new wiki entry for the FlightGear wiki, whose '''event_handler''' callback will be invoked once the FG wiki is visited - the console/log will show a greeting, so that is where other code can be added - e.g. to help clean up/rewrite FGCquote-based articles automatically etc.

There is a vector of "modes", whose members are a hash containing trigger/handler fields, linked to two callbacks - the trigger callback can be used to check some condition, while the handler will be invoked if the trigger returns true.

This can be used to support an arbitrary number of modes, whose triggers are evaluated during page load - all triggers that return true, will have their handlers invoked, which is how the following snippet works to rewrite/augment wiki edit handles:

<syntaxhighlight lang="javascript>
'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile
</syntaxhighlight>

See [[User:Red Leader/Sandbox/AJAX test]]

* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/Extension:VisualEditor
* https://en.wikipedia.org/wiki/Wikipedia:Creating_a_bot

=== Mobile edition ===
{{Note|As of 02/2016, Hooray is contemplating to make this available as an addon for Android phones.}}

=== Issues/limitations ===
==== Bugs ====
* It's eating characters, apparently related to regex/xpath handling - e.g. words like "analyzing" are turned into "analying" [http://forum.flightgear.org/viewtopic.php?f=6&t=28378&p=270735&hilit=analyzing#p270735]
==== Non working URLs ====
* image matching/extraction: http://forum.flightgear.org/viewtopic.php?p=276221#p276221
* http://sourceforge.net/p/flightgear/mailman/message/34754961/
* http://forum.flightgear.org/viewtopic.php?f=18&t=27054&start=90#p273972 → selecting from “As promised, two sample installation sessions on Linux” to “That's it.” towards the end of the message causes Iceweasel (Firefox) 44.0.2 to display a dialog box reading “A script on this page may be busy, or it may have stopped responding. You can stop the script now, open the script in the debugger, or let the script continue.” The line below reads “Script: chrome://greasemonkey-modules/...quotes/instant_cquotes.user.js:544”. Choosing ''Continue'' doesn't help: the same message reappears a few seconds afterwards.

=== Feature requests & ideas ===
* try to recognize list items [https://sourceforge.net/p/flightgear/mailman/message/35095319/] (heuristics: look for colon/asterisk, dashes and CR/LF)
* should add [[Template:News]] to the article dropdown for announcements [http://wiki.flightgear.org/index.php?title=Template:News&oldid=98266]
* add a mode that will download screenshots from forum postings and automatically upload/categorize them, see [[Birds]]
* split the article dropdown into sections, and also populate it with the user's watchlist [https://www.mediawiki.org/wiki/API:Watchlist] {{Progressbar|60}}
* mailing list templates, listed at [http://wiki.flightgear.org/Template_talk:Project_infrastructure#Related_mailing_list_templates]
* expose the cquote/ref markup via the UI so that it can be edited/customized and treated like a template {{Done}} (0.36+)
* identify common/repeated links and automatically create [[Template:Project infrastructure|link/infrastructure templates]] and use those (should be straightforward using the AJAX mode) [http://wiki.flightgear.org/index.php?title=Mailing_lists&curid=2038&diff=97876&oldid=85252]
* add a devel/maintainer mode where it will return the xpath for a selection [http://stackoverflow.com/questions/361130/get-selected-text-and-selected-nodes-on-a-page] [http://stackoverflow.com/questions/12485334/get-surrounding-dom-node-of-selection]
* move openlink,dblog helpers to Environment hash {{Done}}
* identify CLI arguments like --aircraft=c172p and wrap them in between code tags <code>--aircraft=c172p</code> [https://sourceforge.net/p/flightgear/mailman/message/35063277/] (note that we can simply download [https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml options.xml] via openlink() and use that, which is kinda of neat...) {{Progressbar|60}} (see downloadOptionsXML() in the code)
* introduce "layouts" (templates) for different purposes: newsletter, changelog, wiki article, [[The Manual]] (LaTex) ? {{Progressbar|40}}
* use wikipedia template if possible [https://sourceforge.net/p/flightgear/mailman/message/35057670/]
* the new '''tests''' vector could also contain vectors for tests to test the extract/transform* utilities, see Environment.APITests {{Progressbar|50}}
* move environment specific APIs (browser, script host etc) into some kind of Environment hash to encapsulate things (Red Leader was working on a pure Chrome-only version at some point IIRC) {{Progressbar|80}}
* encode script settings in created markup, for future processing/updating of quotes
* look up <code>[x]</code> references and replace with the corresponding link (titled) [https://sourceforge.net/p/flightgear/mailman/message/35055331/] [https://sourceforge.net/p/flightgear/mailman/message/35062598/]
** convert footnotes into Abbr templates [http://article.gmane.org/gmane.games.flightgear.devel/78971]
* support named refs for combining identical refs [http://wiki.flightgear.org/index.php?title=FlightGear_Qt_launcher&curid=13693&diff=97562&oldid=97551]
* adopt [[Template:Forumref]]
* implement a less obnoxious quoting mode, without quotes, where only the ref part would be added, e.g. see the example at [[Graphics Card Profiles]] (it's still 99% quotes, but much less annoying) {{Done}}
* attachment support: identify attachments and link to them: [https://sourceforge.net/p/flightgear/mailman/message/11683451/] [https://sourceforge.net/p/flightgear/mailman/message/23906620/] [https://sourceforge.net/p/flightgear/mailman/message/35059842/] [https://sourceforge.net/p/flightgear/mailman/message/35067087/]
* bulletin points: if there is a colon (:) followed by at least two dashes (-), split up everything after the colon to turn each dash into an asterisk (wiki markup for bulletin points), followed by a newline [http://sourceforge.net/p/flightgear/mailman/message/34760165/]
* generic URL/template matching, e.g. for for sourceforge commit IDs
* make filters/conversions configurable via checkboxes (nowiki, wrap in alert/note boxes)
* make syntax highlighting configurable (language, mode) ?
* consider using something like the Roles template to turn contributor names into tooltips where contributor roles are shown (core dev, fgdata committer etc)
* introduce support for tag clouds to help categorize/classify related quotes
* consider making transformations optional/configurable using check boxes in the jQuery dialog
* add new input method, for quotes that need to be updated/converted (added script version specifically for this purpose), should also add extraction/processing date
* investigate why not all mailing list archives/postings are supported correctly: http://sourceforge.net/p/flightgear/mailman/message/8090479/ (problem traced to <code>getPostID()</code>)
* explore having a ref-only mode without using cquotes, i.e. just copy/paste quotes with proper ref tags and a references section, to rewrite the whole thing (possibly with templates for different purposes, e.g. newsletter/changelog) {{Done}}
* should use Template:Forumref (category:link templates)
* should be updated to use the new repo/flightgear file templates created by Johan & RedLeader {{Not done}}
* resolve links to forum threads to look up the title for the topic/posting, so that the posting's title can be used for those links, instead of just the URL - we can probably do that by making an AJAX call to open URLs asynchronously and extract the title for the thread/posting to come up with something like <code>[http://forum.flightgear.org/viewtopic.php?f=4&t=24421 A call to developers-Lockheed -L188 Electra]</code> ([http://forum.flightgear.org/viewtopic.php?f=4&t=26562&p=247325&hilit=links#p247347]) {{Progressbar|50}}
* convert quoted bug tracker URLs to use the issue template on the wiki {{not done}}
* do regex/xpath validation, and display any errors (e.g. template/theme changes on the forum would currently break the script) {{Progressbar|60}}
* increased focus on supporting different output formats, maybe using a simple [http://www.jquery-steps.com/ jQuery based wizard] (wiki, forum, newsletter, changelog) {{Not done}}
* token matching for keywords/acronyms to link to the corresponding wiki articles (e.g. Nasal, Canvas, FG_ROOT, FG_HOME etc) {{Not done}}
* Add support for [http://sourceforge.net/p/flightgear/codetickets/ tickets], merge requests comments and [http://www.fguk.eu/index.php/forum/index FGUK forum]. (also see [[FlightGear wiki talk:Instant-Cquotes#more sources]])
* GET-encoded SID arguments should be stripped from forum URLs. {{Not done}}
* Links to repositories should be converted to use wiki templates. {{Not done}}
* The {{Abbr|regexes|regular expressions}} used may fail if the HTML DOM of the source changes (e.g., phpBB/theme update)
** Show a warning when that's the case. {{Progressbar|70}} (see the self-check dialog)
** Try multiple regexes in order. {{Progressbar|30}} (see the self-check dialog)
* Use the script to update previously created Cquotes automatically
** Instead of using the <code>getSelection()</code> helper, we could register a match for <tt>wiki.flightgear.org</tt> with <code>action=edit</code> set, so that we can directly process all text of an edited page, using AJAX calls to open the URL in the background. {{Progressbar|40}} (see the self-check dialog, available via the greasemonkey menu)
** See [https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax MW:API:Edit § Editing via Ajax]

=== Changelog ===
{{Note|Contributors are invited to document their changes here, please also add your wiki handle so that others can more easily get in touch.}}

* first stab at implementing unit tests by adding a vector with URLS to be downloaded and fields to be matched (WIP), shown in a jQuery dialog
* support for persistent settings and a jQuery setup dialog with persistence
* hosting is moved, to allow auto-updates [http://www.greasespot.net/2012/02/automatic-script-updates-come-to.html] [https://wiki.greasespot.net/Metadata_Block#.40updateURL] [http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating]
* changed to ref-only quotes for now, not using the FGCquote template anymore, due to its obnoxious appearance on quote-heavy pages (should probably become a runtime option instead)
* updated to use https for forum postings
* add version info to each created quote, i.e. for future updates
* add helper for opening websites asynchronously using AJAX (also via GM helper API)
* display version number in output dialog
* begin using the GreaseMonkey API for setting clipboard content

== The script ==
<gallery mode=packed widths=230px heights=230px>
Instant-cquotes-revamped.png|Instant cquotes: Revamped user interface exposes script internals to make the script better configurable at runtime
Instant-cquotes-template-editor.png|Instant cquotes now features a simple built-in template editor with support for variable substitution, so that wiki templates can be more easily customized
Instant-cquotes-with-wikimedia-API-integration.png|Screenshot showing instant-cquotes with wikimedia API integration to fetch articles/sections and populate dropdown menus accordingly
Instant-cquotes-on-steroids-with-watchlist-support.png|Screenshot showing the JQuery-mode of the instant cquotes script with built-in support for fetching a user's wiki/watchlist to edit/update articles in a semi-automated fashion
</gallery>
{{PD-author|FlightGear contributors}}

{{Note|Anybody interested in contributing to the code is invited to directly edit this wiki article. From 05/2016, the script is hosted on GreasyFork to allow automatic updates. If you'd like to see your changes applied, please bump the version number and [[User:Elgaton|Elgaton]] will upload it in the state it was when the version number was bumped. ''Make sure to perform thorough testing'' before the bump to prevent unexpected breakage; it is generally a good idea to validate your changes using an online syntax checker, e.g.:
* http://jshint.com/
* http://esprima.org/demo/validate.html
* http://codebeautify.org/jsvalidate
<p/>Thank you!}}

Changes that should be mentioned in the changelog, should be added below (and moved to the [[#Changelog]] section subsequently:

* preparations for adding support to download fgdata related files like options.xml to automatically regex known CLI commands
* preparatory work for adding a speech-rewrite engine to assist in converting 1st person speech to 3rd person
* framework for encapsulating userscript specifics in an environment hash to provide better updating/porting support

<syntaxhighlight lang="javascript" enclose="div">// ==UserScript==
// @name Instant-Cquotes
// @name:it Instant-Cquotes
// @license public domain
// @version 0.39
// @date 2016-05-05
// @description Automatically converts selected FlightGear mailing list and forum quotes into post-processed MediaWiki markup (i.e. cquotes).
// @description:it Converte automaticamente citazioni dalla mailing list e dal forum di FlightGear in marcatori MediaWiki (cquote).
// @author Hooray, bigstones, Philosopher, Red Leader & Elgaton (2013-2016)
// @supportURL http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @icon http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @match https://sourceforge.net/p/flightgear/mailman/*
// @match http://sourceforge.net/p/flightgear/mailman/*
// @match https://forum.flightgear.org/*
// @match http://wiki.flightgear.org/*
// @namespace http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @run-at document-start
// @require https://code.jquery.com/jquery-1.10.2.js
// @require https://code.jquery.com/ui/1.11.4/jquery-ui.js
// @require https://cdn.jsdelivr.net/genetic.js/0.1.14/genetic.js
// @require https://cdn.jsdelivr.net/synaptic/1.0.4/synaptic.min.js
// @resource jQUI_CSS https://code.jquery.com/ui/1.11.4/themes/smoothness/jquery-ui.css
// @resource myLogo http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @grant GM_registerMenuCommand
// @grant GM_setValue
// @grant GM_getValue
// @grant GM_addStyle
// @grant GM_getResourceText
// @grant GM_getResourceURL
// @grant GM_setClipboard
// @grant GM_xmlhttpRequest
// @noframes
// ==/UserScript==
//
// This work has been released into the public domain by their authors. This
// applies worldwide.
// In some countries this may not be legally possible; if so:
// The authors grant anyone the right to use this work for any purpose, without
// any conditions, unless such conditions are required by law.
//
// This script has a number of dependencies that are implicitly satisfied when run as a user script
// via GreaseMonkey/TamperMonkey; however, these need to be explicitly handled when using a different mode (e.g. firefox/android):
//
// - jQuery - user interface (REQUIRED)
// - genetic-js - genetic programming (OPTIONAL/EXPERIMENTAL)
// - synaptic - neural networks (OPTIONAL/EXPERIMENTAL)
//
//

/* Here are some TODOs
* - support RSS feeds http://dir.gmane.org/gmane.games.flightgear.devel/
* - move event handling/processing to the CONFIG hash
* - use try/catch more widely
* - wrap function calls in try/call for better debugging/diagnostics
* - add helpers for [].forEach.call, map, apply and call
* - replace for/in, for/of, let statements for better compatibility (dont require ES6)
* - for the same reason, replace use of functions with default params
* - isolate UI (e.g. JQUERY) code in UserInterface hash
* - expose regex/transformations via the UI
*
*/

'use strict';

// TODO: move to GreaseMonkey/UI host
// prevent conflicts with jQuery used on webpages: https://wiki.greasespot.net/Third-Party_Libraries#jQuery
// http://stackoverflow.com/a/5014220
this.$ = this.jQuery = jQuery.noConflict(true);

// this hash is just intended to help isolate UI specifics
// so that we don't need to maintain/port tons of code

var UserInterface = {
get: function() {
return UserInterface.DEFAULT;
},

CONSOLE: {

}, // CONSOLE (shell, mainly useful for testing)

DEFAULT: {
alert: function(msg) {return window.alert(msg); },
prompt: function(msg) {return window.prompt(msg); },
confirm: function(msg) {return window.confirm(msg); },
dialog: null,
selection: null,
populateWatchlist: function() {

},
populateEditSections: function() {

}

}, // default UI mapping (Browser/User script)

JQUERY: {

} // JQUERY

}; // UserInterface

var UI = UserInterface.get(); // DEFAULT for now

// This hash is intended to help encapsulate platform specifics (browser/scripting host)
// Ideally, all APIs that are platform specific should be kept here
// This should make it much easier to update/port and maintain the script in the future
var Environment = {
getHost: function(xpi=false) {

if(xpi) {
Environment.scriptEngine = 'firefox addon';
console.log('in firefox xpi/addon mode');
return Environment.FirefoxAddon; // HACK for testing the xpi mode (firefox addon)
}

// This will determine the script engine in use: http://stackoverflow.com/questions/27487828/how-to-detect-if-a-userscript-is-installed-from-the-chrome-store
if (typeof(GM_info) === 'undefined') {
Environment.scriptEngine = "plain Chrome (Or Opera, or scriptish, or Safari, or rarer)";
// See http://stackoverflow.com/a/2401861/331508 for optional browser sniffing code.
}
else {
Environment.scriptEngine = GM_info.scriptHandler || "Greasemonkey";
}
console.log ('Instant cquotes is running on ' + Environment.scriptEngine + '.');

//console.log("not in firefox addon mode...");
// See also: https://wiki.greasespot.net/Cross-browser_userscripting
return Environment.GreaseMonkey; // return the only/default host (for now)
},

validate: function(host) {
if (host.get_persistent('startup.disable_validation',false)) return;

if(Environment.scriptEngine !== "Greasemonkey")
console.log("NOTE: This script has not been tested with script engines other than GreaseMonkey recently!");

var dependencies = [
{name:'jQuery', test: function() {} },
{name:'genetic.js', test: function() {} },
{name:'synaptic', test: function() {} },
];

[].forEach.call(dependencies, function(dep) {
console.log("Checking for dependency:"+dep.name);
var status=false;
try {
dep.test.call(undefined);
status=true;
}
catch(e) {
status=false;
}
finally {
var success = (status)?'==> success':'==> failed';
console.log(success);
return status;
}
});
}, // validate

// this contains unit tests for checking crucial APIs that must work for the script to work correctly
// for the time being, most of these are stubs waiting to be filled in
// for a working example, refer to the JSON test at the end
// TODO: add jQuery tests
APITests: [
{name:'download', test: function(recipient) {recipient(true);} },
{name:'make_doc', test: function(recipient) { recipient(true);} },
{name:'eval_xpath', test: function(recipient) { recipient(true);} },
{name:'JSON de/serialization', test: function(recipient) {
//console.log("running json test");
var identifier = 'unit_tests.json_serialization';
var hash1 = {x:1,y:2,z:3};
Host.set_persistent(identifier, hash1, true);
var hash2 = Host.get_persistent(identifier,null,true);

recipient(JSON.stringify(hash1) === JSON.stringify(hash2));
} // callback
},

// downloads a posting and tries to transform it to 3rd person speech ...
// TODO: add another test to check forum postings
{name:'text/speech transformation', test: function(recipient) {

// the posting we want to download
var url='https://sourceforge.net/p/flightgear/mailman/message/35066974/';
Host.downloadPosting(url, function (result) {

// only process the first sentence by using comma/dot as delimiter
var firstSentence = result.content.substring(result.content.indexOf(',')+1, result.content.indexOf('.'));

var transformed = transformSpeech(firstSentence, result.author, null, speechTransformations );
console.log("3rd person speech transformation:\n"+transformed);

recipient(true);
}); // downloadPosting()

}// test()
}, // end of speech transform test
{
name:"download $FG_ROOT/options.xml", test: function(recipient) {
downloadOptionsXML();
recipient(true);
} // test
}

], // end of APITests

runAPITests: function(host, recipient) {
console.log("Running API tests");
for(let test of Environment.APITests ) {
//var test = Environment.APITests[t];
// invoke the callback passed, with the hash containing the test specs, so that the console/log or a div can be updated showing the test results

recipient.call(undefined, test);

} // foreach test
}, // runAPITests

/*
* ===================================================================================================================================================
*
*/

// NOTE: This mode/environment is WIP and highly experimental ...
// To see this working, you need to package up the whole file as a firefox xpi using "jpm xpi"
// and then start the whole thing via "jpm run", to do that, you also need a matching package.json (i.e. via jpm init)
// ALSO: you will have to explicitly install any dependencies using jpm
FirefoxAddon: {
init: function() {
console.log("Firefox addon mode ...");
},
getScriptVersion: function() {
return '0.36'; // FIXME
},
dbLog: function(msg) {
console.log(msg);
},
addEventListener: function(ev, cb) {

require("sdk/tabs").on("ready", logURL);
function logURL(tab) {
console.log("URL loaded:" + tab.url);
}
},

registerConfigurationOption: function(name, callback, hook) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
console.log("config menu support n/a in firefox mode");
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Using_third-party_modules_%28jpm%29
var menuitems = require("menuitem");
var menuitem = menuitems.Menuitem({
id: "clickme",
menuid: "menu_ToolsPopup",
label: name,
onCommand: function() {
console.log("menuitem clicked:");
callback();
},
insertbefore: "menu_pageInfo"
});
},

registerTrigger: function() {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/context-menu#Item%28options%29
var contextMenu = require("sdk/context-menu");
var menuItem = contextMenu.Item({
label: "Instant Cquote",
context: contextMenu.SelectionContext(),
// https://developer.mozilla.org/en/Add-ons/SDK/Guides/Two_Types_of_Scripts
// https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts
contentScript: 'self.on("click", function () {' +
' var text = window.getSelection().toString();' +
' self.postMessage(text);' +
'});',
onMessage: function (selectionText) {
console.log(selectionText);
instantCquote(selectionText);
}
});

// for selection handling stuff, see: https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/selection

function myListener() {
console.log("A selection has been made.");
}
var selection = require("sdk/selection");
selection.on('select', myListener);

}, //registerTrigger

get_persistent: function(key, default_value) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/simple-storage
var ss = require("sdk/simple-storage");

console.log("firefox mode does not yet have persistence support");
return default_value;},
set_persistent: function(key, value) {
console.log("firefox persistence stubs not yet filled in !");
},

set_clipboard: function(content) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/clipboard

//console.log('clipboard stub not yet filled in ...');
var clipboard = require("sdk/clipboard");
clipboard.set(content);
} //set_cliipboard

}, // end of FireFox addon config

// placeholder for now ...
Android: {
// NOP
}, // Android

///////////////////////////////////////
// supported script engines:
///////////////////////////////////////

GreaseMonkey: {
// TODO: move environment specific initialization code here
init: function() {
// Check if Greasemonkey/Tampermonkey is available
try {
// TODO: add version check for clipboard API and check for TamperMonkey/Scriptish equivalents ?
GM_addStyle(GM_getResourceText('jQUI_CSS'));
} // try
catch (error) {
console.log('Could not add style or determine script version');
} // catch

var commands = [
{name:'Setup quotes',callback:setupDialog, hook:'S' },
{name:'Check quotes',callback:selfCheckDialog, hook:'C' }
];

for (let c of commands ) {
this.registerConfigurationOption(c.name, c.callback, c.hook);
}

}, // init()

getScriptVersion: function() {
return GM_info.script.version;
},

dbLog: function (message) {
if (Boolean(DEBUG)) {
console.log('Instant cquotes:' + message);
}
}, // dbLog()

registerConfigurationOption: function(name,callback,hook) {
// https://wiki.greasespot.net/GM_registerMenuCommand
// https://wiki.greasespot.net/Greasemonkey_Manual:Monkey_Menu#The_Menu
GM_registerMenuCommand(name, callback, hook);
}, //registerMenuCommand()

registerTrigger: function() {

// TODO: we can use the following callback non-interactively, i.e. to trigger background tasks
// http://javascript.info/tutorial/onload-ondomcontentloaded
document.addEventListener("DOMContentLoaded", function(event) {
console.log("Instant Cquotes: DOM fully loaded and parsed");
});

window.addEventListener('load', init); // page fully loaded
Host.dbLog('Instant Cquotes: page load handler registered');

// Initialize (matching page loaded)
function init() {
console.log('Instant Cquotes: page load handler invoked');
var profile = getProfile();

Host.dbLog("Profile type is:"+profile.type);

// Dispatch to correct event handler (depending on website/URL)
// TODO: this stuff could/should be moved into the config hash itself

if (profile.type=='wiki') {
profile.event_handler(); // just for testing
return;
}

Host.dbLog('using default mode');
document.onmouseup = instantCquote;
// HACK: preparations for moving the the event/handler logic also into the profile hash, so that the wiki (edit mode) can be handled equally
//eval(profile.event+"=instantCquote");

} // init()

}, // registerTrigger

download: function (url, callback, method='GET') {
// http://wiki.greasespot.net/GM_xmlhttpRequest
try {
GM_xmlhttpRequest({
method: method,
url: url,
onload: callback
});
}catch(e) {
console.log("download did not work");
}
}, // download()

// is only intended to work with archives supported by the hash
downloadPosting: function (url, EventHandler) {

Host.download(url, function (response) {
var profile = getProfile(url);
var blob = response.responseText;
var doc = Host.make_doc(blob,'text/html');
var result = {}; // hash to be returned

[].forEach.call(['author','date','title','content'], function(field) {
var xpath_query = '//' + profile[field].xpath;
try {
var value = Host.eval_xpath(doc, xpath_query).stringValue;
//UI.alert("extracted field value:"+value);

// now apply all transformations, if any
value = applyTransformations(value, profile[field].transform );

result[field]=value; // store the extracted/transormed value in the hash that we pass on
} // try
catch(e) {
UI.alert("downloadPosting failed:\n"+ e.message);
} // catch
}); // forEach field

EventHandler(result); // pass the result to the handler
}); // call to Host.download()

}, // downloadPosting()

// TODO: add makeAJAXCall, and makeWikiCall here

// turn a string/text blob into a DOM tree that can be queried (e.g. for xpath expressions)
// FIXME: this is browser specific not GM specific ...
make_doc: function(text, type='text/html') {
// to support other browsers, see: https://developer.mozilla.org/en/docs/Web/API/DOMParser
return new DOMParser().parseFromString(text,type);
}, // make DOM document

// xpath handling may be handled separately depending on browser/platform, so better encapsulate this
// FIXME: this is browser specific not GM specific ...
eval_xpath: function(doc, xpath, type=XPathResult.STRING_TYPE) {
return doc.evaluate(xpath, doc, null, type, null);
}, // eval_xpath

set_persistent: function(key, value, json=false)
{
// transparently stringify to json
if(json) {
// http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
value = JSON.stringify (value);
}

// https://wiki.greasespot.net/GM_setValue
GM_setValue(key, value);
//UI.alert('Saved value for key\n'+key+':'+value);
}, // set_persistent

get_persistent: function(key, default_value, json=false) {
// https://wiki.greasespot.net/GM_getValue

var value=GM_getValue(key, default_value);
// transparently support JSON: http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
if(json) {
value = JSON.parse (value) || {};
}
return value;
}, // get_persistent

setClipboard: function(msg) {
// this being a greasemonkey user-script, we are not
// subject to usual browser restrictions
// http://wiki.greasespot.net/GM_setClipboard
GM_setClipboard(msg);
}, // setClipboard()

getTemplate: function() {

// hard-coded default template
var template = '$CONTENT<ref>{{cite web\n' +
' |url = $URL \n' +
' |title = <nowiki> $TITLE </nowiki> \n' +
' |author = <nowiki> $AUTHOR </nowiki> \n' +
' |date = $DATE \n' +
' |added = $ADDED \n' +
' |script_version = $SCRIPT_VERSION \n' +
' }}</ref>\n';

// return a saved template if found, fall back to hard-coded one above otherwise
return Host.get_persistent('default_template', template);

} // getTemplate

} // end of GreaseMonkey environment, add other environments below

}; // Environment hash - intended to help encapsulate host specific stuff (APIs)

// the first thing we need to do is to determine what APIs are available
// and store everything in a Host hash, which is subsequently used for API lookups
// the Host hash contains all platform/browser-specific APIs
var Host = Environment.getHost();
Environment.validate(Host); // this checks the obtained host to see if all required dependencies are available
Host.init(); // run environment specific initialization code (e.g. logic for GreaseMonkey setup)

// move DEBUG handling to a persistent configuration flag so that we can configure this using a jQuery dialog (defaulted to false)
// TODO: move DEBUG variable to Environment hash / init() routine
var DEBUG = Host.get_persistent('debug_mode_enabled', false);
Host.dbLog("Debug mode is:"+DEBUG);
function DEBUG_mode() {
// reset script invocation counter for testing purposes
Host.dbLog('Resetting script invocation counter');
Host.set_persistent(GM_info.script.version, 0);
}

if (DEBUG)
DEBUG_mode();

// hash with supported websites/URLs, includes xpath and regex expressions to extract certain fields, and a vector with optional transformations for post-processing each field

var CONFIG = {
// WIP: the first entry is special, i.e. it's not an actual list archive (source), but only added here so that the same script can be used
// for editing the FlightGear wiki

'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
// TODO: move downloadWatchlist() etc here
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger() ) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile

'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()', // NOTE this is only used by the downloadPosting helper to retrieve the posting without having a selection (TODO:add content xpath to forum hash)
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [],
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()',
transform:[]
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
// next website/URL (forum)
'FlightGear forum': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler (not used atm)
event_handler: null, // the event handler to be invoked (not used atm)
url_reg: /https:\/\/forum\.flightgear\.org\/.*/,
content: {
xpath: '', //TODO: this must be added for downloadPosting() to work, or it cannot extract contents
selection: getSelectedHtml,
idStyle: /p[0-9]{6}/,
parentTag: [
'className',
'content',
'postbody'
],
transform: [
removeComments,
forum_quote2cquote,
forum_smilies2text,
forum_fontstyle2wikistyle,
forum_code2syntaxhighlight,
img2link,
a2wikilink,
vid2wiki,
list2wiki,
forum_br2newline
]
},
// vector with tests to be executed for sanity checks (unit testing)
// postings will be downloaded using the URL specified, and then the author/title
// fields extracted using the outer regex and matched against what is expected
// NOTE: forum postings can be edited, so that these tests would fail - thus, it makes sense to pick locked topics/postings for such tests
tests: [
{
url: 'https://forum.flightgear.org/viewtopic.php?f=18&p=284108#p284108',
author: 'mickybadia',
date: 'May 3rd, 2016',
title: 'OSM still PNG maps'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=19&p=284120#p284120',
author: 'Thorsten',
date: 'May 3rd, 2016',
title: 'Re: FlightGear\'s Screenshot Of The Month MAY 2016'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=71&t=29279&p=283455#p283446',
author: 'Hooray',
date: 'Apr 25th, 2016',
title: 'Re: Best way to learn Canvas?'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=4&t=1460&p=283994#p283994',
author: 'bugman',
date: 'May 2nd, 2016',
title: 'Re: eurofighter typhoon'
} // add other tests below

], // end of vector with self-tests
author: {
xpath: 'div/div[1]/p/strong/a/text()',
transform: [] // no transformations applied
},
title: {
xpath: 'div/div[1]/h3/a/text()',
transform: [] // no transformations applied
},
date: {
xpath: 'div/div[1]/p/text()[2]',
transform: [extract(/» (.*?[0-9]{4})/)]
},
url: {
xpath: 'div/div[1]/p/a/@href',
transform: [
extract(/\.(.*)/),
prepend('https://forum.flightgear.org')
] // transform vector
} // url
} // forum
}; // CONFIG has

// hash to map URLs (wiki article, issue tracker, sourceforge link, forum thread etc) to existing wiki templates
var MatchURL2Templates = [
// placeholder for now
{
name: 'rewrite sourceforge code links',
url_reg: '',
handler: function() {

} // handler

} // add other templates below

]; // MatchURL2Templates

// output methods (alert and jQuery for now)
var OUTPUT = {
// Shows a window.prompt() message box
msgbox: function (msg) {
UI.prompt('Copy to clipboard ' + Host.getScriptVersion(), msg);
Host.setClipboard(msg);
}, // msgbox

// this is currently work-in-progress, and will need to be refactored sooner or later
// for now, functionality matters more than elegant design/code :)
jQueryTabbed: function(msg, original) {
// FIXME: using backtics here makes the whole thing require ES6 ....
var markup = $(`<div id="tabs">
<ul>
<li><a href="#selection">Selection</a></li>
<li><a href="#articles">Articles</a></li>
<li><a href="#templates">Templates</a></li>
<li><a href="#development">Development</a></li>
<li><a href="#settings">Settings</a></li>
<li><a href="#help">Help</a></li>
<li><a href="#about">About</a></li>
</ul>
<div id="selection">This tab contains your extracted and post-processed selection, converted to proper wikimedia markup, including proper attribution.
<div id="content">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="options">
<b>Note this is work-in-progress, i.e. not yet fully functional</b><br/>
<label for="article_select">Select an article to update</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="release" label="Release"/>
<optgroup id="develop" label="Development"/>
<optgroup id="watchlist" label="Watchlist"/>
</select>
<p/>
<label for="section_select">Select section:</label>
<select name="section_select" id="section_select">
</select>
</div>
</div>
<div id="articles">This tab contains articles that you can directly access/edit using the mediawiki API<br/>
Note: The watchlist is retrieved dynamically, so does not need to be edited here<br/>
<label for="article_select">Select an article</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="develop" label="Development"/>
<optgroup id="release" label="Release"/>

</select>

<button id="article_new">New</button>
<button id="article_remove">Remove</button>

<div id="edit_article">
<label for="article_name">Article</label>
<input type="text" id="article_name" name="article_name"><br/>

<label for="article_url">Link</label>
<input type="text" id="article_url" name="article_url"><br/>

<button id="article_save">Save</button>
</div>

</div>
<div id="templates">This tab contains templates for different types of articles (newsletter, changelog, release plan etc)<p/>
For now, this is WIP - in the future, there will be a dropdown menu added and all templates will be editable.<p/>
<div id="template_header">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="template_area"/>
<div id="template_controls">
<button id="template_save">Save</button>
</div>
</div>
<div id="development">This tab is a placeholder for features currently under development<p/>
<button id="evolve_regex">Evolve regex</button><p/>
<button id="test_perceptron">Test Perceptron</button><p/>
<div id="output">

<table id="results">
<thead>
<tr>
<th>Generation</th>
<th>Fitness</th>
<th>Expression</th>
<th>Result</th>
</tr>
</thead>
<tbody>
</tbody>
</table>


</div>
</div>

<div id="settings">This tab will contain script specific settings
</div>
<div id="help">One day, this tab may contain help....<p/><button id="helpButton">Instant Cquotes</button>
</div>
<div id="about">show some script related information here
</div>
</div>`); // tabs div

var evolve_regex = $('div#development button#evolve_regex', markup);
evolve_regex.click(function() {
//alert("Evolve regex");
evolve_expression_test();
});

var test_perceptron = $('div#development button#test_perceptron', markup);
test_perceptron.click(function() {
alert("Test perceptron");
});

// add dynamic elements to each tab

// NOTE: this affects all template selectors, on all tabs
$('select#template_select', markup).change(function() {
UI.alert("Sorry, templates are not yet fully implemented (WIP)");
});

var help = $('#helpButton', markup);
help.button();
help.click(function() {
window.open("http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes");
});

// rows="10"cols="80" style=" width: 420px; height: 350px"
var textarea = $('<textarea id="quotedtext" rows="20" cols="70"/>');
textarea.val(msg);
$('#selection #content', markup).append(textarea);

var templateArea = $('<textarea id="template-edit" rows="20" cols="70"/>');
templateArea.val( Host.getTemplate() );
$('div#templates div#template_area', markup).append(templateArea);

//$('#templates', markup).append($('<button>'));
$('div#templates div#template_controls button#template_save',markup).button().click(function() {
//UI.alert("Saving template:\n"+templateArea.val() );

Host.set_persistent('default_template',templateArea.val() );
}); // save template

// TODO: Currently, this is hard-coded, but should be made customizable via the "articles" tab at some point ...
var articles = [
// NOTE: category must match an existing <optgroup> above, title must match an existing wiki article
{category:'support', name:'Frequently asked questions', url:''},
{category:'support', name:'Asking for help', url:''},
{category:'news', name:'Next newsletter', url:''},
{category:'news', name:'Next changelog', url:''},
{category:'release', name:'Release plan/Lessons learned', url:''}, // TODO: use wikimedia template
{category:'develop', name:'Nasal library', url:''},
{category:'develop', name:'Canvas Snippets', url:''},

];

// TODO: this should be moved elsewhere
function updateArticleList(selector) {
$.each(articles, function (i, article) {
$(selector+ ' optgroup#'+article.category, markup).append($('<option>', {
value: article.name, // FIXME: just a placeholder for now
text : article.name
})); //append option
}); // foreach
} // updateArticleList

// add the article list to the corresponding dropdown menus
updateArticleList('select#article_select');

// populate watchlist (prototype for now)
// TODO: generalize & refactor: url, format

// https://www.mediawiki.org/wiki/API:Watchlist
// http://wiki.flightgear.org/api.php?action=query&list=watchlist
var watchlist_url = 'http://wiki.flightgear.org/api.php?action=query&list=watchlist&format=json';
Host.download(watchlist_url, function(response) {
try {
var watchlist = JSON.parse(response.responseText);

//$('div#options select#section_select', markup).empty(); // delete all sections

$.each(watchlist.query.watchlist, function (i, article) {
$('div#options select#article_select optgroup#watchlist', markup).append($('<option>', {
value: article.title, //FIXME just a placeholder for now
text : article.title
}));
}); //foreach section

}
catch (e) {
UI.alert("Could not download wiki watchlist\n"+watchlist.error.info);
}
}); // download & populate watchlist

// register an event handler for the main tab, so that article specific sections can be retrieved
$('div#options select#article_select', markup).change(function() {
var article = this.value;

// HACK: try to get a login token (actually not needed just for reading ...)
Host.download('http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page', function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;

// populate dropdown menu with article sections
if (status === 'OK') {

// Resolve redirects: https://www.mediawiki.org/wiki/API:Query#Resolving_redirects
var section_url = 'http://wiki.flightgear.org/api.php?action=parse&page='+encodeURIComponent(article)+'&prop=sections&format=json&redirects';
Host.download(section_url, function(response) {
try {
var sections = JSON.parse(response.responseText);

$('div#options select#section_select', markup).empty(); // delete all sections

$.each(sections.parse.sections, function (i, section) {
$('div#options select#section_select', markup).append($('<option>', {
value: section.line, //FIXME just a placeholder for now
text : section.line
}));
}); //foreach section

}
catch (e) {
UI.alert(e.message);
}

}); //download sections

} // login status is OK

}); // Host.download() call, i.e. we have a login token

}); // on select change

// init the tab stuff
markup.tabs();

var diagParam = {
title: 'Instant Cquotes ' + Host.getScriptVersion(),
modal: true,
width: 700,
buttons: [
{
text:'reported speech',
click: function() {
textarea.val(createCquote(original,true));
}
},

{
text: 'Copy',
click: function () {
Host.setClipboard(msg);
$(this).dialog('close');
}
}

]
};

// actually show our tabbed dialog using the params above
markup.dialog(diagParam);

} // jQueryTabbed()

}; // output methods

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// TODO: we can use an online API to help with some of this: http://www.eslnow.org/reported-speech-converter/
// See also: http://blog.mashape.com/list-of-25-natural-language-processing-apis/
// http://text-processing.com/docs/phrases.html
// http://www.alchemyapi.com/
// https://words.bighugelabs.com/api.php
// https://www.wordsapi.com/
// http://www.dictionaryapi.com/
// https://www.textrazor.com/
// http://www.programmableweb.com/news/how-5-natural-language-processing-apis-stack/analysis/2014/07/28

var speechTransformations = [
// TODO: support aliasing using vectors: would/should
// ordering is crucial here (most specific first, least specific/most generic last)

// first, we start off by expanding short forms: http://www.learnenglish.de/grammar/shortforms.html
// http://www.macmillandictionary.com/thesaurus-category/british/short-forms

{query:/couldn\'t/gi, replacement:'could not'},
{query:/I could not/gi, replacement:'$author could not'},

{query:/I\'m/gi, replacement:'I am'},
{query:/I am/gi, replacement:'$author is'},

{query:/I\'ve/, replacement:'I have'},
{query:/I have had/, replacement:'$author had'},

{query:/can(\'|\’)t/gi, replacement:'cannot'},

{query:/I(\'|\’)ll/gi, replacement:'$author will'},
{query:/I(\'|\’)d/gi, replacement:'$author would'},

{query:/I have done/gi, replacement:'$author has done'},
{query:/I\'ve done/gi, replacement:'$author has done'}, //FIXME. queries should really be vectors ...

{query:/I believe/gi, replacement:'$author suggested'},
{query:/I think/gi, replacement:'$author suggested'},
{query:/I guess/gi, replacement:'$author believes'},

{query:/I can see that/gi, replacement:'$author suggested that'},

{query:/I have got/gi, replacement:'$author has got'},
{query:/I\'ve got/gi, replacement:'$author has got'},

{query:/I\'d suggest/gi, replacement:'$author would suggest'},

{query:/I\’m prototyping/gi, replacement:'$author is prototyping'},

{query:/I myself/gi, replacement:'$author himself'},
{query:/I am/gi, replacement:' $author is'},

{query:/I can see/gi, replacement:'$author can see'},
{query:/I can/gi, replacement:'$author can'},
{query:/I have/gi, replacement:'$author has'},
{query:/I should/g, replacement:'$author should'},
{query:/I shall/gi, replacement:'$author shall'},
{query:/I may/gi, replacement:'$author may'},
{query:/I will/gi, replacement:'$author will'},
{query:/I would/gi, replacement:'$author would'},
{query:/by myself/gi, replacement:'by $author'},
{query:/and I/gi, replacement:'and $author'},
{query:/and me/gi, replacement:'and $author'},
{query:/and myself/gi, replacement:'and $author'}

// least specific stuff last (broad/generic stuff is kept as is, with author clarification added in parentheses)
/*
{query:/I/, replacement:'I ($author)'},

{query:/me/, replacement:'me ($author)'},
{query:/my/, replacement:'my ($author)'},
{query:/myself/, replacement:'myself ($author)'},
{query:/mine/, replacement:'$author'}
*/
];

// try to assist in transforming speech using the transformation vector passed in
// still needs to be exposed via the UI
function transformSpeech(text, author, gender, transformations) {
// WIP: foreach transformation in vector, replace the search pattern with the matched string (replacing author/gender as applicable)
//alert("text to be transformed:\n"+text);
for(var i=0;i< transformations.length; i++) {
var token = transformations[i];
// patch the replacement string using the correct author name
var replacement = token.replacement.replace(/\$author/gi, author);
text = text.replace(token.query, replacement);
} // end of token transformation
console.log("transformed text is:"+text);
return text;
} // transformSpeech

// run a self-test

(function() {
var author ="John Doe";
var transformed = transformSpeech("I have decided to commit a new feature", author, null, speechTransformations );
if (transformed !== author+" has decided to commit a new feature")
Host.dbLog("FIXME: Speech transformations are not working correctly");
}) ();
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

var MONTHS = [
'Jan',
'Feb',
'Mar',
'Apr',
'May',
'Jun',
'Jul',
'Aug',
'Sep',
'Oct',
'Nov',
'Dec'
];
// Conversion for forum emoticons
var EMOTICONS = [
[/:shock:/g,
'O_O'],
[
/:lol:/g,
'(lol)'
],
[
/:oops:/g,
':$'
],
[
/:cry:/g,
';('
],
[
/:evil:/g,
'>:)'
],
[
/:twisted:/g,
'3:)'
],
[
/:roll:/g,
'(eye roll)'
],
[
/:wink:/g,
';)'
],
[
/:!:/g,
'(!)'
],
[
/:\?:/g,
'(?)'
],
[
/:idea:/g,
'(idea)'
],
[
/:arrow:/g,
'(->)'
],
[
/:mrgreen:/g,
'xD'
]
];
// ##################
// # Main functions #
// ##################

// the required trigger is host specific (userscript vs. addon vs. android etc)
// for now, this merely wraps window.load mapping to the instantCquotoe callback below
Host.registerTrigger();

// FIXME: function is currently referenced in CONFIG hash - event_handler, so cannot be easily moved across
// The main function
// TODO: split up, so that we can reuse the code elsewhere
function instantCquote(sel) {
var profile = getProfile();

// TODO: use config hash here
var selection = document.getSelection(),
post_id=0;

try {
post_id = getPostId(selection, profile);
}
catch (error) {
Host.dbLog('Failed extracting post id\nProfile:' + profile);
return;
}
if (selection.toString() === '') {
Host.dbLog('No text is selected, aborting function');
return;
}
if (!checkValid(selection, profile)) {
Host.dbLog('Selection is not valid, aborting function');
return;
}
try {
transformationLoop(profile, post_id);
}
catch(e) {
UI.alert("Transformation loop:\n"+e.message);
}
} // instantCquote

// TODO: this needs to be refactored so that it can be also reused by the async/AJAX mode
// to extract fields in the background (i.e. move to a separate function)
function transformationLoop(profile, post_id) {
var output = {}, field;
Host.dbLog("Starting extraction/transformation loop");
for (field in profile) {
if (field === 'name') continue;
if (field ==='type' || field === 'event' || field === 'event_handler') continue; // skip fields that don't contain xpath expressions
Host.dbLog("Extracting field using field id:"+post_id);
var fieldData = extractFieldInfo(profile, post_id, field);
var transform = profile[field].transform;
if (transform !== undefined) {
Host.dbLog('Field \'' + field + '\' before transformation:\n\'' + fieldData + '\'');
fieldData = applyTransformations(fieldData, transform);
Host.dbLog('Field \'' + field + '\' after transformation:\n\'' + fieldData + '\'');
}
output[field] = fieldData;
} // extract and transform all fields for the current profile (website)
Host.dbLog("extraction and transformation loop finished");
output.content = stripWhitespace(output.content);

var outputPlain = createCquote(output);
outputText(outputPlain, output);
} // transformationLoop()

/// #############

function runProfileTests() {

for (var profile in CONFIG) {
if (CONFIG[profile].type != 'archive' || !CONFIG[profile].enabled ) continue; // skip the wiki entry, because it's not an actual archive that we need to test
// should be really moved to downloadPostign
if (CONFIG[profile].content.xpath === '') console.log("xpath for content extraction is empty, cannot procedurally extract contents");
for (var test in CONFIG[profile].tests) {
var required_data = CONFIG[profile].tests[test];
var title = required_data.title;
//dbLog('Running test for posting titled:' + title);
// fetch posting via getPostingDataAJAX() and compare to the fields we are looking for (author, title, date)
//getPostingDataAJAX(profile, required_data.url);
//alert("required title:"+title);
} // foreach test

} // foreach profile (website)

} //runProfileTests

function selfCheckDialog() {
var sections = '<h3>Important APIs:</h3><div id="api_checks"></div>';

try {
runProfileTests.call(undefined); // check website profiles
}
catch (e) {
UI.alert(e.message);
}

for (var profile in CONFIG) {
// TODO: also check if enabled or not
if (CONFIG[profile].type != 'archive') continue; // skip the wiki entry, because it's not an actual archive that we need to test
var test_results = '';
for (var test in CONFIG[profile].tests) {
// var fieldData = extractFieldInfo(profile, post_id, 'author');
test_results += CONFIG[profile].tests[test].title + '<p/>';
}
sections +='<h3>' + profile + ':<font color="blue">'+ CONFIG[profile].url_reg+'</font></h3><div><p>' + test_results + '</p></div>\n';
} // https://jqueryui.com/accordion/

var checkDlg = $('<div id="selfCheck" title="Self Check dialog"><p><div id="accordion">' + sections + '</div></p></div>');

// run all API tests, invoke the callback to obtain the status
Environment.runAPITests(Host, function(meta) {

//console.log('Running API test '+meta.name);

meta.test(function(result) {
var status = (result)?'success':'fail';
var test = $("<p></p>").text('Running API test '+meta.name+':'+status);
$('#api_checks', checkDlg).append(test);
}); // update tests results

}); // runAPITests

/*
[].forEach.call(CONFIG, function(profile) {
alert("profile is:"+profile);
[].forEach.call(CONFIG[profile].tests, function(test) {

//UI.alert(test.url);
Host.downloadPosting(test.url, function(downloaded) {
alert("downloaded:");
//if (test.title == downloaded.title) alert("titles match:"+test.title);
}); //downloadPosting
}); //forEach test
}); //forEach profile
*/

//$('#accordion',checkDlg).accordion();
checkDlg.dialog({
width: 700,
height: 500,
open: function () {
// http://stackoverflow.com/questions/2929487/putting-a-jquery-ui-accordion-in-a-jquery-ui-dialog
$('#accordion').accordion({
autoHeight: true
});
}
}); // show dialog
} // selfCheckDialog

// show a simple configuration dialog (WIP)
function setupDialog() {
//alert("configuration dialog is not yet implemented");
var checked = (Host.get_persistent('debug_mode_enabled', false) === true) ? 'checked' : '';
//dbLog("value is:"+get_persistent("debug_mode_enabled"));
//dbLog("persistent debug flag is:"+checked);
var setupDiv = $('<div id="setupDialog" title="Setup dialog">NOTE: this configuration dialog is still work-in-progress</p><label><input id="debugcb" type="checkbox"' + checked + '>Enable Debug mode</label><p/><div id="progressbar"></div></div>');
setupDiv.click(function () {
//alert("changing persistent debug state");
Host.set_persistent('debug_mode_enabled', $('#debugcb').is(':checked'));
});
//MediaWiki editing stub, based on: https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax
//only added here to show some status info in the setup dialog
Host.download('http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page', function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;
var color = (status == 'OK') ? 'green' : 'red';
Host.dbLog(message + status);
var statusDiv = $('<p>' + message + status + '</p>').css('color', color);
setupDiv.append(statusDiv);
});
setupDiv.dialog();
} // setupDialog

// this can be used to download/cache $FG_ROOT/options.xml so that fgfs CLI arguments can be recognized and post-processed automatically
// which can help transforming postings correctly
function downloadOptionsXML() {

// download $FG_ROOT/options.xml
Host.download("https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml?format=raw", function(response) {
var xml = response.responseText;
var doc = Host.make_doc(xml, 'text/xml');
// https://developer.mozilla.org/en-US/docs/Web/API/XPathResult
var options = Host.eval_xpath(doc, '//*/option', XPathResult.ORDERED_NODE_SNAPSHOT_TYPE);

// http://help.dottoro.com/ljgnejkp.php
Host.dbLog("Number of options found in options.xml:"+options.snapshotLength);

// http://help.dottoro.com/ljtfvvpx.php

// https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml

}); // end of options.xml download

} // downloadOptionsXML

function getProfile(url=undefined) {

if(url === undefined)
url=window.location.href;
else
url=url;

Host.dbLog("getProfile call URL is:"+url);

for (var profile in CONFIG) {
if (url.match(CONFIG[profile].url_reg) !== null) {
Host.dbLog('Matching website profile found');
var invocations = Host.get_persistent(Host.getScriptVersion(), 0);
Host.dbLog('Number of script invocations for version ' + Host.getScriptVersion() + ' is:' + invocations);

// determine if we want to show a config dialog
if (invocations === 0) {
Host.dbLog("ask for config dialog to be shown");
var response = UI.confirm('This is your first time running version ' + Host.getScriptVersion() + '\nConfigure now?');
if (response) {

// show configuration dialog (jQuery)
setupDialog();
}
else {
} // don't configure

}

// increment number of invocations, use the script's version number as the key, to prevent the config dialog from showing up again (except for updated scripts)
// FIXME: this is triggered/incremented by each click ...
Host.dbLog("increment number of script invocations");
Host.set_persistent(Host.getScriptVersion(), invocations + 1);
return CONFIG[profile];
} // matched website profile
Host.dbLog('Could not find matching URL in getProfile() call!');
} // for each profile
}// Get the HTML code that is selected

function getSelectedHtml() {
// From http://stackoverflow.com/a/6668159
var html = '',
selection = document.getSelection();
if (selection.rangeCount) {
var container = document.createElement('div');
for (var i = 0; i < selection.rangeCount; i++) {
container.appendChild(selection.getRangeAt(i).cloneContents());
}
html = container.innerHTML;
}
Host.dbLog('instantCquote(): Unprocessed HTML\n\'' + html + '\'');
return html;
}// Gets the selected text

function getSelectedText() {
return document.getSelection().toString();
}// Get the ID of the post
// (this needs some work so that it can be used by the AJAX mode, without an actual selection)

function getPostId(selection, profile, focus) {
if (focus !== undefined) {
Host.dbLog("Trying to get PostId with defined focus");
selection = selection.focusNode.parentNode;
} else {
Host.dbLog("Trying to get PostId with undefined focus");
selection = selection.anchorNode.parentNode;
}
while (selection.id.match(profile.content.idStyle) === null) {
selection = selection.parentNode;
}
Host.dbLog("Selection id is:"+selection.id);
return selection.id;
}

// Checks that the selection is valid
function checkValid(selection, profile) {
var ret = true,
selection_cp = {
},
tags = profile.content.parentTag;
for (var n = 0; n < 2; n++) {
if (n === 0) {
selection_cp = selection.anchorNode.parentNode;
} else {
selection_cp = selection.focusNode.parentNode;
}
while (true) {
if (selection_cp.tagName === 'BODY') {
ret = false;
break;
} else {
var cont = false;
for (var i = 0; i < tags.length; i++) {
if (selection_cp[tags[0]] === tags[i]) {
cont = true;
break;
}
}
if (cont) {
break;
} else {
selection_cp = selection_cp.parentNode;
}
}
}
}
ret = ret && (getPostId(selection, profile) === getPostId(selection, profile, 1));
return ret;
}// Extracts the raw text from a certain place, using an XPath

function extractFieldInfo(profile, id, field) {

if (field === 'content') {
Host.dbLog("Returning content (selection)");
return profile[field].selection();
} else {
Host.dbLog("Extracting field via xpath:"+field);
var xpath = '//*[@id="' + id + '"]/' + profile[field].xpath;
return Host.eval_xpath(document, xpath).stringValue; // document.evaluate(xpath, document, null, XPathResult.STRING_TYPE, null).stringValue;
}
}// Change the text using specified transformations

function applyTransformations(fieldInfo, trans) {
for (var i = 0; i < trans.length; i++) {
fieldInfo = trans[i](fieldInfo);
Host.dbLog('applyTransformations(): Multiple transformation, transformation after loop #' + (i + 1) + ':\n\'' + fieldInfo + '\'');
}
return fieldInfo;

} //applyTransformations

// Formats the quote

function createCquote(data, indirect_speech=false) {
if(!indirect_speech)
return nonQuotedRef(data); // conventional/verbatim selection
else {
// pattern match the content using a vector of regexes
data.content = transformSpeech(data.content, data.author, null, speechTransformations );
return nonQuotedRef(data);
}
}

function nonQuotedRef(data) { //TODO: rename
var template = Host.getTemplate();

var substituted = template
.replace('$CONTENT', data.content)
.replace('$URL',data.url)
.replace('$TITLE',data.title)
.replace('$AUTHOR',data.author)
.replace('$DATE',datef(data.date))
.replace('$ADDED',datef(data.date))
.replace('$SCRIPT_VERSION', Host.getScriptVersion() );

return substituted;
}//

// Output the text.
// Tries the jQuery dialog, and falls back to window.prompt()

function outputText(msg, original) {
try {
OUTPUT.jQueryTabbed(msg, original);
}
catch (err) {
msg = msg.replace(/<\/syntaxhighligh(.)>/g, '</syntaxhighligh$1');
OUTPUT.msgbox(msg);
}
}

// #############
// # Utilities #
// #############

function extract(regex) {
return function (text) {
return text.match(regex) [1];
};
}
function prepend(prefix) {
return function (text) {
return prefix + text;
};
}
function removeComments(html) {
return html.replace(//g, '');
}// Not currently used (as of June 2015), but kept just in case

// currently unused
function escapePipes(html) {
html = html.replace(/\|\|/g, '{{!!}n}');
html = html.replace(/\|\-/g, '{{!-}}');
return html.replace(/\|/g, '{{!}}');
}// Converts HTML <a href="...">...</a> tags to wiki links, internal if possible.

function a2wikilink(html) {
// Links to wiki images, because
// they need special treatment, or else they get displayed.
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/File:(.*?)".*?>(.*?)<\/a>/g, '[[Media:$1|$2]]');
// Wiki links without custom text.
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>http:\/\/wiki\.flightgear\.org\/.*?<\/a>/g, '[[$1]]');
// Links to the wiki with custom text
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>(.*?)<\/a>/g, '[[$1|$2]]');
// Remove underscores from all wiki links
var list = html.match(/\[\[.*?\]\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], underscore2Space(list[i]));
}
} // Convert non-wiki links
// TODO: identify forum/devel list links, and use the AJAX/Host.download helper to get a title/subject for unnamed links (using the existing xpath/regex helpers for that)

html = html.replace(/<a.*?href="(.*?)".*?>(.*?)<\/a>/g, '[$1 $2]');
// Remove triple dots from external links.
// Replace with raw URL (MediaWiki converts it to a link).
list = html.match(/\[.*?(\.\.\.).*?\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], list[i].match(/\[(.*?) .*?\]/) [1]);
}
}
return html;
}// Converts images, including images in <a> links

function img2link(html) {
html = html.replace(/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?><\/a>/g, '[[File:$2|250px|link=$1]]');
html = html.replace(/<img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?>/g, '[[File:$1|250px]]');
html = html.replace(/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="(.*?)".*?><\/a>/g, '(see [$2 image], links to [$1 here])');
return html.replace(/<img.*?src="(.*?)".*?>/g, '(see the [$1 linked image])');
}// Converts smilies

function forum_smilies2text(html) {
html = html.replace(/<img src="\.\/images\/smilies\/icon_.*?\.gif" alt="(.*?)".*?>/g, '$1');
for (var i = 0; i < EMOTICONS.length; i++) {
html = html.replace(EMOTICONS[i][0], EMOTICONS[i][1]);
}
return html;
}// Converts font formatting

function forum_fontstyle2wikistyle(html) {
html = html.replace(/<span style="font-weight: bold">(.*?)<\/span>/g, '\'\'\'$1\'\'\'');
html = html.replace(/<span style="text-decoration: underline">(.*?)<\/span>/g, '<u>$1</u>');
html = html.replace(/<span style="font-style: italic">(.*?)<\/span>/g, '\'\'$1\'\'');
return html.replace(/<span class="posthilit">(.*?)<\/span>/g, '$1');
}// Converts code blocks

function forum_code2syntaxhighlight(html) {
var list = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/g),
data = [
];
if (list === null) return html;
for (var n = 0; n < list.length; n++) {
data = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/);
html = html.replace(data[0], processCode(data));
}
return html;
}// Strips any whitespace from the beginning and end of a string

function stripWhitespace(html) {
html = html.replace(/^\s*?(\S)/, '$1');
return html.replace(/(\S)\s*?\z/, '$1');
}// Process code, including basic detection of language

function processCode(data) {
var lang = '',
code = data[1];
code = code.replace(/ /g, ' ');
if (code.match(/=?.*?$?.*?$?;/) !== null) lang = 'nasal';
if (code.match(/<.*?>.*?<\/.*?>/) !== null || code.match(//) !== null) lang = 'xml';
code = code.replace(/<br\/?>/g, '\n');
return '<syntaxhighlight lang="' + lang + '" enclose="div">\n' + code + '\n</syntaxhighlight>';
}// Converts quote blocks to Cquotes

function forum_quote2cquote(html) {
html = html.replace(/<blockquote class="uncited"><div>(.*?)<\/div><\/blockquote>/g, '{{cquote|$1}}');
if (html.match(/<blockquote>/g) === null) return html;
var numQuotes = html.match(/<blockquote>/g).length;
for (var n = 0; n < numQuotes; n++) {
html = html.replace(/<blockquote><div><cite>(.*?) wrote.*?:<\/cite>(.*?)<\/div><\/blockquote>/, '{{cquote|$2|$1}}');
}
return html;
}// Converts videos to wiki style

function vid2wiki(html) {
// YouTube
html = html.replace(/<div class="video-wrapper">\s.*?<div class="video-container">\s*?<iframe class="youtube-player".*?width="(.*?)" height="(.*?)" src="http:\/\/www\.youtube\.com\/embed\/(.*?)".*?><\/iframe>\s*?<\/div>\s*?<\/div>/g, '{{#ev:youtube|$3|$1x$2}}');
// Vimeo
html = html.replace(/<iframe src="http:\/\/player\.vimeo\.com\/video\/(.*?)\?.*?" width="(.*?)" height="(.*?)".*?>.*?<\/iframe>/g, '{{#ev:vimeo|$1|$2x$3}}');
return html.replace(/\[.*? Watch on Vimeo\]/g, '');
}// Not currently used (as of June 2015), but kept just in case

// currently unused
function escapeEquals(html) {
return html.replace(/=/g, '{{=}}');
}// <br> to newline.

function forum_br2newline(html) {
html = html.replace(/<br\/?><br\/?>/g, '\n');
return html.replace(/<br\/?>/g, '\n\n');
}// Forum list to wiki style

function list2wiki(html) {
var list = html.match(/<ul>(.*?)<\/ul>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '* $1\n');
}
}
list = html.match(/<ol.*?>(.*?)<\/ol>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '# $1\n');
}
}
html = html.replace(/<\/?[uo]l>/g, '');
return html;
}
function nowiki(text) {
return '<nowiki>' + text + '</nowiki>';
}// Returns the correct ordinal adjective

function ordAdj(date) {
date = date.toString();
if (date == '11' || date == '12' || date == '13') {
return 'th';
} else if (date.substr(1) == '1' || date == '1') {
return 'st';
} else if (date.substr(1) == '2' || date == '2') {
return 'nd';
} else if (date.substr(1) == '3' || date == '3') {
return 'rd';
} else {
return 'th';
}
}

// Formats the date to this format: Apr 26th, 2015
function datef(text) {
var date = new Date(text);
return MONTHS[date.getMonth()] + ' ' + date.getDate() + ordAdj(date.getDate()) + ', ' + date.getFullYear();
}
function underscore2Space(str) {
return str.replace(/_/g, ' ');
}

// IGNORE EVERYTHING THAT FOLLOWS:
// This is an experiment to use GA/GP (genetic programming) to help procedurally evolve xpath and regex expressions if/when the underlying websites change
// so that we don't have to manually update/edit the script accordingly (this would also work for mobile themes etc)
// For now, this is heavily based on the genetic.js framework/examples: http://subprotocol.com/system/genetic-hello-world.html
// The idea is to evolve the xpath/regex expression by evaluating its return value against the expected/desired value
// the most important thing here is having a suitable fitness function
//

function evolve_expression_test() {

try {
var genetic = Genetic.create();

// TODO: use minimizer: redundant_bytes + duration_msec + xpath.length
genetic.optimize = Genetic.Optimize.Maximize;
genetic.select1 = Genetic.Select1.Tournament2;
genetic.select2 = Genetic.Select2.Tournament2;

genetic.seed = function() {

function randomString(len) {
var text = "";
var charset = "\\abcdefghijklmnopqrstuvwxyz0123456789[] ()<>*.,";
for(var i=0;i<len;i++)
text += charset.charAt(Math.floor(Math.random() * charset.length));

return text; // "From:&(.*)$<.*8.*>"
}

// create random strings that are equal in length to solution
return randomString( this.userData["solution"].length);
};

genetic.mutate = function(entity) {

function replaceAt(str, index, character) {
return str.substr(0, index) + character + str.substr(index+character.length);
}

// chromosomal drift
var i = Math.floor(Math.random()*entity.length);
return replaceAt(entity, i, String.fromCharCode(entity.charCodeAt(i) + (Math.floor(Math.random()*2) ? 1 : -1)));
};

genetic.crossover = function(mother, father) {

// two-point crossover
var len = mother.length;
var ca = Math.floor(Math.random()*len);
var cb = Math.floor(Math.random()*len);
if (ca > cb) {
var tmp = cb;
cb = ca;
ca = tmp;
}

var son = father.substr(0,ca) + mother.substr(ca, cb-ca) + father.substr(cb);
var daughter = mother.substr(0,ca) + father.substr(ca, cb-ca) + mother.substr(cb);

return [son, daughter];
};

genetic.determineExcessBytes = function (text, needle) {
return text.length - needle.length;
};

genetic.containsText = function (text, needle) {
return text.search(needle);
};

genetic.isValid = function(exp) {

};

/* myFitness:
* - must be a valid xpath/regex expression (try/call)
* - must containsText the needle
* - low relative offset in text (begin/end)
* - excessBytes
* - short expression (expression length)
* - expression footprint (runtime)
*/

// TODO: the fitness function should validate each xpath/regex first

genetic.fitness = function(entity) {
var fitness = 0;
var result;
var validExp = 0.1;
var hasToken = 0.1;

var t = this.userData.tests[0].haystack;
//var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness

if (0)
try {
var regex = new RegExp(entity);
var output = t.search( regex);
validExp = 5;
//if (output) validExp = 50;
}
catch(e) {
//validExp = 2;
}

var i;
for (i=0;i<entity.length;++i) {
// increase fitness for each character that matches
if (entity[i] == this.userData["solution"][i])
fitness += 1;

// award fractions of a point as we get warmer
fitness += (127-Math.abs(entity.charCodeAt(i) - this.userData["solution"].charCodeAt(i)))/50;
}

return fitness + (1*validExp + 1* hasToken);
};

genetic.generation = function(pop, generation, stats) {
// stop running once we've reached the solution
return pop[0].entity != this.userData["solution"];
};

genetic.notification = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {
var diff = value.charCodeAt(i) - this.last.charCodeAt(i);
var style = "background: transparent;";
if (diff > 0) {
style = "background: rgb(0,200,50); color: #fff;";
} else if (diff < 0) {
style = "background: rgb(0,100,50); color: #fff;";
}

solution.push("<span style=\"" + style + "\">" + value[i] + "</span>");
}

var t = this.userData.tests[0].haystack;
//console.log("haystack is:"+t);
// "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"}, /From: (.*) <.*@.*>/
var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness
var output = t.search( new RegExp(value));

var buf = "";
buf += "<tr>";
buf += "<td>" + generation + "</td>";
buf += "<td>" + pop[0].fitness.toPrecision(5) + "</td>";
buf += "<td>" + solution.join("") + "</td>";
buf += "<td>" + output + "</td>";
buf += "</tr>";
$("#results tbody").prepend(buf);

this.last = value;
};

/*
genetic.notification2 = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {

solution.push(value[i]);
}
console.log("Generation:"+ generation + " Fitness:" + pop[0].fitness.toPrecision(5) + " Solution:" + solution.join(""));

this.last = value;
};
*/

var config = {
"iterations": 4000
, "size": 250
, "crossover": 0.3
, "mutation": 0.4
, "skip": 30 // notifications
//, "webWorkers": false
};

/*
var profile = CONFIG['Sourceforge Mailing list'];
var posting = profile.tests[0];
var author_xpath = profile.title.xpath;
*/

var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];

// the regex we want to evolve
var solution = "From: (.*) <.*@.*>";

// let's assume, we'd like to evolve a regex expression like this one
var userData = {
solution: solution,
tests: regexTests
};

genetic.evolve(config, userData);

//console.log("genetic.js is loaded and working, but disabled for now");

} // try
catch (e) {
console.log("genetic.js error:\n" +e.message);
} // catch

} // evolveExpression_test()

if(0) //TODO: expose via development tab
try {
// https://github.com/cazala/synaptic
var Neuron = synaptic.Neuron,
Layer = synaptic.Layer,
Network = synaptic.Network,
Trainer = synaptic.Trainer,
Architect = synaptic.Architect;

function Perceptron(input, hidden, output)
{
// create the layers
var inputLayer = new Layer(input);
var hiddenLayer = new Layer(hidden);
var outputLayer = new Layer(output);

// connect the layers
inputLayer.project(hiddenLayer);
hiddenLayer.project(outputLayer);

// set the layers
this.set({
input: inputLayer,
hidden: [hiddenLayer],
output: outputLayer
});
}

// extend the prototype chain
Perceptron.prototype = new Network();
Perceptron.prototype.constructor = Perceptron;

var myPerceptron = new Perceptron(2,3,1);
var myTrainer = new Trainer(myPerceptron);

myTrainer.XOR(); // { error: 0.004998819355993572, iterations: 21871, time: 356 }

myPerceptron.activate([0,0]); // 0.0268581547421616
myPerceptron.activate([1,0]); // 0.9829673642853368
myPerceptron.activate([0,1]); // 0.9831714267395621
myPerceptron.activate([1,1]); // 0.02128894618097928

console.log("Syntaptic loaded");
} catch(e) {
UI.alert(e.message);
}

</syntaxhighlight>

{{Appendix}}

FlightGear wiki:Instant-Refs

2016-05-20T12:24:45Z

Elgaton: /* Usage */ Pressing Ctrl+C is no longer needed

[[File:Quotes-logo-200x200.png|thumb]]
[[File:Instant-cquotes-firefox.png|thumb|Instant-Cquotes script in Firefox]]

[[File:Ref-only-quotes.png|thumb|Instant-Cquotes screenshot prototyping runtime format selection]]

The '''Instant-Cquotes''' script is a browser addon (user script) implemented in JavaScript in order to convert excerpts (created via copy&paste) from FlightGear forum or [[mailing list]] postings into MediaWiki markup/quotes to be used on the FlightGear wiki. It is supported by Firefox, Google Chrome/Chromium, Opera and Safari. It is being developed and maintained by a group of volunteers involved in maintaining the wiki and in trying to provide more up-to-date information to end-users who may not be as involved in the various FlightGear-related communication channels.

== Background and motivation ==
FlightGear's development is, at best, "self-coordinated", meaning that contributors discuss ideas and make proposals to contribute in a certain fashion and then team up to implement certain features and building blocks, often just temporarily.

Unfortunately, due to a lack of development manpower, many ideas are not implemented immediately; it is, thus, important to know their pros and cons, as well as who originally proposed them and/or might help with their implementation, even after a long time, preferably with links to the original discussions so that new contributors can decide whether to get involved in some effort or not. The project documentation, however, is in great need of improvement<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/15444440/
| title = <nowiki>[Flightgear-devel] development process (was: chaos...)</nowiki>
| author = <nowiki>John Denker</nowiki>
| date = Jul 16th, 2007
| added = Jul 16th, 2007
| script_version = 0.23
}}</ref> and usually significantly lacking behind:<ref name="OlsonStateThingsFG">{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861667/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Curtis Olson</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> many core developers update it seldomly, if not anymore, as it takes time to write it, as well as an understanding of the inner workings of a complex system such as FlightGear. Furthermore, this task might not be attractive due to its short term impact on the project,<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861562/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Hal V. Engel</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> and it is overwhelming to think about creating documentation that would address the needs of many different kinds of contributors with different backgrounds, experience levels and goals.<ref name="OlsonStateThingsFG" />

Forum and mailing lists discussions have therefore become the only up-to-date (albeit difficult to filter)<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=280058#p280058
| title = <nowiki>Re: quoting on the wiki</nowiki>
| author = <nowiki>Thorsten</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> source of information about recent development progress; this makes it tricky to know what is going on, what needs fixing, what were the decisions taken by the developers.<ref>{{cite web
| url = https://www.mail-archive.com/flightgear-devel%40lists.sourceforge.net/msg17198.html
| title = <nowiki>[Flightgear-devel] Project tracking</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mon, 28 Jul 2008 10:06:05 -0700
}}</ref>

The aim of the Instant-Cquotes script is to help wiki editors to copy relevant excerpts from such sources, formatting them as proper [[Template:Cquote|quotations]], and bootstrap new articles collecting them until a dedicated rewrite is made. It can also be used to reuse announcements to update the changelogs, [[Next newsletter|newsletter]] or the [[Release plan/Lessons learned]] page.

After being away from the wiki system for some time it becomes more of an effort to re-learn how to start a new file and figure out how to format it , with what headings, etc. Sometimes it is almost too much to do the original write up of the original post and all the work of that layout and effort to have to also duplicate it in a wiki article. If I was a little more current and affluent with the wiki editor, I might not be so hesitant to create the work there instead of the forum.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=284698#p284698
|title = <nowiki> Re: Breaking down NLCD raster image </nowiki>
|author = <nowiki> wlbragg </nowiki>
|date = May 9th, 2016
|added = May 9th, 2016
|script_version = 0.38
}}</ref>

In a few cases, such collections of quotes helped not only create bootstrap new articles, but even actual features.

In other cases, quotes have been used to update documentation of features (e.g. [[Rembrandt]]) whose maintainers may not be actively involved in FlightGear, to help document discussions that are taking place in the meantime, and provide some background information for people interested in the corresponding feature.

== Installation ==
# Install a user script manager. On Firefox, you can use [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey]; on Chrome/Chromium, Opera or Safari, you can use [https://tampermonkey.net/ Tampermonkey] (download links: [https://tampermonkey.net/index.php?ext=dhdg&browser=chrome Chrome/Chromium], [https://tampermonkey.net/index.php?ext=dhdg&browser=opera Opera], [https://tampermonkey.net/index.php?ext=dhdg&browser=safari Safari]).
# Visit [https://greasyfork.org/en/scripts/19331-instant-cquotes the Instant-Cquotes page on GreasyFork] and click on {{button|Install this script}} (green button). If Greasemonkey/Tampermonkey prompts you to confirm the installation, agree to do so.

[[File:Howto-install-instant-cquotes.png|thumb|Click the green button to install the script]]

=== Manual installation ===
{{note|This will install the most recent development version of the script, which might contain bugs. Also, GreaseMonkey/TamperMonkey will not update it automatically whenever a new version is released.}}

* '''Firefox'''
# Install Greasemonkey.
# Save [[#The Script|the script]] below as <code>instant_cquotes.user.js</code>, then drag-and-drop it into Firefox.
[[File:Greasemonkey-setup-on-firefox.png|thumb|Screenshot showing the Greasemonkey setup dialog (on Firefox)]]

* '''Chrome/Chromium''', '''Opera''', or '''Safari'''
# Install Tampermonkey.
# Navigate to '''Add a new Script'''.
# Copy and paste [[#The Script|the script]] below into the editing window.
# Click the {{button|Save}} button (just above the {{button|Search}} button).

=== Mobile installation ===
As of May 2016, there is no separate version available for mobile use. Your best chance is installing a userscript addon on Android, like one of those:
* [https://play.google.com/store/apps/details?id=net.biniok.tampermonkey Tampermonkey (Google Play Store)]
* [http://oilcan.jsharkey.org/ OilCan: Greasemonkey on steroids for Android]

For installation instructions, refer to [https://openuserjs.org/about/Tampermonkey-for-Android Tampermonkey for Android] or [http://www.blogtechnika.com/how-to-access-greasemonkey-scripts-on-android-phones/ How To Access Greasemonkey Scripts on Android Phones].

Testing/feedback would obviously be appreciated - if in doubt, feel free to just edit the wiki page to add your findings/questions.

=== Configuration ===
[[File:User-script-menu.png|thumb|GreaseMonkey menu shown in FireFox with instanct cquotes menu items]]

[[File:Config-dialog-instant-cquotes.png|thumb|The configuration dialog for the Instant-Cquotes script]]

As of version 0.30, a dedicated configuration dialog is in the process of being added, so that certain script features can be dynamically configured, without having to edit the script. For now, this is merely a placeholder that provides a checkbox to easily enable/disable the debug mode. In the future, we are hoping to also expose other features this way.

== Usage ==
[[File:Updated-cquotes-script-by-redleader.png|thumb|Instant-Cquotes script, with updates contributed by Red Leader]]

[[File:New-cquotes.png|thumb|Screenshot showing Instant-Cquotes 0.30 at work]]

# Go to some [[mailing list]] archive URL, for example [http://sourceforge.net/p/flightgear/mailman/message/32400727/] or any forum message, such as {{forumref|title=Re: Get objects to show up on Map/Radar|t=23299|label=p212558|f=71}}.
# Select the relevant portion of text.
# When you release the mouse button, a box will appear containing the converted text (for now, mainly properly-referenced quotes for the wiki).
# The text will be automatically selected and copied to the clipboard.
# Paste the text into the desired wiki page.

For example, by selecting part of the forum post in the link above you can get the following quotation:

{{FGCquote
|1= The upcoming FlightGear version (3.2) will contain a canvas-based map dialog, including a modular "plugin" system for creating custom map layers and charts with roughly ~50 lines of code, most of it boilerplate.
This is entirely XML/Nasal based (scripted) - symbols can be pretty much anything, raster or vector images (png or svg), but even animated. Styling can be customied, too.
For more info, I suggest to check out:
[[MapStructure#Porting the map dialog]]

[[File:MapStructureDialog.png|250px]]
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=212558#p212558
| title = <nowiki>Re: Get objects to show up on Map/Radar</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Jun 14th, 2014
}}
}}

=== On quoting ===
{{Main article|FlightGear wiki:Quoting Guidelines}}

Using the Instant-Cquotes script is a good way to bootstrap and write some preliminary notes; however, while quotes might be useful to understand how undocumented subsystems and features work and are definitely better than nothing, they are not meant to replace proper, structured and well-written wiki articles.<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=282800#p282800
| title = <nowiki>Re: What is the QT launcher?</nowiki>
| author = <nowiki>bugman</nowiki>
| date = Apr 17th, 2016
| added = Apr 17th, 2016
| script_version = 0.25
}}</ref>

One way to convert pages bootstrapped using quotes is to extract relevant information from them and keep citations only as references; in case important details are missing, they can be asked for on the [[Mailing lists|mailing lists]] (on the forum, the chance to get a complete answer might be lower).<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34954385/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> Another option might be moving the quotes to the Talk page for each entry, which would preserve the sources without clogging up the articles.<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34948989/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>Stuart Buchanan</nowiki>
| date = Mar 19th, 2016
| added = Mar 19th, 2016
| script_version = 0.25
}}</ref>

As a matter of fact, the whole paragraph above was assembled using this approach; to see for yourself, look up the references at the end of this page. For another example, see [[TerraSync#News]].

== Development ==
{{Note|A Chrome/Chromium-specific extension that will not need Tampermonkey installed is under development.}}

=== Resources ===
* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/API:Edit

=== Adding sources ===

Adding a new source is pretty straightforward if you understand how xpath and regexes work - basically, you only need an archive (e.g. gmane), and then determine the xpath of each relevant field, as well as the regular expression to process the extracted fields (optional).

The basic steps are these:
# open the user script in an editor
# navigate to the meta header of the user script
# add a new URL to the top of the script, e.g. by copying/adapting an existing line like this:
<syntaxhighlight lang="javascript">
// @match https://sourceforge.net/p/flightgear/mailman/*
</syntaxhighlight>

Once copied, add the new URL:

<syntaxhighlight lang="javascript">
// @match http://thread.gmane.org/gmane.games.flightgear.devel/*
</syntaxhighlight>

Next, you need to navigate to the configuration hash to add a new website to it.

Again, it makes sense to simply take an existing configuration hash and adapt it as needed (ignore/omit the tests vector for now by keeping it empty):

{{Caution|the following example may meanwhile be outdated, so be sure to look at the actual code instead}}

<syntaxhighlight lang="javascript">
'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()',
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [] // vector with transformation callbacks
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()'
transform: []
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
</syntaxhighlight>

Now, we need to review/adapt the profile according to the new archive we'd like to see supported.

for starters, that means:
* changing the name of the profile, e.g. to read gmane (instead of sourceforge)
* change the '''url_reg''' field to the gmane URL (this can be a regular expression)

Next, it makes sense to use an [https://addons.mozilla.org/de/firefox/addon/xpath-checker/ XPath checker], so that we can look up the xpath expression for various HTML elements, and add those to the configuration hash above.

For testing purposes, you will probably go to the setup dialog and enable the DEBUG mode, and use your browser's console to see what is going on.

=== Getting involved ===
While having some experience with JavaScript/HTML and jQuery will definitely be useful, JavaScript is close enough to FlightGear scripting ([[Nasal]]), so that people can get involved pretty easily.

Most maintenance work will typically involve reviewing/maintaining a few configuration hashes, that contain meta information for each supported archive (mailing list/forum).

Usually, each hash contains a combination of xpath/regex expressions to look up the relevant information, as well as vector of optional transformations that are applied (in order) to convert contents to a different format (e.g. dates).

In addition, there is growing library of utility functions, a handful wrappers for useful stuff, for example:

* <code>Host.dbLog(message_string)</code> - log a message to the console if the DEBUG flag is set
* <code>Host.download(url, callback, method='GET')</code> - will download the URL and pass the downloaded content to the callback specified
* <code>Host.downloadPosting(url, callback)</code> - will download the posting URL and pass the extracted and transformed author/content and date fields in a hash to the callback specified, the URL must be one supported in the CONFIG hash (i.e. forum/sourceforge for now)
* <code>Host.make_doc(string, type="text/html")</code> - will turn a string/blob into a DOM that can be queried
* <code>Host.eval_xpath(document, xpath_expression, type=XPathResult.STRING_TYPE)</code> - will apply the xpath expression to the document specified, returning the requested type (defaulted to string)
* <code>Host.set_persistent(key,value)</code> - stores a key/value pair
* <code>Host.get_persistent(key,default_value)</code> - retrieves a values using the key specified, falling back to the default value

=== Porting ===
[[File:Instant-cquote-firefox-addon-mode.png|thumb|Prototyping a dedicated instant-cquote mode for use as a firefox addon]]

Porting the script to support other browsers/script engines is greatly appreciated. Typically, this should be pretty self-contained, because all main APIs are intended to be encapsulated in a so called "Environment" hash, where APIs that are specific to a particular browser/script engine should be provided with a wrapper. As of mid 2016, most APIs are now kept inside such an Environment hash (look at the GreaseMonkey hash for reference/details), so that it is now even possible to turn the script into a standalone FireFox addon without having to change much of the underlying code.

=== Self checks (unit testing) ===
For regression testing purposes, there's a dedicated "self check" dialog that will be extended over time. For now it will download a few profile/website specific postings using a vector called "tests" and then log the posting's title, author and date to the console.

The next step will be actually showing that information in the dialog itself - there's a separate helper function to accomplish that, so that the corresponding div layer can be updated with the results.

[[File:Sanity-check-cquotes-dialog.png|thumb|automatically executed sanity checks]]

=== Debug mode ===
[[File:Instant-cquotes-debug-mode.png|thumb|Instant-Cquotes debug mode]]

=== AJAX (live page editing) ===
{{WIP}}

* http://wiki.flightgear.org/api.php
* http://wiki.flightgear.org/api.php?action=parse&page=Frequently%20asked%20questions&prop=sections

For now, the setup dialog will try to obtain a login token for the wiki and show a message if successful.

In addition, the profile/website hash also contains a new wiki entry for the FlightGear wiki, whose '''event_handler''' callback will be invoked once the FG wiki is visited - the console/log will show a greeting, so that is where other code can be added - e.g. to help clean up/rewrite FGCquote-based articles automatically etc.

There is a vector of "modes", whose members are a hash containing trigger/handler fields, linked to two callbacks - the trigger callback can be used to check some condition, while the handler will be invoked if the trigger returns true.

This can be used to support an arbitrary number of modes, whose triggers are evaluated during page load - all triggers that return true, will have their handlers invoked, which is how the following snippet works to rewrite/augment wiki edit handles:

<syntaxhighlight lang="javascript>
'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile
</syntaxhighlight>

See [[User:Red Leader/Sandbox/AJAX test]]

* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/Extension:VisualEditor
* https://en.wikipedia.org/wiki/Wikipedia:Creating_a_bot

=== Mobile edition ===
{{Note|As of 02/2016, Hooray is contemplating to make this available as an addon for Android phones.}}

=== Issues/limitations ===
==== Bugs ====
* It's eating characters, apparently related to regex/xpath handling - e.g. words like "analyzing" are turned into "analying" [http://forum.flightgear.org/viewtopic.php?f=6&t=28378&p=270735&hilit=analyzing#p270735]
==== Non working URLs ====
* image matching/extraction: http://forum.flightgear.org/viewtopic.php?p=276221#p276221
* http://sourceforge.net/p/flightgear/mailman/message/34754961/
* http://forum.flightgear.org/viewtopic.php?f=18&t=27054&start=90#p273972 → selecting from “As promised, two sample installation sessions on Linux” to “That's it.” towards the end of the message causes Iceweasel (Firefox) 44.0.2 to display a dialog box reading “A script on this page may be busy, or it may have stopped responding. You can stop the script now, open the script in the debugger, or let the script continue.” The line below reads “Script: chrome://greasemonkey-modules/...quotes/instant_cquotes.user.js:544”. Choosing ''Continue'' doesn't help: the same message reappears a few seconds afterwards.

=== Feature requests & ideas ===
* try to recognize list items [https://sourceforge.net/p/flightgear/mailman/message/35095319/] (heuristics: look for colon/asterisk, dashes and CR/LF)
* should add [[Template:News]] to the article dropdown for announcements [http://wiki.flightgear.org/index.php?title=Template:News&oldid=98266]
* add a mode that will download screenshots from forum postings and automatically upload/categorize them, see [[Birds]]
* split the article dropdown into sections, and also populate it with the user's watchlist [https://www.mediawiki.org/wiki/API:Watchlist] {{Progressbar|60}}
* mailing list templates, listed at [http://wiki.flightgear.org/Template_talk:Project_infrastructure#Related_mailing_list_templates]
* expose the cquote/ref markup via the UI so that it can be edited/customized and treated like a template {{Done}} (0.36+)
* identify common/repeated links and automatically create [[Template:Project infrastructure|link/infrastructure templates]] and use those (should be straightforward using the AJAX mode) [http://wiki.flightgear.org/index.php?title=Mailing_lists&curid=2038&diff=97876&oldid=85252]
* add a devel/maintainer mode where it will return the xpath for a selection [http://stackoverflow.com/questions/361130/get-selected-text-and-selected-nodes-on-a-page] [http://stackoverflow.com/questions/12485334/get-surrounding-dom-node-of-selection]
* move openlink,dblog helpers to Environment hash {{Done}}
* identify CLI arguments like --aircraft=c172p and wrap them in between code tags <code>--aircraft=c172p</code> [https://sourceforge.net/p/flightgear/mailman/message/35063277/] (note that we can simply download [https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml options.xml] via openlink() and use that, which is kinda of neat...) {{Progressbar|60}} (see downloadOptionsXML() in the code)
* introduce "layouts" (templates) for different purposes: newsletter, changelog, wiki article, [[The Manual]] (LaTex) ? {{Progressbar|40}}
* use wikipedia template if possible [https://sourceforge.net/p/flightgear/mailman/message/35057670/]
* the new '''tests''' vector could also contain vectors for tests to test the extract/transform* utilities, see Environment.APITests {{Progressbar|50}}
* move environment specific APIs (browser, script host etc) into some kind of Environment hash to encapsulate things (Red Leader was working on a pure Chrome-only version at some point IIRC) {{Progressbar|80}}
* encode script settings in created markup, for future processing/updating of quotes
* look up <code>[x]</code> references and replace with the corresponding link (titled) [https://sourceforge.net/p/flightgear/mailman/message/35055331/] [https://sourceforge.net/p/flightgear/mailman/message/35062598/]
** convert footnotes into Abbr templates [http://article.gmane.org/gmane.games.flightgear.devel/78971]
* support named refs for combining identical refs [http://wiki.flightgear.org/index.php?title=FlightGear_Qt_launcher&curid=13693&diff=97562&oldid=97551]
* adopt [[Template:Forumref]]
* implement a less obnoxious quoting mode, without quotes, where only the ref part would be added, e.g. see the example at [[Graphics Card Profiles]] (it's still 99% quotes, but much less annoying) {{Done}}
* attachment support: identify attachments and link to them: [https://sourceforge.net/p/flightgear/mailman/message/11683451/] [https://sourceforge.net/p/flightgear/mailman/message/23906620/] [https://sourceforge.net/p/flightgear/mailman/message/35059842/] [https://sourceforge.net/p/flightgear/mailman/message/35067087/]
* bulletin points: if there is a colon (:) followed by at least two dashes (-), split up everything after the colon to turn each dash into an asterisk (wiki markup for bulletin points), followed by a newline [http://sourceforge.net/p/flightgear/mailman/message/34760165/]
* generic URL/template matching, e.g. for for sourceforge commit IDs
* make filters/conversions configurable via checkboxes (nowiki, wrap in alert/note boxes)
* make syntax highlighting configurable (language, mode) ?
* consider using something like the Roles template to turn contributor names into tooltips where contributor roles are shown (core dev, fgdata committer etc)
* introduce support for tag clouds to help categorize/classify related quotes
* consider making transformations optional/configurable using check boxes in the jQuery dialog
* add new input method, for quotes that need to be updated/converted (added script version specifically for this purpose), should also add extraction/processing date
* investigate why not all mailing list archives/postings are supported correctly: http://sourceforge.net/p/flightgear/mailman/message/8090479/ (problem traced to <code>getPostID()</code>)
* explore having a ref-only mode without using cquotes, i.e. just copy/paste quotes with proper ref tags and a references section, to rewrite the whole thing (possibly with templates for different purposes, e.g. newsletter/changelog) {{Done}}
* should use Template:Forumref (category:link templates)
* should be updated to use the new repo/flightgear file templates created by Johan & RedLeader {{Not done}}
* resolve links to forum threads to look up the title for the topic/posting, so that the posting's title can be used for those links, instead of just the URL - we can probably do that by making an AJAX call to open URLs asynchronously and extract the title for the thread/posting to come up with something like <code>[http://forum.flightgear.org/viewtopic.php?f=4&t=24421 A call to developers-Lockheed -L188 Electra]</code> ([http://forum.flightgear.org/viewtopic.php?f=4&t=26562&p=247325&hilit=links#p247347]) {{Progressbar|50}}
* convert quoted bug tracker URLs to use the issue template on the wiki {{not done}}
* do regex/xpath validation, and display any errors (e.g. template/theme changes on the forum would currently break the script) {{Progressbar|60}}
* increased focus on supporting different output formats, maybe using a simple [http://www.jquery-steps.com/ jQuery based wizard] (wiki, forum, newsletter, changelog) {{Not done}}
* token matching for keywords/acronyms to link to the corresponding wiki articles (e.g. Nasal, Canvas, FG_ROOT, FG_HOME etc) {{Not done}}
* Add support for [http://sourceforge.net/p/flightgear/codetickets/ tickets], merge requests comments and [http://www.fguk.eu/index.php/forum/index FGUK forum]. (also see [[FlightGear wiki talk:Instant-Cquotes#more sources]])
* GET-encoded SID arguments should be stripped from forum URLs. {{Not done}}
* Links to repositories should be converted to use wiki templates. {{Not done}}
* The {{Abbr|regexes|regular expressions}} used may fail if the HTML DOM of the source changes (e.g., phpBB/theme update)
** Show a warning when that's the case. {{Progressbar|70}} (see the self-check dialog)
** Try multiple regexes in order. {{Progressbar|30}} (see the self-check dialog)
* Use the script to update previously created Cquotes automatically
** Instead of using the <code>getSelection()</code> helper, we could register a match for <tt>wiki.flightgear.org</tt> with <code>action=edit</code> set, so that we can directly process all text of an edited page, using AJAX calls to open the URL in the background. {{Progressbar|40}} (see the self-check dialog, available via the greasemonkey menu)
** See [https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax MW:API:Edit § Editing via Ajax]

=== Changelog ===
{{Note|Contributors are invited to document their changes here, please also add your wiki handle so that others can more easily get in touch.}}

* first stab at implementing unit tests by adding a vector with URLS to be downloaded and fields to be matched (WIP), shown in a jQuery dialog
* support for persistent settings and a jQuery setup dialog with persistence
* hosting is moved, to allow auto-updates [http://www.greasespot.net/2012/02/automatic-script-updates-come-to.html] [https://wiki.greasespot.net/Metadata_Block#.40updateURL] [http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating]
* changed to ref-only quotes for now, not using the FGCquote template anymore, due to its obnoxious appearance on quote-heavy pages (should probably become a runtime option instead)
* updated to use https for forum postings
* add version info to each created quote, i.e. for future updates
* add helper for opening websites asynchronously using AJAX (also via GM helper API)
* display version number in output dialog
* begin using the GreaseMonkey API for setting clipboard content

== The script ==
<gallery mode=packed widths=230px heights=230px>
Instant-cquotes-revamped.png|Instant cquotes: Revamped user interface exposes script internals to make the script better configurable at runtime
Instant-cquotes-template-editor.png|Instant cquotes now features a simple built-in template editor with support for variable substitution, so that wiki templates can be more easily customized
Instant-cquotes-with-wikimedia-API-integration.png|Screenshot showing instant-cquotes with wikimedia API integration to fetch articles/sections and populate dropdown menus accordingly
Instant-cquotes-on-steroids-with-watchlist-support.png|Screenshot showing the JQuery-mode of the instant cquotes script with built-in support for fetching a user's wiki/watchlist to edit/update articles in a semi-automated fashion
</gallery>
{{PD-author|FlightGear contributors}}

{{Note|Anybody interested in contributing to the code is invited to directly edit this wiki article. From 05/2016, the script is hosted on GreasyFork to allow automatic updates. If you'd like to see your changes applied, please bump the version number and [[User:Elgaton|Elgaton]] will upload it in the state it was when the version number was bumped. ''Make sure to perform thorough testing'' before the bump to prevent unexpected breakage; it is generally a good idea to validate your changes using an online syntax checker, e.g.:
* http://jshint.com/
* http://esprima.org/demo/validate.html
* http://codebeautify.org/jsvalidate
<p/>Thank you!}}

Changes that should be mentioned in the changelog, should be added below (and moved to the [[#Changelog]] section subsequently:

* preparations for adding support to download fgdata related files like options.xml to automatically regex known CLI commands
* preparatory work for adding a speech-rewrite engine to assist in converting 1st person speech to 3rd person
* framework for encapsulating userscript specifics in an environment hash to provide better updating/porting support

<syntaxhighlight lang="javascript" enclose="div">// ==UserScript==
// @name Instant-Cquotes
// @name:it Instant-Cquotes
// @license public domain
// @version 0.39
// @date 2016-05-05
// @description Automatically converts selected FlightGear mailing list and forum quotes into post-processed MediaWiki markup (i.e. cquotes).
// @description:it Converte automaticamente citazioni dalla mailing list e dal forum di FlightGear in marcatori MediaWiki (cquote).
// @author Hooray, bigstones, Philosopher, Red Leader & Elgaton (2013-2016)
// @supportURL http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @icon http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @match https://sourceforge.net/p/flightgear/mailman/*
// @match http://sourceforge.net/p/flightgear/mailman/*
// @match https://forum.flightgear.org/*
// @match http://wiki.flightgear.org/*
// @namespace http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @run-at document-start
// @require https://code.jquery.com/jquery-1.10.2.js
// @require https://code.jquery.com/ui/1.11.4/jquery-ui.js
// @require https://cdn.jsdelivr.net/genetic.js/0.1.14/dist.js
// @require https://cdn.jsdelivr.net/synaptic/1.0.4/synaptic.min.js
// @resource jQUI_CSS https://code.jquery.com/ui/1.11.4/themes/smoothness/jquery-ui.css
// @resource myLogo http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @grant GM_registerMenuCommand
// @grant GM_setValue
// @grant GM_getValue
// @grant GM_addStyle
// @grant GM_getResourceText
// @grant GM_getResourceURL
// @grant GM_setClipboard
// @grant GM_xmlhttpRequest
// @noframes
// ==/UserScript==
//
// This work has been released into the public domain by their authors. This
// applies worldwide.
// In some countries this may not be legally possible; if so:
// The authors grant anyone the right to use this work for any purpose, without
// any conditions, unless such conditions are required by law.
//
// This script has a number of dependencies that are implicitly satisfied when run as a user script
// via GreaseMonkey/TamperMonkey; however, these need to be explicitly handled when using a different mode (e.g. firefox/android):
//
// - jQuery - user interface (REQUIRED)
// - genetic-js - genetic programming (OPTIONAL/EXPERIMENTAL)
// - synaptic - neural networks (OPTIONAL/EXPERIMENTAL)
//
//

/* Here are some TODOs
* - support RSS feeds http://dir.gmane.org/gmane.games.flightgear.devel/
* - move event handling/processing to the CONFIG hash
* - use try/catch more widely
* - wrap function calls in try/call for better debugging/diagnostics
* - add helpers for [].forEach.call, map, apply and call
* - replace for/in, for/of, let statements for better compatibility (dont require ES6)
* - for the same reason, replace use of functions with default params
* - isolate UI (e.g. JQUERY) code in UserInterface hash
* - expose regex/transformations via the UI
*
*/

'use strict';

// TODO: move to GreaseMonkey/UI host
// prevent conflicts with jQuery used on webpages: https://wiki.greasespot.net/Third-Party_Libraries#jQuery
// http://stackoverflow.com/a/5014220
this.$ = this.jQuery = jQuery.noConflict(true);

// this hash is just intended to help isolate UI specifics
// so that we don't need to maintain/port tons of code

var UserInterface = {
get: function() {
return UserInterface.DEFAULT;
},

CONSOLE: {

}, // CONSOLE (shell, mainly useful for testing)

DEFAULT: {
alert: function(msg) {return window.alert(msg); },
prompt: function(msg) {return window.prompt(msg); },
confirm: function(msg) {return window.confirm(msg); },
dialog: null,
selection: null,
populateWatchlist: function() {

},
populateEditSections: function() {

}

}, // default UI mapping (Browser/User script)

JQUERY: {

} // JQUERY

}; // UserInterface

var UI = UserInterface.get(); // DEFAULT for now

// This hash is intended to help encapsulate platform specifics (browser/scripting host)
// Ideally, all APIs that are platform specific should be kept here
// This should make it much easier to update/port and maintain the script in the future
var Environment = {
getHost: function(xpi=false) {

if(xpi) {
Environment.scriptEngine = 'firefox addon';
console.log('in firefox xpi/addon mode');
return Environment.FirefoxAddon; // HACK for testing the xpi mode (firefox addon)
}

// This will determine the script engine in use: http://stackoverflow.com/questions/27487828/how-to-detect-if-a-userscript-is-installed-from-the-chrome-store
if (typeof(GM_info) === 'undefined') {
Environment.scriptEngine = "plain Chrome (Or Opera, or scriptish, or Safari, or rarer)";
// See http://stackoverflow.com/a/2401861/331508 for optional browser sniffing code.
}
else {
Environment.scriptEngine = GM_info.scriptHandler || "Greasemonkey";
}
console.log ('Instant cquotes is running on ' + Environment.scriptEngine + '.');

//console.log("not in firefox addon mode...");
// See also: https://wiki.greasespot.net/Cross-browser_userscripting
return Environment.GreaseMonkey; // return the only/default host (for now)
},

validate: function(host) {
if (host.get_persistent('startup.disable_validation',false)) return;

if(Environment.scriptEngine !== "Greasemonkey")
console.log("NOTE: This script has not been tested with script engines other than GreaseMonkey recently!");

var dependencies = [
{name:'jQuery', test: function() {} },
{name:'genetic.js', test: function() {} },
{name:'synaptic', test: function() {} },
];

[].forEach.call(dependencies, function(dep) {
console.log("Checking for dependency:"+dep.name);
var status=false;
try {
dep.test.call(undefined);
status=true;
}
catch(e) {
status=false;
}
finally {
var success = (status)?'==> success':'==> failed';
console.log(success);
return status;
}
});
}, // validate

// this contains unit tests for checking crucial APIs that must work for the script to work correctly
// for the time being, most of these are stubs waiting to be filled in
// for a working example, refer to the JSON test at the end
// TODO: add jQuery tests
APITests: [
{name:'download', test: function(recipient) {recipient(true);} },
{name:'make_doc', test: function(recipient) { recipient(true);} },
{name:'eval_xpath', test: function(recipient) { recipient(true);} },
{name:'JSON de/serialization', test: function(recipient) {
//console.log("running json test");
var identifier = 'unit_tests.json_serialization';
var hash1 = {x:1,y:2,z:3};
Host.set_persistent(identifier, hash1, true);
var hash2 = Host.get_persistent(identifier,null,true);

recipient(JSON.stringify(hash1) === JSON.stringify(hash2));
} // callback
},

// downloads a posting and tries to transform it to 3rd person speech ...
// TODO: add another test to check forum postings
{name:'text/speech transformation', test: function(recipient) {

// the posting we want to download
var url='https://sourceforge.net/p/flightgear/mailman/message/35066974/';
Host.downloadPosting(url, function (result) {

// only process the first sentence by using comma/dot as delimiter
var firstSentence = result.content.substring(result.content.indexOf(',')+1, result.content.indexOf('.'));

var transformed = transformSpeech(firstSentence, result.author, null, speechTransformations );
console.log("3rd person speech transformation:\n"+transformed);

recipient(true);
}); // downloadPosting()

}// test()
}, // end of speech transform test
{
name:"download $FG_ROOT/options.xml", test: function(recipient) {
downloadOptionsXML();
recipient(true);
} // test
}

], // end of APITests

runAPITests: function(host, recipient) {
console.log("Running API tests");
for(let test of Environment.APITests ) {
//var test = Environment.APITests[t];
// invoke the callback passed, with the hash containing the test specs, so that the console/log or a div can be updated showing the test results

recipient.call(undefined, test);

} // foreach test
}, // runAPITests

/*
* ===================================================================================================================================================
*
*/

// NOTE: This mode/environment is WIP and highly experimental ...
// To see this working, you need to package up the whole file as a firefox xpi using "jpm xpi"
// and then start the whole thing via "jpm run", to do that, you also need a matching package.json (i.e. via jpm init)
// ALSO: you will have to explicitly install any dependencies using jpm
FirefoxAddon: {
init: function() {
console.log("Firefox addon mode ...");
},
getScriptVersion: function() {
return '0.36'; // FIXME
},
dbLog: function(msg) {
console.log(msg);
},
addEventListener: function(ev, cb) {

require("sdk/tabs").on("ready", logURL);
function logURL(tab) {
console.log("URL loaded:" + tab.url);
}
},

registerConfigurationOption: function(name, callback, hook) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
console.log("config menu support n/a in firefox mode");
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Using_third-party_modules_%28jpm%29
var menuitems = require("menuitem");
var menuitem = menuitems.Menuitem({
id: "clickme",
menuid: "menu_ToolsPopup",
label: name,
onCommand: function() {
console.log("menuitem clicked:");
callback();
},
insertbefore: "menu_pageInfo"
});
},

registerTrigger: function() {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/context-menu#Item%28options%29
var contextMenu = require("sdk/context-menu");
var menuItem = contextMenu.Item({
label: "Instant Cquote",
context: contextMenu.SelectionContext(),
// https://developer.mozilla.org/en/Add-ons/SDK/Guides/Two_Types_of_Scripts
// https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts
contentScript: 'self.on("click", function () {' +
' var text = window.getSelection().toString();' +
' self.postMessage(text);' +
'});',
onMessage: function (selectionText) {
console.log(selectionText);
instantCquote(selectionText);
}
});

// for selection handling stuff, see: https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/selection

function myListener() {
console.log("A selection has been made.");
}
var selection = require("sdk/selection");
selection.on('select', myListener);

}, //registerTrigger

get_persistent: function(key, default_value) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/simple-storage
var ss = require("sdk/simple-storage");

console.log("firefox mode does not yet have persistence support");
return default_value;},
set_persistent: function(key, value) {
console.log("firefox persistence stubs not yet filled in !");
},

set_clipboard: function(content) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/clipboard

//console.log('clipboard stub not yet filled in ...');
var clipboard = require("sdk/clipboard");
clipboard.set(content);
} //set_cliipboard

}, // end of FireFox addon config

// placeholder for now ...
Android: {
// NOP
}, // Android

///////////////////////////////////////
// supported script engines:
///////////////////////////////////////

GreaseMonkey: {
// TODO: move environment specific initialization code here
init: function() {
// Check if Greasemonkey/Tampermonkey is available
try {
// TODO: add version check for clipboard API and check for TamperMonkey/Scriptish equivalents ?
GM_addStyle(GM_getResourceText('jQUI_CSS'));
} // try
catch (error) {
console.log('Could not add style or determine script version');
} // catch

var commands = [
{name:'Setup quotes',callback:setupDialog, hook:'S' },
{name:'Check quotes',callback:selfCheckDialog, hook:'C' }
];

for (let c of commands ) {
this.registerConfigurationOption(c.name, c.callback, c.hook);
}

}, // init()

getScriptVersion: function() {
return GM_info.script.version;
},

dbLog: function (message) {
if (Boolean(DEBUG)) {
console.log('Instant cquotes:' + message);
}
}, // dbLog()

registerConfigurationOption: function(name,callback,hook) {
// https://wiki.greasespot.net/GM_registerMenuCommand
// https://wiki.greasespot.net/Greasemonkey_Manual:Monkey_Menu#The_Menu
GM_registerMenuCommand(name, callback, hook);
}, //registerMenuCommand()

registerTrigger: function() {

// TODO: we can use the following callback non-interactively, i.e. to trigger background tasks
// http://javascript.info/tutorial/onload-ondomcontentloaded
document.addEventListener("DOMContentLoaded", function(event) {
console.log("Instant Cquotes: DOM fully loaded and parsed");
});

window.addEventListener('load', init); // page fully loaded
Host.dbLog('Instant Cquotes: page load handler registered');

// Initialize (matching page loaded)
function init() {
console.log('Instant Cquotes: page load handler invoked');
var profile = getProfile();

Host.dbLog("Profile type is:"+profile.type);

// Dispatch to correct event handler (depending on website/URL)
// TODO: this stuff could/should be moved into the config hash itself

if (profile.type=='wiki') {
profile.event_handler(); // just for testing
return;
}

Host.dbLog('using default mode');
document.onmouseup = instantCquote;
// HACK: preparations for moving the the event/handler logic also into the profile hash, so that the wiki (edit mode) can be handled equally
//eval(profile.event+"=instantCquote");

} // init()

}, // registerTrigger

download: function (url, callback, method='GET') {
// http://wiki.greasespot.net/GM_xmlhttpRequest
try {
GM_xmlhttpRequest({
method: method,
url: url,
onload: callback
});
}catch(e) {
console.log("download did not work");
}
}, // download()

// is only intended to work with archives supported by the hash
downloadPosting: function (url, EventHandler) {

Host.download(url, function (response) {
var profile = getProfile(url);
var blob = response.responseText;
var doc = Host.make_doc(blob,'text/html');
var result = {}; // hash to be returned

[].forEach.call(['author','date','title','content'], function(field) {
var xpath_query = '//' + profile[field].xpath;
try {
var value = Host.eval_xpath(doc, xpath_query).stringValue;
//UI.alert("extracted field value:"+value);

// now apply all transformations, if any
value = applyTransformations(value, profile[field].transform );

result[field]=value; // store the extracted/transormed value in the hash that we pass on
} // try
catch(e) {
UI.alert("downloadPosting failed:\n"+ e.message);
} // catch
}); // forEach field

EventHandler(result); // pass the result to the handler
}); // call to Host.download()

}, // downloadPosting()

// TODO: add makeAJAXCall, and makeWikiCall here

// turn a string/text blob into a DOM tree that can be queried (e.g. for xpath expressions)
// FIXME: this is browser specific not GM specific ...
make_doc: function(text, type='text/html') {
// to support other browsers, see: https://developer.mozilla.org/en/docs/Web/API/DOMParser
return new DOMParser().parseFromString(text,type);
}, // make DOM document

// xpath handling may be handled separately depending on browser/platform, so better encapsulate this
// FIXME: this is browser specific not GM specific ...
eval_xpath: function(doc, xpath, type=XPathResult.STRING_TYPE) {
return doc.evaluate(xpath, doc, null, type, null);
}, // eval_xpath

set_persistent: function(key, value, json=false)
{
// transparently stringify to json
if(json) {
// http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
value = JSON.stringify (value);
}

// https://wiki.greasespot.net/GM_setValue
GM_setValue(key, value);
//UI.alert('Saved value for key\n'+key+':'+value);
}, // set_persistent

get_persistent: function(key, default_value, json=false) {
// https://wiki.greasespot.net/GM_getValue

var value=GM_getValue(key, default_value);
// transparently support JSON: http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
if(json) {
value = JSON.parse (value) || {};
}
return value;
}, // get_persistent

setClipboard: function(msg) {
// this being a greasemonkey user-script, we are not
// subject to usual browser restrictions
// http://wiki.greasespot.net/GM_setClipboard
GM_setClipboard(msg);
}, // setClipboard()

getTemplate: function() {

// hard-coded default template
var template = '$CONTENT<ref>{{cite web\n' +
' |url = $URL \n' +
' |title = <nowiki> $TITLE </nowiki> \n' +
' |author = <nowiki> $AUTHOR </nowiki> \n' +
' |date = $DATE \n' +
' |added = $ADDED \n' +
' |script_version = $SCRIPT_VERSION \n' +
' }}</ref>\n';

// return a saved template if found, fall back to hard-coded one above otherwise
return Host.get_persistent('default_template', template);

} // getTemplate

} // end of GreaseMonkey environment, add other environments below

}; // Environment hash - intended to help encapsulate host specific stuff (APIs)

// the first thing we need to do is to determine what APIs are available
// and store everything in a Host hash, which is subsequently used for API lookups
// the Host hash contains all platform/browser-specific APIs
var Host = Environment.getHost();
Environment.validate(Host); // this checks the obtained host to see if all required dependencies are available
Host.init(); // run environment specific initialization code (e.g. logic for GreaseMonkey setup)

// move DEBUG handling to a persistent configuration flag so that we can configure this using a jQuery dialog (defaulted to false)
// TODO: move DEBUG variable to Environment hash / init() routine
var DEBUG = Host.get_persistent('debug_mode_enabled', false);
Host.dbLog("Debug mode is:"+DEBUG);
function DEBUG_mode() {
// reset script invocation counter for testing purposes
Host.dbLog('Resetting script invocation counter');
Host.set_persistent(GM_info.script.version, 0);
}

if (DEBUG)
DEBUG_mode();

// hash with supported websites/URLs, includes xpath and regex expressions to extract certain fields, and a vector with optional transformations for post-processing each field

var CONFIG = {
// WIP: the first entry is special, i.e. it's not an actual list archive (source), but only added here so that the same script can be used
// for editing the FlightGear wiki

'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
// TODO: move downloadWatchlist() etc here
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger() ) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile

'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()', // NOTE this is only used by the downloadPosting helper to retrieve the posting without having a selection (TODO:add content xpath to forum hash)
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [],
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()',
transform:[]
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
// next website/URL (forum)
'FlightGear forum': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler (not used atm)
event_handler: null, // the event handler to be invoked (not used atm)
url_reg: /https:\/\/forum\.flightgear\.org\/.*/,
content: {
xpath: '', //TODO: this must be added for downloadPosting() to work, or it cannot extract contents
selection: getSelectedHtml,
idStyle: /p[0-9]{6}/,
parentTag: [
'className',
'content',
'postbody'
],
transform: [
removeComments,
forum_quote2cquote,
forum_smilies2text,
forum_fontstyle2wikistyle,
forum_code2syntaxhighlight,
img2link,
a2wikilink,
vid2wiki,
list2wiki,
forum_br2newline
]
},
// vector with tests to be executed for sanity checks (unit testing)
// postings will be downloaded using the URL specified, and then the author/title
// fields extracted using the outer regex and matched against what is expected
// NOTE: forum postings can be edited, so that these tests would fail - thus, it makes sense to pick locked topics/postings for such tests
tests: [
{
url: 'https://forum.flightgear.org/viewtopic.php?f=18&p=284108#p284108',
author: 'mickybadia',
date: 'May 3rd, 2016',
title: 'OSM still PNG maps'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=19&p=284120#p284120',
author: 'Thorsten',
date: 'May 3rd, 2016',
title: 'Re: FlightGear\'s Screenshot Of The Month MAY 2016'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=71&t=29279&p=283455#p283446',
author: 'Hooray',
date: 'Apr 25th, 2016',
title: 'Re: Best way to learn Canvas?'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=4&t=1460&p=283994#p283994',
author: 'bugman',
date: 'May 2nd, 2016',
title: 'Re: eurofighter typhoon'
} // add other tests below

], // end of vector with self-tests
author: {
xpath: 'div/div[1]/p/strong/a/text()',
transform: [] // no transformations applied
},
title: {
xpath: 'div/div[1]/h3/a/text()',
transform: [] // no transformations applied
},
date: {
xpath: 'div/div[1]/p/text()[2]',
transform: [extract(/» (.*?[0-9]{4})/)]
},
url: {
xpath: 'div/div[1]/p/a/@href',
transform: [
extract(/\.(.*)/),
prepend('https://forum.flightgear.org')
] // transform vector
} // url
} // forum
}; // CONFIG has

// hash to map URLs (wiki article, issue tracker, sourceforge link, forum thread etc) to existing wiki templates
var MatchURL2Templates = [
// placeholder for now
{
name: 'rewrite sourceforge code links',
url_reg: '',
handler: function() {

} // handler

} // add other templates below

]; // MatchURL2Templates

// output methods (alert and jQuery for now)
var OUTPUT = {
// Shows a window.prompt() message box
msgbox: function (msg) {
UI.prompt('Copy to clipboard ' + Host.getScriptVersion(), msg);
Host.setClipboard(msg);
}, // msgbox

// this is currently work-in-progress, and will need to be refactored sooner or later
// for now, functionality matters more than elegant design/code :)
jQueryTabbed: function(msg, original) {
// FIXME: using backtics here makes the whole thing require ES6 ....
var markup = $(`<div id="tabs">
<ul>
<li><a href="#selection">Selection</a></li>
<li><a href="#articles">Articles</a></li>
<li><a href="#templates">Templates</a></li>
<li><a href="#development">Development</a></li>
<li><a href="#settings">Settings</a></li>
<li><a href="#help">Help</a></li>
<li><a href="#about">About</a></li>
</ul>
<div id="selection">This tab contains your extracted and post-processed selection, converted to proper wikimedia markup, including proper attribution.
<div id="content">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="options">
<b>Note this is work-in-progress, i.e. not yet fully functional</b><br/>
<label for="article_select">Select an article to update</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="release" label="Release"/>
<optgroup id="develop" label="Development"/>
<optgroup id="watchlist" label="Watchlist"/>
</select>
<p/>
<label for="section_select">Select section:</label>
<select name="section_select" id="section_select">
</select>
</div>
</div>
<div id="articles">This tab contains articles that you can directly access/edit using the mediawiki API<br/>
Note: The watchlist is retrieved dynamically, so does not need to be edited here<br/>
<label for="article_select">Select an article</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="develop" label="Development"/>
<optgroup id="release" label="Release"/>

</select>

<button id="article_new">New</button>
<button id="article_remove">Remove</button>

<div id="edit_article">
<label for="article_name">Article</label>
<input type="text" id="article_name" name="article_name"><br/>

<label for="article_url">Link</label>
<input type="text" id="article_url" name="article_url"><br/>

<button id="article_save">Save</button>
</div>

</div>
<div id="templates">This tab contains templates for different types of articles (newsletter, changelog, release plan etc)<p/>
For now, this is WIP - in the future, there will be a dropdown menu added and all templates will be editable.<p/>
<div id="template_header">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="template_area"/>
<div id="template_controls">
<button id="template_save">Save</button>
</div>
</div>
<div id="development">This tab is a placeholder for features currently under development<p/>
<button id="evolve_regex">Evolve regex</button><p/>
<button id="test_perceptron">Test Perceptron</button><p/>
<div id="output">

<table id="results">
<thead>
<tr>
<th>Generation</th>
<th>Fitness</th>
<th>Expression</th>
<th>Result</th>
</tr>
</thead>
<tbody>
</tbody>
</table>


</div>
</div>

<div id="settings">This tab will contain script specific settings
</div>
<div id="help">One day, this tab may contain help....<p/><button id="helpButton">Instant Cquotes</button>
</div>
<div id="about">show some script related information here
</div>
</div>`); // tabs div

var evolve_regex = $('div#development button#evolve_regex', markup);
evolve_regex.click(function() {
//alert("Evolve regex");
evolve_expression_test();
});

var test_perceptron = $('div#development button#test_perceptron', markup);
test_perceptron.click(function() {
alert("Test perceptron");
});

// add dynamic elements to each tab

// NOTE: this affects all template selectors, on all tabs
$('select#template_select', markup).change(function() {
UI.alert("Sorry, templates are not yet fully implemented (WIP)");
});

var help = $('#helpButton', markup);
help.button();
help.click(function() {
window.open("http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes");
});

// rows="10"cols="80" style=" width: 420px; height: 350px"
var textarea = $('<textarea id="quotedtext" rows="20" cols="70"/>');
textarea.val(msg);
$('#selection #content', markup).append(textarea);

var templateArea = $('<textarea id="template-edit" rows="20" cols="70"/>');
templateArea.val( Host.getTemplate() );
$('div#templates div#template_area', markup).append(templateArea);

//$('#templates', markup).append($('<button>'));
$('div#templates div#template_controls button#template_save',markup).button().click(function() {
//UI.alert("Saving template:\n"+templateArea.val() );

Host.set_persistent('default_template',templateArea.val() );
}); // save template

// TODO: Currently, this is hard-coded, but should be made customizable via the "articles" tab at some point ...
var articles = [
// NOTE: category must match an existing <optgroup> above, title must match an existing wiki article
{category:'support', name:'Frequently asked questions', url:''},
{category:'support', name:'Asking for help', url:''},
{category:'news', name:'Next newsletter', url:''},
{category:'news', name:'Next changelog', url:''},
{category:'release', name:'Release plan/Lessons learned', url:''}, // TODO: use wikimedia template
{category:'develop', name:'Nasal library', url:''},
{category:'develop', name:'Canvas Snippets', url:''},

];

// TODO: this should be moved elsewhere
function updateArticleList(selector) {
$.each(articles, function (i, article) {
$(selector+ ' optgroup#'+article.category, markup).append($('<option>', {
value: article.name, // FIXME: just a placeholder for now
text : article.name
})); //append option
}); // foreach
} // updateArticleList

// add the article list to the corresponding dropdown menus
updateArticleList('select#article_select');

// populate watchlist (prototype for now)
// TODO: generalize & refactor: url, format

// https://www.mediawiki.org/wiki/API:Watchlist
// http://wiki.flightgear.org/api.php?action=query&list=watchlist
var watchlist_url = 'http://wiki.flightgear.org/api.php?action=query&list=watchlist&format=json';
Host.download(watchlist_url, function(response) {
try {
var watchlist = JSON.parse(response.responseText);

//$('div#options select#section_select', markup).empty(); // delete all sections

$.each(watchlist.query.watchlist, function (i, article) {
$('div#options select#article_select optgroup#watchlist', markup).append($('<option>', {
value: article.title, //FIXME just a placeholder for now
text : article.title
}));
}); //foreach section

}
catch (e) {
UI.alert("Could not download wiki watchlist\n"+watchlist.error.info);
}
}); // download & populate watchlist

// register an event handler for the main tab, so that article specific sections can be retrieved
$('div#options select#article_select', markup).change(function() {
var article = this.value;

// HACK: try to get a login token (actually not needed just for reading ...)
Host.download('http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page', function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;

// populate dropdown menu with article sections
if (status === 'OK') {

// Resolve redirects: https://www.mediawiki.org/wiki/API:Query#Resolving_redirects
var section_url = 'http://wiki.flightgear.org/api.php?action=parse&page='+encodeURIComponent(article)+'&prop=sections&format=json&redirects';
Host.download(section_url, function(response) {
try {
var sections = JSON.parse(response.responseText);

$('div#options select#section_select', markup).empty(); // delete all sections

$.each(sections.parse.sections, function (i, section) {
$('div#options select#section_select', markup).append($('<option>', {
value: section.line, //FIXME just a placeholder for now
text : section.line
}));
}); //foreach section

}
catch (e) {
UI.alert(e.message);
}

}); //download sections

} // login status is OK

}); // Host.download() call, i.e. we have a login token

}); // on select change

// init the tab stuff
markup.tabs();

var diagParam = {
title: 'Instant Cquotes ' + Host.getScriptVersion(),
modal: true,
width: 700,
buttons: [
{
text:'reported speech',
click: function() {
textarea.val(createCquote(original,true));
}
},

{
text: 'Copy',
click: function () {
Host.setClipboard(msg);
$(this).dialog('close');
}
}

]
};

// actually show our tabbed dialog using the params above
markup.dialog(diagParam);

} // jQueryTabbed()

}; // output methods

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// TODO: we can use an online API to help with some of this: http://www.eslnow.org/reported-speech-converter/
// See also: http://blog.mashape.com/list-of-25-natural-language-processing-apis/
// http://text-processing.com/docs/phrases.html
// http://www.alchemyapi.com/
// https://words.bighugelabs.com/api.php
// https://www.wordsapi.com/
// http://www.dictionaryapi.com/
// https://www.textrazor.com/
// http://www.programmableweb.com/news/how-5-natural-language-processing-apis-stack/analysis/2014/07/28

var speechTransformations = [
// TODO: support aliasing using vectors: would/should
// ordering is crucial here (most specific first, least specific/most generic last)

// first, we start off by expanding short forms: http://www.learnenglish.de/grammar/shortforms.html
// http://www.macmillandictionary.com/thesaurus-category/british/short-forms

{query:/couldn\'t/gi, replacement:'could not'},
{query:/I could not/gi, replacement:'$author could not'},

{query:/I\'m/gi, replacement:'I am'},
{query:/I am/gi, replacement:'$author is'},

{query:/I\'ve/, replacement:'I have'},
{query:/I have had/, replacement:'$author had'},

{query:/can(\'|\’)t/gi, replacement:'cannot'},

{query:/I(\'|\’)ll/gi, replacement:'$author will'},
{query:/I(\'|\’)d/gi, replacement:'$author would'},

{query:/I have done/gi, replacement:'$author has done'},
{query:/I\'ve done/gi, replacement:'$author has done'}, //FIXME. queries should really be vectors ...

{query:/I believe/gi, replacement:'$author suggested'},
{query:/I think/gi, replacement:'$author suggested'},
{query:/I guess/gi, replacement:'$author believes'},

{query:/I can see that/gi, replacement:'$author suggested that'},

{query:/I have got/gi, replacement:'$author has got'},
{query:/I\'ve got/gi, replacement:'$author has got'},

{query:/I\'d suggest/gi, replacement:'$author would suggest'},

{query:/I\’m prototyping/gi, replacement:'$author is prototyping'},

{query:/I myself/gi, replacement:'$author himself'},
{query:/I am/gi, replacement:' $author is'},

{query:/I can see/gi, replacement:'$author can see'},
{query:/I can/gi, replacement:'$author can'},
{query:/I have/gi, replacement:'$author has'},
{query:/I should/g, replacement:'$author should'},
{query:/I shall/gi, replacement:'$author shall'},
{query:/I may/gi, replacement:'$author may'},
{query:/I will/gi, replacement:'$author will'},
{query:/I would/gi, replacement:'$author would'},
{query:/by myself/gi, replacement:'by $author'},
{query:/and I/gi, replacement:'and $author'},
{query:/and me/gi, replacement:'and $author'},
{query:/and myself/gi, replacement:'and $author'}

// least specific stuff last (broad/generic stuff is kept as is, with author clarification added in parentheses)
/*
{query:/I/, replacement:'I ($author)'},

{query:/me/, replacement:'me ($author)'},
{query:/my/, replacement:'my ($author)'},
{query:/myself/, replacement:'myself ($author)'},
{query:/mine/, replacement:'$author'}
*/
];

// try to assist in transforming speech using the transformation vector passed in
// still needs to be exposed via the UI
function transformSpeech(text, author, gender, transformations) {
// WIP: foreach transformation in vector, replace the search pattern with the matched string (replacing author/gender as applicable)
//alert("text to be transformed:\n"+text);
for(var i=0;i< transformations.length; i++) {
var token = transformations[i];
// patch the replacement string using the correct author name
var replacement = token.replacement.replace(/\$author/gi, author);
text = text.replace(token.query, replacement);
} // end of token transformation
console.log("transformed text is:"+text);
return text;
} // transformSpeech

// run a self-test

(function() {
var author ="John Doe";
var transformed = transformSpeech("I have decided to commit a new feature", author, null, speechTransformations );
if (transformed !== author+" has decided to commit a new feature")
Host.dbLog("FIXME: Speech transformations are not working correctly");
}) ();
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

var MONTHS = [
'Jan',
'Feb',
'Mar',
'Apr',
'May',
'Jun',
'Jul',
'Aug',
'Sep',
'Oct',
'Nov',
'Dec'
];
// Conversion for forum emoticons
var EMOTICONS = [
[/:shock:/g,
'O_O'],
[
/:lol:/g,
'(lol)'
],
[
/:oops:/g,
':$'
],
[
/:cry:/g,
';('
],
[
/:evil:/g,
'>:)'
],
[
/:twisted:/g,
'3:)'
],
[
/:roll:/g,
'(eye roll)'
],
[
/:wink:/g,
';)'
],
[
/:!:/g,
'(!)'
],
[
/:\?:/g,
'(?)'
],
[
/:idea:/g,
'(idea)'
],
[
/:arrow:/g,
'(->)'
],
[
/:mrgreen:/g,
'xD'
]
];
// ##################
// # Main functions #
// ##################

// the required trigger is host specific (userscript vs. addon vs. android etc)
// for now, this merely wraps window.load mapping to the instantCquotoe callback below
Host.registerTrigger();

// FIXME: function is currently referenced in CONFIG hash - event_handler, so cannot be easily moved across
// The main function
// TODO: split up, so that we can reuse the code elsewhere
function instantCquote(sel) {
var profile = getProfile();

// TODO: use config hash here
var selection = document.getSelection(),
post_id=0;

try {
post_id = getPostId(selection, profile);
}
catch (error) {
Host.dbLog('Failed extracting post id\nProfile:' + profile);
return;
}
if (selection.toString() === '') {
Host.dbLog('No text is selected, aborting function');
return;
}
if (!checkValid(selection, profile)) {
Host.dbLog('Selection is not valid, aborting function');
return;
}
try {
transformationLoop(profile, post_id);
}
catch(e) {
UI.alert("Transformation loop:\n"+e.message);
}
} // instantCquote

// TODO: this needs to be refactored so that it can be also reused by the async/AJAX mode
// to extract fields in the background (i.e. move to a separate function)
function transformationLoop(profile, post_id) {
var output = {}, field;
Host.dbLog("Starting extraction/transformation loop");
for (field in profile) {
if (field === 'name') continue;
if (field ==='type' || field === 'event' || field === 'event_handler') continue; // skip fields that don't contain xpath expressions
Host.dbLog("Extracting field using field id:"+post_id);
var fieldData = extractFieldInfo(profile, post_id, field);
var transform = profile[field].transform;
if (transform !== undefined) {
Host.dbLog('Field \'' + field + '\' before transformation:\n\'' + fieldData + '\'');
fieldData = applyTransformations(fieldData, transform);
Host.dbLog('Field \'' + field + '\' after transformation:\n\'' + fieldData + '\'');
}
output[field] = fieldData;
} // extract and transform all fields for the current profile (website)
Host.dbLog("extraction and transformation loop finished");
output.content = stripWhitespace(output.content);

var outputPlain = createCquote(output);
outputText(outputPlain, output);
} // transformationLoop()

/// #############

function runProfileTests() {

for (var profile in CONFIG) {
if (CONFIG[profile].type != 'archive' || !CONFIG[profile].enabled ) continue; // skip the wiki entry, because it's not an actual archive that we need to test
// should be really moved to downloadPostign
if (CONFIG[profile].content.xpath === '') console.log("xpath for content extraction is empty, cannot procedurally extract contents");
for (var test in CONFIG[profile].tests) {
var required_data = CONFIG[profile].tests[test];
var title = required_data.title;
//dbLog('Running test for posting titled:' + title);
// fetch posting via getPostingDataAJAX() and compare to the fields we are looking for (author, title, date)
//getPostingDataAJAX(profile, required_data.url);
//alert("required title:"+title);
} // foreach test

} // foreach profile (website)

} //runProfileTests

function selfCheckDialog() {
var sections = '<h3>Important APIs:</h3><div id="api_checks"></div>';

try {
runProfileTests.call(undefined); // check website profiles
}
catch (e) {
UI.alert(e.message);
}

for (var profile in CONFIG) {
// TODO: also check if enabled or not
if (CONFIG[profile].type != 'archive') continue; // skip the wiki entry, because it's not an actual archive that we need to test
var test_results = '';
for (var test in CONFIG[profile].tests) {
// var fieldData = extractFieldInfo(profile, post_id, 'author');
test_results += CONFIG[profile].tests[test].title + '<p/>';
}
sections +='<h3>' + profile + ':<font color="blue">'+ CONFIG[profile].url_reg+'</font></h3><div><p>' + test_results + '</p></div>\n';
} // https://jqueryui.com/accordion/

var checkDlg = $('<div id="selfCheck" title="Self Check dialog"><p><div id="accordion">' + sections + '</div></p></div>');

// run all API tests, invoke the callback to obtain the status
Environment.runAPITests(Host, function(meta) {

//console.log('Running API test '+meta.name);

meta.test(function(result) {
var status = (result)?'success':'fail';
var test = $("<p></p>").text('Running API test '+meta.name+':'+status);
$('#api_checks', checkDlg).append(test);
}); // update tests results

}); // runAPITests

/*
[].forEach.call(CONFIG, function(profile) {
alert("profile is:"+profile);
[].forEach.call(CONFIG[profile].tests, function(test) {

//UI.alert(test.url);
Host.downloadPosting(test.url, function(downloaded) {
alert("downloaded:");
//if (test.title == downloaded.title) alert("titles match:"+test.title);
}); //downloadPosting
}); //forEach test
}); //forEach profile
*/

//$('#accordion',checkDlg).accordion();
checkDlg.dialog({
width: 700,
height: 500,
open: function () {
// http://stackoverflow.com/questions/2929487/putting-a-jquery-ui-accordion-in-a-jquery-ui-dialog
$('#accordion').accordion({
autoHeight: true
});
}
}); // show dialog
} // selfCheckDialog

// show a simple configuration dialog (WIP)
function setupDialog() {
//alert("configuration dialog is not yet implemented");
var checked = (Host.get_persistent('debug_mode_enabled', false) === true) ? 'checked' : '';
//dbLog("value is:"+get_persistent("debug_mode_enabled"));
//dbLog("persistent debug flag is:"+checked);
var setupDiv = $('<div id="setupDialog" title="Setup dialog">NOTE: this configuration dialog is still work-in-progress</p><label><input id="debugcb" type="checkbox"' + checked + '>Enable Debug mode</label><p/><div id="progressbar"></div></div>');
setupDiv.click(function () {
//alert("changing persistent debug state");
Host.set_persistent('debug_mode_enabled', $('#debugcb').is(':checked'));
});
//MediaWiki editing stub, based on: https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax
//only added here to show some status info in the setup dialog
Host.download('http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page', function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;
var color = (status == 'OK') ? 'green' : 'red';
Host.dbLog(message + status);
var statusDiv = $('<p>' + message + status + '</p>').css('color', color);
setupDiv.append(statusDiv);
});
setupDiv.dialog();
} // setupDialog

// this can be used to download/cache $FG_ROOT/options.xml so that fgfs CLI arguments can be recognized and post-processed automatically
// which can help transforming postings correctly
function downloadOptionsXML() {

// download $FG_ROOT/options.xml
Host.download("https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml?format=raw", function(response) {
var xml = response.responseText;
var doc = Host.make_doc(xml, 'text/xml');
// https://developer.mozilla.org/en-US/docs/Web/API/XPathResult
var options = Host.eval_xpath(doc, '//*/option', XPathResult.ORDERED_NODE_SNAPSHOT_TYPE);

// http://help.dottoro.com/ljgnejkp.php
Host.dbLog("Number of options found in options.xml:"+options.snapshotLength);

// http://help.dottoro.com/ljtfvvpx.php

// https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml

}); // end of options.xml download

} // downloadOptionsXML

function getProfile(url=undefined) {

if(url === undefined)
url=window.location.href;
else
url=url;

Host.dbLog("getProfile call URL is:"+url);

for (var profile in CONFIG) {
if (url.match(CONFIG[profile].url_reg) !== null) {
Host.dbLog('Matching website profile found');
var invocations = Host.get_persistent(Host.getScriptVersion(), 0);
Host.dbLog('Number of script invocations for version ' + Host.getScriptVersion() + ' is:' + invocations);

// determine if we want to show a config dialog
if (invocations === 0) {
Host.dbLog("ask for config dialog to be shown");
var response = UI.confirm('This is your first time running version ' + Host.getScriptVersion() + '\nConfigure now?');
if (response) {

// show configuration dialog (jQuery)
setupDialog();
}
else {
} // don't configure

}

// increment number of invocations, use the script's version number as the key, to prevent the config dialog from showing up again (except for updated scripts)
// FIXME: this is triggered/incremented by each click ...
Host.dbLog("increment number of script invocations");
Host.set_persistent(Host.getScriptVersion(), invocations + 1);
return CONFIG[profile];
} // matched website profile
Host.dbLog('Could not find matching URL in getProfile() call!');
} // for each profile
}// Get the HTML code that is selected

function getSelectedHtml() {
// From http://stackoverflow.com/a/6668159
var html = '',
selection = document.getSelection();
if (selection.rangeCount) {
var container = document.createElement('div');
for (var i = 0; i < selection.rangeCount; i++) {
container.appendChild(selection.getRangeAt(i).cloneContents());
}
html = container.innerHTML;
}
Host.dbLog('instantCquote(): Unprocessed HTML\n\'' + html + '\'');
return html;
}// Gets the selected text

function getSelectedText() {
return document.getSelection().toString();
}// Get the ID of the post
// (this needs some work so that it can be used by the AJAX mode, without an actual selection)

function getPostId(selection, profile, focus) {
if (focus !== undefined) {
Host.dbLog("Trying to get PostId with defined focus");
selection = selection.focusNode.parentNode;
} else {
Host.dbLog("Trying to get PostId with undefined focus");
selection = selection.anchorNode.parentNode;
}
while (selection.id.match(profile.content.idStyle) === null) {
selection = selection.parentNode;
}
Host.dbLog("Selection id is:"+selection.id);
return selection.id;
}

// Checks that the selection is valid
function checkValid(selection, profile) {
var ret = true,
selection_cp = {
},
tags = profile.content.parentTag;
for (var n = 0; n < 2; n++) {
if (n === 0) {
selection_cp = selection.anchorNode.parentNode;
} else {
selection_cp = selection.focusNode.parentNode;
}
while (true) {
if (selection_cp.tagName === 'BODY') {
ret = false;
break;
} else {
var cont = false;
for (var i = 0; i < tags.length; i++) {
if (selection_cp[tags[0]] === tags[i]) {
cont = true;
break;
}
}
if (cont) {
break;
} else {
selection_cp = selection_cp.parentNode;
}
}
}
}
ret = ret && (getPostId(selection, profile) === getPostId(selection, profile, 1));
return ret;
}// Extracts the raw text from a certain place, using an XPath

function extractFieldInfo(profile, id, field) {

if (field === 'content') {
Host.dbLog("Returning content (selection)");
return profile[field].selection();
} else {
Host.dbLog("Extracting field via xpath:"+field);
var xpath = '//*[@id="' + id + '"]/' + profile[field].xpath;
return Host.eval_xpath(document, xpath).stringValue; // document.evaluate(xpath, document, null, XPathResult.STRING_TYPE, null).stringValue;
}
}// Change the text using specified transformations

function applyTransformations(fieldInfo, trans) {
for (var i = 0; i < trans.length; i++) {
fieldInfo = trans[i](fieldInfo);
Host.dbLog('applyTransformations(): Multiple transformation, transformation after loop #' + (i + 1) + ':\n\'' + fieldInfo + '\'');
}
return fieldInfo;

} //applyTransformations

// Formats the quote

function createCquote(data, indirect_speech=false) {
if(!indirect_speech)
return nonQuotedRef(data); // conventional/verbatim selection
else {
// pattern match the content using a vector of regexes
data.content = transformSpeech(data.content, data.author, null, speechTransformations );
return nonQuotedRef(data);
}
}

function nonQuotedRef(data) { //TODO: rename
var template = Host.getTemplate();

var substituted = template
.replace('$CONTENT', data.content)
.replace('$URL',data.url)
.replace('$TITLE',data.title)
.replace('$AUTHOR',data.author)
.replace('$DATE',datef(data.date))
.replace('$ADDED',datef(data.date))
.replace('$SCRIPT_VERSION', Host.getScriptVersion() );

return substituted;
}//

// Output the text.
// Tries the jQuery dialog, and falls back to window.prompt()

function outputText(msg, original) {
try {
OUTPUT.jQueryTabbed(msg, original);
}
catch (err) {
msg = msg.replace(/<\/syntaxhighligh(.)>/g, '</syntaxhighligh$1');
OUTPUT.msgbox(msg);
}
}

// #############
// # Utilities #
// #############

function extract(regex) {
return function (text) {
return text.match(regex) [1];
};
}
function prepend(prefix) {
return function (text) {
return prefix + text;
};
}
function removeComments(html) {
return html.replace(//g, '');
}// Not currently used (as of June 2015), but kept just in case

// currently unused
function escapePipes(html) {
html = html.replace(/\|\|/g, '{{!!}n}');
html = html.replace(/\|\-/g, '{{!-}}');
return html.replace(/\|/g, '{{!}}');
}// Converts HTML <a href="...">...</a> tags to wiki links, internal if possible.

function a2wikilink(html) {
// Links to wiki images, because
// they need special treatment, or else they get displayed.
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/File:(.*?)".*?>(.*?)<\/a>/g, '[[Media:$1|$2]]');
// Wiki links without custom text.
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>http:\/\/wiki\.flightgear\.org\/.*?<\/a>/g, '[[$1]]');
// Links to the wiki with custom text
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>(.*?)<\/a>/g, '[[$1|$2]]');
// Remove underscores from all wiki links
var list = html.match(/\[\[.*?\]\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], underscore2Space(list[i]));
}
} // Convert non-wiki links
// TODO: identify forum/devel list links, and use the AJAX/Host.download helper to get a title/subject for unnamed links (using the existing xpath/regex helpers for that)

html = html.replace(/<a.*?href="(.*?)".*?>(.*?)<\/a>/g, '[$1 $2]');
// Remove triple dots from external links.
// Replace with raw URL (MediaWiki converts it to a link).
list = html.match(/\[.*?(\.\.\.).*?\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], list[i].match(/\[(.*?) .*?\]/) [1]);
}
}
return html;
}// Converts images, including images in <a> links

function img2link(html) {
html = html.replace(/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?><\/a>/g, '[[File:$2|250px|link=$1]]');
html = html.replace(/<img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?>/g, '[[File:$1|250px]]');
html = html.replace(/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="(.*?)".*?><\/a>/g, '(see [$2 image], links to [$1 here])');
return html.replace(/<img.*?src="(.*?)".*?>/g, '(see the [$1 linked image])');
}// Converts smilies

function forum_smilies2text(html) {
html = html.replace(/<img src="\.\/images\/smilies\/icon_.*?\.gif" alt="(.*?)".*?>/g, '$1');
for (var i = 0; i < EMOTICONS.length; i++) {
html = html.replace(EMOTICONS[i][0], EMOTICONS[i][1]);
}
return html;
}// Converts font formatting

function forum_fontstyle2wikistyle(html) {
html = html.replace(/<span style="font-weight: bold">(.*?)<\/span>/g, '\'\'\'$1\'\'\'');
html = html.replace(/<span style="text-decoration: underline">(.*?)<\/span>/g, '<u>$1</u>');
html = html.replace(/<span style="font-style: italic">(.*?)<\/span>/g, '\'\'$1\'\'');
return html.replace(/<span class="posthilit">(.*?)<\/span>/g, '$1');
}// Converts code blocks

function forum_code2syntaxhighlight(html) {
var list = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/g),
data = [
];
if (list === null) return html;
for (var n = 0; n < list.length; n++) {
data = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/);
html = html.replace(data[0], processCode(data));
}
return html;
}// Strips any whitespace from the beginning and end of a string

function stripWhitespace(html) {
html = html.replace(/^\s*?(\S)/, '$1');
return html.replace(/(\S)\s*?\z/, '$1');
}// Process code, including basic detection of language

function processCode(data) {
var lang = '',
code = data[1];
code = code.replace(/ /g, ' ');
if (code.match(/=?.*?$?.*?$?;/) !== null) lang = 'nasal';
if (code.match(/<.*?>.*?<\/.*?>/) !== null || code.match(//) !== null) lang = 'xml';
code = code.replace(/<br\/?>/g, '\n');
return '<syntaxhighlight lang="' + lang + '" enclose="div">\n' + code + '\n</syntaxhighlight>';
}// Converts quote blocks to Cquotes

function forum_quote2cquote(html) {
html = html.replace(/<blockquote class="uncited"><div>(.*?)<\/div><\/blockquote>/g, '{{cquote|$1}}');
if (html.match(/<blockquote>/g) === null) return html;
var numQuotes = html.match(/<blockquote>/g).length;
for (var n = 0; n < numQuotes; n++) {
html = html.replace(/<blockquote><div><cite>(.*?) wrote.*?:<\/cite>(.*?)<\/div><\/blockquote>/, '{{cquote|$2|$1}}');
}
return html;
}// Converts videos to wiki style

function vid2wiki(html) {
// YouTube
html = html.replace(/<div class="video-wrapper">\s.*?<div class="video-container">\s*?<iframe class="youtube-player".*?width="(.*?)" height="(.*?)" src="http:\/\/www\.youtube\.com\/embed\/(.*?)".*?><\/iframe>\s*?<\/div>\s*?<\/div>/g, '{{#ev:youtube|$3|$1x$2}}');
// Vimeo
html = html.replace(/<iframe src="http:\/\/player\.vimeo\.com\/video\/(.*?)\?.*?" width="(.*?)" height="(.*?)".*?>.*?<\/iframe>/g, '{{#ev:vimeo|$1|$2x$3}}');
return html.replace(/\[.*? Watch on Vimeo\]/g, '');
}// Not currently used (as of June 2015), but kept just in case

// currently unused
function escapeEquals(html) {
return html.replace(/=/g, '{{=}}');
}// <br> to newline.

function forum_br2newline(html) {
html = html.replace(/<br\/?><br\/?>/g, '\n');
return html.replace(/<br\/?>/g, '\n\n');
}// Forum list to wiki style

function list2wiki(html) {
var list = html.match(/<ul>(.*?)<\/ul>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '* $1\n');
}
}
list = html.match(/<ol.*?>(.*?)<\/ol>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '# $1\n');
}
}
html = html.replace(/<\/?[uo]l>/g, '');
return html;
}
function nowiki(text) {
return '<nowiki>' + text + '</nowiki>';
}// Returns the correct ordinal adjective

function ordAdj(date) {
date = date.toString();
if (date == '11' || date == '12' || date == '13') {
return 'th';
} else if (date.substr(1) == '1' || date == '1') {
return 'st';
} else if (date.substr(1) == '2' || date == '2') {
return 'nd';
} else if (date.substr(1) == '3' || date == '3') {
return 'rd';
} else {
return 'th';
}
}

// Formats the date to this format: Apr 26th, 2015
function datef(text) {
var date = new Date(text);
return MONTHS[date.getMonth()] + ' ' + date.getDate() + ordAdj(date.getDate()) + ', ' + date.getFullYear();
}
function underscore2Space(str) {
return str.replace(/_/g, ' ');
}

// IGNORE EVERYTHING THAT FOLLOWS:
// This is an experiment to use GA/GP (genetic programming) to help procedurally evolve xpath and regex expressions if/when the underlying websites change
// so that we don't have to manually update/edit the script accordingly (this would also work for mobile themes etc)
// For now, this is heavily based on the genetic.js framework/examples: http://subprotocol.com/system/genetic-hello-world.html
// The idea is to evolve the xpath/regex expression by evaluating its return value against the expected/desired value
// the most important thing here is having a suitable fitness function
//

function evolve_expression_test() {

try {
var genetic = Genetic.create();

// TODO: use minimizer: redundant_bytes + duration_msec + xpath.length
genetic.optimize = Genetic.Optimize.Maximize;
genetic.select1 = Genetic.Select1.Tournament2;
genetic.select2 = Genetic.Select2.Tournament2;

genetic.seed = function() {

function randomString(len) {
var text = "";
var charset = "\\abcdefghijklmnopqrstuvwxyz0123456789[] ()<>*.,";
for(var i=0;i<len;i++)
text += charset.charAt(Math.floor(Math.random() * charset.length));

return text; // "From:&(.*)$<.*8.*>"
}

// create random strings that are equal in length to solution
return randomString( this.userData["solution"].length);
};

genetic.mutate = function(entity) {

function replaceAt(str, index, character) {
return str.substr(0, index) + character + str.substr(index+character.length);
}

// chromosomal drift
var i = Math.floor(Math.random()*entity.length);
return replaceAt(entity, i, String.fromCharCode(entity.charCodeAt(i) + (Math.floor(Math.random()*2) ? 1 : -1)));
};

genetic.crossover = function(mother, father) {

// two-point crossover
var len = mother.length;
var ca = Math.floor(Math.random()*len);
var cb = Math.floor(Math.random()*len);
if (ca > cb) {
var tmp = cb;
cb = ca;
ca = tmp;
}

var son = father.substr(0,ca) + mother.substr(ca, cb-ca) + father.substr(cb);
var daughter = mother.substr(0,ca) + father.substr(ca, cb-ca) + mother.substr(cb);

return [son, daughter];
};

genetic.determineExcessBytes = function (text, needle) {
return text.length - needle.length;
};

genetic.containsText = function (text, needle) {
return text.search(needle);
};

genetic.isValid = function(exp) {

};

/* myFitness:
* - must be a valid xpath/regex expression (try/call)
* - must containsText the needle
* - low relative offset in text (begin/end)
* - excessBytes
* - short expression (expression length)
* - expression footprint (runtime)
*/

// TODO: the fitness function should validate each xpath/regex first

genetic.fitness = function(entity) {
var fitness = 0;
var result;
var validExp = 0.1;
var hasToken = 0.1;

var t = this.userData.tests[0].haystack;
//var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness

if (0)
try {
var regex = new RegExp(entity);
var output = t.search( regex);
validExp = 5;
//if (output) validExp = 50;
}
catch(e) {
//validExp = 2;
}

var i;
for (i=0;i<entity.length;++i) {
// increase fitness for each character that matches
if (entity[i] == this.userData["solution"][i])
fitness += 1;

// award fractions of a point as we get warmer
fitness += (127-Math.abs(entity.charCodeAt(i) - this.userData["solution"].charCodeAt(i)))/50;
}

return fitness + (1*validExp + 1* hasToken);
};

genetic.generation = function(pop, generation, stats) {
// stop running once we've reached the solution
return pop[0].entity != this.userData["solution"];
};

genetic.notification = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {
var diff = value.charCodeAt(i) - this.last.charCodeAt(i);
var style = "background: transparent;";
if (diff > 0) {
style = "background: rgb(0,200,50); color: #fff;";
} else if (diff < 0) {
style = "background: rgb(0,100,50); color: #fff;";
}

solution.push("<span style=\"" + style + "\">" + value[i] + "</span>");
}

var t = this.userData.tests[0].haystack;
//console.log("haystack is:"+t);
// "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"}, /From: (.*) <.*@.*>/
var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness
var output = t.search( new RegExp(value));

var buf = "";
buf += "<tr>";
buf += "<td>" + generation + "</td>";
buf += "<td>" + pop[0].fitness.toPrecision(5) + "</td>";
buf += "<td>" + solution.join("") + "</td>";
buf += "<td>" + output + "</td>";
buf += "</tr>";
$("#results tbody").prepend(buf);

this.last = value;
};

/*
genetic.notification2 = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {

solution.push(value[i]);
}
console.log("Generation:"+ generation + " Fitness:" + pop[0].fitness.toPrecision(5) + " Solution:" + solution.join(""));

this.last = value;
};
*/

var config = {
"iterations": 4000
, "size": 250
, "crossover": 0.3
, "mutation": 0.4
, "skip": 30 // notifications
//, "webWorkers": false
};

/*
var profile = CONFIG['Sourceforge Mailing list'];
var posting = profile.tests[0];
var author_xpath = profile.title.xpath;
*/

var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];

// the regex we want to evolve
var solution = "From: (.*) <.*@.*>";

// let's assume, we'd like to evolve a regex expression like this one
var userData = {
solution: solution,
tests: regexTests
};

genetic.evolve(config, userData);

//console.log("genetic.js is loaded and working, but disabled for now");

} // try
catch (e) {
console.log("genetic.js error:\n" +e.message);
} // catch

} // evolveExpression_test()

if(0) //TODO: expose via development tab
try {
// https://github.com/cazala/synaptic
var Neuron = synaptic.Neuron,
Layer = synaptic.Layer,
Network = synaptic.Network,
Trainer = synaptic.Trainer,
Architect = synaptic.Architect;

function Perceptron(input, hidden, output)
{
// create the layers
var inputLayer = new Layer(input);
var hiddenLayer = new Layer(hidden);
var outputLayer = new Layer(output);

// connect the layers
inputLayer.project(hiddenLayer);
hiddenLayer.project(outputLayer);

// set the layers
this.set({
input: inputLayer,
hidden: [hiddenLayer],
output: outputLayer
});
}

// extend the prototype chain
Perceptron.prototype = new Network();
Perceptron.prototype.constructor = Perceptron;

var myPerceptron = new Perceptron(2,3,1);
var myTrainer = new Trainer(myPerceptron);

myTrainer.XOR(); // { error: 0.004998819355993572, iterations: 21871, time: 356 }

myPerceptron.activate([0,0]); // 0.0268581547421616
myPerceptron.activate([1,0]); // 0.9829673642853368
myPerceptron.activate([0,1]); // 0.9831714267395621
myPerceptron.activate([1,1]); // 0.02128894618097928

console.log("Syntaptic loaded");
} catch(e) {
UI.alert(e.message);
}

</syntaxhighlight>

{{Appendix}}

FlightGear wiki:Instant-Refs

2016-05-20T12:20:56Z

Elgaton: /* Installation */ Styling

[[File:Quotes-logo-200x200.png|thumb]]
[[File:Instant-cquotes-firefox.png|thumb|Instant-Cquotes script in Firefox]]

[[File:Ref-only-quotes.png|thumb|Instant-Cquotes screenshot prototyping runtime format selection]]

The '''Instant-Cquotes''' script is a browser addon (user script) implemented in JavaScript in order to convert excerpts (created via copy&paste) from FlightGear forum or [[mailing list]] postings into MediaWiki markup/quotes to be used on the FlightGear wiki. It is supported by Firefox, Google Chrome/Chromium, Opera and Safari. It is being developed and maintained by a group of volunteers involved in maintaining the wiki and in trying to provide more up-to-date information to end-users who may not be as involved in the various FlightGear-related communication channels.

== Background and motivation ==
FlightGear's development is, at best, "self-coordinated", meaning that contributors discuss ideas and make proposals to contribute in a certain fashion and then team up to implement certain features and building blocks, often just temporarily.

Unfortunately, due to a lack of development manpower, many ideas are not implemented immediately; it is, thus, important to know their pros and cons, as well as who originally proposed them and/or might help with their implementation, even after a long time, preferably with links to the original discussions so that new contributors can decide whether to get involved in some effort or not. The project documentation, however, is in great need of improvement<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/15444440/
| title = <nowiki>[Flightgear-devel] development process (was: chaos...)</nowiki>
| author = <nowiki>John Denker</nowiki>
| date = Jul 16th, 2007
| added = Jul 16th, 2007
| script_version = 0.23
}}</ref> and usually significantly lacking behind:<ref name="OlsonStateThingsFG">{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861667/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Curtis Olson</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> many core developers update it seldomly, if not anymore, as it takes time to write it, as well as an understanding of the inner workings of a complex system such as FlightGear. Furthermore, this task might not be attractive due to its short term impact on the project,<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861562/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Hal V. Engel</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> and it is overwhelming to think about creating documentation that would address the needs of many different kinds of contributors with different backgrounds, experience levels and goals.<ref name="OlsonStateThingsFG" />

Forum and mailing lists discussions have therefore become the only up-to-date (albeit difficult to filter)<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=280058#p280058
| title = <nowiki>Re: quoting on the wiki</nowiki>
| author = <nowiki>Thorsten</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> source of information about recent development progress; this makes it tricky to know what is going on, what needs fixing, what were the decisions taken by the developers.<ref>{{cite web
| url = https://www.mail-archive.com/flightgear-devel%40lists.sourceforge.net/msg17198.html
| title = <nowiki>[Flightgear-devel] Project tracking</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mon, 28 Jul 2008 10:06:05 -0700
}}</ref>

The aim of the Instant-Cquotes script is to help wiki editors to copy relevant excerpts from such sources, formatting them as proper [[Template:Cquote|quotations]], and bootstrap new articles collecting them until a dedicated rewrite is made. It can also be used to reuse announcements to update the changelogs, [[Next newsletter|newsletter]] or the [[Release plan/Lessons learned]] page.

After being away from the wiki system for some time it becomes more of an effort to re-learn how to start a new file and figure out how to format it , with what headings, etc. Sometimes it is almost too much to do the original write up of the original post and all the work of that layout and effort to have to also duplicate it in a wiki article. If I was a little more current and affluent with the wiki editor, I might not be so hesitant to create the work there instead of the forum.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=284698#p284698
|title = <nowiki> Re: Breaking down NLCD raster image </nowiki>
|author = <nowiki> wlbragg </nowiki>
|date = May 9th, 2016
|added = May 9th, 2016
|script_version = 0.38
}}</ref>

In a few cases, such collections of quotes helped not only create bootstrap new articles, but even actual features.

In other cases, quotes have been used to update documentation of features (e.g. [[Rembrandt]]) whose maintainers may not be actively involved in FlightGear, to help document discussions that are taking place in the meantime, and provide some background information for people interested in the corresponding feature.

== Installation ==
# Install a user script manager. On Firefox, you can use [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey]; on Chrome/Chromium, Opera or Safari, you can use [https://tampermonkey.net/ Tampermonkey] (download links: [https://tampermonkey.net/index.php?ext=dhdg&browser=chrome Chrome/Chromium], [https://tampermonkey.net/index.php?ext=dhdg&browser=opera Opera], [https://tampermonkey.net/index.php?ext=dhdg&browser=safari Safari]).
# Visit [https://greasyfork.org/en/scripts/19331-instant-cquotes the Instant-Cquotes page on GreasyFork] and click on {{button|Install this script}} (green button). If Greasemonkey/Tampermonkey prompts you to confirm the installation, agree to do so.

[[File:Howto-install-instant-cquotes.png|thumb|Click the green button to install the script]]

=== Manual installation ===
{{note|This will install the most recent development version of the script, which might contain bugs. Also, GreaseMonkey/TamperMonkey will not update it automatically whenever a new version is released.}}

* '''Firefox'''
# Install Greasemonkey.
# Save [[#The Script|the script]] below as <code>instant_cquotes.user.js</code>, then drag-and-drop it into Firefox.
[[File:Greasemonkey-setup-on-firefox.png|thumb|Screenshot showing the Greasemonkey setup dialog (on Firefox)]]

* '''Chrome/Chromium''', '''Opera''', or '''Safari'''
# Install Tampermonkey.
# Navigate to '''Add a new Script'''.
# Copy and paste [[#The Script|the script]] below into the editing window.
# Click the {{button|Save}} button (just above the {{button|Search}} button).

=== Mobile installation ===
As of May 2016, there is no separate version available for mobile use. Your best chance is installing a userscript addon on Android, like one of those:
* [https://play.google.com/store/apps/details?id=net.biniok.tampermonkey Tampermonkey (Google Play Store)]
* [http://oilcan.jsharkey.org/ OilCan: Greasemonkey on steroids for Android]

For installation instructions, refer to [https://openuserjs.org/about/Tampermonkey-for-Android Tampermonkey for Android] or [http://www.blogtechnika.com/how-to-access-greasemonkey-scripts-on-android-phones/ How To Access Greasemonkey Scripts on Android Phones].

Testing/feedback would obviously be appreciated - if in doubt, feel free to just edit the wiki page to add your findings/questions.

=== Configuration ===
[[File:User-script-menu.png|thumb|GreaseMonkey menu shown in FireFox with instanct cquotes menu items]]

[[File:Config-dialog-instant-cquotes.png|thumb|The configuration dialog for the Instant-Cquotes script]]

As of version 0.30, a dedicated configuration dialog is in the process of being added, so that certain script features can be dynamically configured, without having to edit the script. For now, this is merely a placeholder that provides a checkbox to easily enable/disable the debug mode. In the future, we are hoping to also expose other features this way.

== Usage ==
[[File:Updated-cquotes-script-by-redleader.png|thumb|Instant-Cquotes script, with updates contributed by Red Leader]]

[[File:New-cquotes.png|thumb|Screenshot showing Instant-Cquotes 0.30 at work]]

# Go to some [[mailing list]] archive URL, for example [http://sourceforge.net/p/flightgear/mailman/message/32400727/] or any forum message, such as {{forumref|title=Re: Get objects to show up on Map/Radar|t=23299|label=p212558|f=71}}.
# Select the relevant portion of text.
# When you release the mouse button, a box will appear containing the converted text (for now, mainly properly-referenced quotes for the wiki).
# As the text will already be selected for you, press {{key press|Ctrl|C}} to copy it (no longer necessary).
# Paste the text into the desired wiki page.

For example, by selecting part of the forum post in the link above you can get the following quotation:

{{FGCquote
|1= The upcoming FlightGear version (3.2) will contain a canvas-based map dialog, including a modular "plugin" system for creating custom map layers and charts with roughly ~50 lines of code, most of it boilerplate.
This is entirely XML/Nasal based (scripted) - symbols can be pretty much anything, raster or vector images (png or svg), but even animated. Styling can be customied, too.
For more info, I suggest to check out:
[[MapStructure#Porting the map dialog]]

[[File:MapStructureDialog.png|250px]]
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=212558#p212558
| title = <nowiki>Re: Get objects to show up on Map/Radar</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Jun 14th, 2014
}}
}}

=== On quoting ===
{{Main article|FlightGear wiki:Quoting Guidelines}}

Using the Instant-Cquotes script is a good way to bootstrap and write some preliminary notes; however, while quotes might be useful to understand how undocumented subsystems and features work and are definitely better than nothing, they are not meant to replace proper, structured and well-written wiki articles.<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=282800#p282800
| title = <nowiki>Re: What is the QT launcher?</nowiki>
| author = <nowiki>bugman</nowiki>
| date = Apr 17th, 2016
| added = Apr 17th, 2016
| script_version = 0.25
}}</ref>

One way to convert pages bootstrapped using quotes is to extract relevant information from them and keep citations only as references; in case important details are missing, they can be asked for on the [[Mailing lists|mailing lists]] (on the forum, the chance to get a complete answer might be lower).<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34954385/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> Another option might be moving the quotes to the Talk page for each entry, which would preserve the sources without clogging up the articles.<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34948989/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>Stuart Buchanan</nowiki>
| date = Mar 19th, 2016
| added = Mar 19th, 2016
| script_version = 0.25
}}</ref>

As a matter of fact, the whole paragraph above was assembled using this approach; to see for yourself, look up the references at the end of this page. For another example, see [[TerraSync#News]].

== Development ==
{{Note|A Chrome/Chromium-specific extension that will not need Tampermonkey installed is under development.}}

=== Resources ===
* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/API:Edit

=== Adding sources ===

Adding a new source is pretty straightforward if you understand how xpath and regexes work - basically, you only need an archive (e.g. gmane), and then determine the xpath of each relevant field, as well as the regular expression to process the extracted fields (optional).

The basic steps are these:
# open the user script in an editor
# navigate to the meta header of the user script
# add a new URL to the top of the script, e.g. by copying/adapting an existing line like this:
<syntaxhighlight lang="javascript">
// @match https://sourceforge.net/p/flightgear/mailman/*
</syntaxhighlight>

Once copied, add the new URL:

<syntaxhighlight lang="javascript">
// @match http://thread.gmane.org/gmane.games.flightgear.devel/*
</syntaxhighlight>

Next, you need to navigate to the configuration hash to add a new website to it.

Again, it makes sense to simply take an existing configuration hash and adapt it as needed (ignore/omit the tests vector for now by keeping it empty):

{{Caution|the following example may meanwhile be outdated, so be sure to look at the actual code instead}}

<syntaxhighlight lang="javascript">
'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()',
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [] // vector with transformation callbacks
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()'
transform: []
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
</syntaxhighlight>

Now, we need to review/adapt the profile according to the new archive we'd like to see supported.

for starters, that means:
* changing the name of the profile, e.g. to read gmane (instead of sourceforge)
* change the '''url_reg''' field to the gmane URL (this can be a regular expression)

Next, it makes sense to use an [https://addons.mozilla.org/de/firefox/addon/xpath-checker/ XPath checker], so that we can look up the xpath expression for various HTML elements, and add those to the configuration hash above.

For testing purposes, you will probably go to the setup dialog and enable the DEBUG mode, and use your browser's console to see what is going on.

=== Getting involved ===
While having some experience with JavaScript/HTML and jQuery will definitely be useful, JavaScript is close enough to FlightGear scripting ([[Nasal]]), so that people can get involved pretty easily.

Most maintenance work will typically involve reviewing/maintaining a few configuration hashes, that contain meta information for each supported archive (mailing list/forum).

Usually, each hash contains a combination of xpath/regex expressions to look up the relevant information, as well as vector of optional transformations that are applied (in order) to convert contents to a different format (e.g. dates).

In addition, there is growing library of utility functions, a handful wrappers for useful stuff, for example:

* <code>Host.dbLog(message_string)</code> - log a message to the console if the DEBUG flag is set
* <code>Host.download(url, callback, method='GET')</code> - will download the URL and pass the downloaded content to the callback specified
* <code>Host.downloadPosting(url, callback)</code> - will download the posting URL and pass the extracted and transformed author/content and date fields in a hash to the callback specified, the URL must be one supported in the CONFIG hash (i.e. forum/sourceforge for now)
* <code>Host.make_doc(string, type="text/html")</code> - will turn a string/blob into a DOM that can be queried
* <code>Host.eval_xpath(document, xpath_expression, type=XPathResult.STRING_TYPE)</code> - will apply the xpath expression to the document specified, returning the requested type (defaulted to string)
* <code>Host.set_persistent(key,value)</code> - stores a key/value pair
* <code>Host.get_persistent(key,default_value)</code> - retrieves a values using the key specified, falling back to the default value

=== Porting ===
[[File:Instant-cquote-firefox-addon-mode.png|thumb|Prototyping a dedicated instant-cquote mode for use as a firefox addon]]

Porting the script to support other browsers/script engines is greatly appreciated. Typically, this should be pretty self-contained, because all main APIs are intended to be encapsulated in a so called "Environment" hash, where APIs that are specific to a particular browser/script engine should be provided with a wrapper. As of mid 2016, most APIs are now kept inside such an Environment hash (look at the GreaseMonkey hash for reference/details), so that it is now even possible to turn the script into a standalone FireFox addon without having to change much of the underlying code.

=== Self checks (unit testing) ===
For regression testing purposes, there's a dedicated "self check" dialog that will be extended over time. For now it will download a few profile/website specific postings using a vector called "tests" and then log the posting's title, author and date to the console.

The next step will be actually showing that information in the dialog itself - there's a separate helper function to accomplish that, so that the corresponding div layer can be updated with the results.

[[File:Sanity-check-cquotes-dialog.png|thumb|automatically executed sanity checks]]

=== Debug mode ===
[[File:Instant-cquotes-debug-mode.png|thumb|Instant-Cquotes debug mode]]

=== AJAX (live page editing) ===
{{WIP}}

* http://wiki.flightgear.org/api.php
* http://wiki.flightgear.org/api.php?action=parse&page=Frequently%20asked%20questions&prop=sections

For now, the setup dialog will try to obtain a login token for the wiki and show a message if successful.

In addition, the profile/website hash also contains a new wiki entry for the FlightGear wiki, whose '''event_handler''' callback will be invoked once the FG wiki is visited - the console/log will show a greeting, so that is where other code can be added - e.g. to help clean up/rewrite FGCquote-based articles automatically etc.

There is a vector of "modes", whose members are a hash containing trigger/handler fields, linked to two callbacks - the trigger callback can be used to check some condition, while the handler will be invoked if the trigger returns true.

This can be used to support an arbitrary number of modes, whose triggers are evaluated during page load - all triggers that return true, will have their handlers invoked, which is how the following snippet works to rewrite/augment wiki edit handles:

<syntaxhighlight lang="javascript>
'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile
</syntaxhighlight>

See [[User:Red Leader/Sandbox/AJAX test]]

* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/Extension:VisualEditor
* https://en.wikipedia.org/wiki/Wikipedia:Creating_a_bot

=== Mobile edition ===
{{Note|As of 02/2016, Hooray is contemplating to make this available as an addon for Android phones.}}

=== Issues/limitations ===
==== Bugs ====
* It's eating characters, apparently related to regex/xpath handling - e.g. words like "analyzing" are turned into "analying" [http://forum.flightgear.org/viewtopic.php?f=6&t=28378&p=270735&hilit=analyzing#p270735]
==== Non working URLs ====
* image matching/extraction: http://forum.flightgear.org/viewtopic.php?p=276221#p276221
* http://sourceforge.net/p/flightgear/mailman/message/34754961/
* http://forum.flightgear.org/viewtopic.php?f=18&t=27054&start=90#p273972 → selecting from “As promised, two sample installation sessions on Linux” to “That's it.” towards the end of the message causes Iceweasel (Firefox) 44.0.2 to display a dialog box reading “A script on this page may be busy, or it may have stopped responding. You can stop the script now, open the script in the debugger, or let the script continue.” The line below reads “Script: chrome://greasemonkey-modules/...quotes/instant_cquotes.user.js:544”. Choosing ''Continue'' doesn't help: the same message reappears a few seconds afterwards.

=== Feature requests & ideas ===
* try to recognize list items [https://sourceforge.net/p/flightgear/mailman/message/35095319/] (heuristics: look for colon/asterisk, dashes and CR/LF)
* should add [[Template:News]] to the article dropdown for announcements [http://wiki.flightgear.org/index.php?title=Template:News&oldid=98266]
* add a mode that will download screenshots from forum postings and automatically upload/categorize them, see [[Birds]]
* split the article dropdown into sections, and also populate it with the user's watchlist [https://www.mediawiki.org/wiki/API:Watchlist] {{Progressbar|60}}
* mailing list templates, listed at [http://wiki.flightgear.org/Template_talk:Project_infrastructure#Related_mailing_list_templates]
* expose the cquote/ref markup via the UI so that it can be edited/customized and treated like a template {{Done}} (0.36+)
* identify common/repeated links and automatically create [[Template:Project infrastructure|link/infrastructure templates]] and use those (should be straightforward using the AJAX mode) [http://wiki.flightgear.org/index.php?title=Mailing_lists&curid=2038&diff=97876&oldid=85252]
* add a devel/maintainer mode where it will return the xpath for a selection [http://stackoverflow.com/questions/361130/get-selected-text-and-selected-nodes-on-a-page] [http://stackoverflow.com/questions/12485334/get-surrounding-dom-node-of-selection]
* move openlink,dblog helpers to Environment hash {{Done}}
* identify CLI arguments like --aircraft=c172p and wrap them in between code tags <code>--aircraft=c172p</code> [https://sourceforge.net/p/flightgear/mailman/message/35063277/] (note that we can simply download [https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml options.xml] via openlink() and use that, which is kinda of neat...) {{Progressbar|60}} (see downloadOptionsXML() in the code)
* introduce "layouts" (templates) for different purposes: newsletter, changelog, wiki article, [[The Manual]] (LaTex) ? {{Progressbar|40}}
* use wikipedia template if possible [https://sourceforge.net/p/flightgear/mailman/message/35057670/]
* the new '''tests''' vector could also contain vectors for tests to test the extract/transform* utilities, see Environment.APITests {{Progressbar|50}}
* move environment specific APIs (browser, script host etc) into some kind of Environment hash to encapsulate things (Red Leader was working on a pure Chrome-only version at some point IIRC) {{Progressbar|80}}
* encode script settings in created markup, for future processing/updating of quotes
* look up <code>[x]</code> references and replace with the corresponding link (titled) [https://sourceforge.net/p/flightgear/mailman/message/35055331/] [https://sourceforge.net/p/flightgear/mailman/message/35062598/]
** convert footnotes into Abbr templates [http://article.gmane.org/gmane.games.flightgear.devel/78971]
* support named refs for combining identical refs [http://wiki.flightgear.org/index.php?title=FlightGear_Qt_launcher&curid=13693&diff=97562&oldid=97551]
* adopt [[Template:Forumref]]
* implement a less obnoxious quoting mode, without quotes, where only the ref part would be added, e.g. see the example at [[Graphics Card Profiles]] (it's still 99% quotes, but much less annoying) {{Done}}
* attachment support: identify attachments and link to them: [https://sourceforge.net/p/flightgear/mailman/message/11683451/] [https://sourceforge.net/p/flightgear/mailman/message/23906620/] [https://sourceforge.net/p/flightgear/mailman/message/35059842/] [https://sourceforge.net/p/flightgear/mailman/message/35067087/]
* bulletin points: if there is a colon (:) followed by at least two dashes (-), split up everything after the colon to turn each dash into an asterisk (wiki markup for bulletin points), followed by a newline [http://sourceforge.net/p/flightgear/mailman/message/34760165/]
* generic URL/template matching, e.g. for for sourceforge commit IDs
* make filters/conversions configurable via checkboxes (nowiki, wrap in alert/note boxes)
* make syntax highlighting configurable (language, mode) ?
* consider using something like the Roles template to turn contributor names into tooltips where contributor roles are shown (core dev, fgdata committer etc)
* introduce support for tag clouds to help categorize/classify related quotes
* consider making transformations optional/configurable using check boxes in the jQuery dialog
* add new input method, for quotes that need to be updated/converted (added script version specifically for this purpose), should also add extraction/processing date
* investigate why not all mailing list archives/postings are supported correctly: http://sourceforge.net/p/flightgear/mailman/message/8090479/ (problem traced to <code>getPostID()</code>)
* explore having a ref-only mode without using cquotes, i.e. just copy/paste quotes with proper ref tags and a references section, to rewrite the whole thing (possibly with templates for different purposes, e.g. newsletter/changelog) {{Done}}
* should use Template:Forumref (category:link templates)
* should be updated to use the new repo/flightgear file templates created by Johan & RedLeader {{Not done}}
* resolve links to forum threads to look up the title for the topic/posting, so that the posting's title can be used for those links, instead of just the URL - we can probably do that by making an AJAX call to open URLs asynchronously and extract the title for the thread/posting to come up with something like <code>[http://forum.flightgear.org/viewtopic.php?f=4&t=24421 A call to developers-Lockheed -L188 Electra]</code> ([http://forum.flightgear.org/viewtopic.php?f=4&t=26562&p=247325&hilit=links#p247347]) {{Progressbar|50}}
* convert quoted bug tracker URLs to use the issue template on the wiki {{not done}}
* do regex/xpath validation, and display any errors (e.g. template/theme changes on the forum would currently break the script) {{Progressbar|60}}
* increased focus on supporting different output formats, maybe using a simple [http://www.jquery-steps.com/ jQuery based wizard] (wiki, forum, newsletter, changelog) {{Not done}}
* token matching for keywords/acronyms to link to the corresponding wiki articles (e.g. Nasal, Canvas, FG_ROOT, FG_HOME etc) {{Not done}}
* Add support for [http://sourceforge.net/p/flightgear/codetickets/ tickets], merge requests comments and [http://www.fguk.eu/index.php/forum/index FGUK forum]. (also see [[FlightGear wiki talk:Instant-Cquotes#more sources]])
* GET-encoded SID arguments should be stripped from forum URLs. {{Not done}}
* Links to repositories should be converted to use wiki templates. {{Not done}}
* The {{Abbr|regexes|regular expressions}} used may fail if the HTML DOM of the source changes (e.g., phpBB/theme update)
** Show a warning when that's the case. {{Progressbar|70}} (see the self-check dialog)
** Try multiple regexes in order. {{Progressbar|30}} (see the self-check dialog)
* Use the script to update previously created Cquotes automatically
** Instead of using the <code>getSelection()</code> helper, we could register a match for <tt>wiki.flightgear.org</tt> with <code>action=edit</code> set, so that we can directly process all text of an edited page, using AJAX calls to open the URL in the background. {{Progressbar|40}} (see the self-check dialog, available via the greasemonkey menu)
** See [https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax MW:API:Edit § Editing via Ajax]

=== Changelog ===
{{Note|Contributors are invited to document their changes here, please also add your wiki handle so that others can more easily get in touch.}}

* first stab at implementing unit tests by adding a vector with URLS to be downloaded and fields to be matched (WIP), shown in a jQuery dialog
* support for persistent settings and a jQuery setup dialog with persistence
* hosting is moved, to allow auto-updates [http://www.greasespot.net/2012/02/automatic-script-updates-come-to.html] [https://wiki.greasespot.net/Metadata_Block#.40updateURL] [http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating]
* changed to ref-only quotes for now, not using the FGCquote template anymore, due to its obnoxious appearance on quote-heavy pages (should probably become a runtime option instead)
* updated to use https for forum postings
* add version info to each created quote, i.e. for future updates
* add helper for opening websites asynchronously using AJAX (also via GM helper API)
* display version number in output dialog
* begin using the GreaseMonkey API for setting clipboard content

== The script ==
<gallery mode=packed widths=230px heights=230px>
Instant-cquotes-revamped.png|Instant cquotes: Revamped user interface exposes script internals to make the script better configurable at runtime
Instant-cquotes-template-editor.png|Instant cquotes now features a simple built-in template editor with support for variable substitution, so that wiki templates can be more easily customized
Instant-cquotes-with-wikimedia-API-integration.png|Screenshot showing instant-cquotes with wikimedia API integration to fetch articles/sections and populate dropdown menus accordingly
Instant-cquotes-on-steroids-with-watchlist-support.png|Screenshot showing the JQuery-mode of the instant cquotes script with built-in support for fetching a user's wiki/watchlist to edit/update articles in a semi-automated fashion
</gallery>
{{PD-author|FlightGear contributors}}

{{Note|Anybody interested in contributing to the code is invited to directly edit this wiki article. From 05/2016, the script is hosted on GreasyFork to allow automatic updates. If you'd like to see your changes applied, please bump the version number and [[User:Elgaton|Elgaton]] will upload it in the state it was when the version number was bumped. ''Make sure to perform thorough testing'' before the bump to prevent unexpected breakage; it is generally a good idea to validate your changes using an online syntax checker, e.g.:
* http://jshint.com/
* http://esprima.org/demo/validate.html
* http://codebeautify.org/jsvalidate
<p/>Thank you!}}

Changes that should be mentioned in the changelog, should be added below (and moved to the [[#Changelog]] section subsequently:

* preparations for adding support to download fgdata related files like options.xml to automatically regex known CLI commands
* preparatory work for adding a speech-rewrite engine to assist in converting 1st person speech to 3rd person
* framework for encapsulating userscript specifics in an environment hash to provide better updating/porting support

<syntaxhighlight lang="javascript" enclose="div">// ==UserScript==
// @name Instant-Cquotes
// @name:it Instant-Cquotes
// @license public domain
// @version 0.39
// @date 2016-05-05
// @description Automatically converts selected FlightGear mailing list and forum quotes into post-processed MediaWiki markup (i.e. cquotes).
// @description:it Converte automaticamente citazioni dalla mailing list e dal forum di FlightGear in marcatori MediaWiki (cquote).
// @author Hooray, bigstones, Philosopher, Red Leader & Elgaton (2013-2016)
// @supportURL http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @icon http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @match https://sourceforge.net/p/flightgear/mailman/*
// @match http://sourceforge.net/p/flightgear/mailman/*
// @match https://forum.flightgear.org/*
// @match http://wiki.flightgear.org/*
// @namespace http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @run-at document-start
// @require https://code.jquery.com/jquery-1.10.2.js
// @require https://code.jquery.com/ui/1.11.4/jquery-ui.js
// @require https://cdn.jsdelivr.net/genetic.js/0.1.14/dist.js
// @require https://cdn.jsdelivr.net/synaptic/1.0.4/synaptic.min.js
// @resource jQUI_CSS https://code.jquery.com/ui/1.11.4/themes/smoothness/jquery-ui.css
// @resource myLogo http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @grant GM_registerMenuCommand
// @grant GM_setValue
// @grant GM_getValue
// @grant GM_addStyle
// @grant GM_getResourceText
// @grant GM_getResourceURL
// @grant GM_setClipboard
// @grant GM_xmlhttpRequest
// @noframes
// ==/UserScript==
//
// This work has been released into the public domain by their authors. This
// applies worldwide.
// In some countries this may not be legally possible; if so:
// The authors grant anyone the right to use this work for any purpose, without
// any conditions, unless such conditions are required by law.
//
// This script has a number of dependencies that are implicitly satisfied when run as a user script
// via GreaseMonkey/TamperMonkey; however, these need to be explicitly handled when using a different mode (e.g. firefox/android):
//
// - jQuery - user interface (REQUIRED)
// - genetic-js - genetic programming (OPTIONAL/EXPERIMENTAL)
// - synaptic - neural networks (OPTIONAL/EXPERIMENTAL)
//
//

/* Here are some TODOs
* - support RSS feeds http://dir.gmane.org/gmane.games.flightgear.devel/
* - move event handling/processing to the CONFIG hash
* - use try/catch more widely
* - wrap function calls in try/call for better debugging/diagnostics
* - add helpers for [].forEach.call, map, apply and call
* - replace for/in, for/of, let statements for better compatibility (dont require ES6)
* - for the same reason, replace use of functions with default params
* - isolate UI (e.g. JQUERY) code in UserInterface hash
* - expose regex/transformations via the UI
*
*/

'use strict';

// TODO: move to GreaseMonkey/UI host
// prevent conflicts with jQuery used on webpages: https://wiki.greasespot.net/Third-Party_Libraries#jQuery
// http://stackoverflow.com/a/5014220
this.$ = this.jQuery = jQuery.noConflict(true);

// this hash is just intended to help isolate UI specifics
// so that we don't need to maintain/port tons of code

var UserInterface = {
get: function() {
return UserInterface.DEFAULT;
},

CONSOLE: {

}, // CONSOLE (shell, mainly useful for testing)

DEFAULT: {
alert: function(msg) {return window.alert(msg); },
prompt: function(msg) {return window.prompt(msg); },
confirm: function(msg) {return window.confirm(msg); },
dialog: null,
selection: null,
populateWatchlist: function() {

},
populateEditSections: function() {

}

}, // default UI mapping (Browser/User script)

JQUERY: {

} // JQUERY

}; // UserInterface

var UI = UserInterface.get(); // DEFAULT for now

// This hash is intended to help encapsulate platform specifics (browser/scripting host)
// Ideally, all APIs that are platform specific should be kept here
// This should make it much easier to update/port and maintain the script in the future
var Environment = {
getHost: function(xpi=false) {

if(xpi) {
Environment.scriptEngine = 'firefox addon';
console.log('in firefox xpi/addon mode');
return Environment.FirefoxAddon; // HACK for testing the xpi mode (firefox addon)
}

// This will determine the script engine in use: http://stackoverflow.com/questions/27487828/how-to-detect-if-a-userscript-is-installed-from-the-chrome-store
if (typeof(GM_info) === 'undefined') {
Environment.scriptEngine = "plain Chrome (Or Opera, or scriptish, or Safari, or rarer)";
// See http://stackoverflow.com/a/2401861/331508 for optional browser sniffing code.
}
else {
Environment.scriptEngine = GM_info.scriptHandler || "Greasemonkey";
}
console.log ('Instant cquotes is running on ' + Environment.scriptEngine + '.');

//console.log("not in firefox addon mode...");
// See also: https://wiki.greasespot.net/Cross-browser_userscripting
return Environment.GreaseMonkey; // return the only/default host (for now)
},

validate: function(host) {
if (host.get_persistent('startup.disable_validation',false)) return;

if(Environment.scriptEngine !== "Greasemonkey")
console.log("NOTE: This script has not been tested with script engines other than GreaseMonkey recently!");

var dependencies = [
{name:'jQuery', test: function() {} },
{name:'genetic.js', test: function() {} },
{name:'synaptic', test: function() {} },
];

[].forEach.call(dependencies, function(dep) {
console.log("Checking for dependency:"+dep.name);
var status=false;
try {
dep.test.call(undefined);
status=true;
}
catch(e) {
status=false;
}
finally {
var success = (status)?'==> success':'==> failed';
console.log(success);
return status;
}
});
}, // validate

// this contains unit tests for checking crucial APIs that must work for the script to work correctly
// for the time being, most of these are stubs waiting to be filled in
// for a working example, refer to the JSON test at the end
// TODO: add jQuery tests
APITests: [
{name:'download', test: function(recipient) {recipient(true);} },
{name:'make_doc', test: function(recipient) { recipient(true);} },
{name:'eval_xpath', test: function(recipient) { recipient(true);} },
{name:'JSON de/serialization', test: function(recipient) {
//console.log("running json test");
var identifier = 'unit_tests.json_serialization';
var hash1 = {x:1,y:2,z:3};
Host.set_persistent(identifier, hash1, true);
var hash2 = Host.get_persistent(identifier,null,true);

recipient(JSON.stringify(hash1) === JSON.stringify(hash2));
} // callback
},

// downloads a posting and tries to transform it to 3rd person speech ...
// TODO: add another test to check forum postings
{name:'text/speech transformation', test: function(recipient) {

// the posting we want to download
var url='https://sourceforge.net/p/flightgear/mailman/message/35066974/';
Host.downloadPosting(url, function (result) {

// only process the first sentence by using comma/dot as delimiter
var firstSentence = result.content.substring(result.content.indexOf(',')+1, result.content.indexOf('.'));

var transformed = transformSpeech(firstSentence, result.author, null, speechTransformations );
console.log("3rd person speech transformation:\n"+transformed);

recipient(true);
}); // downloadPosting()

}// test()
}, // end of speech transform test
{
name:"download $FG_ROOT/options.xml", test: function(recipient) {
downloadOptionsXML();
recipient(true);
} // test
}

], // end of APITests

runAPITests: function(host, recipient) {
console.log("Running API tests");
for(let test of Environment.APITests ) {
//var test = Environment.APITests[t];
// invoke the callback passed, with the hash containing the test specs, so that the console/log or a div can be updated showing the test results

recipient.call(undefined, test);

} // foreach test
}, // runAPITests

/*
* ===================================================================================================================================================
*
*/

// NOTE: This mode/environment is WIP and highly experimental ...
// To see this working, you need to package up the whole file as a firefox xpi using "jpm xpi"
// and then start the whole thing via "jpm run", to do that, you also need a matching package.json (i.e. via jpm init)
// ALSO: you will have to explicitly install any dependencies using jpm
FirefoxAddon: {
init: function() {
console.log("Firefox addon mode ...");
},
getScriptVersion: function() {
return '0.36'; // FIXME
},
dbLog: function(msg) {
console.log(msg);
},
addEventListener: function(ev, cb) {

require("sdk/tabs").on("ready", logURL);
function logURL(tab) {
console.log("URL loaded:" + tab.url);
}
},

registerConfigurationOption: function(name, callback, hook) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
console.log("config menu support n/a in firefox mode");
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Using_third-party_modules_%28jpm%29
var menuitems = require("menuitem");
var menuitem = menuitems.Menuitem({
id: "clickme",
menuid: "menu_ToolsPopup",
label: name,
onCommand: function() {
console.log("menuitem clicked:");
callback();
},
insertbefore: "menu_pageInfo"
});
},

registerTrigger: function() {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/context-menu#Item%28options%29
var contextMenu = require("sdk/context-menu");
var menuItem = contextMenu.Item({
label: "Instant Cquote",
context: contextMenu.SelectionContext(),
// https://developer.mozilla.org/en/Add-ons/SDK/Guides/Two_Types_of_Scripts
// https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts
contentScript: 'self.on("click", function () {' +
' var text = window.getSelection().toString();' +
' self.postMessage(text);' +
'});',
onMessage: function (selectionText) {
console.log(selectionText);
instantCquote(selectionText);
}
});

// for selection handling stuff, see: https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/selection

function myListener() {
console.log("A selection has been made.");
}
var selection = require("sdk/selection");
selection.on('select', myListener);

}, //registerTrigger

get_persistent: function(key, default_value) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/simple-storage
var ss = require("sdk/simple-storage");

console.log("firefox mode does not yet have persistence support");
return default_value;},
set_persistent: function(key, value) {
console.log("firefox persistence stubs not yet filled in !");
},

set_clipboard: function(content) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/clipboard

//console.log('clipboard stub not yet filled in ...');
var clipboard = require("sdk/clipboard");
clipboard.set(content);
} //set_cliipboard

}, // end of FireFox addon config

// placeholder for now ...
Android: {
// NOP
}, // Android

///////////////////////////////////////
// supported script engines:
///////////////////////////////////////

GreaseMonkey: {
// TODO: move environment specific initialization code here
init: function() {
// Check if Greasemonkey/Tampermonkey is available
try {
// TODO: add version check for clipboard API and check for TamperMonkey/Scriptish equivalents ?
GM_addStyle(GM_getResourceText('jQUI_CSS'));
} // try
catch (error) {
console.log('Could not add style or determine script version');
} // catch

var commands = [
{name:'Setup quotes',callback:setupDialog, hook:'S' },
{name:'Check quotes',callback:selfCheckDialog, hook:'C' }
];

for (let c of commands ) {
this.registerConfigurationOption(c.name, c.callback, c.hook);
}

}, // init()

getScriptVersion: function() {
return GM_info.script.version;
},

dbLog: function (message) {
if (Boolean(DEBUG)) {
console.log('Instant cquotes:' + message);
}
}, // dbLog()

registerConfigurationOption: function(name,callback,hook) {
// https://wiki.greasespot.net/GM_registerMenuCommand
// https://wiki.greasespot.net/Greasemonkey_Manual:Monkey_Menu#The_Menu
GM_registerMenuCommand(name, callback, hook);
}, //registerMenuCommand()

registerTrigger: function() {

// TODO: we can use the following callback non-interactively, i.e. to trigger background tasks
// http://javascript.info/tutorial/onload-ondomcontentloaded
document.addEventListener("DOMContentLoaded", function(event) {
console.log("Instant Cquotes: DOM fully loaded and parsed");
});

window.addEventListener('load', init); // page fully loaded
Host.dbLog('Instant Cquotes: page load handler registered');

// Initialize (matching page loaded)
function init() {
console.log('Instant Cquotes: page load handler invoked');
var profile = getProfile();

Host.dbLog("Profile type is:"+profile.type);

// Dispatch to correct event handler (depending on website/URL)
// TODO: this stuff could/should be moved into the config hash itself

if (profile.type=='wiki') {
profile.event_handler(); // just for testing
return;
}

Host.dbLog('using default mode');
document.onmouseup = instantCquote;
// HACK: preparations for moving the the event/handler logic also into the profile hash, so that the wiki (edit mode) can be handled equally
//eval(profile.event+"=instantCquote");

} // init()

}, // registerTrigger

download: function (url, callback, method='GET') {
// http://wiki.greasespot.net/GM_xmlhttpRequest
try {
GM_xmlhttpRequest({
method: method,
url: url,
onload: callback
});
}catch(e) {
console.log("download did not work");
}
}, // download()

// is only intended to work with archives supported by the hash
downloadPosting: function (url, EventHandler) {

Host.download(url, function (response) {
var profile = getProfile(url);
var blob = response.responseText;
var doc = Host.make_doc(blob,'text/html');
var result = {}; // hash to be returned

[].forEach.call(['author','date','title','content'], function(field) {
var xpath_query = '//' + profile[field].xpath;
try {
var value = Host.eval_xpath(doc, xpath_query).stringValue;
//UI.alert("extracted field value:"+value);

// now apply all transformations, if any
value = applyTransformations(value, profile[field].transform );

result[field]=value; // store the extracted/transormed value in the hash that we pass on
} // try
catch(e) {
UI.alert("downloadPosting failed:\n"+ e.message);
} // catch
}); // forEach field

EventHandler(result); // pass the result to the handler
}); // call to Host.download()

}, // downloadPosting()

// TODO: add makeAJAXCall, and makeWikiCall here

// turn a string/text blob into a DOM tree that can be queried (e.g. for xpath expressions)
// FIXME: this is browser specific not GM specific ...
make_doc: function(text, type='text/html') {
// to support other browsers, see: https://developer.mozilla.org/en/docs/Web/API/DOMParser
return new DOMParser().parseFromString(text,type);
}, // make DOM document

// xpath handling may be handled separately depending on browser/platform, so better encapsulate this
// FIXME: this is browser specific not GM specific ...
eval_xpath: function(doc, xpath, type=XPathResult.STRING_TYPE) {
return doc.evaluate(xpath, doc, null, type, null);
}, // eval_xpath

set_persistent: function(key, value, json=false)
{
// transparently stringify to json
if(json) {
// http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
value = JSON.stringify (value);
}

// https://wiki.greasespot.net/GM_setValue
GM_setValue(key, value);
//UI.alert('Saved value for key\n'+key+':'+value);
}, // set_persistent

get_persistent: function(key, default_value, json=false) {
// https://wiki.greasespot.net/GM_getValue

var value=GM_getValue(key, default_value);
// transparently support JSON: http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
if(json) {
value = JSON.parse (value) || {};
}
return value;
}, // get_persistent

setClipboard: function(msg) {
// this being a greasemonkey user-script, we are not
// subject to usual browser restrictions
// http://wiki.greasespot.net/GM_setClipboard
GM_setClipboard(msg);
}, // setClipboard()

getTemplate: function() {

// hard-coded default template
var template = '$CONTENT<ref>{{cite web\n' +
' |url = $URL \n' +
' |title = <nowiki> $TITLE </nowiki> \n' +
' |author = <nowiki> $AUTHOR </nowiki> \n' +
' |date = $DATE \n' +
' |added = $ADDED \n' +
' |script_version = $SCRIPT_VERSION \n' +
' }}</ref>\n';

// return a saved template if found, fall back to hard-coded one above otherwise
return Host.get_persistent('default_template', template);

} // getTemplate

} // end of GreaseMonkey environment, add other environments below

}; // Environment hash - intended to help encapsulate host specific stuff (APIs)

// the first thing we need to do is to determine what APIs are available
// and store everything in a Host hash, which is subsequently used for API lookups
// the Host hash contains all platform/browser-specific APIs
var Host = Environment.getHost();
Environment.validate(Host); // this checks the obtained host to see if all required dependencies are available
Host.init(); // run environment specific initialization code (e.g. logic for GreaseMonkey setup)

// move DEBUG handling to a persistent configuration flag so that we can configure this using a jQuery dialog (defaulted to false)
// TODO: move DEBUG variable to Environment hash / init() routine
var DEBUG = Host.get_persistent('debug_mode_enabled', false);
Host.dbLog("Debug mode is:"+DEBUG);
function DEBUG_mode() {
// reset script invocation counter for testing purposes
Host.dbLog('Resetting script invocation counter');
Host.set_persistent(GM_info.script.version, 0);
}

if (DEBUG)
DEBUG_mode();

// hash with supported websites/URLs, includes xpath and regex expressions to extract certain fields, and a vector with optional transformations for post-processing each field

var CONFIG = {
// WIP: the first entry is special, i.e. it's not an actual list archive (source), but only added here so that the same script can be used
// for editing the FlightGear wiki

'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
// TODO: move downloadWatchlist() etc here
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger() ) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile

'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()', // NOTE this is only used by the downloadPosting helper to retrieve the posting without having a selection (TODO:add content xpath to forum hash)
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [],
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()',
transform:[]
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
// next website/URL (forum)
'FlightGear forum': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler (not used atm)
event_handler: null, // the event handler to be invoked (not used atm)
url_reg: /https:\/\/forum\.flightgear\.org\/.*/,
content: {
xpath: '', //TODO: this must be added for downloadPosting() to work, or it cannot extract contents
selection: getSelectedHtml,
idStyle: /p[0-9]{6}/,
parentTag: [
'className',
'content',
'postbody'
],
transform: [
removeComments,
forum_quote2cquote,
forum_smilies2text,
forum_fontstyle2wikistyle,
forum_code2syntaxhighlight,
img2link,
a2wikilink,
vid2wiki,
list2wiki,
forum_br2newline
]
},
// vector with tests to be executed for sanity checks (unit testing)
// postings will be downloaded using the URL specified, and then the author/title
// fields extracted using the outer regex and matched against what is expected
// NOTE: forum postings can be edited, so that these tests would fail - thus, it makes sense to pick locked topics/postings for such tests
tests: [
{
url: 'https://forum.flightgear.org/viewtopic.php?f=18&p=284108#p284108',
author: 'mickybadia',
date: 'May 3rd, 2016',
title: 'OSM still PNG maps'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=19&p=284120#p284120',
author: 'Thorsten',
date: 'May 3rd, 2016',
title: 'Re: FlightGear\'s Screenshot Of The Month MAY 2016'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=71&t=29279&p=283455#p283446',
author: 'Hooray',
date: 'Apr 25th, 2016',
title: 'Re: Best way to learn Canvas?'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=4&t=1460&p=283994#p283994',
author: 'bugman',
date: 'May 2nd, 2016',
title: 'Re: eurofighter typhoon'
} // add other tests below

], // end of vector with self-tests
author: {
xpath: 'div/div[1]/p/strong/a/text()',
transform: [] // no transformations applied
},
title: {
xpath: 'div/div[1]/h3/a/text()',
transform: [] // no transformations applied
},
date: {
xpath: 'div/div[1]/p/text()[2]',
transform: [extract(/» (.*?[0-9]{4})/)]
},
url: {
xpath: 'div/div[1]/p/a/@href',
transform: [
extract(/\.(.*)/),
prepend('https://forum.flightgear.org')
] // transform vector
} // url
} // forum
}; // CONFIG has

// hash to map URLs (wiki article, issue tracker, sourceforge link, forum thread etc) to existing wiki templates
var MatchURL2Templates = [
// placeholder for now
{
name: 'rewrite sourceforge code links',
url_reg: '',
handler: function() {

} // handler

} // add other templates below

]; // MatchURL2Templates

// output methods (alert and jQuery for now)
var OUTPUT = {
// Shows a window.prompt() message box
msgbox: function (msg) {
UI.prompt('Copy to clipboard ' + Host.getScriptVersion(), msg);
Host.setClipboard(msg);
}, // msgbox

// this is currently work-in-progress, and will need to be refactored sooner or later
// for now, functionality matters more than elegant design/code :)
jQueryTabbed: function(msg, original) {
// FIXME: using backtics here makes the whole thing require ES6 ....
var markup = $(`<div id="tabs">
<ul>
<li><a href="#selection">Selection</a></li>
<li><a href="#articles">Articles</a></li>
<li><a href="#templates">Templates</a></li>
<li><a href="#development">Development</a></li>
<li><a href="#settings">Settings</a></li>
<li><a href="#help">Help</a></li>
<li><a href="#about">About</a></li>
</ul>
<div id="selection">This tab contains your extracted and post-processed selection, converted to proper wikimedia markup, including proper attribution.
<div id="content">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="options">
<b>Note this is work-in-progress, i.e. not yet fully functional</b><br/>
<label for="article_select">Select an article to update</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="release" label="Release"/>
<optgroup id="develop" label="Development"/>
<optgroup id="watchlist" label="Watchlist"/>
</select>
<p/>
<label for="section_select">Select section:</label>
<select name="section_select" id="section_select">
</select>
</div>
</div>
<div id="articles">This tab contains articles that you can directly access/edit using the mediawiki API<br/>
Note: The watchlist is retrieved dynamically, so does not need to be edited here<br/>
<label for="article_select">Select an article</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="develop" label="Development"/>
<optgroup id="release" label="Release"/>

</select>

<button id="article_new">New</button>
<button id="article_remove">Remove</button>

<div id="edit_article">
<label for="article_name">Article</label>
<input type="text" id="article_name" name="article_name"><br/>

<label for="article_url">Link</label>
<input type="text" id="article_url" name="article_url"><br/>

<button id="article_save">Save</button>
</div>

</div>
<div id="templates">This tab contains templates for different types of articles (newsletter, changelog, release plan etc)<p/>
For now, this is WIP - in the future, there will be a dropdown menu added and all templates will be editable.<p/>
<div id="template_header">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="template_area"/>
<div id="template_controls">
<button id="template_save">Save</button>
</div>
</div>
<div id="development">This tab is a placeholder for features currently under development<p/>
<button id="evolve_regex">Evolve regex</button><p/>
<button id="test_perceptron">Test Perceptron</button><p/>
<div id="output">

<table id="results">
<thead>
<tr>
<th>Generation</th>
<th>Fitness</th>
<th>Expression</th>
<th>Result</th>
</tr>
</thead>
<tbody>
</tbody>
</table>


</div>
</div>

<div id="settings">This tab will contain script specific settings
</div>
<div id="help">One day, this tab may contain help....<p/><button id="helpButton">Instant Cquotes</button>
</div>
<div id="about">show some script related information here
</div>
</div>`); // tabs div

var evolve_regex = $('div#development button#evolve_regex', markup);
evolve_regex.click(function() {
//alert("Evolve regex");
evolve_expression_test();
});

var test_perceptron = $('div#development button#test_perceptron', markup);
test_perceptron.click(function() {
alert("Test perceptron");
});

// add dynamic elements to each tab

// NOTE: this affects all template selectors, on all tabs
$('select#template_select', markup).change(function() {
UI.alert("Sorry, templates are not yet fully implemented (WIP)");
});

var help = $('#helpButton', markup);
help.button();
help.click(function() {
window.open("http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes");
});

// rows="10"cols="80" style=" width: 420px; height: 350px"
var textarea = $('<textarea id="quotedtext" rows="20" cols="70"/>');
textarea.val(msg);
$('#selection #content', markup).append(textarea);

var templateArea = $('<textarea id="template-edit" rows="20" cols="70"/>');
templateArea.val( Host.getTemplate() );
$('div#templates div#template_area', markup).append(templateArea);

//$('#templates', markup).append($('<button>'));
$('div#templates div#template_controls button#template_save',markup).button().click(function() {
//UI.alert("Saving template:\n"+templateArea.val() );

Host.set_persistent('default_template',templateArea.val() );
}); // save template

// TODO: Currently, this is hard-coded, but should be made customizable via the "articles" tab at some point ...
var articles = [
// NOTE: category must match an existing <optgroup> above, title must match an existing wiki article
{category:'support', name:'Frequently asked questions', url:''},
{category:'support', name:'Asking for help', url:''},
{category:'news', name:'Next newsletter', url:''},
{category:'news', name:'Next changelog', url:''},
{category:'release', name:'Release plan/Lessons learned', url:''}, // TODO: use wikimedia template
{category:'develop', name:'Nasal library', url:''},
{category:'develop', name:'Canvas Snippets', url:''},

];

// TODO: this should be moved elsewhere
function updateArticleList(selector) {
$.each(articles, function (i, article) {
$(selector+ ' optgroup#'+article.category, markup).append($('<option>', {
value: article.name, // FIXME: just a placeholder for now
text : article.name
})); //append option
}); // foreach
} // updateArticleList

// add the article list to the corresponding dropdown menus
updateArticleList('select#article_select');

// populate watchlist (prototype for now)
// TODO: generalize & refactor: url, format

// https://www.mediawiki.org/wiki/API:Watchlist
// http://wiki.flightgear.org/api.php?action=query&list=watchlist
var watchlist_url = 'http://wiki.flightgear.org/api.php?action=query&list=watchlist&format=json';
Host.download(watchlist_url, function(response) {
try {
var watchlist = JSON.parse(response.responseText);

//$('div#options select#section_select', markup).empty(); // delete all sections

$.each(watchlist.query.watchlist, function (i, article) {
$('div#options select#article_select optgroup#watchlist', markup).append($('<option>', {
value: article.title, //FIXME just a placeholder for now
text : article.title
}));
}); //foreach section

}
catch (e) {
UI.alert("Could not download wiki watchlist\n"+watchlist.error.info);
}
}); // download & populate watchlist

// register an event handler for the main tab, so that article specific sections can be retrieved
$('div#options select#article_select', markup).change(function() {
var article = this.value;

// HACK: try to get a login token (actually not needed just for reading ...)
Host.download('http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page', function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;

// populate dropdown menu with article sections
if (status === 'OK') {

// Resolve redirects: https://www.mediawiki.org/wiki/API:Query#Resolving_redirects
var section_url = 'http://wiki.flightgear.org/api.php?action=parse&page='+encodeURIComponent(article)+'&prop=sections&format=json&redirects';
Host.download(section_url, function(response) {
try {
var sections = JSON.parse(response.responseText);

$('div#options select#section_select', markup).empty(); // delete all sections

$.each(sections.parse.sections, function (i, section) {
$('div#options select#section_select', markup).append($('<option>', {
value: section.line, //FIXME just a placeholder for now
text : section.line
}));
}); //foreach section

}
catch (e) {
UI.alert(e.message);
}

}); //download sections

} // login status is OK

}); // Host.download() call, i.e. we have a login token

}); // on select change

// init the tab stuff
markup.tabs();

var diagParam = {
title: 'Instant Cquotes ' + Host.getScriptVersion(),
modal: true,
width: 700,
buttons: [
{
text:'reported speech',
click: function() {
textarea.val(createCquote(original,true));
}
},

{
text: 'Copy',
click: function () {
Host.setClipboard(msg);
$(this).dialog('close');
}
}

]
};

// actually show our tabbed dialog using the params above
markup.dialog(diagParam);

} // jQueryTabbed()

}; // output methods

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// TODO: we can use an online API to help with some of this: http://www.eslnow.org/reported-speech-converter/
// See also: http://blog.mashape.com/list-of-25-natural-language-processing-apis/
// http://text-processing.com/docs/phrases.html
// http://www.alchemyapi.com/
// https://words.bighugelabs.com/api.php
// https://www.wordsapi.com/
// http://www.dictionaryapi.com/
// https://www.textrazor.com/
// http://www.programmableweb.com/news/how-5-natural-language-processing-apis-stack/analysis/2014/07/28

var speechTransformations = [
// TODO: support aliasing using vectors: would/should
// ordering is crucial here (most specific first, least specific/most generic last)

// first, we start off by expanding short forms: http://www.learnenglish.de/grammar/shortforms.html
// http://www.macmillandictionary.com/thesaurus-category/british/short-forms

{query:/couldn\'t/gi, replacement:'could not'},
{query:/I could not/gi, replacement:'$author could not'},

{query:/I\'m/gi, replacement:'I am'},
{query:/I am/gi, replacement:'$author is'},

{query:/I\'ve/, replacement:'I have'},
{query:/I have had/, replacement:'$author had'},

{query:/can(\'|\’)t/gi, replacement:'cannot'},

{query:/I(\'|\’)ll/gi, replacement:'$author will'},
{query:/I(\'|\’)d/gi, replacement:'$author would'},

{query:/I have done/gi, replacement:'$author has done'},
{query:/I\'ve done/gi, replacement:'$author has done'}, //FIXME. queries should really be vectors ...

{query:/I believe/gi, replacement:'$author suggested'},
{query:/I think/gi, replacement:'$author suggested'},
{query:/I guess/gi, replacement:'$author believes'},

{query:/I can see that/gi, replacement:'$author suggested that'},

{query:/I have got/gi, replacement:'$author has got'},
{query:/I\'ve got/gi, replacement:'$author has got'},

{query:/I\'d suggest/gi, replacement:'$author would suggest'},

{query:/I\’m prototyping/gi, replacement:'$author is prototyping'},

{query:/I myself/gi, replacement:'$author himself'},
{query:/I am/gi, replacement:' $author is'},

{query:/I can see/gi, replacement:'$author can see'},
{query:/I can/gi, replacement:'$author can'},
{query:/I have/gi, replacement:'$author has'},
{query:/I should/g, replacement:'$author should'},
{query:/I shall/gi, replacement:'$author shall'},
{query:/I may/gi, replacement:'$author may'},
{query:/I will/gi, replacement:'$author will'},
{query:/I would/gi, replacement:'$author would'},
{query:/by myself/gi, replacement:'by $author'},
{query:/and I/gi, replacement:'and $author'},
{query:/and me/gi, replacement:'and $author'},
{query:/and myself/gi, replacement:'and $author'}

// least specific stuff last (broad/generic stuff is kept as is, with author clarification added in parentheses)
/*
{query:/I/, replacement:'I ($author)'},

{query:/me/, replacement:'me ($author)'},
{query:/my/, replacement:'my ($author)'},
{query:/myself/, replacement:'myself ($author)'},
{query:/mine/, replacement:'$author'}
*/
];

// try to assist in transforming speech using the transformation vector passed in
// still needs to be exposed via the UI
function transformSpeech(text, author, gender, transformations) {
// WIP: foreach transformation in vector, replace the search pattern with the matched string (replacing author/gender as applicable)
//alert("text to be transformed:\n"+text);
for(var i=0;i< transformations.length; i++) {
var token = transformations[i];
// patch the replacement string using the correct author name
var replacement = token.replacement.replace(/\$author/gi, author);
text = text.replace(token.query, replacement);
} // end of token transformation
console.log("transformed text is:"+text);
return text;
} // transformSpeech

// run a self-test

(function() {
var author ="John Doe";
var transformed = transformSpeech("I have decided to commit a new feature", author, null, speechTransformations );
if (transformed !== author+" has decided to commit a new feature")
Host.dbLog("FIXME: Speech transformations are not working correctly");
}) ();
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

var MONTHS = [
'Jan',
'Feb',
'Mar',
'Apr',
'May',
'Jun',
'Jul',
'Aug',
'Sep',
'Oct',
'Nov',
'Dec'
];
// Conversion for forum emoticons
var EMOTICONS = [
[/:shock:/g,
'O_O'],
[
/:lol:/g,
'(lol)'
],
[
/:oops:/g,
':$'
],
[
/:cry:/g,
';('
],
[
/:evil:/g,
'>:)'
],
[
/:twisted:/g,
'3:)'
],
[
/:roll:/g,
'(eye roll)'
],
[
/:wink:/g,
';)'
],
[
/:!:/g,
'(!)'
],
[
/:\?:/g,
'(?)'
],
[
/:idea:/g,
'(idea)'
],
[
/:arrow:/g,
'(->)'
],
[
/:mrgreen:/g,
'xD'
]
];
// ##################
// # Main functions #
// ##################

// the required trigger is host specific (userscript vs. addon vs. android etc)
// for now, this merely wraps window.load mapping to the instantCquotoe callback below
Host.registerTrigger();

// FIXME: function is currently referenced in CONFIG hash - event_handler, so cannot be easily moved across
// The main function
// TODO: split up, so that we can reuse the code elsewhere
function instantCquote(sel) {
var profile = getProfile();

// TODO: use config hash here
var selection = document.getSelection(),
post_id=0;

try {
post_id = getPostId(selection, profile);
}
catch (error) {
Host.dbLog('Failed extracting post id\nProfile:' + profile);
return;
}
if (selection.toString() === '') {
Host.dbLog('No text is selected, aborting function');
return;
}
if (!checkValid(selection, profile)) {
Host.dbLog('Selection is not valid, aborting function');
return;
}
try {
transformationLoop(profile, post_id);
}
catch(e) {
UI.alert("Transformation loop:\n"+e.message);
}
} // instantCquote

// TODO: this needs to be refactored so that it can be also reused by the async/AJAX mode
// to extract fields in the background (i.e. move to a separate function)
function transformationLoop(profile, post_id) {
var output = {}, field;
Host.dbLog("Starting extraction/transformation loop");
for (field in profile) {
if (field === 'name') continue;
if (field ==='type' || field === 'event' || field === 'event_handler') continue; // skip fields that don't contain xpath expressions
Host.dbLog("Extracting field using field id:"+post_id);
var fieldData = extractFieldInfo(profile, post_id, field);
var transform = profile[field].transform;
if (transform !== undefined) {
Host.dbLog('Field \'' + field + '\' before transformation:\n\'' + fieldData + '\'');
fieldData = applyTransformations(fieldData, transform);
Host.dbLog('Field \'' + field + '\' after transformation:\n\'' + fieldData + '\'');
}
output[field] = fieldData;
} // extract and transform all fields for the current profile (website)
Host.dbLog("extraction and transformation loop finished");
output.content = stripWhitespace(output.content);

var outputPlain = createCquote(output);
outputText(outputPlain, output);
} // transformationLoop()

/// #############

function runProfileTests() {

for (var profile in CONFIG) {
if (CONFIG[profile].type != 'archive' || !CONFIG[profile].enabled ) continue; // skip the wiki entry, because it's not an actual archive that we need to test
// should be really moved to downloadPostign
if (CONFIG[profile].content.xpath === '') console.log("xpath for content extraction is empty, cannot procedurally extract contents");
for (var test in CONFIG[profile].tests) {
var required_data = CONFIG[profile].tests[test];
var title = required_data.title;
//dbLog('Running test for posting titled:' + title);
// fetch posting via getPostingDataAJAX() and compare to the fields we are looking for (author, title, date)
//getPostingDataAJAX(profile, required_data.url);
//alert("required title:"+title);
} // foreach test

} // foreach profile (website)

} //runProfileTests

function selfCheckDialog() {
var sections = '<h3>Important APIs:</h3><div id="api_checks"></div>';

try {
runProfileTests.call(undefined); // check website profiles
}
catch (e) {
UI.alert(e.message);
}

for (var profile in CONFIG) {
// TODO: also check if enabled or not
if (CONFIG[profile].type != 'archive') continue; // skip the wiki entry, because it's not an actual archive that we need to test
var test_results = '';
for (var test in CONFIG[profile].tests) {
// var fieldData = extractFieldInfo(profile, post_id, 'author');
test_results += CONFIG[profile].tests[test].title + '<p/>';
}
sections +='<h3>' + profile + ':<font color="blue">'+ CONFIG[profile].url_reg+'</font></h3><div><p>' + test_results + '</p></div>\n';
} // https://jqueryui.com/accordion/

var checkDlg = $('<div id="selfCheck" title="Self Check dialog"><p><div id="accordion">' + sections + '</div></p></div>');

// run all API tests, invoke the callback to obtain the status
Environment.runAPITests(Host, function(meta) {

//console.log('Running API test '+meta.name);

meta.test(function(result) {
var status = (result)?'success':'fail';
var test = $("<p></p>").text('Running API test '+meta.name+':'+status);
$('#api_checks', checkDlg).append(test);
}); // update tests results

}); // runAPITests

/*
[].forEach.call(CONFIG, function(profile) {
alert("profile is:"+profile);
[].forEach.call(CONFIG[profile].tests, function(test) {

//UI.alert(test.url);
Host.downloadPosting(test.url, function(downloaded) {
alert("downloaded:");
//if (test.title == downloaded.title) alert("titles match:"+test.title);
}); //downloadPosting
}); //forEach test
}); //forEach profile
*/

//$('#accordion',checkDlg).accordion();
checkDlg.dialog({
width: 700,
height: 500,
open: function () {
// http://stackoverflow.com/questions/2929487/putting-a-jquery-ui-accordion-in-a-jquery-ui-dialog
$('#accordion').accordion({
autoHeight: true
});
}
}); // show dialog
} // selfCheckDialog

// show a simple configuration dialog (WIP)
function setupDialog() {
//alert("configuration dialog is not yet implemented");
var checked = (Host.get_persistent('debug_mode_enabled', false) === true) ? 'checked' : '';
//dbLog("value is:"+get_persistent("debug_mode_enabled"));
//dbLog("persistent debug flag is:"+checked);
var setupDiv = $('<div id="setupDialog" title="Setup dialog">NOTE: this configuration dialog is still work-in-progress</p><label><input id="debugcb" type="checkbox"' + checked + '>Enable Debug mode</label><p/><div id="progressbar"></div></div>');
setupDiv.click(function () {
//alert("changing persistent debug state");
Host.set_persistent('debug_mode_enabled', $('#debugcb').is(':checked'));
});
//MediaWiki editing stub, based on: https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax
//only added here to show some status info in the setup dialog
Host.download('http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page', function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;
var color = (status == 'OK') ? 'green' : 'red';
Host.dbLog(message + status);
var statusDiv = $('<p>' + message + status + '</p>').css('color', color);
setupDiv.append(statusDiv);
});
setupDiv.dialog();
} // setupDialog

// this can be used to download/cache $FG_ROOT/options.xml so that fgfs CLI arguments can be recognized and post-processed automatically
// which can help transforming postings correctly
function downloadOptionsXML() {

// download $FG_ROOT/options.xml
Host.download("https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml?format=raw", function(response) {
var xml = response.responseText;
var doc = Host.make_doc(xml, 'text/xml');
// https://developer.mozilla.org/en-US/docs/Web/API/XPathResult
var options = Host.eval_xpath(doc, '//*/option', XPathResult.ORDERED_NODE_SNAPSHOT_TYPE);

// http://help.dottoro.com/ljgnejkp.php
Host.dbLog("Number of options found in options.xml:"+options.snapshotLength);

// http://help.dottoro.com/ljtfvvpx.php

// https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml

}); // end of options.xml download

} // downloadOptionsXML

function getProfile(url=undefined) {

if(url === undefined)
url=window.location.href;
else
url=url;

Host.dbLog("getProfile call URL is:"+url);

for (var profile in CONFIG) {
if (url.match(CONFIG[profile].url_reg) !== null) {
Host.dbLog('Matching website profile found');
var invocations = Host.get_persistent(Host.getScriptVersion(), 0);
Host.dbLog('Number of script invocations for version ' + Host.getScriptVersion() + ' is:' + invocations);

// determine if we want to show a config dialog
if (invocations === 0) {
Host.dbLog("ask for config dialog to be shown");
var response = UI.confirm('This is your first time running version ' + Host.getScriptVersion() + '\nConfigure now?');
if (response) {

// show configuration dialog (jQuery)
setupDialog();
}
else {
} // don't configure

}

// increment number of invocations, use the script's version number as the key, to prevent the config dialog from showing up again (except for updated scripts)
// FIXME: this is triggered/incremented by each click ...
Host.dbLog("increment number of script invocations");
Host.set_persistent(Host.getScriptVersion(), invocations + 1);
return CONFIG[profile];
} // matched website profile
Host.dbLog('Could not find matching URL in getProfile() call!');
} // for each profile
}// Get the HTML code that is selected

function getSelectedHtml() {
// From http://stackoverflow.com/a/6668159
var html = '',
selection = document.getSelection();
if (selection.rangeCount) {
var container = document.createElement('div');
for (var i = 0; i < selection.rangeCount; i++) {
container.appendChild(selection.getRangeAt(i).cloneContents());
}
html = container.innerHTML;
}
Host.dbLog('instantCquote(): Unprocessed HTML\n\'' + html + '\'');
return html;
}// Gets the selected text

function getSelectedText() {
return document.getSelection().toString();
}// Get the ID of the post
// (this needs some work so that it can be used by the AJAX mode, without an actual selection)

function getPostId(selection, profile, focus) {
if (focus !== undefined) {
Host.dbLog("Trying to get PostId with defined focus");
selection = selection.focusNode.parentNode;
} else {
Host.dbLog("Trying to get PostId with undefined focus");
selection = selection.anchorNode.parentNode;
}
while (selection.id.match(profile.content.idStyle) === null) {
selection = selection.parentNode;
}
Host.dbLog("Selection id is:"+selection.id);
return selection.id;
}

// Checks that the selection is valid
function checkValid(selection, profile) {
var ret = true,
selection_cp = {
},
tags = profile.content.parentTag;
for (var n = 0; n < 2; n++) {
if (n === 0) {
selection_cp = selection.anchorNode.parentNode;
} else {
selection_cp = selection.focusNode.parentNode;
}
while (true) {
if (selection_cp.tagName === 'BODY') {
ret = false;
break;
} else {
var cont = false;
for (var i = 0; i < tags.length; i++) {
if (selection_cp[tags[0]] === tags[i]) {
cont = true;
break;
}
}
if (cont) {
break;
} else {
selection_cp = selection_cp.parentNode;
}
}
}
}
ret = ret && (getPostId(selection, profile) === getPostId(selection, profile, 1));
return ret;
}// Extracts the raw text from a certain place, using an XPath

function extractFieldInfo(profile, id, field) {

if (field === 'content') {
Host.dbLog("Returning content (selection)");
return profile[field].selection();
} else {
Host.dbLog("Extracting field via xpath:"+field);
var xpath = '//*[@id="' + id + '"]/' + profile[field].xpath;
return Host.eval_xpath(document, xpath).stringValue; // document.evaluate(xpath, document, null, XPathResult.STRING_TYPE, null).stringValue;
}
}// Change the text using specified transformations

function applyTransformations(fieldInfo, trans) {
for (var i = 0; i < trans.length; i++) {
fieldInfo = trans[i](fieldInfo);
Host.dbLog('applyTransformations(): Multiple transformation, transformation after loop #' + (i + 1) + ':\n\'' + fieldInfo + '\'');
}
return fieldInfo;

} //applyTransformations

// Formats the quote

function createCquote(data, indirect_speech=false) {
if(!indirect_speech)
return nonQuotedRef(data); // conventional/verbatim selection
else {
// pattern match the content using a vector of regexes
data.content = transformSpeech(data.content, data.author, null, speechTransformations );
return nonQuotedRef(data);
}
}

function nonQuotedRef(data) { //TODO: rename
var template = Host.getTemplate();

var substituted = template
.replace('$CONTENT', data.content)
.replace('$URL',data.url)
.replace('$TITLE',data.title)
.replace('$AUTHOR',data.author)
.replace('$DATE',datef(data.date))
.replace('$ADDED',datef(data.date))
.replace('$SCRIPT_VERSION', Host.getScriptVersion() );

return substituted;
}//

// Output the text.
// Tries the jQuery dialog, and falls back to window.prompt()

function outputText(msg, original) {
try {
OUTPUT.jQueryTabbed(msg, original);
}
catch (err) {
msg = msg.replace(/<\/syntaxhighligh(.)>/g, '</syntaxhighligh$1');
OUTPUT.msgbox(msg);
}
}

// #############
// # Utilities #
// #############

function extract(regex) {
return function (text) {
return text.match(regex) [1];
};
}
function prepend(prefix) {
return function (text) {
return prefix + text;
};
}
function removeComments(html) {
return html.replace(//g, '');
}// Not currently used (as of June 2015), but kept just in case

// currently unused
function escapePipes(html) {
html = html.replace(/\|\|/g, '{{!!}n}');
html = html.replace(/\|\-/g, '{{!-}}');
return html.replace(/\|/g, '{{!}}');
}// Converts HTML <a href="...">...</a> tags to wiki links, internal if possible.

function a2wikilink(html) {
// Links to wiki images, because
// they need special treatment, or else they get displayed.
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/File:(.*?)".*?>(.*?)<\/a>/g, '[[Media:$1|$2]]');
// Wiki links without custom text.
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>http:\/\/wiki\.flightgear\.org\/.*?<\/a>/g, '[[$1]]');
// Links to the wiki with custom text
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>(.*?)<\/a>/g, '[[$1|$2]]');
// Remove underscores from all wiki links
var list = html.match(/\[\[.*?\]\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], underscore2Space(list[i]));
}
} // Convert non-wiki links
// TODO: identify forum/devel list links, and use the AJAX/Host.download helper to get a title/subject for unnamed links (using the existing xpath/regex helpers for that)

html = html.replace(/<a.*?href="(.*?)".*?>(.*?)<\/a>/g, '[$1 $2]');
// Remove triple dots from external links.
// Replace with raw URL (MediaWiki converts it to a link).
list = html.match(/\[.*?(\.\.\.).*?\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], list[i].match(/\[(.*?) .*?\]/) [1]);
}
}
return html;
}// Converts images, including images in <a> links

function img2link(html) {
html = html.replace(/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?><\/a>/g, '[[File:$2|250px|link=$1]]');
html = html.replace(/<img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?>/g, '[[File:$1|250px]]');
html = html.replace(/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="(.*?)".*?><\/a>/g, '(see [$2 image], links to [$1 here])');
return html.replace(/<img.*?src="(.*?)".*?>/g, '(see the [$1 linked image])');
}// Converts smilies

function forum_smilies2text(html) {
html = html.replace(/<img src="\.\/images\/smilies\/icon_.*?\.gif" alt="(.*?)".*?>/g, '$1');
for (var i = 0; i < EMOTICONS.length; i++) {
html = html.replace(EMOTICONS[i][0], EMOTICONS[i][1]);
}
return html;
}// Converts font formatting

function forum_fontstyle2wikistyle(html) {
html = html.replace(/<span style="font-weight: bold">(.*?)<\/span>/g, '\'\'\'$1\'\'\'');
html = html.replace(/<span style="text-decoration: underline">(.*?)<\/span>/g, '<u>$1</u>');
html = html.replace(/<span style="font-style: italic">(.*?)<\/span>/g, '\'\'$1\'\'');
return html.replace(/<span class="posthilit">(.*?)<\/span>/g, '$1');
}// Converts code blocks

function forum_code2syntaxhighlight(html) {
var list = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/g),
data = [
];
if (list === null) return html;
for (var n = 0; n < list.length; n++) {
data = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/);
html = html.replace(data[0], processCode(data));
}
return html;
}// Strips any whitespace from the beginning and end of a string

function stripWhitespace(html) {
html = html.replace(/^\s*?(\S)/, '$1');
return html.replace(/(\S)\s*?\z/, '$1');
}// Process code, including basic detection of language

function processCode(data) {
var lang = '',
code = data[1];
code = code.replace(/ /g, ' ');
if (code.match(/=?.*?$?.*?$?;/) !== null) lang = 'nasal';
if (code.match(/<.*?>.*?<\/.*?>/) !== null || code.match(//) !== null) lang = 'xml';
code = code.replace(/<br\/?>/g, '\n');
return '<syntaxhighlight lang="' + lang + '" enclose="div">\n' + code + '\n</syntaxhighlight>';
}// Converts quote blocks to Cquotes

function forum_quote2cquote(html) {
html = html.replace(/<blockquote class="uncited"><div>(.*?)<\/div><\/blockquote>/g, '{{cquote|$1}}');
if (html.match(/<blockquote>/g) === null) return html;
var numQuotes = html.match(/<blockquote>/g).length;
for (var n = 0; n < numQuotes; n++) {
html = html.replace(/<blockquote><div><cite>(.*?) wrote.*?:<\/cite>(.*?)<\/div><\/blockquote>/, '{{cquote|$2|$1}}');
}
return html;
}// Converts videos to wiki style

function vid2wiki(html) {
// YouTube
html = html.replace(/<div class="video-wrapper">\s.*?<div class="video-container">\s*?<iframe class="youtube-player".*?width="(.*?)" height="(.*?)" src="http:\/\/www\.youtube\.com\/embed\/(.*?)".*?><\/iframe>\s*?<\/div>\s*?<\/div>/g, '{{#ev:youtube|$3|$1x$2}}');
// Vimeo
html = html.replace(/<iframe src="http:\/\/player\.vimeo\.com\/video\/(.*?)\?.*?" width="(.*?)" height="(.*?)".*?>.*?<\/iframe>/g, '{{#ev:vimeo|$1|$2x$3}}');
return html.replace(/\[.*? Watch on Vimeo\]/g, '');
}// Not currently used (as of June 2015), but kept just in case

// currently unused
function escapeEquals(html) {
return html.replace(/=/g, '{{=}}');
}// <br> to newline.

function forum_br2newline(html) {
html = html.replace(/<br\/?><br\/?>/g, '\n');
return html.replace(/<br\/?>/g, '\n\n');
}// Forum list to wiki style

function list2wiki(html) {
var list = html.match(/<ul>(.*?)<\/ul>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '* $1\n');
}
}
list = html.match(/<ol.*?>(.*?)<\/ol>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '# $1\n');
}
}
html = html.replace(/<\/?[uo]l>/g, '');
return html;
}
function nowiki(text) {
return '<nowiki>' + text + '</nowiki>';
}// Returns the correct ordinal adjective

function ordAdj(date) {
date = date.toString();
if (date == '11' || date == '12' || date == '13') {
return 'th';
} else if (date.substr(1) == '1' || date == '1') {
return 'st';
} else if (date.substr(1) == '2' || date == '2') {
return 'nd';
} else if (date.substr(1) == '3' || date == '3') {
return 'rd';
} else {
return 'th';
}
}

// Formats the date to this format: Apr 26th, 2015
function datef(text) {
var date = new Date(text);
return MONTHS[date.getMonth()] + ' ' + date.getDate() + ordAdj(date.getDate()) + ', ' + date.getFullYear();
}
function underscore2Space(str) {
return str.replace(/_/g, ' ');
}

// IGNORE EVERYTHING THAT FOLLOWS:
// This is an experiment to use GA/GP (genetic programming) to help procedurally evolve xpath and regex expressions if/when the underlying websites change
// so that we don't have to manually update/edit the script accordingly (this would also work for mobile themes etc)
// For now, this is heavily based on the genetic.js framework/examples: http://subprotocol.com/system/genetic-hello-world.html
// The idea is to evolve the xpath/regex expression by evaluating its return value against the expected/desired value
// the most important thing here is having a suitable fitness function
//

function evolve_expression_test() {

try {
var genetic = Genetic.create();

// TODO: use minimizer: redundant_bytes + duration_msec + xpath.length
genetic.optimize = Genetic.Optimize.Maximize;
genetic.select1 = Genetic.Select1.Tournament2;
genetic.select2 = Genetic.Select2.Tournament2;

genetic.seed = function() {

function randomString(len) {
var text = "";
var charset = "\\abcdefghijklmnopqrstuvwxyz0123456789[] ()<>*.,";
for(var i=0;i<len;i++)
text += charset.charAt(Math.floor(Math.random() * charset.length));

return text; // "From:&(.*)$<.*8.*>"
}

// create random strings that are equal in length to solution
return randomString( this.userData["solution"].length);
};

genetic.mutate = function(entity) {

function replaceAt(str, index, character) {
return str.substr(0, index) + character + str.substr(index+character.length);
}

// chromosomal drift
var i = Math.floor(Math.random()*entity.length);
return replaceAt(entity, i, String.fromCharCode(entity.charCodeAt(i) + (Math.floor(Math.random()*2) ? 1 : -1)));
};

genetic.crossover = function(mother, father) {

// two-point crossover
var len = mother.length;
var ca = Math.floor(Math.random()*len);
var cb = Math.floor(Math.random()*len);
if (ca > cb) {
var tmp = cb;
cb = ca;
ca = tmp;
}

var son = father.substr(0,ca) + mother.substr(ca, cb-ca) + father.substr(cb);
var daughter = mother.substr(0,ca) + father.substr(ca, cb-ca) + mother.substr(cb);

return [son, daughter];
};

genetic.determineExcessBytes = function (text, needle) {
return text.length - needle.length;
};

genetic.containsText = function (text, needle) {
return text.search(needle);
};

genetic.isValid = function(exp) {

};

/* myFitness:
* - must be a valid xpath/regex expression (try/call)
* - must containsText the needle
* - low relative offset in text (begin/end)
* - excessBytes
* - short expression (expression length)
* - expression footprint (runtime)
*/

// TODO: the fitness function should validate each xpath/regex first

genetic.fitness = function(entity) {
var fitness = 0;
var result;
var validExp = 0.1;
var hasToken = 0.1;

var t = this.userData.tests[0].haystack;
//var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness

if (0)
try {
var regex = new RegExp(entity);
var output = t.search( regex);
validExp = 5;
//if (output) validExp = 50;
}
catch(e) {
//validExp = 2;
}

var i;
for (i=0;i<entity.length;++i) {
// increase fitness for each character that matches
if (entity[i] == this.userData["solution"][i])
fitness += 1;

// award fractions of a point as we get warmer
fitness += (127-Math.abs(entity.charCodeAt(i) - this.userData["solution"].charCodeAt(i)))/50;
}

return fitness + (1*validExp + 1* hasToken);
};

genetic.generation = function(pop, generation, stats) {
// stop running once we've reached the solution
return pop[0].entity != this.userData["solution"];
};

genetic.notification = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {
var diff = value.charCodeAt(i) - this.last.charCodeAt(i);
var style = "background: transparent;";
if (diff > 0) {
style = "background: rgb(0,200,50); color: #fff;";
} else if (diff < 0) {
style = "background: rgb(0,100,50); color: #fff;";
}

solution.push("<span style=\"" + style + "\">" + value[i] + "</span>");
}

var t = this.userData.tests[0].haystack;
//console.log("haystack is:"+t);
// "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"}, /From: (.*) <.*@.*>/
var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness
var output = t.search( new RegExp(value));

var buf = "";
buf += "<tr>";
buf += "<td>" + generation + "</td>";
buf += "<td>" + pop[0].fitness.toPrecision(5) + "</td>";
buf += "<td>" + solution.join("") + "</td>";
buf += "<td>" + output + "</td>";
buf += "</tr>";
$("#results tbody").prepend(buf);

this.last = value;
};

/*
genetic.notification2 = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {

solution.push(value[i]);
}
console.log("Generation:"+ generation + " Fitness:" + pop[0].fitness.toPrecision(5) + " Solution:" + solution.join(""));

this.last = value;
};
*/

var config = {
"iterations": 4000
, "size": 250
, "crossover": 0.3
, "mutation": 0.4
, "skip": 30 // notifications
//, "webWorkers": false
};

/*
var profile = CONFIG['Sourceforge Mailing list'];
var posting = profile.tests[0];
var author_xpath = profile.title.xpath;
*/

var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];

// the regex we want to evolve
var solution = "From: (.*) <.*@.*>";

// let's assume, we'd like to evolve a regex expression like this one
var userData = {
solution: solution,
tests: regexTests
};

genetic.evolve(config, userData);

//console.log("genetic.js is loaded and working, but disabled for now");

} // try
catch (e) {
console.log("genetic.js error:\n" +e.message);
} // catch

} // evolveExpression_test()

if(0) //TODO: expose via development tab
try {
// https://github.com/cazala/synaptic
var Neuron = synaptic.Neuron,
Layer = synaptic.Layer,
Network = synaptic.Network,
Trainer = synaptic.Trainer,
Architect = synaptic.Architect;

function Perceptron(input, hidden, output)
{
// create the layers
var inputLayer = new Layer(input);
var hiddenLayer = new Layer(hidden);
var outputLayer = new Layer(output);

// connect the layers
inputLayer.project(hiddenLayer);
hiddenLayer.project(outputLayer);

// set the layers
this.set({
input: inputLayer,
hidden: [hiddenLayer],
output: outputLayer
});
}

// extend the prototype chain
Perceptron.prototype = new Network();
Perceptron.prototype.constructor = Perceptron;

var myPerceptron = new Perceptron(2,3,1);
var myTrainer = new Trainer(myPerceptron);

myTrainer.XOR(); // { error: 0.004998819355993572, iterations: 21871, time: 356 }

myPerceptron.activate([0,0]); // 0.0268581547421616
myPerceptron.activate([1,0]); // 0.9829673642853368
myPerceptron.activate([0,1]); // 0.9831714267395621
myPerceptron.activate([1,1]); // 0.02128894618097928

console.log("Syntaptic loaded");
} catch(e) {
UI.alert(e.message);
}

</syntaxhighlight>

{{Appendix}}

FlightGear wiki:Instant-Refs

2016-05-20T12:19:30Z

Elgaton: /* Background and motivation */ Remove duplicate reference

[[File:Quotes-logo-200x200.png|thumb]]
[[File:Instant-cquotes-firefox.png|thumb|Instant-Cquotes script in Firefox]]

[[File:Ref-only-quotes.png|thumb|Instant-Cquotes screenshot prototyping runtime format selection]]

The '''Instant-Cquotes''' script is a browser addon (user script) implemented in JavaScript in order to convert excerpts (created via copy&paste) from FlightGear forum or [[mailing list]] postings into MediaWiki markup/quotes to be used on the FlightGear wiki. It is supported by Firefox, Google Chrome/Chromium, Opera and Safari. It is being developed and maintained by a group of volunteers involved in maintaining the wiki and in trying to provide more up-to-date information to end-users who may not be as involved in the various FlightGear-related communication channels.

== Background and motivation ==
FlightGear's development is, at best, "self-coordinated", meaning that contributors discuss ideas and make proposals to contribute in a certain fashion and then team up to implement certain features and building blocks, often just temporarily.

Unfortunately, due to a lack of development manpower, many ideas are not implemented immediately; it is, thus, important to know their pros and cons, as well as who originally proposed them and/or might help with their implementation, even after a long time, preferably with links to the original discussions so that new contributors can decide whether to get involved in some effort or not. The project documentation, however, is in great need of improvement<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/15444440/
| title = <nowiki>[Flightgear-devel] development process (was: chaos...)</nowiki>
| author = <nowiki>John Denker</nowiki>
| date = Jul 16th, 2007
| added = Jul 16th, 2007
| script_version = 0.23
}}</ref> and usually significantly lacking behind:<ref name="OlsonStateThingsFG">{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861667/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Curtis Olson</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> many core developers update it seldomly, if not anymore, as it takes time to write it, as well as an understanding of the inner workings of a complex system such as FlightGear. Furthermore, this task might not be attractive due to its short term impact on the project,<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/27861562/
| title = <nowiki>Re: [Flightgear-devel] The state of things in Flight Gear</nowiki>
| author = <nowiki>Hal V. Engel</nowiki>
| date = Jul 27th, 2011
| added = Jul 27th, 2011
| script_version = 0.23
}}</ref> and it is overwhelming to think about creating documentation that would address the needs of many different kinds of contributors with different backgrounds, experience levels and goals.<ref name="OlsonStateThingsFG" />

Forum and mailing lists discussions have therefore become the only up-to-date (albeit difficult to filter)<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=280058#p280058
| title = <nowiki>Re: quoting on the wiki</nowiki>
| author = <nowiki>Thorsten</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> source of information about recent development progress; this makes it tricky to know what is going on, what needs fixing, what were the decisions taken by the developers.<ref>{{cite web
| url = https://www.mail-archive.com/flightgear-devel%40lists.sourceforge.net/msg17198.html
| title = <nowiki>[Flightgear-devel] Project tracking</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mon, 28 Jul 2008 10:06:05 -0700
}}</ref>

The aim of the Instant-Cquotes script is to help wiki editors to copy relevant excerpts from such sources, formatting them as proper [[Template:Cquote|quotations]], and bootstrap new articles collecting them until a dedicated rewrite is made. It can also be used to reuse announcements to update the changelogs, [[Next newsletter|newsletter]] or the [[Release plan/Lessons learned]] page.

After being away from the wiki system for some time it becomes more of an effort to re-learn how to start a new file and figure out how to format it , with what headings, etc. Sometimes it is almost too much to do the original write up of the original post and all the work of that layout and effort to have to also duplicate it in a wiki article. If I was a little more current and affluent with the wiki editor, I might not be so hesitant to create the work there instead of the forum.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=284698#p284698
|title = <nowiki> Re: Breaking down NLCD raster image </nowiki>
|author = <nowiki> wlbragg </nowiki>
|date = May 9th, 2016
|added = May 9th, 2016
|script_version = 0.38
}}</ref>

In a few cases, such collections of quotes helped not only create bootstrap new articles, but even actual features.

In other cases, quotes have been used to update documentation of features (e.g. [[Rembrandt]]) whose maintainers may not be actively involved in FlightGear, to help document discussions that are taking place in the meantime, and provide some background information for people interested in the corresponding feature.

== Installation ==
# Install a user script manager. On Firefox, you can use [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey]; on Chrome/Chromium, Opera or Safari, you can use [https://tampermonkey.net/ Tampermonkey] (download links: [https://tampermonkey.net/index.php?ext=dhdg&browser=chrome Chrome/Chromium], [https://tampermonkey.net/index.php?ext=dhdg&browser=opera Opera], [https://tampermonkey.net/index.php?ext=dhdg&browser=safari Safari]).
# Visit [https://greasyfork.org/en/scripts/19331-instant-cquotes the Instant-Cquotes page on GreasyFork] and click on '''Install this script''' (green button). If Greasemonkey/Tampermonkey prompts you to confirm the installation, agree to do so.

[[File:Howto-install-instant-cquotes.png|thumb|click the green button to install the script]]

=== Manual installation ===
{{note|This will install the most recent development version of the script, which might contain bugs. Also, GreaseMonkey/TamperMonkey will not update it automatically whenever a new version is released.}}

* '''Firefox'''
# Install Greasemonkey.
# Save [[#The Script|the script]] below as <code>instant_cquotes.user.js</code>, then drag-and-drop it into Firefox.
[[File:Greasemonkey-setup-on-firefox.png|thumb|Screenshot showing the Greasemonkey setup dialog (on Firefox)]]

* '''Chrome/Chromium''', '''Opera''', or '''Safari'''
# Install Tampermonkey.
# Navigate to '''Add a new Script'''.
# Copy and paste [[#The Script|the script]] below into the editing window.
# Click the '''Save''' button (just above the {{button|Search}} button).

=== Mobile installation ===
As of May 2016, there is no separate version available for mobile use. Your best chance is installing a userscript addon on Android, like one of those:
* [https://play.google.com/store/apps/details?id=net.biniok.tampermonkey Tampermonkey (Google Play Store)]
* [http://oilcan.jsharkey.org/ OilCan: Greasemonkey on steroids for Android]

For installation instructions, refer to [https://openuserjs.org/about/Tampermonkey-for-Android Tampermonkey for Android] or [http://www.blogtechnika.com/how-to-access-greasemonkey-scripts-on-android-phones/ How To Access Greasemonkey Scripts on Android Phones].

Testing/feedback would obviously be appreciated - if in doubt, feel free to just edit the wiki page to add your findings/questions.

=== Configuration ===
[[File:User-script-menu.png|thumb|GreaseMonkey menu shown in FireFox with instanct cquotes menu items]]

[[File:Config-dialog-instant-cquotes.png|thumb|The configuration dialog for the Instant-Cquotes script]]

As of version 0.30, a dedicated configuration dialog is in the process of being added, so that certain script features can be dynamically configured, without having to edit the script. For now, this is merely a placeholder that provides a checkbox to easily enable/disable the debug mode. In the future, we are hoping to also expose other features this way.

== Usage ==
[[File:Updated-cquotes-script-by-redleader.png|thumb|Instant-Cquotes script, with updates contributed by Red Leader]]

[[File:New-cquotes.png|thumb|Screenshot showing Instant-Cquotes 0.30 at work]]

# Go to some [[mailing list]] archive URL, for example [http://sourceforge.net/p/flightgear/mailman/message/32400727/] or any forum message, such as {{forumref|title=Re: Get objects to show up on Map/Radar|t=23299|label=p212558|f=71}}.
# Select the relevant portion of text.
# When you release the mouse button, a box will appear containing the converted text (for now, mainly properly-referenced quotes for the wiki).
# As the text will already be selected for you, press {{key press|Ctrl|C}} to copy it (no longer necessary).
# Paste the text into the desired wiki page.

For example, by selecting part of the forum post in the link above you can get the following quotation:

{{FGCquote
|1= The upcoming FlightGear version (3.2) will contain a canvas-based map dialog, including a modular "plugin" system for creating custom map layers and charts with roughly ~50 lines of code, most of it boilerplate.
This is entirely XML/Nasal based (scripted) - symbols can be pretty much anything, raster or vector images (png or svg), but even animated. Styling can be customied, too.
For more info, I suggest to check out:
[[MapStructure#Porting the map dialog]]

[[File:MapStructureDialog.png|250px]]
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=212558#p212558
| title = <nowiki>Re: Get objects to show up on Map/Radar</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Jun 14th, 2014
}}
}}

=== On quoting ===
{{Main article|FlightGear wiki:Quoting Guidelines}}

Using the Instant-Cquotes script is a good way to bootstrap and write some preliminary notes; however, while quotes might be useful to understand how undocumented subsystems and features work and are definitely better than nothing, they are not meant to replace proper, structured and well-written wiki articles.<ref>{{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=282800#p282800
| title = <nowiki>Re: What is the QT launcher?</nowiki>
| author = <nowiki>bugman</nowiki>
| date = Apr 17th, 2016
| added = Apr 17th, 2016
| script_version = 0.25
}}</ref>

One way to convert pages bootstrapped using quotes is to extract relevant information from them and keep citations only as references; in case important details are missing, they can be asked for on the [[Mailing lists|mailing lists]] (on the forum, the chance to get a complete answer might be lower).<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34954385/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>James Turner</nowiki>
| date = Mar 21st, 2016
| added = Mar 21st, 2016
| script_version = 0.25
}}</ref> Another option might be moving the quotes to the Talk page for each entry, which would preserve the sources without clogging up the articles.<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34948989/
| title = <nowiki>Re: [Flightgear-devel] Wiki Quotes</nowiki>
| author = <nowiki>Stuart Buchanan</nowiki>
| date = Mar 19th, 2016
| added = Mar 19th, 2016
| script_version = 0.25
}}</ref>

As a matter of fact, the whole paragraph above was assembled using this approach; to see for yourself, look up the references at the end of this page. For another example, see [[TerraSync#News]].

== Development ==
{{Note|A Chrome/Chromium-specific extension that will not need Tampermonkey installed is under development.}}

=== Resources ===
* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/API:Edit

=== Adding sources ===

Adding a new source is pretty straightforward if you understand how xpath and regexes work - basically, you only need an archive (e.g. gmane), and then determine the xpath of each relevant field, as well as the regular expression to process the extracted fields (optional).

The basic steps are these:
# open the user script in an editor
# navigate to the meta header of the user script
# add a new URL to the top of the script, e.g. by copying/adapting an existing line like this:
<syntaxhighlight lang="javascript">
// @match https://sourceforge.net/p/flightgear/mailman/*
</syntaxhighlight>

Once copied, add the new URL:

<syntaxhighlight lang="javascript">
// @match http://thread.gmane.org/gmane.games.flightgear.devel/*
</syntaxhighlight>

Next, you need to navigate to the configuration hash to add a new website to it.

Again, it makes sense to simply take an existing configuration hash and adapt it as needed (ignore/omit the tests vector for now by keeping it empty):

{{Caution|the following example may meanwhile be outdated, so be sure to look at the actual code instead}}

<syntaxhighlight lang="javascript">
'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()',
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [] // vector with transformation callbacks
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()'
transform: []
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
</syntaxhighlight>

Now, we need to review/adapt the profile according to the new archive we'd like to see supported.

for starters, that means:
* changing the name of the profile, e.g. to read gmane (instead of sourceforge)
* change the '''url_reg''' field to the gmane URL (this can be a regular expression)

Next, it makes sense to use an [https://addons.mozilla.org/de/firefox/addon/xpath-checker/ XPath checker], so that we can look up the xpath expression for various HTML elements, and add those to the configuration hash above.

For testing purposes, you will probably go to the setup dialog and enable the DEBUG mode, and use your browser's console to see what is going on.

=== Getting involved ===
While having some experience with JavaScript/HTML and jQuery will definitely be useful, JavaScript is close enough to FlightGear scripting ([[Nasal]]), so that people can get involved pretty easily.

Most maintenance work will typically involve reviewing/maintaining a few configuration hashes, that contain meta information for each supported archive (mailing list/forum).

Usually, each hash contains a combination of xpath/regex expressions to look up the relevant information, as well as vector of optional transformations that are applied (in order) to convert contents to a different format (e.g. dates).

In addition, there is growing library of utility functions, a handful wrappers for useful stuff, for example:

* <code>Host.dbLog(message_string)</code> - log a message to the console if the DEBUG flag is set
* <code>Host.download(url, callback, method='GET')</code> - will download the URL and pass the downloaded content to the callback specified
* <code>Host.downloadPosting(url, callback)</code> - will download the posting URL and pass the extracted and transformed author/content and date fields in a hash to the callback specified, the URL must be one supported in the CONFIG hash (i.e. forum/sourceforge for now)
* <code>Host.make_doc(string, type="text/html")</code> - will turn a string/blob into a DOM that can be queried
* <code>Host.eval_xpath(document, xpath_expression, type=XPathResult.STRING_TYPE)</code> - will apply the xpath expression to the document specified, returning the requested type (defaulted to string)
* <code>Host.set_persistent(key,value)</code> - stores a key/value pair
* <code>Host.get_persistent(key,default_value)</code> - retrieves a values using the key specified, falling back to the default value

=== Porting ===
[[File:Instant-cquote-firefox-addon-mode.png|thumb|Prototyping a dedicated instant-cquote mode for use as a firefox addon]]

Porting the script to support other browsers/script engines is greatly appreciated. Typically, this should be pretty self-contained, because all main APIs are intended to be encapsulated in a so called "Environment" hash, where APIs that are specific to a particular browser/script engine should be provided with a wrapper. As of mid 2016, most APIs are now kept inside such an Environment hash (look at the GreaseMonkey hash for reference/details), so that it is now even possible to turn the script into a standalone FireFox addon without having to change much of the underlying code.

=== Self checks (unit testing) ===
For regression testing purposes, there's a dedicated "self check" dialog that will be extended over time. For now it will download a few profile/website specific postings using a vector called "tests" and then log the posting's title, author and date to the console.

The next step will be actually showing that information in the dialog itself - there's a separate helper function to accomplish that, so that the corresponding div layer can be updated with the results.

[[File:Sanity-check-cquotes-dialog.png|thumb|automatically executed sanity checks]]

=== Debug mode ===
[[File:Instant-cquotes-debug-mode.png|thumb|Instant-Cquotes debug mode]]

=== AJAX (live page editing) ===
{{WIP}}

* http://wiki.flightgear.org/api.php
* http://wiki.flightgear.org/api.php?action=parse&page=Frequently%20asked%20questions&prop=sections

For now, the setup dialog will try to obtain a login token for the wiki and show a message if successful.

In addition, the profile/website hash also contains a new wiki entry for the FlightGear wiki, whose '''event_handler''' callback will be invoked once the FG wiki is visited - the console/log will show a greeting, so that is where other code can be added - e.g. to help clean up/rewrite FGCquote-based articles automatically etc.

There is a vector of "modes", whose members are a hash containing trigger/handler fields, linked to two callbacks - the trigger callback can be used to check some condition, while the handler will be invoked if the trigger returns true.

This can be used to support an arbitrary number of modes, whose triggers are evaluated during page load - all triggers that return true, will have their handlers invoked, which is how the following snippet works to rewrite/augment wiki edit handles:

<syntaxhighlight lang="javascript>
'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile
</syntaxhighlight>

See [[User:Red Leader/Sandbox/AJAX test]]

* https://www.mediawiki.org/wiki/API:Changing_wiki_content
* https://www.mediawiki.org/wiki/Extension:VisualEditor
* https://en.wikipedia.org/wiki/Wikipedia:Creating_a_bot

=== Mobile edition ===
{{Note|As of 02/2016, Hooray is contemplating to make this available as an addon for Android phones.}}

=== Issues/limitations ===
==== Bugs ====
* It's eating characters, apparently related to regex/xpath handling - e.g. words like "analyzing" are turned into "analying" [http://forum.flightgear.org/viewtopic.php?f=6&t=28378&p=270735&hilit=analyzing#p270735]
==== Non working URLs ====
* image matching/extraction: http://forum.flightgear.org/viewtopic.php?p=276221#p276221
* http://sourceforge.net/p/flightgear/mailman/message/34754961/
* http://forum.flightgear.org/viewtopic.php?f=18&t=27054&start=90#p273972 → selecting from “As promised, two sample installation sessions on Linux” to “That's it.” towards the end of the message causes Iceweasel (Firefox) 44.0.2 to display a dialog box reading “A script on this page may be busy, or it may have stopped responding. You can stop the script now, open the script in the debugger, or let the script continue.” The line below reads “Script: chrome://greasemonkey-modules/...quotes/instant_cquotes.user.js:544”. Choosing ''Continue'' doesn't help: the same message reappears a few seconds afterwards.

=== Feature requests & ideas ===
* try to recognize list items [https://sourceforge.net/p/flightgear/mailman/message/35095319/] (heuristics: look for colon/asterisk, dashes and CR/LF)
* should add [[Template:News]] to the article dropdown for announcements [http://wiki.flightgear.org/index.php?title=Template:News&oldid=98266]
* add a mode that will download screenshots from forum postings and automatically upload/categorize them, see [[Birds]]
* split the article dropdown into sections, and also populate it with the user's watchlist [https://www.mediawiki.org/wiki/API:Watchlist] {{Progressbar|60}}
* mailing list templates, listed at [http://wiki.flightgear.org/Template_talk:Project_infrastructure#Related_mailing_list_templates]
* expose the cquote/ref markup via the UI so that it can be edited/customized and treated like a template {{Done}} (0.36+)
* identify common/repeated links and automatically create [[Template:Project infrastructure|link/infrastructure templates]] and use those (should be straightforward using the AJAX mode) [http://wiki.flightgear.org/index.php?title=Mailing_lists&curid=2038&diff=97876&oldid=85252]
* add a devel/maintainer mode where it will return the xpath for a selection [http://stackoverflow.com/questions/361130/get-selected-text-and-selected-nodes-on-a-page] [http://stackoverflow.com/questions/12485334/get-surrounding-dom-node-of-selection]
* move openlink,dblog helpers to Environment hash {{Done}}
* identify CLI arguments like --aircraft=c172p and wrap them in between code tags <code>--aircraft=c172p</code> [https://sourceforge.net/p/flightgear/mailman/message/35063277/] (note that we can simply download [https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml options.xml] via openlink() and use that, which is kinda of neat...) {{Progressbar|60}} (see downloadOptionsXML() in the code)
* introduce "layouts" (templates) for different purposes: newsletter, changelog, wiki article, [[The Manual]] (LaTex) ? {{Progressbar|40}}
* use wikipedia template if possible [https://sourceforge.net/p/flightgear/mailman/message/35057670/]
* the new '''tests''' vector could also contain vectors for tests to test the extract/transform* utilities, see Environment.APITests {{Progressbar|50}}
* move environment specific APIs (browser, script host etc) into some kind of Environment hash to encapsulate things (Red Leader was working on a pure Chrome-only version at some point IIRC) {{Progressbar|80}}
* encode script settings in created markup, for future processing/updating of quotes
* look up <code>[x]</code> references and replace with the corresponding link (titled) [https://sourceforge.net/p/flightgear/mailman/message/35055331/] [https://sourceforge.net/p/flightgear/mailman/message/35062598/]
** convert footnotes into Abbr templates [http://article.gmane.org/gmane.games.flightgear.devel/78971]
* support named refs for combining identical refs [http://wiki.flightgear.org/index.php?title=FlightGear_Qt_launcher&curid=13693&diff=97562&oldid=97551]
* adopt [[Template:Forumref]]
* implement a less obnoxious quoting mode, without quotes, where only the ref part would be added, e.g. see the example at [[Graphics Card Profiles]] (it's still 99% quotes, but much less annoying) {{Done}}
* attachment support: identify attachments and link to them: [https://sourceforge.net/p/flightgear/mailman/message/11683451/] [https://sourceforge.net/p/flightgear/mailman/message/23906620/] [https://sourceforge.net/p/flightgear/mailman/message/35059842/] [https://sourceforge.net/p/flightgear/mailman/message/35067087/]
* bulletin points: if there is a colon (:) followed by at least two dashes (-), split up everything after the colon to turn each dash into an asterisk (wiki markup for bulletin points), followed by a newline [http://sourceforge.net/p/flightgear/mailman/message/34760165/]
* generic URL/template matching, e.g. for for sourceforge commit IDs
* make filters/conversions configurable via checkboxes (nowiki, wrap in alert/note boxes)
* make syntax highlighting configurable (language, mode) ?
* consider using something like the Roles template to turn contributor names into tooltips where contributor roles are shown (core dev, fgdata committer etc)
* introduce support for tag clouds to help categorize/classify related quotes
* consider making transformations optional/configurable using check boxes in the jQuery dialog
* add new input method, for quotes that need to be updated/converted (added script version specifically for this purpose), should also add extraction/processing date
* investigate why not all mailing list archives/postings are supported correctly: http://sourceforge.net/p/flightgear/mailman/message/8090479/ (problem traced to <code>getPostID()</code>)
* explore having a ref-only mode without using cquotes, i.e. just copy/paste quotes with proper ref tags and a references section, to rewrite the whole thing (possibly with templates for different purposes, e.g. newsletter/changelog) {{Done}}
* should use Template:Forumref (category:link templates)
* should be updated to use the new repo/flightgear file templates created by Johan & RedLeader {{Not done}}
* resolve links to forum threads to look up the title for the topic/posting, so that the posting's title can be used for those links, instead of just the URL - we can probably do that by making an AJAX call to open URLs asynchronously and extract the title for the thread/posting to come up with something like <code>[http://forum.flightgear.org/viewtopic.php?f=4&t=24421 A call to developers-Lockheed -L188 Electra]</code> ([http://forum.flightgear.org/viewtopic.php?f=4&t=26562&p=247325&hilit=links#p247347]) {{Progressbar|50}}
* convert quoted bug tracker URLs to use the issue template on the wiki {{not done}}
* do regex/xpath validation, and display any errors (e.g. template/theme changes on the forum would currently break the script) {{Progressbar|60}}
* increased focus on supporting different output formats, maybe using a simple [http://www.jquery-steps.com/ jQuery based wizard] (wiki, forum, newsletter, changelog) {{Not done}}
* token matching for keywords/acronyms to link to the corresponding wiki articles (e.g. Nasal, Canvas, FG_ROOT, FG_HOME etc) {{Not done}}
* Add support for [http://sourceforge.net/p/flightgear/codetickets/ tickets], merge requests comments and [http://www.fguk.eu/index.php/forum/index FGUK forum]. (also see [[FlightGear wiki talk:Instant-Cquotes#more sources]])
* GET-encoded SID arguments should be stripped from forum URLs. {{Not done}}
* Links to repositories should be converted to use wiki templates. {{Not done}}
* The {{Abbr|regexes|regular expressions}} used may fail if the HTML DOM of the source changes (e.g., phpBB/theme update)
** Show a warning when that's the case. {{Progressbar|70}} (see the self-check dialog)
** Try multiple regexes in order. {{Progressbar|30}} (see the self-check dialog)
* Use the script to update previously created Cquotes automatically
** Instead of using the <code>getSelection()</code> helper, we could register a match for <tt>wiki.flightgear.org</tt> with <code>action=edit</code> set, so that we can directly process all text of an edited page, using AJAX calls to open the URL in the background. {{Progressbar|40}} (see the self-check dialog, available via the greasemonkey menu)
** See [https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax MW:API:Edit § Editing via Ajax]

=== Changelog ===
{{Note|Contributors are invited to document their changes here, please also add your wiki handle so that others can more easily get in touch.}}

* first stab at implementing unit tests by adding a vector with URLS to be downloaded and fields to be matched (WIP), shown in a jQuery dialog
* support for persistent settings and a jQuery setup dialog with persistence
* hosting is moved, to allow auto-updates [http://www.greasespot.net/2012/02/automatic-script-updates-come-to.html] [https://wiki.greasespot.net/Metadata_Block#.40updateURL] [http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating]
* changed to ref-only quotes for now, not using the FGCquote template anymore, due to its obnoxious appearance on quote-heavy pages (should probably become a runtime option instead)
* updated to use https for forum postings
* add version info to each created quote, i.e. for future updates
* add helper for opening websites asynchronously using AJAX (also via GM helper API)
* display version number in output dialog
* begin using the GreaseMonkey API for setting clipboard content

== The script ==
<gallery mode=packed widths=230px heights=230px>
Instant-cquotes-revamped.png|Instant cquotes: Revamped user interface exposes script internals to make the script better configurable at runtime
Instant-cquotes-template-editor.png|Instant cquotes now features a simple built-in template editor with support for variable substitution, so that wiki templates can be more easily customized
Instant-cquotes-with-wikimedia-API-integration.png|Screenshot showing instant-cquotes with wikimedia API integration to fetch articles/sections and populate dropdown menus accordingly
Instant-cquotes-on-steroids-with-watchlist-support.png|Screenshot showing the JQuery-mode of the instant cquotes script with built-in support for fetching a user's wiki/watchlist to edit/update articles in a semi-automated fashion
</gallery>
{{PD-author|FlightGear contributors}}

{{Note|Anybody interested in contributing to the code is invited to directly edit this wiki article. From 05/2016, the script is hosted on GreasyFork to allow automatic updates. If you'd like to see your changes applied, please bump the version number and [[User:Elgaton|Elgaton]] will upload it in the state it was when the version number was bumped. ''Make sure to perform thorough testing'' before the bump to prevent unexpected breakage; it is generally a good idea to validate your changes using an online syntax checker, e.g.:
* http://jshint.com/
* http://esprima.org/demo/validate.html
* http://codebeautify.org/jsvalidate
<p/>Thank you!}}

Changes that should be mentioned in the changelog, should be added below (and moved to the [[#Changelog]] section subsequently:

* preparations for adding support to download fgdata related files like options.xml to automatically regex known CLI commands
* preparatory work for adding a speech-rewrite engine to assist in converting 1st person speech to 3rd person
* framework for encapsulating userscript specifics in an environment hash to provide better updating/porting support

<syntaxhighlight lang="javascript" enclose="div">// ==UserScript==
// @name Instant-Cquotes
// @name:it Instant-Cquotes
// @license public domain
// @version 0.39
// @date 2016-05-05
// @description Automatically converts selected FlightGear mailing list and forum quotes into post-processed MediaWiki markup (i.e. cquotes).
// @description:it Converte automaticamente citazioni dalla mailing list e dal forum di FlightGear in marcatori MediaWiki (cquote).
// @author Hooray, bigstones, Philosopher, Red Leader & Elgaton (2013-2016)
// @supportURL http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @icon http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @match https://sourceforge.net/p/flightgear/mailman/*
// @match http://sourceforge.net/p/flightgear/mailman/*
// @match https://forum.flightgear.org/*
// @match http://wiki.flightgear.org/*
// @namespace http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes
// @run-at document-start
// @require https://code.jquery.com/jquery-1.10.2.js
// @require https://code.jquery.com/ui/1.11.4/jquery-ui.js
// @require https://cdn.jsdelivr.net/genetic.js/0.1.14/dist.js
// @require https://cdn.jsdelivr.net/synaptic/1.0.4/synaptic.min.js
// @resource jQUI_CSS https://code.jquery.com/ui/1.11.4/themes/smoothness/jquery-ui.css
// @resource myLogo http://wiki.flightgear.org/images/2/25/Quotes-logo-200x200.png
// @grant GM_registerMenuCommand
// @grant GM_setValue
// @grant GM_getValue
// @grant GM_addStyle
// @grant GM_getResourceText
// @grant GM_getResourceURL
// @grant GM_setClipboard
// @grant GM_xmlhttpRequest
// @noframes
// ==/UserScript==
//
// This work has been released into the public domain by their authors. This
// applies worldwide.
// In some countries this may not be legally possible; if so:
// The authors grant anyone the right to use this work for any purpose, without
// any conditions, unless such conditions are required by law.
//
// This script has a number of dependencies that are implicitly satisfied when run as a user script
// via GreaseMonkey/TamperMonkey; however, these need to be explicitly handled when using a different mode (e.g. firefox/android):
//
// - jQuery - user interface (REQUIRED)
// - genetic-js - genetic programming (OPTIONAL/EXPERIMENTAL)
// - synaptic - neural networks (OPTIONAL/EXPERIMENTAL)
//
//

/* Here are some TODOs
* - support RSS feeds http://dir.gmane.org/gmane.games.flightgear.devel/
* - move event handling/processing to the CONFIG hash
* - use try/catch more widely
* - wrap function calls in try/call for better debugging/diagnostics
* - add helpers for [].forEach.call, map, apply and call
* - replace for/in, for/of, let statements for better compatibility (dont require ES6)
* - for the same reason, replace use of functions with default params
* - isolate UI (e.g. JQUERY) code in UserInterface hash
* - expose regex/transformations via the UI
*
*/

'use strict';

// TODO: move to GreaseMonkey/UI host
// prevent conflicts with jQuery used on webpages: https://wiki.greasespot.net/Third-Party_Libraries#jQuery
// http://stackoverflow.com/a/5014220
this.$ = this.jQuery = jQuery.noConflict(true);

// this hash is just intended to help isolate UI specifics
// so that we don't need to maintain/port tons of code

var UserInterface = {
get: function() {
return UserInterface.DEFAULT;
},

CONSOLE: {

}, // CONSOLE (shell, mainly useful for testing)

DEFAULT: {
alert: function(msg) {return window.alert(msg); },
prompt: function(msg) {return window.prompt(msg); },
confirm: function(msg) {return window.confirm(msg); },
dialog: null,
selection: null,
populateWatchlist: function() {

},
populateEditSections: function() {

}

}, // default UI mapping (Browser/User script)

JQUERY: {

} // JQUERY

}; // UserInterface

var UI = UserInterface.get(); // DEFAULT for now

// This hash is intended to help encapsulate platform specifics (browser/scripting host)
// Ideally, all APIs that are platform specific should be kept here
// This should make it much easier to update/port and maintain the script in the future
var Environment = {
getHost: function(xpi=false) {

if(xpi) {
Environment.scriptEngine = 'firefox addon';
console.log('in firefox xpi/addon mode');
return Environment.FirefoxAddon; // HACK for testing the xpi mode (firefox addon)
}

// This will determine the script engine in use: http://stackoverflow.com/questions/27487828/how-to-detect-if-a-userscript-is-installed-from-the-chrome-store
if (typeof(GM_info) === 'undefined') {
Environment.scriptEngine = "plain Chrome (Or Opera, or scriptish, or Safari, or rarer)";
// See http://stackoverflow.com/a/2401861/331508 for optional browser sniffing code.
}
else {
Environment.scriptEngine = GM_info.scriptHandler || "Greasemonkey";
}
console.log ('Instant cquotes is running on ' + Environment.scriptEngine + '.');

//console.log("not in firefox addon mode...");
// See also: https://wiki.greasespot.net/Cross-browser_userscripting
return Environment.GreaseMonkey; // return the only/default host (for now)
},

validate: function(host) {
if (host.get_persistent('startup.disable_validation',false)) return;

if(Environment.scriptEngine !== "Greasemonkey")
console.log("NOTE: This script has not been tested with script engines other than GreaseMonkey recently!");

var dependencies = [
{name:'jQuery', test: function() {} },
{name:'genetic.js', test: function() {} },
{name:'synaptic', test: function() {} },
];

[].forEach.call(dependencies, function(dep) {
console.log("Checking for dependency:"+dep.name);
var status=false;
try {
dep.test.call(undefined);
status=true;
}
catch(e) {
status=false;
}
finally {
var success = (status)?'==> success':'==> failed';
console.log(success);
return status;
}
});
}, // validate

// this contains unit tests for checking crucial APIs that must work for the script to work correctly
// for the time being, most of these are stubs waiting to be filled in
// for a working example, refer to the JSON test at the end
// TODO: add jQuery tests
APITests: [
{name:'download', test: function(recipient) {recipient(true);} },
{name:'make_doc', test: function(recipient) { recipient(true);} },
{name:'eval_xpath', test: function(recipient) { recipient(true);} },
{name:'JSON de/serialization', test: function(recipient) {
//console.log("running json test");
var identifier = 'unit_tests.json_serialization';
var hash1 = {x:1,y:2,z:3};
Host.set_persistent(identifier, hash1, true);
var hash2 = Host.get_persistent(identifier,null,true);

recipient(JSON.stringify(hash1) === JSON.stringify(hash2));
} // callback
},

// downloads a posting and tries to transform it to 3rd person speech ...
// TODO: add another test to check forum postings
{name:'text/speech transformation', test: function(recipient) {

// the posting we want to download
var url='https://sourceforge.net/p/flightgear/mailman/message/35066974/';
Host.downloadPosting(url, function (result) {

// only process the first sentence by using comma/dot as delimiter
var firstSentence = result.content.substring(result.content.indexOf(',')+1, result.content.indexOf('.'));

var transformed = transformSpeech(firstSentence, result.author, null, speechTransformations );
console.log("3rd person speech transformation:\n"+transformed);

recipient(true);
}); // downloadPosting()

}// test()
}, // end of speech transform test
{
name:"download $FG_ROOT/options.xml", test: function(recipient) {
downloadOptionsXML();
recipient(true);
} // test
}

], // end of APITests

runAPITests: function(host, recipient) {
console.log("Running API tests");
for(let test of Environment.APITests ) {
//var test = Environment.APITests[t];
// invoke the callback passed, with the hash containing the test specs, so that the console/log or a div can be updated showing the test results

recipient.call(undefined, test);

} // foreach test
}, // runAPITests

/*
* ===================================================================================================================================================
*
*/

// NOTE: This mode/environment is WIP and highly experimental ...
// To see this working, you need to package up the whole file as a firefox xpi using "jpm xpi"
// and then start the whole thing via "jpm run", to do that, you also need a matching package.json (i.e. via jpm init)
// ALSO: you will have to explicitly install any dependencies using jpm
FirefoxAddon: {
init: function() {
console.log("Firefox addon mode ...");
},
getScriptVersion: function() {
return '0.36'; // FIXME
},
dbLog: function(msg) {
console.log(msg);
},
addEventListener: function(ev, cb) {

require("sdk/tabs").on("ready", logURL);
function logURL(tab) {
console.log("URL loaded:" + tab.url);
}
},

registerConfigurationOption: function(name, callback, hook) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
console.log("config menu support n/a in firefox mode");
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Using_third-party_modules_%28jpm%29
var menuitems = require("menuitem");
var menuitem = menuitems.Menuitem({
id: "clickme",
menuid: "menu_ToolsPopup",
label: name,
onCommand: function() {
console.log("menuitem clicked:");
callback();
},
insertbefore: "menu_pageInfo"
});
},

registerTrigger: function() {
// https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/context-menu#Item%28options%29
var contextMenu = require("sdk/context-menu");
var menuItem = contextMenu.Item({
label: "Instant Cquote",
context: contextMenu.SelectionContext(),
// https://developer.mozilla.org/en/Add-ons/SDK/Guides/Two_Types_of_Scripts
// https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts
contentScript: 'self.on("click", function () {' +
' var text = window.getSelection().toString();' +
' self.postMessage(text);' +
'});',
onMessage: function (selectionText) {
console.log(selectionText);
instantCquote(selectionText);
}
});

// for selection handling stuff, see: https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/selection

function myListener() {
console.log("A selection has been made.");
}
var selection = require("sdk/selection");
selection.on('select', myListener);

}, //registerTrigger

get_persistent: function(key, default_value) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/simple-storage
var ss = require("sdk/simple-storage");

console.log("firefox mode does not yet have persistence support");
return default_value;},
set_persistent: function(key, value) {
console.log("firefox persistence stubs not yet filled in !");
},

set_clipboard: function(content) {
// https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/clipboard

//console.log('clipboard stub not yet filled in ...');
var clipboard = require("sdk/clipboard");
clipboard.set(content);
} //set_cliipboard

}, // end of FireFox addon config

// placeholder for now ...
Android: {
// NOP
}, // Android

///////////////////////////////////////
// supported script engines:
///////////////////////////////////////

GreaseMonkey: {
// TODO: move environment specific initialization code here
init: function() {
// Check if Greasemonkey/Tampermonkey is available
try {
// TODO: add version check for clipboard API and check for TamperMonkey/Scriptish equivalents ?
GM_addStyle(GM_getResourceText('jQUI_CSS'));
} // try
catch (error) {
console.log('Could not add style or determine script version');
} // catch

var commands = [
{name:'Setup quotes',callback:setupDialog, hook:'S' },
{name:'Check quotes',callback:selfCheckDialog, hook:'C' }
];

for (let c of commands ) {
this.registerConfigurationOption(c.name, c.callback, c.hook);
}

}, // init()

getScriptVersion: function() {
return GM_info.script.version;
},

dbLog: function (message) {
if (Boolean(DEBUG)) {
console.log('Instant cquotes:' + message);
}
}, // dbLog()

registerConfigurationOption: function(name,callback,hook) {
// https://wiki.greasespot.net/GM_registerMenuCommand
// https://wiki.greasespot.net/Greasemonkey_Manual:Monkey_Menu#The_Menu
GM_registerMenuCommand(name, callback, hook);
}, //registerMenuCommand()

registerTrigger: function() {

// TODO: we can use the following callback non-interactively, i.e. to trigger background tasks
// http://javascript.info/tutorial/onload-ondomcontentloaded
document.addEventListener("DOMContentLoaded", function(event) {
console.log("Instant Cquotes: DOM fully loaded and parsed");
});

window.addEventListener('load', init); // page fully loaded
Host.dbLog('Instant Cquotes: page load handler registered');

// Initialize (matching page loaded)
function init() {
console.log('Instant Cquotes: page load handler invoked');
var profile = getProfile();

Host.dbLog("Profile type is:"+profile.type);

// Dispatch to correct event handler (depending on website/URL)
// TODO: this stuff could/should be moved into the config hash itself

if (profile.type=='wiki') {
profile.event_handler(); // just for testing
return;
}

Host.dbLog('using default mode');
document.onmouseup = instantCquote;
// HACK: preparations for moving the the event/handler logic also into the profile hash, so that the wiki (edit mode) can be handled equally
//eval(profile.event+"=instantCquote");

} // init()

}, // registerTrigger

download: function (url, callback, method='GET') {
// http://wiki.greasespot.net/GM_xmlhttpRequest
try {
GM_xmlhttpRequest({
method: method,
url: url,
onload: callback
});
}catch(e) {
console.log("download did not work");
}
}, // download()

// is only intended to work with archives supported by the hash
downloadPosting: function (url, EventHandler) {

Host.download(url, function (response) {
var profile = getProfile(url);
var blob = response.responseText;
var doc = Host.make_doc(blob,'text/html');
var result = {}; // hash to be returned

[].forEach.call(['author','date','title','content'], function(field) {
var xpath_query = '//' + profile[field].xpath;
try {
var value = Host.eval_xpath(doc, xpath_query).stringValue;
//UI.alert("extracted field value:"+value);

// now apply all transformations, if any
value = applyTransformations(value, profile[field].transform );

result[field]=value; // store the extracted/transormed value in the hash that we pass on
} // try
catch(e) {
UI.alert("downloadPosting failed:\n"+ e.message);
} // catch
}); // forEach field

EventHandler(result); // pass the result to the handler
}); // call to Host.download()

}, // downloadPosting()

// TODO: add makeAJAXCall, and makeWikiCall here

// turn a string/text blob into a DOM tree that can be queried (e.g. for xpath expressions)
// FIXME: this is browser specific not GM specific ...
make_doc: function(text, type='text/html') {
// to support other browsers, see: https://developer.mozilla.org/en/docs/Web/API/DOMParser
return new DOMParser().parseFromString(text,type);
}, // make DOM document

// xpath handling may be handled separately depending on browser/platform, so better encapsulate this
// FIXME: this is browser specific not GM specific ...
eval_xpath: function(doc, xpath, type=XPathResult.STRING_TYPE) {
return doc.evaluate(xpath, doc, null, type, null);
}, // eval_xpath

set_persistent: function(key, value, json=false)
{
// transparently stringify to json
if(json) {
// http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
value = JSON.stringify (value);
}

// https://wiki.greasespot.net/GM_setValue
GM_setValue(key, value);
//UI.alert('Saved value for key\n'+key+':'+value);
}, // set_persistent

get_persistent: function(key, default_value, json=false) {
// https://wiki.greasespot.net/GM_getValue

var value=GM_getValue(key, default_value);
// transparently support JSON: http://stackoverflow.com/questions/16682150/store-a-persistent-list-between-sessions
if(json) {
value = JSON.parse (value) || {};
}
return value;
}, // get_persistent

setClipboard: function(msg) {
// this being a greasemonkey user-script, we are not
// subject to usual browser restrictions
// http://wiki.greasespot.net/GM_setClipboard
GM_setClipboard(msg);
}, // setClipboard()

getTemplate: function() {

// hard-coded default template
var template = '$CONTENT<ref>{{cite web\n' +
' |url = $URL \n' +
' |title = <nowiki> $TITLE </nowiki> \n' +
' |author = <nowiki> $AUTHOR </nowiki> \n' +
' |date = $DATE \n' +
' |added = $ADDED \n' +
' |script_version = $SCRIPT_VERSION \n' +
' }}</ref>\n';

// return a saved template if found, fall back to hard-coded one above otherwise
return Host.get_persistent('default_template', template);

} // getTemplate

} // end of GreaseMonkey environment, add other environments below

}; // Environment hash - intended to help encapsulate host specific stuff (APIs)

// the first thing we need to do is to determine what APIs are available
// and store everything in a Host hash, which is subsequently used for API lookups
// the Host hash contains all platform/browser-specific APIs
var Host = Environment.getHost();
Environment.validate(Host); // this checks the obtained host to see if all required dependencies are available
Host.init(); // run environment specific initialization code (e.g. logic for GreaseMonkey setup)

// move DEBUG handling to a persistent configuration flag so that we can configure this using a jQuery dialog (defaulted to false)
// TODO: move DEBUG variable to Environment hash / init() routine
var DEBUG = Host.get_persistent('debug_mode_enabled', false);
Host.dbLog("Debug mode is:"+DEBUG);
function DEBUG_mode() {
// reset script invocation counter for testing purposes
Host.dbLog('Resetting script invocation counter');
Host.set_persistent(GM_info.script.version, 0);
}

if (DEBUG)
DEBUG_mode();

// hash with supported websites/URLs, includes xpath and regex expressions to extract certain fields, and a vector with optional transformations for post-processing each field

var CONFIG = {
// WIP: the first entry is special, i.e. it's not an actual list archive (source), but only added here so that the same script can be used
// for editing the FlightGear wiki

'FlightGear.wiki': {
type: 'wiki',
enabled: false,
event: 'document.onmouseup', // when to invoke the event handler
// TODO: move downloadWatchlist() etc here
event_handler: function () {
console.log('FlightGear wiki handler active (waiting to be populated)');
// this is where the logic for a wiki mode can be added over time (for now, it's a NOP)

//for each supported mode, invoke the trigger and call the corresponding handler
[].forEach.call(CONFIG['FlightGear.wiki'].modes, function(mode) {
//dbLog("Checking trigger:"+mode.name);
if(mode.trigger() ) {
mode.handler();
}
});

}, // the event handler to be invoked
url_reg: '^(http|https)://wiki.flightgear.org', // ignore for now: not currently used by the wiki mode

modes: [
{ name:'process-editSections',
trigger: function() {return true;}, // match URL regex - return true for always match

// the code implementing the mode
handler: function() {

var editSections = document.getElementsByClassName('mw-editsection');
console.log('FlightGear wiki article, number of edit sections: '+editSections.length);

// for now, just rewrite edit sections and add a note to them

[].forEach.call(editSections, function (sec) {
sec.appendChild(
document.createTextNode(' (instant-cquotes is lurking) ')
);
}); //forEach section
} // handler

} // process-editSections
// TODO: add other wiki modes below

] // modes

}, // end of wiki profile

'Sourceforge Mailing list': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler
event_handler: instantCquote, // the event handler to be invoked
url_reg: '^(http|https)://sourceforge.net/p/flightgear/mailman/.*/',
content: {
xpath: 'tbody/tr[2]/td/pre/text()', // NOTE this is only used by the downloadPosting helper to retrieve the posting without having a selection (TODO:add content xpath to forum hash)
selection: getSelectedText,
idStyle: /msg[0-9]{8}/,
parentTag: [
'tagName',
'PRE'
],
transform: [],
}, // content recipe
// vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
// regex/xpath and transformations for extracting various required fields
author: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/From: (.*) <.*@.*>/)]
},
title: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/text()',
transform:[]
},
date: {
xpath: 'tbody/tr[1]/td/div/small/text()',
transform: [extract(/- (.*-.*-.*) /)]
},
url: {
xpath: 'tbody/tr[1]/td/div/div[1]/b/a/@href',
transform: [prepend('https://sourceforge.net')]
}
}, // end of mailing list profile
// next website/URL (forum)
'FlightGear forum': {
enabled: true,
type: 'archive',
event: 'document.onmouseup', // when to invoke the event handler (not used atm)
event_handler: null, // the event handler to be invoked (not used atm)
url_reg: /https:\/\/forum\.flightgear\.org\/.*/,
content: {
xpath: '', //TODO: this must be added for downloadPosting() to work, or it cannot extract contents
selection: getSelectedHtml,
idStyle: /p[0-9]{6}/,
parentTag: [
'className',
'content',
'postbody'
],
transform: [
removeComments,
forum_quote2cquote,
forum_smilies2text,
forum_fontstyle2wikistyle,
forum_code2syntaxhighlight,
img2link,
a2wikilink,
vid2wiki,
list2wiki,
forum_br2newline
]
},
// vector with tests to be executed for sanity checks (unit testing)
// postings will be downloaded using the URL specified, and then the author/title
// fields extracted using the outer regex and matched against what is expected
// NOTE: forum postings can be edited, so that these tests would fail - thus, it makes sense to pick locked topics/postings for such tests
tests: [
{
url: 'https://forum.flightgear.org/viewtopic.php?f=18&p=284108#p284108',
author: 'mickybadia',
date: 'May 3rd, 2016',
title: 'OSM still PNG maps'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=19&p=284120#p284120',
author: 'Thorsten',
date: 'May 3rd, 2016',
title: 'Re: FlightGear\'s Screenshot Of The Month MAY 2016'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=71&t=29279&p=283455#p283446',
author: 'Hooray',
date: 'Apr 25th, 2016',
title: 'Re: Best way to learn Canvas?'
},
{
url: 'https://forum.flightgear.org/viewtopic.php?f=4&t=1460&p=283994#p283994',
author: 'bugman',
date: 'May 2nd, 2016',
title: 'Re: eurofighter typhoon'
} // add other tests below

], // end of vector with self-tests
author: {
xpath: 'div/div[1]/p/strong/a/text()',
transform: [] // no transformations applied
},
title: {
xpath: 'div/div[1]/h3/a/text()',
transform: [] // no transformations applied
},
date: {
xpath: 'div/div[1]/p/text()[2]',
transform: [extract(/» (.*?[0-9]{4})/)]
},
url: {
xpath: 'div/div[1]/p/a/@href',
transform: [
extract(/\.(.*)/),
prepend('https://forum.flightgear.org')
] // transform vector
} // url
} // forum
}; // CONFIG has

// hash to map URLs (wiki article, issue tracker, sourceforge link, forum thread etc) to existing wiki templates
var MatchURL2Templates = [
// placeholder for now
{
name: 'rewrite sourceforge code links',
url_reg: '',
handler: function() {

} // handler

} // add other templates below

]; // MatchURL2Templates

// output methods (alert and jQuery for now)
var OUTPUT = {
// Shows a window.prompt() message box
msgbox: function (msg) {
UI.prompt('Copy to clipboard ' + Host.getScriptVersion(), msg);
Host.setClipboard(msg);
}, // msgbox

// this is currently work-in-progress, and will need to be refactored sooner or later
// for now, functionality matters more than elegant design/code :)
jQueryTabbed: function(msg, original) {
// FIXME: using backtics here makes the whole thing require ES6 ....
var markup = $(`<div id="tabs">
<ul>
<li><a href="#selection">Selection</a></li>
<li><a href="#articles">Articles</a></li>
<li><a href="#templates">Templates</a></li>
<li><a href="#development">Development</a></li>
<li><a href="#settings">Settings</a></li>
<li><a href="#help">Help</a></li>
<li><a href="#about">About</a></li>
</ul>
<div id="selection">This tab contains your extracted and post-processed selection, converted to proper wikimedia markup, including proper attribution.
<div id="content">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="options">
<b>Note this is work-in-progress, i.e. not yet fully functional</b><br/>
<label for="article_select">Select an article to update</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="release" label="Release"/>
<optgroup id="develop" label="Development"/>
<optgroup id="watchlist" label="Watchlist"/>
</select>
<p/>
<label for="section_select">Select section:</label>
<select name="section_select" id="section_select">
</select>
</div>
</div>
<div id="articles">This tab contains articles that you can directly access/edit using the mediawiki API<br/>
Note: The watchlist is retrieved dynamically, so does not need to be edited here<br/>
<label for="article_select">Select an article</label>
<select name="article_select" id="article_select">
<optgroup id="news" label="News"/>
<optgroup id="support" label="Support"/>
<optgroup id="develop" label="Development"/>
<optgroup id="release" label="Release"/>

</select>

<button id="article_new">New</button>
<button id="article_remove">Remove</button>

<div id="edit_article">
<label for="article_name">Article</label>
<input type="text" id="article_name" name="article_name"><br/>

<label for="article_url">Link</label>
<input type="text" id="article_url" name="article_url"><br/>

<button id="article_save">Save</button>
</div>

</div>
<div id="templates">This tab contains templates for different types of articles (newsletter, changelog, release plan etc)<p/>
For now, this is WIP - in the future, there will be a dropdown menu added and all templates will be editable.<p/>
<div id="template_header">

<label for="template_select">Select a template</label>
<select name="template_select" id="template_select">
<option>default</option>
<option>cquote</option>
</select>

</div>
<div id="template_area"/>
<div id="template_controls">
<button id="template_save">Save</button>
</div>
</div>
<div id="development">This tab is a placeholder for features currently under development<p/>
<button id="evolve_regex">Evolve regex</button><p/>
<button id="test_perceptron">Test Perceptron</button><p/>
<div id="output">

<table id="results">
<thead>
<tr>
<th>Generation</th>
<th>Fitness</th>
<th>Expression</th>
<th>Result</th>
</tr>
</thead>
<tbody>
</tbody>
</table>


</div>
</div>

<div id="settings">This tab will contain script specific settings
</div>
<div id="help">One day, this tab may contain help....<p/><button id="helpButton">Instant Cquotes</button>
</div>
<div id="about">show some script related information here
</div>
</div>`); // tabs div

var evolve_regex = $('div#development button#evolve_regex', markup);
evolve_regex.click(function() {
//alert("Evolve regex");
evolve_expression_test();
});

var test_perceptron = $('div#development button#test_perceptron', markup);
test_perceptron.click(function() {
alert("Test perceptron");
});

// add dynamic elements to each tab

// NOTE: this affects all template selectors, on all tabs
$('select#template_select', markup).change(function() {
UI.alert("Sorry, templates are not yet fully implemented (WIP)");
});

var help = $('#helpButton', markup);
help.button();
help.click(function() {
window.open("http://wiki.flightgear.org/FlightGear_wiki:Instant-Cquotes");
});

// rows="10"cols="80" style=" width: 420px; height: 350px"
var textarea = $('<textarea id="quotedtext" rows="20" cols="70"/>');
textarea.val(msg);
$('#selection #content', markup).append(textarea);

var templateArea = $('<textarea id="template-edit" rows="20" cols="70"/>');
templateArea.val( Host.getTemplate() );
$('div#templates div#template_area', markup).append(templateArea);

//$('#templates', markup).append($('<button>'));
$('div#templates div#template_controls button#template_save',markup).button().click(function() {
//UI.alert("Saving template:\n"+templateArea.val() );

Host.set_persistent('default_template',templateArea.val() );
}); // save template

// TODO: Currently, this is hard-coded, but should be made customizable via the "articles" tab at some point ...
var articles = [
// NOTE: category must match an existing <optgroup> above, title must match an existing wiki article
{category:'support', name:'Frequently asked questions', url:''},
{category:'support', name:'Asking for help', url:''},
{category:'news', name:'Next newsletter', url:''},
{category:'news', name:'Next changelog', url:''},
{category:'release', name:'Release plan/Lessons learned', url:''}, // TODO: use wikimedia template
{category:'develop', name:'Nasal library', url:''},
{category:'develop', name:'Canvas Snippets', url:''},

];

// TODO: this should be moved elsewhere
function updateArticleList(selector) {
$.each(articles, function (i, article) {
$(selector+ ' optgroup#'+article.category, markup).append($('<option>', {
value: article.name, // FIXME: just a placeholder for now
text : article.name
})); //append option
}); // foreach
} // updateArticleList

// add the article list to the corresponding dropdown menus
updateArticleList('select#article_select');

// populate watchlist (prototype for now)
// TODO: generalize & refactor: url, format

// https://www.mediawiki.org/wiki/API:Watchlist
// http://wiki.flightgear.org/api.php?action=query&list=watchlist
var watchlist_url = 'http://wiki.flightgear.org/api.php?action=query&list=watchlist&format=json';
Host.download(watchlist_url, function(response) {
try {
var watchlist = JSON.parse(response.responseText);

//$('div#options select#section_select', markup).empty(); // delete all sections

$.each(watchlist.query.watchlist, function (i, article) {
$('div#options select#article_select optgroup#watchlist', markup).append($('<option>', {
value: article.title, //FIXME just a placeholder for now
text : article.title
}));
}); //foreach section

}
catch (e) {
UI.alert("Could not download wiki watchlist\n"+watchlist.error.info);
}
}); // download & populate watchlist

// register an event handler for the main tab, so that article specific sections can be retrieved
$('div#options select#article_select', markup).change(function() {
var article = this.value;

// HACK: try to get a login token (actually not needed just for reading ...)
Host.download('http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page', function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;

// populate dropdown menu with article sections
if (status === 'OK') {

// Resolve redirects: https://www.mediawiki.org/wiki/API:Query#Resolving_redirects
var section_url = 'http://wiki.flightgear.org/api.php?action=parse&page='+encodeURIComponent(article)+'&prop=sections&format=json&redirects';
Host.download(section_url, function(response) {
try {
var sections = JSON.parse(response.responseText);

$('div#options select#section_select', markup).empty(); // delete all sections

$.each(sections.parse.sections, function (i, section) {
$('div#options select#section_select', markup).append($('<option>', {
value: section.line, //FIXME just a placeholder for now
text : section.line
}));
}); //foreach section

}
catch (e) {
UI.alert(e.message);
}

}); //download sections

} // login status is OK

}); // Host.download() call, i.e. we have a login token

}); // on select change

// init the tab stuff
markup.tabs();

var diagParam = {
title: 'Instant Cquotes ' + Host.getScriptVersion(),
modal: true,
width: 700,
buttons: [
{
text:'reported speech',
click: function() {
textarea.val(createCquote(original,true));
}
},

{
text: 'Copy',
click: function () {
Host.setClipboard(msg);
$(this).dialog('close');
}
}

]
};

// actually show our tabbed dialog using the params above
markup.dialog(diagParam);

} // jQueryTabbed()

}; // output methods

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// TODO: we can use an online API to help with some of this: http://www.eslnow.org/reported-speech-converter/
// See also: http://blog.mashape.com/list-of-25-natural-language-processing-apis/
// http://text-processing.com/docs/phrases.html
// http://www.alchemyapi.com/
// https://words.bighugelabs.com/api.php
// https://www.wordsapi.com/
// http://www.dictionaryapi.com/
// https://www.textrazor.com/
// http://www.programmableweb.com/news/how-5-natural-language-processing-apis-stack/analysis/2014/07/28

var speechTransformations = [
// TODO: support aliasing using vectors: would/should
// ordering is crucial here (most specific first, least specific/most generic last)

// first, we start off by expanding short forms: http://www.learnenglish.de/grammar/shortforms.html
// http://www.macmillandictionary.com/thesaurus-category/british/short-forms

{query:/couldn\'t/gi, replacement:'could not'},
{query:/I could not/gi, replacement:'$author could not'},

{query:/I\'m/gi, replacement:'I am'},
{query:/I am/gi, replacement:'$author is'},

{query:/I\'ve/, replacement:'I have'},
{query:/I have had/, replacement:'$author had'},

{query:/can(\'|\’)t/gi, replacement:'cannot'},

{query:/I(\'|\’)ll/gi, replacement:'$author will'},
{query:/I(\'|\’)d/gi, replacement:'$author would'},

{query:/I have done/gi, replacement:'$author has done'},
{query:/I\'ve done/gi, replacement:'$author has done'}, //FIXME. queries should really be vectors ...

{query:/I believe/gi, replacement:'$author suggested'},
{query:/I think/gi, replacement:'$author suggested'},
{query:/I guess/gi, replacement:'$author believes'},

{query:/I can see that/gi, replacement:'$author suggested that'},

{query:/I have got/gi, replacement:'$author has got'},
{query:/I\'ve got/gi, replacement:'$author has got'},

{query:/I\'d suggest/gi, replacement:'$author would suggest'},

{query:/I\’m prototyping/gi, replacement:'$author is prototyping'},

{query:/I myself/gi, replacement:'$author himself'},
{query:/I am/gi, replacement:' $author is'},

{query:/I can see/gi, replacement:'$author can see'},
{query:/I can/gi, replacement:'$author can'},
{query:/I have/gi, replacement:'$author has'},
{query:/I should/g, replacement:'$author should'},
{query:/I shall/gi, replacement:'$author shall'},
{query:/I may/gi, replacement:'$author may'},
{query:/I will/gi, replacement:'$author will'},
{query:/I would/gi, replacement:'$author would'},
{query:/by myself/gi, replacement:'by $author'},
{query:/and I/gi, replacement:'and $author'},
{query:/and me/gi, replacement:'and $author'},
{query:/and myself/gi, replacement:'and $author'}

// least specific stuff last (broad/generic stuff is kept as is, with author clarification added in parentheses)
/*
{query:/I/, replacement:'I ($author)'},

{query:/me/, replacement:'me ($author)'},
{query:/my/, replacement:'my ($author)'},
{query:/myself/, replacement:'myself ($author)'},
{query:/mine/, replacement:'$author'}
*/
];

// try to assist in transforming speech using the transformation vector passed in
// still needs to be exposed via the UI
function transformSpeech(text, author, gender, transformations) {
// WIP: foreach transformation in vector, replace the search pattern with the matched string (replacing author/gender as applicable)
//alert("text to be transformed:\n"+text);
for(var i=0;i< transformations.length; i++) {
var token = transformations[i];
// patch the replacement string using the correct author name
var replacement = token.replacement.replace(/\$author/gi, author);
text = text.replace(token.query, replacement);
} // end of token transformation
console.log("transformed text is:"+text);
return text;
} // transformSpeech

// run a self-test

(function() {
var author ="John Doe";
var transformed = transformSpeech("I have decided to commit a new feature", author, null, speechTransformations );
if (transformed !== author+" has decided to commit a new feature")
Host.dbLog("FIXME: Speech transformations are not working correctly");
}) ();
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

var MONTHS = [
'Jan',
'Feb',
'Mar',
'Apr',
'May',
'Jun',
'Jul',
'Aug',
'Sep',
'Oct',
'Nov',
'Dec'
];
// Conversion for forum emoticons
var EMOTICONS = [
[/:shock:/g,
'O_O'],
[
/:lol:/g,
'(lol)'
],
[
/:oops:/g,
':$'
],
[
/:cry:/g,
';('
],
[
/:evil:/g,
'>:)'
],
[
/:twisted:/g,
'3:)'
],
[
/:roll:/g,
'(eye roll)'
],
[
/:wink:/g,
';)'
],
[
/:!:/g,
'(!)'
],
[
/:\?:/g,
'(?)'
],
[
/:idea:/g,
'(idea)'
],
[
/:arrow:/g,
'(->)'
],
[
/:mrgreen:/g,
'xD'
]
];
// ##################
// # Main functions #
// ##################

// the required trigger is host specific (userscript vs. addon vs. android etc)
// for now, this merely wraps window.load mapping to the instantCquotoe callback below
Host.registerTrigger();

// FIXME: function is currently referenced in CONFIG hash - event_handler, so cannot be easily moved across
// The main function
// TODO: split up, so that we can reuse the code elsewhere
function instantCquote(sel) {
var profile = getProfile();

// TODO: use config hash here
var selection = document.getSelection(),
post_id=0;

try {
post_id = getPostId(selection, profile);
}
catch (error) {
Host.dbLog('Failed extracting post id\nProfile:' + profile);
return;
}
if (selection.toString() === '') {
Host.dbLog('No text is selected, aborting function');
return;
}
if (!checkValid(selection, profile)) {
Host.dbLog('Selection is not valid, aborting function');
return;
}
try {
transformationLoop(profile, post_id);
}
catch(e) {
UI.alert("Transformation loop:\n"+e.message);
}
} // instantCquote

// TODO: this needs to be refactored so that it can be also reused by the async/AJAX mode
// to extract fields in the background (i.e. move to a separate function)
function transformationLoop(profile, post_id) {
var output = {}, field;
Host.dbLog("Starting extraction/transformation loop");
for (field in profile) {
if (field === 'name') continue;
if (field ==='type' || field === 'event' || field === 'event_handler') continue; // skip fields that don't contain xpath expressions
Host.dbLog("Extracting field using field id:"+post_id);
var fieldData = extractFieldInfo(profile, post_id, field);
var transform = profile[field].transform;
if (transform !== undefined) {
Host.dbLog('Field \'' + field + '\' before transformation:\n\'' + fieldData + '\'');
fieldData = applyTransformations(fieldData, transform);
Host.dbLog('Field \'' + field + '\' after transformation:\n\'' + fieldData + '\'');
}
output[field] = fieldData;
} // extract and transform all fields for the current profile (website)
Host.dbLog("extraction and transformation loop finished");
output.content = stripWhitespace(output.content);

var outputPlain = createCquote(output);
outputText(outputPlain, output);
} // transformationLoop()

/// #############

function runProfileTests() {

for (var profile in CONFIG) {
if (CONFIG[profile].type != 'archive' || !CONFIG[profile].enabled ) continue; // skip the wiki entry, because it's not an actual archive that we need to test
// should be really moved to downloadPostign
if (CONFIG[profile].content.xpath === '') console.log("xpath for content extraction is empty, cannot procedurally extract contents");
for (var test in CONFIG[profile].tests) {
var required_data = CONFIG[profile].tests[test];
var title = required_data.title;
//dbLog('Running test for posting titled:' + title);
// fetch posting via getPostingDataAJAX() and compare to the fields we are looking for (author, title, date)
//getPostingDataAJAX(profile, required_data.url);
//alert("required title:"+title);
} // foreach test

} // foreach profile (website)

} //runProfileTests

function selfCheckDialog() {
var sections = '<h3>Important APIs:</h3><div id="api_checks"></div>';

try {
runProfileTests.call(undefined); // check website profiles
}
catch (e) {
UI.alert(e.message);
}

for (var profile in CONFIG) {
// TODO: also check if enabled or not
if (CONFIG[profile].type != 'archive') continue; // skip the wiki entry, because it's not an actual archive that we need to test
var test_results = '';
for (var test in CONFIG[profile].tests) {
// var fieldData = extractFieldInfo(profile, post_id, 'author');
test_results += CONFIG[profile].tests[test].title + '<p/>';
}
sections +='<h3>' + profile + ':<font color="blue">'+ CONFIG[profile].url_reg+'</font></h3><div><p>' + test_results + '</p></div>\n';
} // https://jqueryui.com/accordion/

var checkDlg = $('<div id="selfCheck" title="Self Check dialog"><p><div id="accordion">' + sections + '</div></p></div>');

// run all API tests, invoke the callback to obtain the status
Environment.runAPITests(Host, function(meta) {

//console.log('Running API test '+meta.name);

meta.test(function(result) {
var status = (result)?'success':'fail';
var test = $("<p></p>").text('Running API test '+meta.name+':'+status);
$('#api_checks', checkDlg).append(test);
}); // update tests results

}); // runAPITests

/*
[].forEach.call(CONFIG, function(profile) {
alert("profile is:"+profile);
[].forEach.call(CONFIG[profile].tests, function(test) {

//UI.alert(test.url);
Host.downloadPosting(test.url, function(downloaded) {
alert("downloaded:");
//if (test.title == downloaded.title) alert("titles match:"+test.title);
}); //downloadPosting
}); //forEach test
}); //forEach profile
*/

//$('#accordion',checkDlg).accordion();
checkDlg.dialog({
width: 700,
height: 500,
open: function () {
// http://stackoverflow.com/questions/2929487/putting-a-jquery-ui-accordion-in-a-jquery-ui-dialog
$('#accordion').accordion({
autoHeight: true
});
}
}); // show dialog
} // selfCheckDialog

// show a simple configuration dialog (WIP)
function setupDialog() {
//alert("configuration dialog is not yet implemented");
var checked = (Host.get_persistent('debug_mode_enabled', false) === true) ? 'checked' : '';
//dbLog("value is:"+get_persistent("debug_mode_enabled"));
//dbLog("persistent debug flag is:"+checked);
var setupDiv = $('<div id="setupDialog" title="Setup dialog">NOTE: this configuration dialog is still work-in-progress</p><label><input id="debugcb" type="checkbox"' + checked + '>Enable Debug mode</label><p/><div id="progressbar"></div></div>');
setupDiv.click(function () {
//alert("changing persistent debug state");
Host.set_persistent('debug_mode_enabled', $('#debugcb').is(':checked'));
});
//MediaWiki editing stub, based on: https://www.mediawiki.org/wiki/API:Edit#Editing_via_Ajax
//only added here to show some status info in the setup dialog
Host.download('http://wiki.flightgear.org/api.php?action=query&prop=info|revisions&intoken=edit&rvprop=timestamp&titles=Main%20Page', function (response) {
var message = 'FlightGear wiki login status (AJAX):';
var status = response.statusText;
var color = (status == 'OK') ? 'green' : 'red';
Host.dbLog(message + status);
var statusDiv = $('<p>' + message + status + '</p>').css('color', color);
setupDiv.append(statusDiv);
});
setupDiv.dialog();
} // setupDialog

// this can be used to download/cache $FG_ROOT/options.xml so that fgfs CLI arguments can be recognized and post-processed automatically
// which can help transforming postings correctly
function downloadOptionsXML() {

// download $FG_ROOT/options.xml
Host.download("https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml?format=raw", function(response) {
var xml = response.responseText;
var doc = Host.make_doc(xml, 'text/xml');
// https://developer.mozilla.org/en-US/docs/Web/API/XPathResult
var options = Host.eval_xpath(doc, '//*/option', XPathResult.ORDERED_NODE_SNAPSHOT_TYPE);

// http://help.dottoro.com/ljgnejkp.php
Host.dbLog("Number of options found in options.xml:"+options.snapshotLength);

// http://help.dottoro.com/ljtfvvpx.php

// https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/options.xml

}); // end of options.xml download

} // downloadOptionsXML

function getProfile(url=undefined) {

if(url === undefined)
url=window.location.href;
else
url=url;

Host.dbLog("getProfile call URL is:"+url);

for (var profile in CONFIG) {
if (url.match(CONFIG[profile].url_reg) !== null) {
Host.dbLog('Matching website profile found');
var invocations = Host.get_persistent(Host.getScriptVersion(), 0);
Host.dbLog('Number of script invocations for version ' + Host.getScriptVersion() + ' is:' + invocations);

// determine if we want to show a config dialog
if (invocations === 0) {
Host.dbLog("ask for config dialog to be shown");
var response = UI.confirm('This is your first time running version ' + Host.getScriptVersion() + '\nConfigure now?');
if (response) {

// show configuration dialog (jQuery)
setupDialog();
}
else {
} // don't configure

}

// increment number of invocations, use the script's version number as the key, to prevent the config dialog from showing up again (except for updated scripts)
// FIXME: this is triggered/incremented by each click ...
Host.dbLog("increment number of script invocations");
Host.set_persistent(Host.getScriptVersion(), invocations + 1);
return CONFIG[profile];
} // matched website profile
Host.dbLog('Could not find matching URL in getProfile() call!');
} // for each profile
}// Get the HTML code that is selected

function getSelectedHtml() {
// From http://stackoverflow.com/a/6668159
var html = '',
selection = document.getSelection();
if (selection.rangeCount) {
var container = document.createElement('div');
for (var i = 0; i < selection.rangeCount; i++) {
container.appendChild(selection.getRangeAt(i).cloneContents());
}
html = container.innerHTML;
}
Host.dbLog('instantCquote(): Unprocessed HTML\n\'' + html + '\'');
return html;
}// Gets the selected text

function getSelectedText() {
return document.getSelection().toString();
}// Get the ID of the post
// (this needs some work so that it can be used by the AJAX mode, without an actual selection)

function getPostId(selection, profile, focus) {
if (focus !== undefined) {
Host.dbLog("Trying to get PostId with defined focus");
selection = selection.focusNode.parentNode;
} else {
Host.dbLog("Trying to get PostId with undefined focus");
selection = selection.anchorNode.parentNode;
}
while (selection.id.match(profile.content.idStyle) === null) {
selection = selection.parentNode;
}
Host.dbLog("Selection id is:"+selection.id);
return selection.id;
}

// Checks that the selection is valid
function checkValid(selection, profile) {
var ret = true,
selection_cp = {
},
tags = profile.content.parentTag;
for (var n = 0; n < 2; n++) {
if (n === 0) {
selection_cp = selection.anchorNode.parentNode;
} else {
selection_cp = selection.focusNode.parentNode;
}
while (true) {
if (selection_cp.tagName === 'BODY') {
ret = false;
break;
} else {
var cont = false;
for (var i = 0; i < tags.length; i++) {
if (selection_cp[tags[0]] === tags[i]) {
cont = true;
break;
}
}
if (cont) {
break;
} else {
selection_cp = selection_cp.parentNode;
}
}
}
}
ret = ret && (getPostId(selection, profile) === getPostId(selection, profile, 1));
return ret;
}// Extracts the raw text from a certain place, using an XPath

function extractFieldInfo(profile, id, field) {

if (field === 'content') {
Host.dbLog("Returning content (selection)");
return profile[field].selection();
} else {
Host.dbLog("Extracting field via xpath:"+field);
var xpath = '//*[@id="' + id + '"]/' + profile[field].xpath;
return Host.eval_xpath(document, xpath).stringValue; // document.evaluate(xpath, document, null, XPathResult.STRING_TYPE, null).stringValue;
}
}// Change the text using specified transformations

function applyTransformations(fieldInfo, trans) {
for (var i = 0; i < trans.length; i++) {
fieldInfo = trans[i](fieldInfo);
Host.dbLog('applyTransformations(): Multiple transformation, transformation after loop #' + (i + 1) + ':\n\'' + fieldInfo + '\'');
}
return fieldInfo;

} //applyTransformations

// Formats the quote

function createCquote(data, indirect_speech=false) {
if(!indirect_speech)
return nonQuotedRef(data); // conventional/verbatim selection
else {
// pattern match the content using a vector of regexes
data.content = transformSpeech(data.content, data.author, null, speechTransformations );
return nonQuotedRef(data);
}
}

function nonQuotedRef(data) { //TODO: rename
var template = Host.getTemplate();

var substituted = template
.replace('$CONTENT', data.content)
.replace('$URL',data.url)
.replace('$TITLE',data.title)
.replace('$AUTHOR',data.author)
.replace('$DATE',datef(data.date))
.replace('$ADDED',datef(data.date))
.replace('$SCRIPT_VERSION', Host.getScriptVersion() );

return substituted;
}//

// Output the text.
// Tries the jQuery dialog, and falls back to window.prompt()

function outputText(msg, original) {
try {
OUTPUT.jQueryTabbed(msg, original);
}
catch (err) {
msg = msg.replace(/<\/syntaxhighligh(.)>/g, '</syntaxhighligh$1');
OUTPUT.msgbox(msg);
}
}

// #############
// # Utilities #
// #############

function extract(regex) {
return function (text) {
return text.match(regex) [1];
};
}
function prepend(prefix) {
return function (text) {
return prefix + text;
};
}
function removeComments(html) {
return html.replace(//g, '');
}// Not currently used (as of June 2015), but kept just in case

// currently unused
function escapePipes(html) {
html = html.replace(/\|\|/g, '{{!!}n}');
html = html.replace(/\|\-/g, '{{!-}}');
return html.replace(/\|/g, '{{!}}');
}// Converts HTML <a href="...">...</a> tags to wiki links, internal if possible.

function a2wikilink(html) {
// Links to wiki images, because
// they need special treatment, or else they get displayed.
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/File:(.*?)".*?>(.*?)<\/a>/g, '[[Media:$1|$2]]');
// Wiki links without custom text.
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>http:\/\/wiki\.flightgear\.org\/.*?<\/a>/g, '[[$1]]');
// Links to the wiki with custom text
html = html.replace(/<a.*?href="http:\/\/wiki\.flightgear\.org\/(.*?)".*?>(.*?)<\/a>/g, '[[$1|$2]]');
// Remove underscores from all wiki links
var list = html.match(/\[\[.*?\]\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], underscore2Space(list[i]));
}
} // Convert non-wiki links
// TODO: identify forum/devel list links, and use the AJAX/Host.download helper to get a title/subject for unnamed links (using the existing xpath/regex helpers for that)

html = html.replace(/<a.*?href="(.*?)".*?>(.*?)<\/a>/g, '[$1 $2]');
// Remove triple dots from external links.
// Replace with raw URL (MediaWiki converts it to a link).
list = html.match(/\[.*?(\.\.\.).*?\]/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(list[i], list[i].match(/\[(.*?) .*?\]/) [1]);
}
}
return html;
}// Converts images, including images in <a> links

function img2link(html) {
html = html.replace(/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?><\/a>/g, '[[File:$2|250px|link=$1]]');
html = html.replace(/<img.*?src="http:\/\/wiki\.flightgear\.org\/images\/.*?\/.*?\/(.*?)".*?>/g, '[[File:$1|250px]]');
html = html.replace(/<a[^<]*?href="([^<]*?)"[^<]*?><img.*?src="(.*?)".*?><\/a>/g, '(see [$2 image], links to [$1 here])');
return html.replace(/<img.*?src="(.*?)".*?>/g, '(see the [$1 linked image])');
}// Converts smilies

function forum_smilies2text(html) {
html = html.replace(/<img src="\.\/images\/smilies\/icon_.*?\.gif" alt="(.*?)".*?>/g, '$1');
for (var i = 0; i < EMOTICONS.length; i++) {
html = html.replace(EMOTICONS[i][0], EMOTICONS[i][1]);
}
return html;
}// Converts font formatting

function forum_fontstyle2wikistyle(html) {
html = html.replace(/<span style="font-weight: bold">(.*?)<\/span>/g, '\'\'\'$1\'\'\'');
html = html.replace(/<span style="text-decoration: underline">(.*?)<\/span>/g, '<u>$1</u>');
html = html.replace(/<span style="font-style: italic">(.*?)<\/span>/g, '\'\'$1\'\'');
return html.replace(/<span class="posthilit">(.*?)<\/span>/g, '$1');
}// Converts code blocks

function forum_code2syntaxhighlight(html) {
var list = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/g),
data = [
];
if (list === null) return html;
for (var n = 0; n < list.length; n++) {
data = html.match(/<dl class="codebox">.*?<code>(.*?)<\/code>.*?<\/dl>/);
html = html.replace(data[0], processCode(data));
}
return html;
}// Strips any whitespace from the beginning and end of a string

function stripWhitespace(html) {
html = html.replace(/^\s*?(\S)/, '$1');
return html.replace(/(\S)\s*?\z/, '$1');
}// Process code, including basic detection of language

function processCode(data) {
var lang = '',
code = data[1];
code = code.replace(/ /g, ' ');
if (code.match(/=?.*?$?.*?$?;/) !== null) lang = 'nasal';
if (code.match(/<.*?>.*?<\/.*?>/) !== null || code.match(//) !== null) lang = 'xml';
code = code.replace(/<br\/?>/g, '\n');
return '<syntaxhighlight lang="' + lang + '" enclose="div">\n' + code + '\n</syntaxhighlight>';
}// Converts quote blocks to Cquotes

function forum_quote2cquote(html) {
html = html.replace(/<blockquote class="uncited"><div>(.*?)<\/div><\/blockquote>/g, '{{cquote|$1}}');
if (html.match(/<blockquote>/g) === null) return html;
var numQuotes = html.match(/<blockquote>/g).length;
for (var n = 0; n < numQuotes; n++) {
html = html.replace(/<blockquote><div><cite>(.*?) wrote.*?:<\/cite>(.*?)<\/div><\/blockquote>/, '{{cquote|$2|$1}}');
}
return html;
}// Converts videos to wiki style

function vid2wiki(html) {
// YouTube
html = html.replace(/<div class="video-wrapper">\s.*?<div class="video-container">\s*?<iframe class="youtube-player".*?width="(.*?)" height="(.*?)" src="http:\/\/www\.youtube\.com\/embed\/(.*?)".*?><\/iframe>\s*?<\/div>\s*?<\/div>/g, '{{#ev:youtube|$3|$1x$2}}');
// Vimeo
html = html.replace(/<iframe src="http:\/\/player\.vimeo\.com\/video\/(.*?)\?.*?" width="(.*?)" height="(.*?)".*?>.*?<\/iframe>/g, '{{#ev:vimeo|$1|$2x$3}}');
return html.replace(/\[.*? Watch on Vimeo\]/g, '');
}// Not currently used (as of June 2015), but kept just in case

// currently unused
function escapeEquals(html) {
return html.replace(/=/g, '{{=}}');
}// <br> to newline.

function forum_br2newline(html) {
html = html.replace(/<br\/?><br\/?>/g, '\n');
return html.replace(/<br\/?>/g, '\n\n');
}// Forum list to wiki style

function list2wiki(html) {
var list = html.match(/<ul>(.*?)<\/ul>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '* $1\n');
}
}
list = html.match(/<ol.*?>(.*?)<\/ol>/g);
if (list !== null) {
for (var i = 0; i < list.length; i++) {
html = html.replace(/<li>(.*?)<\/li>/g, '# $1\n');
}
}
html = html.replace(/<\/?[uo]l>/g, '');
return html;
}
function nowiki(text) {
return '<nowiki>' + text + '</nowiki>';
}// Returns the correct ordinal adjective

function ordAdj(date) {
date = date.toString();
if (date == '11' || date == '12' || date == '13') {
return 'th';
} else if (date.substr(1) == '1' || date == '1') {
return 'st';
} else if (date.substr(1) == '2' || date == '2') {
return 'nd';
} else if (date.substr(1) == '3' || date == '3') {
return 'rd';
} else {
return 'th';
}
}

// Formats the date to this format: Apr 26th, 2015
function datef(text) {
var date = new Date(text);
return MONTHS[date.getMonth()] + ' ' + date.getDate() + ordAdj(date.getDate()) + ', ' + date.getFullYear();
}
function underscore2Space(str) {
return str.replace(/_/g, ' ');
}

// IGNORE EVERYTHING THAT FOLLOWS:
// This is an experiment to use GA/GP (genetic programming) to help procedurally evolve xpath and regex expressions if/when the underlying websites change
// so that we don't have to manually update/edit the script accordingly (this would also work for mobile themes etc)
// For now, this is heavily based on the genetic.js framework/examples: http://subprotocol.com/system/genetic-hello-world.html
// The idea is to evolve the xpath/regex expression by evaluating its return value against the expected/desired value
// the most important thing here is having a suitable fitness function
//

function evolve_expression_test() {

try {
var genetic = Genetic.create();

// TODO: use minimizer: redundant_bytes + duration_msec + xpath.length
genetic.optimize = Genetic.Optimize.Maximize;
genetic.select1 = Genetic.Select1.Tournament2;
genetic.select2 = Genetic.Select2.Tournament2;

genetic.seed = function() {

function randomString(len) {
var text = "";
var charset = "\\abcdefghijklmnopqrstuvwxyz0123456789[] ()<>*.,";
for(var i=0;i<len;i++)
text += charset.charAt(Math.floor(Math.random() * charset.length));

return text; // "From:&(.*)$<.*8.*>"
}

// create random strings that are equal in length to solution
return randomString( this.userData["solution"].length);
};

genetic.mutate = function(entity) {

function replaceAt(str, index, character) {
return str.substr(0, index) + character + str.substr(index+character.length);
}

// chromosomal drift
var i = Math.floor(Math.random()*entity.length);
return replaceAt(entity, i, String.fromCharCode(entity.charCodeAt(i) + (Math.floor(Math.random()*2) ? 1 : -1)));
};

genetic.crossover = function(mother, father) {

// two-point crossover
var len = mother.length;
var ca = Math.floor(Math.random()*len);
var cb = Math.floor(Math.random()*len);
if (ca > cb) {
var tmp = cb;
cb = ca;
ca = tmp;
}

var son = father.substr(0,ca) + mother.substr(ca, cb-ca) + father.substr(cb);
var daughter = mother.substr(0,ca) + father.substr(ca, cb-ca) + mother.substr(cb);

return [son, daughter];
};

genetic.determineExcessBytes = function (text, needle) {
return text.length - needle.length;
};

genetic.containsText = function (text, needle) {
return text.search(needle);
};

genetic.isValid = function(exp) {

};

/* myFitness:
* - must be a valid xpath/regex expression (try/call)
* - must containsText the needle
* - low relative offset in text (begin/end)
* - excessBytes
* - short expression (expression length)
* - expression footprint (runtime)
*/

// TODO: the fitness function should validate each xpath/regex first

genetic.fitness = function(entity) {
var fitness = 0;
var result;
var validExp = 0.1;
var hasToken = 0.1;

var t = this.userData.tests[0].haystack;
//var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness

if (0)
try {
var regex = new RegExp(entity);
var output = t.search( regex);
validExp = 5;
//if (output) validExp = 50;
}
catch(e) {
//validExp = 2;
}

var i;
for (i=0;i<entity.length;++i) {
// increase fitness for each character that matches
if (entity[i] == this.userData["solution"][i])
fitness += 1;

// award fractions of a point as we get warmer
fitness += (127-Math.abs(entity.charCodeAt(i) - this.userData["solution"].charCodeAt(i)))/50;
}

return fitness + (1*validExp + 1* hasToken);
};

genetic.generation = function(pop, generation, stats) {
// stop running once we've reached the solution
return pop[0].entity != this.userData["solution"];
};

genetic.notification = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {
var diff = value.charCodeAt(i) - this.last.charCodeAt(i);
var style = "background: transparent;";
if (diff > 0) {
style = "background: rgb(0,200,50); color: #fff;";
} else if (diff < 0) {
style = "background: rgb(0,100,50); color: #fff;";
}

solution.push("<span style=\"" + style + "\">" + value[i] + "</span>");
}

var t = this.userData.tests[0].haystack;
//console.log("haystack is:"+t);
// "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"}, /From: (.*) <.*@.*>/
var regex = new RegExp(this.userData.solution);
//var output = t.match( new RegExp("From: (.*) <.*@.*>"))[1];
// TODO: use search & match for improving the fitness
var output = t.search( new RegExp(value));

var buf = "";
buf += "<tr>";
buf += "<td>" + generation + "</td>";
buf += "<td>" + pop[0].fitness.toPrecision(5) + "</td>";
buf += "<td>" + solution.join("") + "</td>";
buf += "<td>" + output + "</td>";
buf += "</tr>";
$("#results tbody").prepend(buf);

this.last = value;
};

/*
genetic.notification2 = function(pop, generation, stats, isFinished) {

function lerp(a, b, p) {
return a + (b-a)*p;
}

var value = pop[0].entity;
this.last = this.last||value;

if (pop != 0 && value == this.last)
return;

var solution = [];
var i;
for (i=0;i<value.length;++i) {

solution.push(value[i]);
}
console.log("Generation:"+ generation + " Fitness:" + pop[0].fitness.toPrecision(5) + " Solution:" + solution.join(""));

this.last = value;
};
*/

var config = {
"iterations": 4000
, "size": 250
, "crossover": 0.3
, "mutation": 0.4
, "skip": 30 // notifications
//, "webWorkers": false
};

/*
var profile = CONFIG['Sourceforge Mailing list'];
var posting = profile.tests[0];
var author_xpath = profile.title.xpath;
*/

var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];

// the regex we want to evolve
var solution = "From: (.*) <.*@.*>";

// let's assume, we'd like to evolve a regex expression like this one
var userData = {
solution: solution,
tests: regexTests
};

genetic.evolve(config, userData);

//console.log("genetic.js is loaded and working, but disabled for now");

} // try
catch (e) {
console.log("genetic.js error:\n" +e.message);
} // catch

} // evolveExpression_test()

if(0) //TODO: expose via development tab
try {
// https://github.com/cazala/synaptic
var Neuron = synaptic.Neuron,
Layer = synaptic.Layer,
Network = synaptic.Network,
Trainer = synaptic.Trainer,
Architect = synaptic.Architect;

function Perceptron(input, hidden, output)
{
// create the layers
var inputLayer = new Layer(input);
var hiddenLayer = new Layer(hidden);
var outputLayer = new Layer(output);

// connect the layers
inputLayer.project(hiddenLayer);
hiddenLayer.project(outputLayer);

// set the layers
this.set({
input: inputLayer,
hidden: [hiddenLayer],
output: outputLayer
});
}

// extend the prototype chain
Perceptron.prototype = new Network();
Perceptron.prototype.constructor = Perceptron;

var myPerceptron = new Perceptron(2,3,1);
var myTrainer = new Trainer(myPerceptron);

myTrainer.XOR(); // { error: 0.004998819355993572, iterations: 21871, time: 356 }

myPerceptron.activate([0,0]); // 0.0268581547421616
myPerceptron.activate([1,0]); // 0.9829673642853368
myPerceptron.activate([0,1]); // 0.9831714267395621
myPerceptron.activate([1,1]); // 0.02128894618097928

console.log("Syntaptic loaded");
} catch(e) {
UI.alert(e.message);
}

</syntaxhighlight>

{{Appendix}}

FlightGear wiki talk:Instant-Refs

2016-05-20T06:59:44Z

Elgaton: /* External genetic/neural network libraries */ Libraries submitted to CDN

== more sources ==

at some point, we may also want to add support for other sources, such as:
* old forum URLs, i.e. not yet using the subdomain format (should be easy, it's just a different/additional URL after all)
* thread.gmane.org/gmane.games.flightgear.devel/
* jsbsim devel list
* github tickets
* the new SF.net issue tracker
* SF.net commit logs http://gitorious.org/fg/
* http://www.mail-archive.com/flightgear-devel@flightgear.org/ (until 2005)
* http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/maillist.html (until 10/2013)

that should cover all important sources. And it would allow us to also use the same script to help populate [[FlightGear Newsletter]] & [[Changelog 3.2|changelogs]], but also [[Release plan/Lessons learned]]. So this could be a real time-saver. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:40, 1 June 2014 (UTC)

== Automatic update of script and old quotes ==
Thanks for the heads-up. Now, that makes me wonder if I can adapt the script to automatically parse existing wiki articles and update cquotes there automatically by re-opening the URL and re-running the extraction logic :) BTW: That reminds me: I was going to investigate adopting the '''downloadURL''' attribute[http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating] so that scripts can auto-update --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:51, 11 June 2014 (UTC)

:: if we should continue to see this widely used, having a good way to re-download and re-run the script on pages with existing cquotes would be a good way to automatically update quotes. For that, we would want to encode certain meta info in each template, e.g.:
* script version
* quoting date/time
* quote URL
* selection offsets
* quoting settings (format)

We can hook into form submission to update arbitrary quotes/contents using this: http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Developer_Tools#Intercept_and_Modify_Form_Submissions

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:19, 15 November 2015 (EST)

=== Hosting ===
The script seems to be about to become sufficiently complex to deserve actual hosting:
* http://wiki.greasespot.net/User_Script_Hosting
* https://openuserjs.org/

(that would allow updating the script automatically)

: Hi, is there any progress being made on this? I think the best way to host it would be to put in in a SourceForge repository under the FlightGear project (I don't know if it allows direct downloads, though, and we would need to relicense the script because [https://opensource.org/faq#public-domain public domain licenses are not OSI-approved]); otherwise, I can submit it to [https://greasyfork.org/ GreasyFork] (OpenUserJS is unsuitable as [https://openuserjs.org/about/Terms-of-Service public domain licenses are not allowed]). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 03:58, 1 May 2016 (EDT)

:: I don't think anybody has looked into this recently - however, relicensing should be a no-brainer, given that all the code is in the public domain anyway. I am not sure if it's worth the hassle to put up under sourceforge/FlightGear; we also need to keep in mind that this is not exactly the most popular "tool" around here. So, before this becomes even better accessible, it might be a good idea to comply with some of the requests made, e.g. by adding support for a different output mode (without using the FGCquote template, just the copied text, plus the ref part), so that quote-heavy pages don't look that obnoxious.
:: Regarding hosting in general, I still think it may be a good idea, but we would probably need to make sure that some requirements are met, e.g. having a revision history, and to provide other contributors with access-alternatively, we should maintain a copy of the script in the wiki, and add a note saying that changes to it will be reviewed/integrated with the hosted script by one of us (if you'd volunteer to help with that, I'd suggest to just go ahead and set up a public repository).
:: Admittedly, this is going to remain a fairly FG specific script, it would need quite a bit of work to become useful for other purposes (even though other OSS projects may be easy to support). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 06:33, 1 May 2016 (EDT)

::: OK, I think we can leave the script here and host it on GreasyFork (it allows public domain scripts) - I'll put the page on my watchlist to make sure I update the script there every time there's a version bump. Does that look good to you and the other contributors? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:26, 1 May 2016 (EDT)

:::: Sounds good to me, given how the script has evolved over time, we've probably hit a natural limit already, i.e. being able to use multiple files easily, and update scripts automatically sounds like a useful thing to me. I don't know if greasyfork supports "teams" of contributors for better collaboration ? It might also be a good idea to generalize the script so that it supports arbitrary phpBB installations and mailing list archives other than just sourceforge (think gmane) - and maybe output formats other than just wikimedia markup, that way, the script may become more useful over time.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:46, 1 May 2016 (EDT)

::::: It doesn't as it only offers a user script downloading facility (source code repositories like GitHub and SourceForge are better suited for the kind of work you mention). I'll wait a bit in case Red Leader, Philosopher or bigstones have any objections/remarks, then I'll upload the script there. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:14, 1 May 2016 (EDT)

:: do they support extensions spread across multiple files ? That is something that would help us quite a bit cleaning up the current code, which has become a bit convoluted over time. Apart from that, nothing wrong with github et al - I am just not sure if they're suitable for automatically propagating updated changes.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:12, 2 May 2016 (EDT)

::: No, not that I know of (generally speaking, all user scripts are made of a single .user.js file). We could "hack" it by splitting the current script in multiple files and requiring them from a main one as libraries via the <tt>@include</tt> directive, but that would rule out most hosting solutions (many providers only allow GreaseMonkey scripts which include additional files only from a handful of trusted domains/CDNs, for safety reasons).
::: As for propagating changes on GitHub and other code repository, the update URL must remain constant throughout the lifetime of the script. I'm sure this can be done on GitHub by publishing updates not as releases (where the addresses change), but on GitHub Pages (a user script I use does exactly this); on SourceForge, the usual download hosting could do the trick, but I'd need to perform a test first. (I'd prefer SF to keep the script "inside" the FG project hierarchy, if possible). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:50, 2 May 2016 (EDT)

: actually, user scripts can be compromised of multiple files, e.g. via the require directive [http://stackoverflow.com/questions/8695459/is-it-possible-to-split-greasemonkey-user-scripts-into-multiple-files]. Personally, I would like to make use of that - we are already using that to include jQuery stuff, and it would help us organize the script a little better. I am not oposed to seeing the script hosted as some part of FG/SF, but I just don't think it's going to be a very popular idea - so far, everything worked out without major hinderance, so I would rather use an independent hosting solution, or continue to use the wiki to ensure that the barrier to entry/contributing isn't raised, e.g. by going through merge requests etc. Major contributions to the script like those from bigstones or Red Leader were simply "dropped" here directly, so this seems to have worked out really well.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:26, 2 May 2016 (EDT)

:: I've checked the [https://greasyfork.org/it/help/external-scripts GreasyFork external script policy]: as long as all the files are hosted on/uploaded to GreasyFork, it's not a problem. (Also, sorry about the typo, I wrote <tt>@include</tt> instead of <tt>@require</tt> by mistake). I guess I can proceed with the upload now? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 12:22, 2 May 2016 (EDT)

: sure, why not - it's in the public domain after all - feel free to make any changes to the script to have it auto-update. We can review everything once we have gathered a little more experience with this kind of scheme. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:27, 2 May 2016 (EDT)

:: {{done}} - I'm updating the installation instructions in the main page. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:52, 2 May 2016 (EDT)

::: Script at: https://greasyfork.org/en/scripts/19331-instant-cquotes
--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:18, 2 May 2016 (EDT)

:::: Regarding updates, bumping the version number is fine - I'll take the script at the wiki revision where the version is bumped and upload it. (Note that I will not perform any prior testing, so be extra careful - maybe I should add this in the note above the script?). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:08, 2 May 2016 (EDT)

:: sounds good, I will be sure to stop updating the version number without prior testing, we could also add some tests to the code to spot the more obvious mistakes - in fact, there is already an OpenLink helper that could be used to download a few postings and try to extract the corresponding fields, so that we would only bump the version number if that succeeds. BTW: Thanks for handling the hosting part, much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:25, 2 May 2016 (EDT)

== Issues ==
=== too greedy non-greedy regexes ===
The problem described in the previous section regarding regexes that eat up half messages seems to be related to my [http://blog.liip.ch/archive/2009/07/24/the-greedyness-of-non-greedy-regular-expressions.html misunderstanding of the non-greediness]. So, I managed to fix it for this one case, but this means that using .*? to match everything until you meet the following character (as I currently do pretty much everywhere) is dangerous and prone to failure. Any occurrence of that should be changed as I did in [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Instant-Cquotes&oldid=72839 this edit] and that's clearly cumbersome, not to say that it can still be incorrect: say I have
<nowiki><a someprop="href" href="http://www.link.org" ... ></nowiki>
If I want to mach anything between a and href, I use <tt><nowiki>[^(?:href)]*</nowiki></tt>, but that would match only up to the text inside someprop, so I'd have to check that it's not inside doublequotes... Well, I guess this is getting too complicated for handling it [http://blog.codinghorror.com/parsing-html-the-cthulhu-way/ the Chtulu way].

So my approach would be: fix this whenever the problem comes up, but don't overdo because we're already moving in dangerous ground. Or, rewrite it all using ''only'' xpaths *sobs*.
--[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 16:49, 17 June 2014 (UTC)

=== regex vectors ===

When testing things I realized that you are right: there are some scenarios where the regex may fail depending on how "complete" the selection is, because we obviously have hard-coded assumptions here. I'll see if it's feasible to also support vectors for regexes to extract the corresponding fields and try each regex in order to get a certain field, or if that doesn't make any sense... But quoting with/without author (anonymous quote) would be a valid test case here.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

: Probably going to look into this sooner or later because this could be a simple solution to also support PM quoting - without having to parse the actual URL, we'd just try different regexes in order and use the one that succeeds. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

=== Syntaxhighlighting ===
Need to investigate what needs to be updated to support quoting code sections, as per [http://forum.flightgear.org/viewtopic.php?f=66&t=21855&p=212585#p212581] --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:33, 14 June 2014 (UTC)

=== Postings that break our script for some reason ===
* http://forum.flightgear.org/viewtopic.php?f=19&t=23365

== Misc notes ==

=== Detecting failed XPaths ===
you've got a point, we should probably check if xpath/regexes succeed or fail, and show a warning so that we know that the scripts needs to be updated because some xpath/regex may have changed.

=== Paragraphs / br (trailing slash) ===
There are some minor issues now, i.e. newline2br will no longer contain the trailing forward slash, so there's probably some JavaScript/regex oddity involved here, maybe slashes just need to be escaped. Will be testing the code with a few different forum postings and check the resulting cquote
: {{done}}. That's because newline2br wasn't used at all in html mode. I added addNewlines which puts newlines after br's and list related tags, if there are more newlines to be added that should be the place.
: --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 14:03, 17 June 2014 (UTC)

=== support/ignore highlighted keywords/smilies ===
see [[Understanding Forward Compatibility]] for examples
: {{done}} --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 15:13, 17 June 2014 (UTC)

== Beyond just cquotes (newsletter/changelog) ==

Gijs has recently revamped the newsletter template rather significantly, see: [[FlightGear_Newsletter_June_2014]], and [[User_talk:Gijs#06.2F2014_newsletter:_too_much_of_a_]] - basically, we could extend the script to support another output FORMAT to directly create markup for the newsletter/changelog. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 20:40, 30 June 2014 (UTC)

== more styles/output formats ==

looking at some of the cleanup done by Red Leader recently, we could also directly support other styles/output formats to directly provide a format that looks well enough without requiring tons of manual editing. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:11, 13 February 2015 (EST)

== token matching for keywords/variables ==

seems like it might make sense to match common keywords/acronyms and variables, such as e.g.:
* FG_ROOT => [[$FG_ROOT]]
* FG_HOME => [[$FG_HOME]]
* FG_SRC => [[$FG_SRC]]

file names with a known prefix like $FG_ROOT could even be pattern-matched using git link: $FG_ROOT/Nasal/canvas/MapStructure.nas would become [[$FG_ROOT]]{{Git link|gitorious|fg/fgdata|master|Nasal/canvas/MapStructure.nass|text=/Nasal/canvas/MapStructure.nas}}

Equally, we could match common property paths to use code tags, e.g.: /sim/rendering would become <code>/sim/rendering</code>
Ultimately, it might be a good idea to get in touch with Johan_G, Gijs and Red Leader to see what kind of format they'd prefer, especially because this could then be directly used for creating newsletter contents. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:19, 13 February 2015 (EST)

== matching repository references using git link template ==

Most of us commonly refer to repository files using either the $FG_* references, or relative paths in the form of <code>src/Main/fg_init.cxx:line number</code>, we could automatically convert such references using the git/repo link template, e.g.:

{{FGCquote
|Further investigation found that the launcher *is* trying to add this directory to fg-aircraft (src/GUI/QtLauncher.cxx:772), but that this doesn't work because this option is processed before the launcher is run (intentionally, to allow the launcher to find aircraft in fg-aircraft: '''src/Main/main.cxx:448''').
|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33686356/
|title=<nowiki>Re: [Flightgear-devel] Launcher issues on Linux</nowiki>
|author=<nowiki>Rebecca N. Palmer</nowiki>
|date=<nowiki>2015-04-01</nowiki>
}}
}}

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:48, 1 April 2015 (EDT)

== chrome specific port ==

Hi Red Leader, when/if you do come up with a chrome specific version of the script, I would suggest to refactor existing APIs accordingly, so that we can come up with a common library of general purpose/utility helpers, so that both scripts can co-exist and use a common/shared file (think all the extraction/transformation logic), by referencing an external .js/JavaScript file that will be maintained/updated and hosted separately. I think this could be accomplished easily using jsfiddle. So basically, I am suggesting to come up with a shared back-end for both versions of the script. Given the complexity we're reaching meanwhile, as well as the number of edits and contributors, it may also make sense to consider using github for this at some point. One of the main advantages being that we could easily distribute updates automatically to all people who've installed the script, without them having to do anything manually.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 08:38, 23 June 2015 (EDT)

== Development resources ==

* https://www.youtube.com/watch?v=xpXNDT0SxM0
* http://wiki.greasespot.net/GM_getResourceText
* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script

== Future focus/development and priorities (De-quoting) ==

Given that most people involved in maintaining the wiki don't seem to particularly appreciate the nature of articles consisting mainly of quotes, and that we don't seem to have any other good way to populate new articles quickly, I was thinking of changing the focus of the script to dynamically create articles using quotes (with proper refs), that would be merely copy-edited, i.e. using the process we are currently using to "de-quote" such articles by 1) categorizing related quotes, 2) coming up with headers/sub-headers, 3) re-writing/merging certain quotes, 4) attributing them - linking back to the quotes archives.
Should we decide to pursue this, the script would be turned into a "wizard" where we can topics and sub-topics (wiki headings) and then add arbitrary text using the existing approach, but without using cquotes - i.e. the focus would be on extracting relevant contents, distilling them down and adding plenty of refs, including a references section at the bottom. Some tokens/words could be changed dynamically, but some kind of proof-reading/copy-editing would still need to be done afterwards, because people tend to use first person speech in their announcements/postings, which we would need to convert to 3rd person semi-automagically. Thoughts/ideas ?--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:11, 15 November 2015 (EST)

== changing and automating regex/xpath handling ==
{{See also|#Genetic_Expression_solver}}

We have currently hard-coded handling of different websites, regexes and xpath expressions so that things are a bit fragile at the moment, and once a website changes its style/template, our script would break immediately. However, we could change the way the script works by using a very simple NN (neural network) to come up with matching regex/xpath expressions automatically. The way this could work would be "supervised" training, where we would replace/adapt our existing CONFIG hash with a vector of URLs and contents to be extracted (date, time, title, posting). This kind of data would suffice entirely for a neural network to self-train itself and "learn" how to come up with regex/xpath expressions to extract the relevant contents, including not only hard-coded websites like sourceforge, but even completely different websites (think gmane) - because the "learning" routine would self-adapt by looking at how to get its contents, and never contain any hard-coded regex/xpath expressions anymore. The CONFIG hash would end up being a vector with "training data" for different websites to be supported. And whenever an expression fails, it could re-train itself accordingly.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:33, 15 November 2015 (EST)

== nested quotes and AJAX for thread titles ==

{{FGCquote
|1= http://sourceforge.net/p/flightgear/mailman/message/33451055/
{{cquote|As we move forward with FlightGear development and future versions, we will be expanding the "in app" aircraft center. This dialog inside flightgear lets you select, download, and switch to any of the aircraft in the library.|Curt}}
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=259879#p259879
| title = <nowiki>Re: New Canvas GUI</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Oct 7th, 2015
}}
}}

== AJAX mode/testing ==

We should probably add a dialog to store credentials that we can use for accessing the wiki, which would need to be shown after installing the script, i.e. first-time use

* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script
* http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Getting_Started#During_Installation
* https://www.safaribooksonline.com/library/view/greasemonkey-hacks/0596101651/ch01s06.html

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 20 November 2015 (EST)

== libraries ==

Referring to the [[#Hosting]] section, and my comment on wanting to use additional libs (like jQuery), I am primarily thinking about using a wizard-framework (e.g. jQuery steps) and a framework for creating wikimedia editor plugins (actions):

* http://mstratman.github.io/jQuery-Smart-Wizard/
* http://www.jquery-steps.com/
* http://www.jqueryrain.com/demo/jquery-step-form-wizard/
* https://www.mediawiki.org/wiki/Extension:WikiEditor

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:07, 2 May 2016 (EDT)

== About dequoting the script's article ==

Thanks for doing this, but I am frankly not sure if it's worth the effort - there are much more popular/important articles using tons of quotes than this one, and given the reputation of the script, having quotes in this article may actually be a useful thing to make the case for having quotes in the first place - thus, I would frankly not spend much time going through this particular article - in fact, I'd be very surprised if the greasyfork download stats showed more than 3-5 people actually downloading, and using, the script - so this is really just a niche tool, and we probably better spend our time doing other things, and reviewing other wiki articles, than the script's article - at the very least, I would suggest to retain the references to the original discussions revolving these quotes (just my 2c). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 19:00, 2 May 2016 (EDT)

: {{done}} I've added back the quotes as references. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:53, 3 May 2016 (EDT)

== Script configuration (persistence) ==

* https://wiki.greasespot.net/GM_config
* https://github.com/sizzlemctwizzle/GM_config/wiki
* https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API

== Work in progress ==

We have now several more or less related development efforts going on, and the code is also growing because of that - so it seems to make sense to summarize what's been going on recently. In general, all changes were made in response to the collection of feature requests and ideas we have accumulated over time - specifically, that means that the following roadmap is in the process of being implemented:

* establish unit testing, and add a few self-tests, so that the script can be more easily tested, updated/reviewed in the future
* rework the script to more easily support other sources (think gmane)
* make it much easier to update modified xpath/regex expressions (i.e. provide a UI for that)
* support persistence for script-specific settings
* make it easier for people to port/maintain the script by encapsulating platform specifics
* support asynchronous fetching of postings (AJAX), e.g. to fetch posting titles, attachments etc
* prepare the groundwork for supporting template-based output formats (think newsletter, changelog, articles)
* review what's necessary to allow the script to update fgcquote-based quotes automagically

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:47, 4 May 2016 (EDT)

== External genetic/neural network libraries ==
While uploading the latest version of the script, I noticed that the Genetic and Synaptic libraries are hosted on sites not on [https://greasyfork.org/en/help/external-scripts the approved GreasyFork list]. Shall I ask them to host them? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:28, 11 May 2016 (EDT)

: Thanks for pointing that out, I missed that completely, because everything is working correctly here - but obviously, I rarely get to actually download/install the latest version via greasyfork. Those libs should be safe to be added to the list, i.e. they're fairly established/popular, lest I'd not be using them. For now, this is just an experiment anyway. The idea is to update the xpath/regex code to evolve if/when the underlying website (theme) changes. But if there is a problem, we could use other libs - the code is just used for testing ATM. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:41, 11 May 2016 (EDT)

* https://github.com/subprotocol/genetic-js
* https://github.com/cazala/synaptic

:: {{ongoing}} I have submitted the libraries to the JSDelivr CDN; once they are up, I'll change the source URLs in the script and update it on GreasyFork as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:32, 17 May 2016 (EDT)

::: Hi Elgaton, thank you for taking care of this, it's very much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:55, 17 May 2016 (EDT)

:::: You're welcome! My merge requests for the CDN were approved (this took a bit longer than expected because I had made a small mistake - I forgot to include a file required by the Genetic.js library). The libraries should be up in a day or two, at which point I'll update the URLs in the script and submit the new version to GreasyFork. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:59, 20 May 2016 (EDT)

== Genetic Expression solver ==
[[File:Instant-cquotes-genetic-regex-solving.png|thumb|Screenshot showing the instant cquotes script with integrated regex solving support using genetic algorithms.]]

The genetic-js framework has been integrated, it is intended to help solve xpath/regex expressions procedurally using genetic algorithms/programming.

The idea is to provide a set of desired outputs (needles), available input data (haystack), and use existing (possibly outdated) regex/xpath expressions to seed a pool with potential solutions for retrieving the desired output. For now, this is just proof-of-concept, i.e. just an experiment.

For example, let's consider the typical format of a from header for any sourceforge posting:
<syntaxhighlight lang="javascript">
var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];
</syntaxhighlight>

The basic idea is to run a fitness function and score regex expressions based on not throwing an exception (which makes them valid), and by checking if the desired tokens are part of the output string, and evolve (mutate/cross-over) the "fittest" expressions - i.e. those that satisfy at least /some/ of the heuristics.

Some of the metrics that can be used by the fitness function to determine if an expression is "fit", are:
* valid expression
* relative offset/excess bytes in matches string
* number of examples it can successfully extract
* length of the expression
* runtime of the expression

The search space, and runtime, can be significantly reduced by looking at similarities between all examples and coming up with a subset string that contains all identical components (e.g. the <code>From:</code> part in the author regex) and use that for seeding the initial generations.

Ultimately, this would allow the script to self-update its regex/xpath expressions if/when the underlying website (themes) change, but it would also allow to add support for new websites, without ever manually adding the required xpath/regex expressions, i.e. all that is needed is a sufficiently large number of example datasets to obtain the author, date and title information, and a URL for the script to download the HTML markup of the posting in question:

{{Note|The date field won't work as is, because it's actually post-processed using a transformation function, so we'd need to undo the transformation or use the actual date string instead}}
<syntaxhighlight lang="javascript"> // vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
</syntaxhighlight>

Note how this no longer contains any hard-coded xpath/regex expressions - instead, the script can refer to the website specific defaults, and try those first, and if they fail, use those to seed new generations and evolve them procedurally until all tests succeed.

For a regex to be valid, it must work for all tests/examples.

Once the regex solver is working correctly, the code can be further generalized to also evolve xpath expressions (NOTE: the DOMParser API is /not/ available to webworkers ...) and chain those two components together.

* http://regex.inginf.units.it/how.html
* http://www.i-programmer.info/programming/perl/9503-automatically-generating-regular-expressions-with-genetic-programming.html
* http://jkff.info/articles/ire/
* http://www.networkworld.com/article/2955126/software/genetic-programming-meets-regular-expressions.html
* https://handcraftsman.wordpress.com/2012/04/11/evolving-a-regular-expression-with-go/
* http://stackoverflow.com/questions/4880402/how-to-auto-generate-regex-from-given-list-of-strings
* http://regex.inginf.units.it/
* http://www.genetic-programming.org/hc2014/Bartoli-Paper.pdf

== Hierarchical Clustering ==

Been tinkering with a JavaScript module to automatically cluster postings based on certain keywords in the topic/title or posting (e.g. Nasal, Canvas, 2D API, rendering): https://harthur.github.io/clusterfck/

Note that in conjunction with processing article sections and/or whole articles, this could help automatically come up with matching postings for articles and vice versa.

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:11, 19 May 2016 (EDT)

FlightGear wiki talk:Instant-Refs

2016-05-17T22:32:42Z

Elgaton: /* External genetic/neural network libraries */ Uploaded libraries to JSDelivr

== more sources ==

at some point, we may also want to add support for other sources, such as:
* old forum URLs, i.e. not yet using the subdomain format (should be easy, it's just a different/additional URL after all)
* thread.gmane.org/gmane.games.flightgear.devel/
* jsbsim devel list
* github tickets
* the new SF.net issue tracker
* SF.net commit logs http://gitorious.org/fg/
* http://www.mail-archive.com/flightgear-devel@flightgear.org/ (until 2005)
* http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/maillist.html (until 10/2013)

that should cover all important sources. And it would allow us to also use the same script to help populate [[FlightGear Newsletter]] & [[Changelog 3.2|changelogs]], but also [[Release plan/Lessons learned]]. So this could be a real time-saver. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:40, 1 June 2014 (UTC)

== Automatic update of script and old quotes ==
Thanks for the heads-up. Now, that makes me wonder if I can adapt the script to automatically parse existing wiki articles and update cquotes there automatically by re-opening the URL and re-running the extraction logic :) BTW: That reminds me: I was going to investigate adopting the '''downloadURL''' attribute[http://stackoverflow.com/questions/15095055/why-isnt-my-greasemonkey-script-updating] so that scripts can auto-update --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:51, 11 June 2014 (UTC)

:: if we should continue to see this widely used, having a good way to re-download and re-run the script on pages with existing cquotes would be a good way to automatically update quotes. For that, we would want to encode certain meta info in each template, e.g.:
* script version
* quoting date/time
* quote URL
* selection offsets
* quoting settings (format)

We can hook into form submission to update arbitrary quotes/contents using this: http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Developer_Tools#Intercept_and_Modify_Form_Submissions

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:19, 15 November 2015 (EST)

=== Hosting ===
The script seems to be about to become sufficiently complex to deserve actual hosting:
* http://wiki.greasespot.net/User_Script_Hosting
* https://openuserjs.org/

(that would allow updating the script automatically)

: Hi, is there any progress being made on this? I think the best way to host it would be to put in in a SourceForge repository under the FlightGear project (I don't know if it allows direct downloads, though, and we would need to relicense the script because [https://opensource.org/faq#public-domain public domain licenses are not OSI-approved]); otherwise, I can submit it to [https://greasyfork.org/ GreasyFork] (OpenUserJS is unsuitable as [https://openuserjs.org/about/Terms-of-Service public domain licenses are not allowed]). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 03:58, 1 May 2016 (EDT)

:: I don't think anybody has looked into this recently - however, relicensing should be a no-brainer, given that all the code is in the public domain anyway. I am not sure if it's worth the hassle to put up under sourceforge/FlightGear; we also need to keep in mind that this is not exactly the most popular "tool" around here. So, before this becomes even better accessible, it might be a good idea to comply with some of the requests made, e.g. by adding support for a different output mode (without using the FGCquote template, just the copied text, plus the ref part), so that quote-heavy pages don't look that obnoxious.
:: Regarding hosting in general, I still think it may be a good idea, but we would probably need to make sure that some requirements are met, e.g. having a revision history, and to provide other contributors with access-alternatively, we should maintain a copy of the script in the wiki, and add a note saying that changes to it will be reviewed/integrated with the hosted script by one of us (if you'd volunteer to help with that, I'd suggest to just go ahead and set up a public repository).
:: Admittedly, this is going to remain a fairly FG specific script, it would need quite a bit of work to become useful for other purposes (even though other OSS projects may be easy to support). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 06:33, 1 May 2016 (EDT)

::: OK, I think we can leave the script here and host it on GreasyFork (it allows public domain scripts) - I'll put the page on my watchlist to make sure I update the script there every time there's a version bump. Does that look good to you and the other contributors? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:26, 1 May 2016 (EDT)

:::: Sounds good to me, given how the script has evolved over time, we've probably hit a natural limit already, i.e. being able to use multiple files easily, and update scripts automatically sounds like a useful thing to me. I don't know if greasyfork supports "teams" of contributors for better collaboration ? It might also be a good idea to generalize the script so that it supports arbitrary phpBB installations and mailing list archives other than just sourceforge (think gmane) - and maybe output formats other than just wikimedia markup, that way, the script may become more useful over time.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:46, 1 May 2016 (EDT)

::::: It doesn't as it only offers a user script downloading facility (source code repositories like GitHub and SourceForge are better suited for the kind of work you mention). I'll wait a bit in case Red Leader, Philosopher or bigstones have any objections/remarks, then I'll upload the script there. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:14, 1 May 2016 (EDT)

:: do they support extensions spread across multiple files ? That is something that would help us quite a bit cleaning up the current code, which has become a bit convoluted over time. Apart from that, nothing wrong with github et al - I am just not sure if they're suitable for automatically propagating updated changes.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:12, 2 May 2016 (EDT)

::: No, not that I know of (generally speaking, all user scripts are made of a single .user.js file). We could "hack" it by splitting the current script in multiple files and requiring them from a main one as libraries via the <tt>@include</tt> directive, but that would rule out most hosting solutions (many providers only allow GreaseMonkey scripts which include additional files only from a handful of trusted domains/CDNs, for safety reasons).
::: As for propagating changes on GitHub and other code repository, the update URL must remain constant throughout the lifetime of the script. I'm sure this can be done on GitHub by publishing updates not as releases (where the addresses change), but on GitHub Pages (a user script I use does exactly this); on SourceForge, the usual download hosting could do the trick, but I'd need to perform a test first. (I'd prefer SF to keep the script "inside" the FG project hierarchy, if possible). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:50, 2 May 2016 (EDT)

: actually, user scripts can be compromised of multiple files, e.g. via the require directive [http://stackoverflow.com/questions/8695459/is-it-possible-to-split-greasemonkey-user-scripts-into-multiple-files]. Personally, I would like to make use of that - we are already using that to include jQuery stuff, and it would help us organize the script a little better. I am not oposed to seeing the script hosted as some part of FG/SF, but I just don't think it's going to be a very popular idea - so far, everything worked out without major hinderance, so I would rather use an independent hosting solution, or continue to use the wiki to ensure that the barrier to entry/contributing isn't raised, e.g. by going through merge requests etc. Major contributions to the script like those from bigstones or Red Leader were simply "dropped" here directly, so this seems to have worked out really well.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:26, 2 May 2016 (EDT)

:: I've checked the [https://greasyfork.org/it/help/external-scripts GreasyFork external script policy]: as long as all the files are hosted on/uploaded to GreasyFork, it's not a problem. (Also, sorry about the typo, I wrote <tt>@include</tt> instead of <tt>@require</tt> by mistake). I guess I can proceed with the upload now? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 12:22, 2 May 2016 (EDT)

: sure, why not - it's in the public domain after all - feel free to make any changes to the script to have it auto-update. We can review everything once we have gathered a little more experience with this kind of scheme. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:27, 2 May 2016 (EDT)

:: {{done}} - I'm updating the installation instructions in the main page. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:52, 2 May 2016 (EDT)

::: Script at: https://greasyfork.org/en/scripts/19331-instant-cquotes
--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:18, 2 May 2016 (EDT)

:::: Regarding updates, bumping the version number is fine - I'll take the script at the wiki revision where the version is bumped and upload it. (Note that I will not perform any prior testing, so be extra careful - maybe I should add this in the note above the script?). -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:08, 2 May 2016 (EDT)

:: sounds good, I will be sure to stop updating the version number without prior testing, we could also add some tests to the code to spot the more obvious mistakes - in fact, there is already an OpenLink helper that could be used to download a few postings and try to extract the corresponding fields, so that we would only bump the version number if that succeeds. BTW: Thanks for handling the hosting part, much appreciated ! --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 18:25, 2 May 2016 (EDT)

== Issues ==
=== too greedy non-greedy regexes ===
The problem described in the previous section regarding regexes that eat up half messages seems to be related to my [http://blog.liip.ch/archive/2009/07/24/the-greedyness-of-non-greedy-regular-expressions.html misunderstanding of the non-greediness]. So, I managed to fix it for this one case, but this means that using .*? to match everything until you meet the following character (as I currently do pretty much everywhere) is dangerous and prone to failure. Any occurrence of that should be changed as I did in [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Instant-Cquotes&oldid=72839 this edit] and that's clearly cumbersome, not to say that it can still be incorrect: say I have
<nowiki><a someprop="href" href="http://www.link.org" ... ></nowiki>
If I want to mach anything between a and href, I use <tt><nowiki>[^(?:href)]*</nowiki></tt>, but that would match only up to the text inside someprop, so I'd have to check that it's not inside doublequotes... Well, I guess this is getting too complicated for handling it [http://blog.codinghorror.com/parsing-html-the-cthulhu-way/ the Chtulu way].

So my approach would be: fix this whenever the problem comes up, but don't overdo because we're already moving in dangerous ground. Or, rewrite it all using ''only'' xpaths *sobs*.
--[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 16:49, 17 June 2014 (UTC)

=== regex vectors ===

When testing things I realized that you are right: there are some scenarios where the regex may fail depending on how "complete" the selection is, because we obviously have hard-coded assumptions here. I'll see if it's feasible to also support vectors for regexes to extract the corresponding fields and try each regex in order to get a certain field, or if that doesn't make any sense... But quoting with/without author (anonymous quote) would be a valid test case here.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

: Probably going to look into this sooner or later because this could be a simple solution to also support PM quoting - without having to parse the actual URL, we'd just try different regexes in order and use the one that succeeds. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:46, 16 June 2014 (UTC)

=== Syntaxhighlighting ===
Need to investigate what needs to be updated to support quoting code sections, as per [http://forum.flightgear.org/viewtopic.php?f=66&t=21855&p=212585#p212581] --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 22:33, 14 June 2014 (UTC)

=== Postings that break our script for some reason ===
* http://forum.flightgear.org/viewtopic.php?f=19&t=23365

== Misc notes ==

=== Detecting failed XPaths ===
you've got a point, we should probably check if xpath/regexes succeed or fail, and show a warning so that we know that the scripts needs to be updated because some xpath/regex may have changed.

=== Paragraphs / br (trailing slash) ===
There are some minor issues now, i.e. newline2br will no longer contain the trailing forward slash, so there's probably some JavaScript/regex oddity involved here, maybe slashes just need to be escaped. Will be testing the code with a few different forum postings and check the resulting cquote
: {{done}}. That's because newline2br wasn't used at all in html mode. I added addNewlines which puts newlines after br's and list related tags, if there are more newlines to be added that should be the place.
: --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 14:03, 17 June 2014 (UTC)

=== support/ignore highlighted keywords/smilies ===
see [[Understanding Forward Compatibility]] for examples
: {{done}} --[[User:Bigstones|Bigstones]] ([[User talk:Bigstones|talk]]) 15:13, 17 June 2014 (UTC)

== Beyond just cquotes (newsletter/changelog) ==

Gijs has recently revamped the newsletter template rather significantly, see: [[FlightGear_Newsletter_June_2014]], and [[User_talk:Gijs#06.2F2014_newsletter:_too_much_of_a_]] - basically, we could extend the script to support another output FORMAT to directly create markup for the newsletter/changelog. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 20:40, 30 June 2014 (UTC)

== more styles/output formats ==

looking at some of the cleanup done by Red Leader recently, we could also directly support other styles/output formats to directly provide a format that looks well enough without requiring tons of manual editing. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:11, 13 February 2015 (EST)

== token matching for keywords/variables ==

seems like it might make sense to match common keywords/acronyms and variables, such as e.g.:
* FG_ROOT => [[$FG_ROOT]]
* FG_HOME => [[$FG_HOME]]
* FG_SRC => [[$FG_SRC]]

file names with a known prefix like $FG_ROOT could even be pattern-matched using git link: $FG_ROOT/Nasal/canvas/MapStructure.nas would become [[$FG_ROOT]]{{Git link|gitorious|fg/fgdata|master|Nasal/canvas/MapStructure.nass|text=/Nasal/canvas/MapStructure.nas}}

Equally, we could match common property paths to use code tags, e.g.: /sim/rendering would become <code>/sim/rendering</code>
Ultimately, it might be a good idea to get in touch with Johan_G, Gijs and Red Leader to see what kind of format they'd prefer, especially because this could then be directly used for creating newsletter contents. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 11:19, 13 February 2015 (EST)

== matching repository references using git link template ==

Most of us commonly refer to repository files using either the $FG_* references, or relative paths in the form of <code>src/Main/fg_init.cxx:line number</code>, we could automatically convert such references using the git/repo link template, e.g.:

{{FGCquote
|Further investigation found that the launcher *is* trying to add this directory to fg-aircraft (src/GUI/QtLauncher.cxx:772), but that this doesn't work because this option is processed before the launcher is run (intentionally, to allow the launcher to find aircraft in fg-aircraft: '''src/Main/main.cxx:448''').
|{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33686356/
|title=<nowiki>Re: [Flightgear-devel] Launcher issues on Linux</nowiki>
|author=<nowiki>Rebecca N. Palmer</nowiki>
|date=<nowiki>2015-04-01</nowiki>
}}
}}

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:48, 1 April 2015 (EDT)

== chrome specific port ==

Hi Red Leader, when/if you do come up with a chrome specific version of the script, I would suggest to refactor existing APIs accordingly, so that we can come up with a common library of general purpose/utility helpers, so that both scripts can co-exist and use a common/shared file (think all the extraction/transformation logic), by referencing an external .js/JavaScript file that will be maintained/updated and hosted separately. I think this could be accomplished easily using jsfiddle. So basically, I am suggesting to come up with a shared back-end for both versions of the script. Given the complexity we're reaching meanwhile, as well as the number of edits and contributors, it may also make sense to consider using github for this at some point. One of the main advantages being that we could easily distribute updates automatically to all people who've installed the script, without them having to do anything manually.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 08:38, 23 June 2015 (EDT)

== Development resources ==

* https://www.youtube.com/watch?v=xpXNDT0SxM0
* http://wiki.greasespot.net/GM_getResourceText
* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script

== Future focus/development and priorities (De-quoting) ==

Given that most people involved in maintaining the wiki don't seem to particularly appreciate the nature of articles consisting mainly of quotes, and that we don't seem to have any other good way to populate new articles quickly, I was thinking of changing the focus of the script to dynamically create articles using quotes (with proper refs), that would be merely copy-edited, i.e. using the process we are currently using to "de-quote" such articles by 1) categorizing related quotes, 2) coming up with headers/sub-headers, 3) re-writing/merging certain quotes, 4) attributing them - linking back to the quotes archives.
Should we decide to pursue this, the script would be turned into a "wizard" where we can topics and sub-topics (wiki headings) and then add arbitrary text using the existing approach, but without using cquotes - i.e. the focus would be on extracting relevant contents, distilling them down and adding plenty of refs, including a references section at the bottom. Some tokens/words could be changed dynamically, but some kind of proof-reading/copy-editing would still need to be done afterwards, because people tend to use first person speech in their announcements/postings, which we would need to convert to 3rd person semi-automagically. Thoughts/ideas ?--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 07:11, 15 November 2015 (EST)

== changing and automating regex/xpath handling ==
{{See also|#Genetic_Expression_solver}}

We have currently hard-coded handling of different websites, regexes and xpath expressions so that things are a bit fragile at the moment, and once a website changes its style/template, our script would break immediately. However, we could change the way the script works by using a very simple NN (neural network) to come up with matching regex/xpath expressions automatically. The way this could work would be "supervised" training, where we would replace/adapt our existing CONFIG hash with a vector of URLs and contents to be extracted (date, time, title, posting). This kind of data would suffice entirely for a neural network to self-train itself and "learn" how to come up with regex/xpath expressions to extract the relevant contents, including not only hard-coded websites like sourceforge, but even completely different websites (think gmane) - because the "learning" routine would self-adapt by looking at how to get its contents, and never contain any hard-coded regex/xpath expressions anymore. The CONFIG hash would end up being a vector with "training data" for different websites to be supported. And whenever an expression fails, it could re-train itself accordingly.--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:33, 15 November 2015 (EST)

== nested quotes and AJAX for thread titles ==

{{FGCquote
|1= http://sourceforge.net/p/flightgear/mailman/message/33451055/
{{cquote|As we move forward with FlightGear development and future versions, we will be expanding the "in app" aircraft center. This dialog inside flightgear lets you select, download, and switch to any of the aircraft in the library.|Curt}}
|2= {{cite web
| url = http://forum.flightgear.org/viewtopic.php?p=259879#p259879
| title = <nowiki>Re: New Canvas GUI</nowiki>
| author = <nowiki>Hooray</nowiki>
| date = Oct 7th, 2015
}}
}}

== AJAX mode/testing ==

We should probably add a dialog to store credentials that we can use for accessing the wiki, which would need to be shown after installing the script, i.e. first-time use

* http://stackoverflow.com/questions/14594346/create-a-config-or-options-page-for-a-greasemonkey-script
* http://commons.oreilly.com/wiki/index.php/Greasemonkey_Hacks/Getting_Started#During_Installation
* https://www.safaribooksonline.com/library/view/greasemonkey-hacks/0596101651/ch01s06.html

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 20 November 2015 (EST)

== libraries ==

Referring to the [[#Hosting]] section, and my comment on wanting to use additional libs (like jQuery), I am primarily thinking about using a wizard-framework (e.g. jQuery steps) and a framework for creating wikimedia editor plugins (actions):

* http://mstratman.github.io/jQuery-Smart-Wizard/
* http://www.jquery-steps.com/
* http://www.jqueryrain.com/demo/jquery-step-form-wizard/
* https://www.mediawiki.org/wiki/Extension:WikiEditor

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:07, 2 May 2016 (EDT)

== About dequoting the script's article ==

Thanks for doing this, but I am frankly not sure if it's worth the effort - there are much more popular/important articles using tons of quotes than this one, and given the reputation of the script, having quotes in this article may actually be a useful thing to make the case for having quotes in the first place - thus, I would frankly not spend much time going through this particular article - in fact, I'd be very surprised if the greasyfork download stats showed more than 3-5 people actually downloading, and using, the script - so this is really just a niche tool, and we probably better spend our time doing other things, and reviewing other wiki articles, than the script's article - at the very least, I would suggest to retain the references to the original discussions revolving these quotes (just my 2c). --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 19:00, 2 May 2016 (EDT)

: {{done}} I've added back the quotes as references. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 02:53, 3 May 2016 (EDT)

== Script configuration (persistence) ==

* https://wiki.greasespot.net/GM_config
* https://github.com/sizzlemctwizzle/GM_config/wiki
* https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API

== Work in progress ==

We have now several more or less related development efforts going on, and the code is also growing because of that - so it seems to make sense to summarize what's been going on recently. In general, all changes were made in response to the collection of feature requests and ideas we have accumulated over time - specifically, that means that the following roadmap is in the process of being implemented:

* establish unit testing, and add a few self-tests, so that the script can be more easily tested, updated/reviewed in the future
* rework the script to more easily support other sources (think gmane)
* make it much easier to update modified xpath/regex expressions (i.e. provide a UI for that)
* support persistence for script-specific settings
* make it easier for people to port/maintain the script by encapsulating platform specifics
* support asynchronous fetching of postings (AJAX), e.g. to fetch posting titles, attachments etc
* prepare the groundwork for supporting template-based output formats (think newsletter, changelog, articles)
* review what's necessary to allow the script to update fgcquote-based quotes automagically

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:47, 4 May 2016 (EDT)

== External genetic/neural network libraries ==
While uploading the latest version of the script, I noticed that the Genetic and Synaptic libraries are hosted on sites not on [https://greasyfork.org/en/help/external-scripts the approved GreasyFork list]. Shall I ask them to host them? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 13:28, 11 May 2016 (EDT)

: Thanks for pointing that out, I missed that completely, because everything is working correctly here - but obviously, I rarely get to actually download/install the latest version via greasyfork. Those libs should be safe to be added to the list, i.e. they're fairly established/popular, lest I'd not be using them. For now, this is just an experiment anyway. The idea is to update the xpath/regex code to evolve if/when the underlying website (theme) changes. But if there is a problem, we could use other libs - the code is just used for testing ATM. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 13:41, 11 May 2016 (EDT)

* https://github.com/subprotocol/genetic-js
* https://github.com/cazala/synaptic

:: {{ongoing}} I have submitted the libraries to the JSDelivr CDN; once they are up, I'll change the source URLs in the script and update it on GreasyFork as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 18:32, 17 May 2016 (EDT)

== Genetic Expression solver ==
[[File:Instant-cquotes-genetic-regex-solving.png|thumb|Screenshot showing the instant cquotes script with integrated regex solving support using genetic algorithms.]]

The genetic-js framework has been integrated, it is intended to help solve xpath/regex expressions procedurally using genetic algorithms/programming.

The idea is to provide a set of desired outputs (needles), available input data (haystack), and use existing (possibly outdated) regex/xpath expressions to seed a pool with potential solutions for retrieving the desired output. For now, this is just proof-of-concept, i.e. just an experiment.

For example, let's consider the typical format of a from header for any sourceforge posting:
<syntaxhighlight lang="javascript">
var regexTests = [
{haystack: "From: John Doe <John@do...> - 2020-07-02 17:36:03", needle: "John Doe"},
{haystack: "From: Marc Twain <Marc@ta...> - 2010-01-03 07:36:03", needle: "Marc Twain"},
{haystack: "From: George W. Bush <GWB@wh...> - 2055-11-11 17:33:13", needle: "George W. Bush"}
];
</syntaxhighlight>

The basic idea is to run a fitness function and score regex expressions based on not throwing an exception (which makes them valid), and by checking if the desired tokens are part of the output string, and evolve (mutate/cross-over) the "fittest" expressions - i.e. those that satisfy at least /some/ of the heuristics.

Some of the metrics that can be used by the fitness function to determine if an expression is "fit", are:
* valid expression
* relative offset/excess bytes in matches string
* number of examples it can successfully extract
* length of the expression
* runtime of the expression

The search space, and runtime, can be significantly reduced by looking at similarities between all examples and coming up with a subset string that contains all identical components (e.g. the <code>From:</code> part in the author regex) and use that for seeding the initial generations.

Ultimately, this would allow the script to self-update its regex/xpath expressions if/when the underlying website (themes) change, but it would also allow to add support for new websites, without ever manually adding the required xpath/regex expressions, i.e. all that is needed is a sufficiently large number of example datasets to obtain the author, date and title information, and a URL for the script to download the HTML markup of the posting in question:

{{Note|The date field won't work as is, because it's actually post-processed using a transformation function, so we'd need to undo the transformation or use the actual date string instead}}
<syntaxhighlight lang="javascript"> // vector with tests to be executed for sanity checks (unit testing)
tests: [
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059454/',
author: 'Erik Hofman',
date: 'May 3rd, 2016', // NOTE: using the transformed date here
title: 'Re: [Flightgear-devel] Auto altimeter setting at startup (?)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/35059961/',
author: 'Ludovic Brenta',
date: 'May 3rd, 2016',
title: 'Re: [Flightgear-devel] dual-control-tools and the limit on packet size'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/20014126/',
author: 'Tim Moore',
date: 'Aug 4th, 2008',
title: 'Re: [Flightgear-devel] Cockpit displays (rendering, modelling)'
},
{
url: 'https://sourceforge.net/p/flightgear/mailman/message/23518343/',
author: 'Tim Moore',
date: 'Sep 10th, 2009',
title: '[Flightgear-devel] Atmosphere patch from John Denker'
} // add other tests below

], // end of vector with self-tests
</syntaxhighlight>

Note how this no longer contains any hard-coded xpath/regex expressions - instead, the script can refer to the website specific defaults, and try those first, and if they fail, use those to seed new generations and evolve them procedurally until all tests succeed.

For a regex to be valid, it must work for all tests/examples.

Once the regex solver is working correctly, the code can be further generalized to also evolve xpath expressions (NOTE: the DOMParser API is /not/ available to webworkers ...) and chain those two components together.

* http://regex.inginf.units.it/how.html
* http://www.i-programmer.info/programming/perl/9503-automatically-generating-regular-expressions-with-genetic-programming.html
* http://jkff.info/articles/ire/
* http://www.networkworld.com/article/2955126/software/genetic-programming-meets-regular-expressions.html
* https://handcraftsman.wordpress.com/2012/04/11/evolving-a-regular-expression-with-go/
* http://stackoverflow.com/questions/4880402/how-to-auto-generate-regex-from-given-list-of-strings
* http://regex.inginf.units.it/
* http://www.genetic-programming.org/hc2014/Bartoli-Paper.pdf

Template:Forum link

2016-05-17T20:01:00Z

Elgaton: Try using the decimal version of the HTML entity

<span class="plainlinks">[https://forum.flightgear.org/viewtopic.php?{{#if:{{{f|}}}|f={{{f}}}{{#if:{{{t|}}}|&|{{#if:{{{p|}}}|&|{{#if:{{{hilit|}}}|&|}}}}}}|}}{{#if:{{{t|}}}|t={{{t}}}{{#if:{{{p|}}}|&|{{#if:{{{hilit|}}}|&|}}}}|}}{{#if:{{{p|}}}|p={{{p}}}{{#if:{{{hilit|}}}|&|}}|}}{{#if:{{{hilit|}}}|hilit={{{hilit}}}|}}{{#if:{{{label|}}}|#{{{label}}}|}} {{#if:{{{title|}}}|''{{{title}}}'' on the forum|Forum link}}]</span>{{#if: {{{noicon|}}} | |  [[File:FlightGear icon 15px.png|This is a link to the FlightGear forum|link=Template:Forumref]] }}<noinclude>
{{Informative template|1=
__NOTOC__
== Goal ==
A template to standardize forum links.

== Usage ==
{{obr}}'''forumref'''{{!}}title={{!}}''t=''{{!}}''p=''{{!}}''label=''{{!}}''hilit=''{{!}}''f=''{{!}}''noicon=''{{cbr}}

; title: Topic title

; t: Thread number to be passed to phpBB's viewtopic.php (optional)

; p: Post number to be passed to phpBB's viewtopic.php (optional)

; label: HTML label, used for jumping to posts (optional)

; hilit: Words on the forum posts to be highlighted (optional)

; f: Forum number to be passed to phpBB's viewtopic.php (optional)

; noicon: If true, the little FlightGear icon ([[File:FlightGear icon 15px.png]]) will not be shown.

== Example ==
<nowiki>{{forumref|title=FlightGear Newsletter|t=7794}}</nowiki>

{{forumref|title=FlightGear Newsletter|t=7794}}

== Related template ==
* {{tl|forum}}
}}

[[Category:Link templates]]
</noinclude>

Template:Forum link

2016-05-17T19:58:55Z

Elgaton: Fix numbered list being created when the ''label'' parameter was passed

<span class="plainlinks">[https://forum.flightgear.org/viewtopic.php?{{#if:{{{f|}}}|f={{{f}}}{{#if:{{{t|}}}|&|{{#if:{{{p|}}}|&|{{#if:{{{hilit|}}}|&|}}}}}}|}}{{#if:{{{t|}}}|t={{{t}}}{{#if:{{{p|}}}|&|{{#if:{{{hilit|}}}|&|}}}}|}}{{#if:{{{p|}}}|p={{{p}}}{{#if:{{{hilit|}}}|&|}}|}}{{#if:{{{hilit|}}}|hilit={{{hilit}}}|}}{{#if:{{{label|}}}|&num;{{{label}}}|}} {{#if:{{{title|}}}|''{{{title}}}'' on the forum|Forum link}}]</span>{{#if: {{{noicon|}}} | |  [[File:FlightGear icon 15px.png|This is a link to the FlightGear forum|link=Template:Forumref]] }}<noinclude>
{{Informative template|1=
__NOTOC__
== Goal ==
A template to standardize forum links.

== Usage ==
{{obr}}'''forumref'''{{!}}title={{!}}''t=''{{!}}''p=''{{!}}''label=''{{!}}''hilit=''{{!}}''f=''{{!}}''noicon=''{{cbr}}

; title: Topic title

; t: Thread number to be passed to phpBB's viewtopic.php (optional)

; p: Post number to be passed to phpBB's viewtopic.php (optional)

; label: HTML label, used for jumping to posts (optional)

; hilit: Words on the forum posts to be highlighted (optional)

; f: Forum number to be passed to phpBB's viewtopic.php (optional)

; noicon: If true, the little FlightGear icon ([[File:FlightGear icon 15px.png]]) will not be shown.

== Example ==
<nowiki>{{forumref|title=FlightGear Newsletter|t=7794}}</nowiki>

{{forumref|title=FlightGear Newsletter|t=7794}}

== Related template ==
* {{tl|forum}}
}}

[[Category:Link templates]]
</noinclude>

Template:News

2016-05-17T14:01:32Z

Elgaton: Dequoted

{{LangSwitch
| en = 
: [[FlightGear Newsletter {{#time: F Y | {{{date|last month}}} | en }}]] ([[FlightGear Newsletter|archive]])
* '''May 17, 2016:''' The [[FlightGear Build Server]] is now able to build the 2016.2 nightly full builds with the latest [[LEBL]] scenery pack included; they can be downloaded from the [https://sourceforge.net/projects/flightgear/files/unstable/ nightly build page]. The version on the <tt>next</tt> branch is now 2016.3.0; users compiling FlightGear from source need to recompile SimGear ''and'' FlightGear ''and'' use the latest FGData to avoid the infamous "version number mismatch" error message.
* '''February 17, 2016:''' FlightGear 2016.1.1 "San Francisco" is released.
* '''November 2015:''' FlightGear is the SourceForge [https://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ Community Choice Project of the Month].
* '''April 15, 2015:''' FlightGear completes the move from [http://gitorious.org Gitorious] to [https://sourceforge.net/ SourceForge].
* '''February 17, 2015:''' FlightGear 3.4 is released.
* '''February 14, 2015:''' The [[FlightGear Wiki]] exceeds [[Special:Statistics|2,000]] articles.
| de = 
: [[FlightGear Newsletter {{#time: F Y | {{{date|last month}}} | en }}]] ([[FlightGear Newsletter|Archiv]])
* '''17. Februar 2016:''' FlightGear 2016.1.1 "San Francisco" ist freigegeben.
* '''2015 November:''' FlightGear ist die SourceForge [https://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ Gemeinschaft Wahl Projekt des Monats].
* '''15. April 2015:''' FlightGear vervollständigt den Umzug von [http://gitorious.org Gitorious] auf [https://sourceforge.net/ SourceForge].
* '''17. Februar 2015:''' FlightGear 3.4 ist freigegeben.
* '''14. Februar 2015:''' Die [[:de:FlightGear Wiki|FlightGear Wiki]] überschreitet [[Special:Statistics|2000]] Artikel.
| es = 
: [[FlightGear Newsletter {{#time: F Y | {{{date|last month}}} | en }}]] ([[FlightGear Newsletter|archivo]])
* '''17 de de febrero de, 2016:''' FlightGear 2016.1.1 "San Francisco" se libera.
* '''De noviembre de 2015:''' FlightGear es el SourceForge [https://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ Community Choice Proyecto del mes].
* '''15 de de abril de, 2015:''' FlightGear completa el paso de [http://gitorious.org Gitorious] a [https://sourceforge.net/ SourceForge].
* '''17 de de febrero de, 2015:''' FlightGear 3.4 se libera.
* '''14 de de febrero de, 2015:''' El [[FlightGear Wiki]] excede de [[Special:Statistics|2.000]] artículos.
| ca = 
: [[FlightGear Newsletter {{#time: F Y | {{{date|last month}}} | en }}]] ([[FlightGear Newsletter|Arxiu]])
* '''17 de de febrer de, 2016:''' FlightGear 2016.1.1 "San Francisco" s'allibera.
* '''De novembre de 2015:''' FlightGear és el SourceForge [https://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ Community Choice Projecte del mes].
* '''15 d'abril de, 2015:''' FlightGear completa el pas de [http://gitorious.org Gitorious] a [https://sourceforge.net/ SourceForge].
* '''17 de de febrer de, 2015:''' FlightGear 3.4 s'allibera.
* '''14 a de febrer de, 2015:''' El [[:ca:FlightGear Wiki|FlightGear Wiki]] excedeix de [[Special:Statistics|2.000]] articles.
| it = 
: [[FlightGear Newsletter {{#time: F Y | {{{date|last month}}} | en }}]] ([[FlightGear Newsletter|archivio]])
* '''17 febbraio 2016:''' FlightGear 2016.1.1 "San Francisco", viene rilasciato.
* '''novembre 2015:''' FlightGear è la SourceForge [https://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ Community Choice Progetto del mese].
* '''15 aprile 2015:''' FlightGear completa il passaggio da [http://gitorious.org Gitorious] a [https://sourceforge.net/ SourceForge].
* '''17 febbraio 2015:''' FlightGear 3.4 viene rilasciato.
* '''14 febbraio 2015:''' Il [[FlightGear Wiki]] supera [[Special:Statistics|2.000]] articoli.
| nl = 
: [[FlightGear Newsletter {{#time: F Y | {{{date|last month}}} | en }}]] ([[FlightGear Newsletter|archief]])
* '''17 februari 2016:''' FlightGear 2016.1.1 "San Francisco" wordt losgelaten.
* '''November 2015:''' FlightGear is de SourceForge [https://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ Gemeenschap Choice Project van de Maand].
* '''15 april 2015:''' FlightGear de overgang van [http://gitorious.org Gitorious] tot [https://sourceforge.net/ SourceForge] voltooid.
* '''17 februari 2015:''' FlightGear 3.4 is vrijgegeven.
* '''14 februari 2015:''' De [[FlightGear Wiki]] hoger dan [[Special:Statistics|2000]] artikelen.
| pl = 
: [[FlightGear Newsletter {{#time: F Y | {{{date|last month}}} | en }}]] ([[FlightGear Newsletter|archiwum]])
* '''17 lutego 2016:''' FlightGear 2016.1.1 "San Francisco" zostanie zwolniony.
* '''Listopad 2015:''' FlightGear jest SourceForge [https://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ Społeczność Wybór Projekt miesiąca].
* '''15 kwietnia 2015:''' FlightGear kończy przejście od [http://gitorious.org Gitorious] na [https://sourceforge.net/ SourceForge].
* '''17 lutego 2015:''' FlightGear 3.4 zostanie zwolniony.
* '''14 lutego 2015:''' [[:pl:FlightGear Wiki|FlightGear Wiki]] przekracza [[Special:Statistics|2000]] artykułów.
| pt = 
: [[FlightGear Newsletter {{#time: F Y | {{{date|last month}}} | en }}]] ([[FlightGear Newsletter|arquivo]])
* '''17 de Fevereiro de 2016:''' Lançado o FlightGear 2016.1.1 "San Francisco".
* '''Novembro de 2015:''' FlightGear é escolhido o [https://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ Projeto do Mês da Comunidade SourceForge].
* '''15 de Abril de 2015:''' FlightGear completa a mudança do [http://gitorious.org Gitorious] para [https://sourceforge.net/ SourceForge].
* '''17 de Fevereiro de 2015:''' Lançado o FlightGear 3.4.
* '''14 de Fevereiro de 2015:''' O [[FlightGear Wiki]] ultrapassou [[Special:Statistics|2,000]] artigos.
}}<noinclude>
{{Informative template|1=
This template contains the news section as displayed on the [[Main Page]], for each single language.

== Usage ==
* Use no more than five news items (excluding the newsletter)
* Use short text lines
* Use present tense

== Related templates ==
* {{tl|Localized Release Announcement}}

}}

[[Category:Templates]]
</noinclude>

FlightGear wiki:Village pump

2016-05-15T13:06:03Z

Elgaton: /* Reorganizing the Git articles */

{{Archives|[[/Archive 2012|2012]]|[[/Archive 2013|2013]]|[[/Archive 2014|2014]]|[[/Archive 2015|2015]]}}
{{shortcut|FGW:VP}}
Welcome to the '''Village Pump'''. This page is used to discuss the technical issues, operations and guidelines of the [[FlightGear wiki]].

Please <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit&section=new}} add new topics]</span> to the '''bottom''' of this page.

Old discussion should be moved to a [[FlightGear wiki:Village pump/Archive YEAR]]. These discussions can then be moved to a relevant talk page if appropriate.

== Welcome template? ==
I have been thinking about suggesting a welcome template, for example named {{obr}}welcome{{cbr}}, to place on top of (at least) new users user discussion pages.

It should welcome the (new) user

In addition, it should probably mention and/or link to pages mentioning:
* The introduction page/tutorial (Hmm, I do not think I did finish that one. See [[Help talk:Tutorial]] ([http://wiki.flightgear.org/index.php?title=Help_talk:Tutorial&oldid=70843 perm])).
* Help pages
* How to use categories (in particular not like #tags, ;-) but also that image and article categories should be separate, but link to each other)
* The portals
* The style manual
* Discussion pages and where to discuss what:
** How to use discussion pages
** The wiki in general: The village pump (this page)
** Wiki articles: Article discussion pages
** Wiki user actions: User discussion pages

Maybe it should also mention that FGAddon aircraft, effects, other features etc. (except for their articles) and their bugs should be discussed on the forum, unless developers say otherwise, and that core features should be discussed on the developer mailing list and core bugs on the bug tracker.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 20:31, 30 January 2016 (EST)

: I think this is a great idea. A nice concise summary with links to help a new user navigate the FlightGear jungle would be a great addition. It should however remain very short with simple sentences - while being complete - as many users are not native speakers. So maybe there should be translations of the template with manually added links at the bottom for easy access to all the translations?

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:35, 12 February 2016 (EST)

:: Regarding an introduction article, I have come to the conclusion that a complete but long article is probably not as helpful as short but specific help pages. In essence the latter would be easier to navigate and absorb. I have therefore started to slowly split up some of the help pages and have added one more section to [[Help:Contents]].
:: I think that a welcome phrase, a link to that page and the [[FlightGear wiki:Manual of Style|style manual]] might actually suffice for a welcome template for now. It is at least better than what we currently have (i.e. more or less nothing).
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 14:47, 4 March 2016 (EST)

:: I now consider
::* A Welcome message
::* A link to this page
::* A link to the help pages
::* A link to the manual of style
::* Some final welcoming words

:: A welcome template should probably also very briefly mention a pet peeve of mine: the categories.
:: Many (if not most) image uploaders seem to treat them like tags, but if say all screenshots of aircraft (probably >2000) would end up at [[:Category:Aircraft]] (instead of under a subcategory to [[:Category:Screenshots of aircraft]]), of what use would that page be when looking for a specific one? If people would like to be able to search for an aircraft, a concise but comprehensive image description is very hard to beat.
:: How do I convey all that in a way that is, short, to the point and easy to absorb (and act by)? And where is the best place?
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:46, 8 March 2016 (EST)

:: An early draft is now at [[User:Johan G/Template:Welcome to the wiki]]
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:52, 18 April 2016 (EDT)

::: Some comments on the draft:
::: * I'm not fully sure about using a prominent box - I think it stands out a bit too much. Wikipedia {{wikipedia|Template:Welcome|uses a simple thread on the Talk page}}; as an alternative, we could use lighter colors.
::: * I've also expanded the text a bit. My proposal would be (I've put it in a box, but I'm for the "thread" solution):
<div style="background: #fff; border: 1px #585858 solid; padding: 12px; margin: 12px">
[[Image:Example.png|left]] '''Welcome to the FlightGear wiki, {{#if: {{{name|}}} | {{{name}}} | {{BASEPAGENAME}}}}'''! We hope you will enjoy your stay!

See [[Help:Contents#Reading|Reading]] to learn how wikis work. You can also [[Special:CategoryTree/Root category|browse the existing page categories]].

Should you wish to create or edit some articles, ''do so''! Here are some resources to get you started:
* [[Help:Contents#Editing|How to edit pages]]
* [[Help:Discussion pages|Discussion pages]], where we discuss and agree on potential improvements
* [[FlightGear wiki:Manual of Style|The Manual of Style]], a set of guidelines to help editors maintain a consistent style and formatting (please follow them)
* [[Help:Contents|Wiki help page]]

If you have any questions, just start a topic on the [[FlightGear wiki:Village pump|''Discuss!'' page]]. Again, welcome!
</div>
::: ...where the image on the left is an appropriately chosen icon.
::: Finally, we could use the {{mediawiki|Extension:NewUserMessage|NewUserMessage extension}} to have the wiki software automatically post the message to the new user's talk page.
::: ---- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:30, 1 May 2016 (EDT)

== Permanently removing spam bots ==
For permanently removing spam bots, has the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] Mediawiki extension been considered? I use that regularly on [http://wiki.nmr-relax.com my own wiki], though there we have also reverted to communicating to the person via email before manually granting access (probably not an option here), as all of the Mediawiki captcha methods were recently cracked.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:15, 12 February 2016 (EST)

: Oh, for the extension, we simply have a user called 'Spam bot' in a blocked state, and merge the spam bot accounts into this one, deleting the old account.
: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:20, 12 February 2016 (EST)

:: I'd use the [https://www.mediawiki.org/wiki/Extension:AbuseFilter abuse filter extension] instead (much more powerful and automated) - other users have also proposed different remedies, see [http://forum.flightgear.org/viewtopic.php?f=42&t=28734 this forum thread]. Anyway, Gijs is going to upgrade MediaWiki shortly and review the current anti-spam measures.
:: -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:26, 13 February 2016 (EST)

::: A lot of the spam bots are using their name as advertising nowadays, so the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] extension is the only one I know which will allow a user and associated name to be permanently deleted.

::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:04, 14 February 2016 (EST)

:::: The problem now is that they're also adding the information to the page title, so that it will still show up in the deletion logs [http://wiki.flightgear.org/Special:Log/delete] in other words, there's still some SEO juice associated with deleted entries ... Another idea would be to allow admins to temporarily disable wiki registrations/article creation, e.g. if more than 2 admins agree, this could be done to protect the wiki from spam attacks.

::::: Hooray, you should sign your posts ;) The bots don't target the deletion logs, as that's a little pointless. It's a Special:* page, and the default Mediawiki robots.txt file tells all search engines to not index these pages. User pages, page histories, etc. are however normally indexed.

::::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:36, 19 February 2016 (EST)

:: The point was not what the bots are targeting, but what shows up in the logs - i.e. SEO-wise - Gijs' article blacklist stuff should help with that hopefully. PS: I could not find the signature button on the mobile device I am using, and I am not too good at remembering the correct number of tildes ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:04, 19 February 2016 (EST)

== WIP vs. Under construction ==
I have been beginning to miss the under construction template[http://wiki.flightgear.org/index.php?title=Template:Under_Construction&direction=prev&oldid=46229] more and more (though I could it definitively could be improved).

I have begun to appreciate the need to differentiate between letting readers that a page is to be considered a yet to be finished construction site (though we in a way have that through the {{tl|incomplete}} template) and letting the reader (and other editors) that a page will receive a large amount of work for some hours or even days, usually the use for {{tl|WIP}}.

In summary i miss templates giving a clear distinction between conditions akin to "Under construction" and "Caution - Wet floors", rather than "being worked on" and "could need more work".

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 10:11, 17 February 2016 (EST)

== [[Fr/Pilote automatique]] ==
Bonjour,

Je viens de créer la page de traduction en français de l'article original en anglais [[Autopilot]]. Vu mes faibles compétences en matière de pilotage, vu que je n'ai pas sur ma version téléchargée d'avion avec un pilote automatique, la traduction doit souffrir quelques approximations, si ce n'est des contresens plus ennuyeux. Si quelques bonnes âmes plus qualifiées pouvaient me faire la grâce d'une relecture... merci d'avance.

Cordialement, et Hop ! --[[User:F-WTSS|F-WTSS]] ([[User talk:F-WTSS|talk]]) 15:30, 18 February 2016 (EST)

== MediaWiki updated to 1.26.2 ==
I've updated MediaWiki to the latest stable release (1.26.2) today. I've still got to update some of the extensions, so there may be regressions for now. Please report bugs if you find any. For a list of changes, see https://www.mediawiki.org/wiki/Release_notes/1.26

[[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 10:47, 19 February 2016 (EST)

: Cheers! I was hoping that it would solve the uneditable Chinese, Russian, and other non-latin character-based pages (Polish strangely as well), but unfortunately [[FlightGear_wiki:Village_pump/Archive_2015#UTF-8_language_pages_cannot_be_edited|that issue remains]].

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 10:54, 19 February 2016 (EST)

:: Hm, looks that will require quite some attention indeed. I'm afraid that'll has to wait for now.
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

=== Nasal Syntaxhighlighting ===
: Thanks for your efforts, btw: Nasal syntax highlighting is gone again.
: {{unsigned|17:22, 19 February 2016‎|Hooray}}

:: Unfortunately this time it isn't me forgetting to copy a file. The SyntaxHighlight extension no longer uses GeSHi, but has switched to Pygments. This means our Nasal mapping no longer works and has to be re-written. If anyone is interested, be my guest. See http://pygments.org/docs/lexerdevelopment/
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

::: Hi Gijs,
::: I'm interested in making a Pygments Nasal lexer, but unfortunately I won't be able to work on it until the end of March at the earliest.
::: [[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:59, 23 February 2016 (EST)

:::: Unless Gijs is facing any problems, I don't think it's necessarily needed, see my comment/suggestion in this revision: [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=93166] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:20, 23 February 2016 (EST)

:::Hi Gijs,
:::Here's the code for a Nasal lexer. Be warned, it's thoroughly untested, but has the following features:
:::* Full support for all three string types (backtick, single quote, and double quote), including escapes and formatting strings (e.g., for {{func link|sprintf}}).
:::* All kinds of numbers, including numbers in scientific notation and octal and hex numbers.
:::* All global functions and variables as of FG v2016.1.1.
:::* Some of the commonly-used <code>props.Node</code> methods.
:::* All the other things that can be expected (keywords, punctuation, etc.).
:::I have also created a lexer based on the XML lexer for XML with embedded Nasal, which I thought would be useful.
:::Regards,
:::[[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:35, 2 April 2016 (EDT)

:::http://pygments.org/docs/lexerdevelopment/#adding-and-testing-a-new-lexer
:::<syntaxhighlight lang="python" enclose="div">
# -*- coding: utf-8 -*-
"""
Lexer for Nasal.
"""

from pygments.lexer import RegexLexer, words, include, inherit, bygroups, using
from pygments.token import Text, Keyword, Name, String, Number, Operator, Punctuation, Comment
from pygments.lexers.html import XmlLexer

__all__ = ['NasalLexer', 'XMLNasalLexer']

class NasalLexer(RegexLexer):

name = 'Nasal'
aliases = ['nasal']
filenames = ['*.nas']

tokens = {
'formatters': [
(r'%[-#0 +]*(?:[0-9]+)?(?:\.[0-9]+)?[dis%couxXeEfFgG]', String.Interpol),
],
'backtick': [
(r'`', String.Backtick, '#pop'),
(r'[^`\\]+', String.Backtick),
(r'\\n|\\r|\\t|\\`|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
],
'sqstring': [
(r"'", String.Single, '#pop'),
(r"[^'\\%]+", String.Single),
(r"\\'", String.Escape),
include('formatters'),
],
'dqstring': [
(r'"', String.Double, '#pop'),
(r'[^"\\%]+', String.Double),
(r'\\n|\\r|\\t|\\"|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
include('formatters'),
],
'root': [
(r'\s+', Text),
(r'#.*?$'m, Comment.Single),
(r':|\?|[!=<>+\-*\/~&|^]=?', Operator),
(words(('or', 'and'), suffix=r'\b'), Operator.Word),
(r'[{(\[})\]\.;,]', Punctuation),
(words(('for', 'foreach', 'forindex', 'while', 'break', 'return', 'continue', 'if', 'else', 'elsif'), suffix=r'\b'), Keyword),
(words(('var', 'func'), suffix=r'\b'), Keyword.Declaration),
(words(('nil'), suffix=r'\b'), Keyword.Constant),
(words(('me', 'arg'), suffix=r'\b'), Name.Builtin.Pseudo),
(words(('new', 'del', 'getNode', 'getParent', 'getChild', 'getChildren', 'removeChild', 'removeChildren', 'removeAllChildren', 'getName', 'getIndex', 'getType', 'getAttribute', 'setAttribute', 'getValue', 'setValue', 'setIntValue', 'setBoolValue', 'setDoubleValue', 'unalias', 'alias', 'getPath', 'getBoolValue', 'remove', 'setValues', 'getValues', 'initNode'), suffix=r'\b'), Keyword.Pseudo),
(r'0o[0-7]+', Number.Oct),
(r'0x[0-9a-fA-F]+', Number.Hex),
(r'\d*(?:\.\d*)?[eE][+-]?\d+', Number.Float),
(r'\d*\.\d*', Number.Float),
(r'\b[0-9]+\b', Number.Integer),
(words(('D2R', 'R2D', 'FT2M', 'M2FT', 'IN2M', 'M2IN', 'NM2M', 'M2NM', 'KT2MPS', 'MPS2KT', 'FPS2KT', 'KT2FPS', 'LB2KG', 'KG2LB', 'GAL2L', 'L2GAL'), suffix=r'\b'), Name.Variable.Global),
(words(('abort', 'abs', 'addcommand', 'airportinfo', 'airwaysRoute', 'assert', 'carttogeod', 'cmdarg', 'courseAndDistance', 'createViaTo', 'createDiscontinuity', 'createWP', 'createWPFrom', 'defined', 'directory', 'fgcommand', 'findAirportsByICAO', 'findAirportsWithinRange', 'findFixesByID', 'findNavaidByFrequency', 'findNavaidsByFrequency', 'findNavaidsByID', 'findNavaidsWithinRange', 'finddata', 'flightplan', 'geodinfo', 'geodtocart', 'getprop', 'greatCircleMove', 'interpolate', 'isa', 'logprint', 'magvar', 'maketimer', 'md5', 'navinfo', 'parse_markdown', 'parsexml', 'print', 'printf', 'printlog', 'rand', 'registerFlightPlanDelegate', 'removecommand', 'removelistener', 'resolvepath', 'setlistener', 'setprop', 'settimer', 'srand', 'systime', 'thisfunc', 'tileIndex', 'tilePath', 'values'), suffix=r'\b'), Name.Builtin),
(words(('append', 'bind', 'call', 'caller', 'chr', 'closure', 'cmp', 'compile', 'contains', 'delete', 'die', 'find', 'ghosttype', 'id', 'int', 'keys', 'left', 'num', 'pop', 'right', 'setsize', 'size', 'sort', 'split', 'sprintf', 'streq', 'substr', 'subvec', 'typeof'), suffix=r'\b'), Name.Builtin),
(words(('_createCondition', '_fgcommand', '_interpolate', '_setlistener'), suffix=r'\b'), Keyword.Reserved),
(r'`', String.Backtick, 'backtick'),
(r"'", String.Single, 'sqstring'),
(r'"', String.Double 'dqstring'),
(r'\b_\w*?\b', Keyword.Reserved),
#(r'\b\w*?\b', Name),
]
}

class XMLNasalLexer(XmlLexer):
"""
For Nasal code embedded in XML files.
"""

name = 'XML-Nasal'
aliases = ['xml-nasal', 'xml-ns']

tokens = {
'root': [
(r'(<(?:load|unload|script)>)(<!\[CDATA\[)?(.*?)(]]>)?(</(?:load|unload|script)>)', bygroups(Name.Tag, Comment.Preproc, using(NasalLexer), Comment.Preproc, Name.Tag),
inherit,
],
}
</syntaxhighlight>

:: We can use the ECMAScript/JavaScript lexer[http://pygments.org/docs/lexers/#lexers-for-javascript-and-related-languages] for now, my suggestion would be to copy that over to a file so that we can work on a custom Nasal lexer (Syntax is almost identical, with a few different keywords, and many others being irrelevant). What is missing/different can be obtained from other lexers that are similar, e.g. [http://pygments.org/docs/lexers/#lexers-for-other-c-like-languages] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:45, 19 February 2016 (EST)

:: Okay, here's the better/quick&easy way: We have Nasal support for some fairly popular editors, like [http://wiki.flightgear.org/Howto:Syntax_highlighting_for_Nasal#Vim|vim](originally created by Melchior<ref>https://sourceforge.net/p/flightgear/flightgear/ci/next/tree/scripts/syntax/nasal.vim</ref>), listed at [[Howto:Syntax_highlighting_for_Nasal]] - there are various free converters available that will read such a syntaxhighlighting file and convert it to a pygments class, e.g. see: https://github.com/honza/vim2pygments [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:00, 19 February 2016 (EST)

==== References ====
<references />

== The repository link templates ==
=== Complete overhaul of the repository link templates ===

I have now performed a complete overhaul of the repository link templates (see {{tl|repo link/doc related}}). This was motivated by the incomplete state of these templates, the lack of standardisation, the lack of SourceForge git repository support for {{tl|repo link}}, web-interface only support, etc. I have used a lot of recursive transclusion for standardisation, so that there is a single point for updating for any FlightGear infrastructure changes. This is the master {{tl|repo link}} template. All the other templates are subtemplates which recursively transclude from this master template. I have also created a number of documentation templates for simplifying template maintenance (see {{tl|repo link/doc related‎}}, {{tl|repo link/doc specific file git‎‎}}, {{tl|repo link/doc git clone‎‎}}, and {{tl|repo link/doc commit}}). The changes were constrained to maintain backwards compatibility as much as possible. However I would like to break this to allow the following templates to be updated to transclude from the master {{tl|repo link}} template:

* {{tl|flightgear file}},
* {{tl|simgear file}},
* {{tl|fgdata file}},
* {{tl|fgaddon file}}.

If no one objects, I would like to completely break these and expand and rename the parameter set to match the other <nowiki>{{* file}}</nowiki> repository templates (e.g. {{tl|terragear file}}). My overhaul currently does not include Hooray's ideas for non command line usages, i.e. different GUIs, but it enables it to be easily added via the master template and the addition of a single parameter to any subtemplates.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 15:05, 25 February 2016 (EST)

: I don't have any objections myself, I appreciate all the work you are putting into this, and would like to thank you for helping us clean up all that mess by doing such unglamorous work ;-) I also appreciate that your changes would facilitate adding a non-CLI mode to the corresponding templates. However, I would suggest to wait for Gijs' feedback, because he's ultimately the most likely person to veto something around here ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:31, 25 February 2016 (EST)

:: Johan seems to be the one who did a lot of the initial work on these <nowiki>{{* file}}</nowiki> templates, and Red Leader with the {{tl|repo link}} template. And they were involved in the general discussions ([[http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=87148#Repository_link_templates perm]). But I know Gijs was also involved in the design.

:: For the non-CLI mode, that will need -a lot- more planning. For example a definitive list of all these modes would be useful. Should this use an optional Mediawiki pop up extension showing a link to a general page that describes the action for all different GUIs, CLI, etc.? Should we have a switch box so that the reader can switch in-text between CLI, and the numerous GUIs? Are we going to have a large set of screenshots for each GUI? If so, I would strongly recommend the [https://www.mediawiki.org/wiki/Extension:Labeled_Section_Transclusion labelled section transclusion extension] for creating a single page for one GUI with everything for that GUI, as a tutorial. Here is [http://wiki.nmr-relax.com/Relax_4.0.1 an external example where I have used this], to fragment the base release page to create [http://wiki.nmr-relax.com/Relax_release_descriptions this meta page], as well as many other meta pages.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:14, 26 February 2016 (EST)

I am also thinking of changing the name of the <nowiki>{{* file}}</nowiki> templates, as I hope to make the scope of the templates far more general. The name <nowiki>{{* source}}</nowiki> or <nowiki>{{* repo}}</nowiki> might be better. For example these will allow the repository commit, tree view, log view (and maybe rss feed), with or without a file/directory path. And I would like to generalise this to handle both the SF web-interface and non-web net protocols (git://, ssh://, svn://, etc.). It will allow for CLI instructions to be built up and embedded in <nowiki>{{#tag:source|<content>|lang=sh}}</nowiki> tags. And I will defer all infrastructure decisions in the subtemplates to the single point of {{tl|project infrastructure}}, so that if there are changes in the future, then only this single template needs to be updated to update the entire wiki.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:22, 26 February 2016 (EST)

: The {{tl|project infrastructure}} template as a single point provider of various project infrastructure names and URL pairs seem like a great idea. If it work out well it will really lessen the maintenance by having less places needing updates, while allowing the various repository templates to be simple to use, in essence by having comprehensible names and no boiler plate parameters for their users.
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 15:15, 27 February 2016 (EST)

==== Repository link update ====
For those following, I have massively expanded the capabilities of the {{tl|repo link}} template:
* The SourceForge URLs are now comprehensive.
* Full support for the new query-based URLs for the Gitorious archives.
* Functional GitLab URLs.
* Generic repository support (used to create the {{tl|openscenegraph co}} template).
* Detailed documentation and extensive examples for checking the implementation (if you find any non-supported links, please add these as examples).
* Isolation of the '''cmd''' parameter from the CLI options — this is to enable future support for non-CLI instructions based on the value of '''cmd'''.

I have also completed a large set of subtemplates of {{tl|repo link}}, see the list at {{tl|repo link/doc related}}. This includes a full set of <nowiki>{{* source}}</nowiki> templates. I have left the original <nowiki>{{* file}}</nowiki> templates, rather than renaming and modifying them, so these are now redundant. All of the <nowiki>{{* source}}</nowiki>, <nowiki>{{* commit}}</nowiki>, <nowiki>{{* clone}}</nowiki>, and <nowiki>{{* co}}</nowiki> templates transclude from the master {{tl|repo link}} template to do all of the work.

One important template is {{tl|gitorious source}}. The support for the new query-based URLs for the Gitorious archives is now quite comprehensive in {{tl|repo link}}. Therefore I have converted almost every single FlightGear wiki link to https://gitorious.org to use {{tl|gitorious source}} instead. This fixes a lot of broken links and broken git instructions. I have reduced the number of hits for gitorious.org on the wiki (searching just for "gitorious") to 22 hits. This includes 2 very outdated articles ([[FlightGear Git: aircraft authors]], [[Fr/FlightGear et Git]]), 15 locked newsletters, 1 with no longer existent Gitorious merge request links, and 4 base URL links for Hangars. This way we can maintain the Gitorious web interface links and git command instructions in a functional state by simply updating the single source of {{tl|repo link}}.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 11:38, 29 February 2016 (EST)

: I just remembered [[Special:LinkSearch]], so make that 184 broken gitorious.org links remaining. Lots more work to do :)

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:46, 29 February 2016 (EST)

For some of these templates, e.g. {{tl|repo link/doc usage}}, I'm trying to implement some logic for automatic whitespace padding for documentation formatting, but the <code><nowiki>{{#len:string}}</nowiki></code> function is not enabled. According to {{mediawiki|Wikitext_parser/Core_parser_functions#.23len}} and {{mediawiki|Extension:StringFunctions}}, the option <code>$wgPFEnableStringFunctions = true;</code> should be set (in <code>LocalSettings.php</code>). Unless there is a reason for not using this, I was wondering if someone could enable this? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 09:53, 8 March 2016 (EST)

=== Archived newsletters and dead links? ===

Do we have a policy for the dead links in the FlightGear newsletters? It is obviously good to preserve the historic state. But there are many Gitorious links that could be made functional again using the {{tl|gitorious source}} template to point to the historic Gitorious archives (including the official FlightGear repositories, rather than using {{tl|fgdata source}}, for example). The https://gitorious.org links have been converted from URL/path based to query based, so absolutely all of the old links are broken. I am steadily converting all Gitorious links to use the [[Template:repo link/doc related|{{obr}}repo link{{cbr}} family of templates]], with the exception of the newsletters.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 04:52, 8 March 2016 (EST)

: I think it could be a good idea to try update old links in those newsletters. I sometimes look back at things and tend to think that I probably are not the only one doing that.
: I wonder if the rotten links should be replaced or stricken, but I think they could just as well be replaced. The key thing is that they go to the same resource or content, not weather they have been updated or not (also, the change will be visible in the revision history after all).
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 07:11, 8 March 2016 (EST)

:: I should add that I'm using [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=http%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] and [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>]. And I am also not touching the <code>User*</code> pages, <code>*talk*</code> pages, or pages tagged as out of date or up for deletion. For the newsletters I might look at these later when the broken Gitorious links are fixed in the rest of the wiki but, as these are locked, someone else might have make the switch to {{tl|gitorious source}}, {{tl|gitorious url}}, {{tl|gitorious clone}}, and {{tl|gitorious merge request}}.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 02:53, 9 March 2016 (EST)

::: I will temporarily add a table here for the templates in the newsletters and will slowly fix them one by one together with any other admin.
{{navbox
| title = Click "show" to show -->
| state = collapsed
| navbar = plain
| list1 =
http:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!}} No equivalent link for the Gitorious archive - project pages are dead. Maybe just use http://gitorious.org/?
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!}} Functional link, equivalent to {{gitorious url|fg|flightgear|commit=5c6fe952598053fa63631fc0161d666f22a50f51}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/headtrack

http://gitorious.org/arduinocockpit
{{!}} Project pages are dead, switched to {{gitorious url|headtrack|headtrack}}

{{gitorious url|arduinocockpit|arduinocockpit}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/arduinocockpi

http://gitorious.org/headtrack
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Missing project - i.e. {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra|text=migrated to GitLab}}. Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2011]]
{{!}} http://gitorious.org/flightgear-aircraft
{{!}} Switched to {{gitorious source}} and rephrased text slightly to help readers find the repositories.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} http://gitorious.org/anders-hangar/mtb_20m/trees/master
{{!}} Switch to {{gitorious url|proj=anders-hangar|repo=mtb_20m}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} http://gitorious.org/fg/flightgear/blobs/next/scripts/java/FGClient/src/FGFSDemo.java
{{!}} Switched to {{gitorious url|proj=fg|repo=flightgear|path=scripts/java/FGClient/src/FGFSDemo.java}}. This points to the old Gitorious repository to protect against path changes in the future.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2014]]
{{!}} http://gitorious.org/nasal-support/nasal-npp
{{!}} Switched to {{gitorious url|nasal-support|nasal-npp}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2015]]
{{!}} http://gitorious.org
{{!}} Switched to {{tl|gitorious source}} without parameters for the Gitorious base URL, to future-protect it.
{{!}}}

https:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/papillon81/flightgear-custom-scenery/

https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery

https://gitorious.org/papillon81/flightgear-custom-scenery/
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter December 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Fr/Nouvelles du projet FlightGear - décembre 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2012]]
{{!}} https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/README

https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/doc/doc-en.htm
{{!}} Switched to {{fgdata source|path=Aircraft/Instruments-3d/garmin196/README|full=1}} and {{fgdata source|path=Aircraft/Instruments-3d/garmin196/doc/doc-en.htm|full=1}} to point to the current FGData locations and removed the name "Gitorious" to make the text of the Garmin 196 GPS section still relevant
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter August 2012]]
{{!}} https://gitorious.org/mil-mi-6
{{!}} Switched to {{gitorious url|proj=mil-mi-6|repo=mi6dev}}, and changed from the non-existent project page to the main repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} https://gitorious.org/fgradar
{{!}} Switched from the project page to the direct repository {{gitorious url|fgradar|fgradar}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} https://gitorious.org/fg/flightgear/commit/913727239d6776c0508d206f395e16c265413ec3

https://gitorious.org/fg/flightgear/commit/eba03b5e469824ee8f1494723fcddbbc56155a08
{{!}} Switched to {{flightgear url|commit=913727239d6776c0508d206f395e16c265413ec3}} and {{flightgear url|commit=eba03b5e469824ee8f1494723fcddbbc56155a08}}. This deliberately points to the current repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2013]]
{{!}} https://gitorious.org/fg-radi/osm2city

https://gitorious.org/scenery-france-850
{{!}} Switched to the new GitLab repository {{gitlab source|proj=fg-radi|repo=osm2city|full=1}}

and removed the no longer existent scenery-france-850 repository, replacing it with "<s>Scenery repository (Gitorious)</s>".
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Switched to {{gitorious source|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console/repl.nas|line=708}}

{{gitorious url|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console|view=tree}}

{{fgdata-old url|commit=eaaf816b772649d5b0826a1d0bdd166dbc5b968f}}

{{flightgear commit|34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353}}

{{gitorious merge request|mr=54}}

{{gitorious merge request|mr=26}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Changes match the English article.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} https://gitorious.org/fg/fgdata/flightgear?p=fg/fgdata:flightgear.git;a=blob;f=keyboard.xml

https://gitorious.org/fg/fgdata?p=fg:fgdata.git;a=commit;h=f8c56dcc52ffd3d6dfca1d39dc4a72b6b3478368

https://gitorious.org/fg/hoorays-flightgear?p=fg:hoorays-flightgear.git;a=shortlog;h=refs/heads/topics/cppbind-fgprotocol
{{!}} This first link was the broken {{tl|git link}} template (see the table below). The other two links are not in the article?!
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter June 2014]]
{{!}} https://gitorious.org/eddp-custom-scenery/eddp-custom-scenery/
{{!}} Switched to {{tl|gitorious clone}} to provide functional '''git clone''' instructions.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2014]]
{{!}} https://gitorious.org/fg/hoorays-fgdata/source/2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876:Nasal/ai/aim9/aim9.fdm#L9
{{!}} Switch to {{gitorious url|proj=fg|repo=hoorays-fgdata|commit=2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876|path=Nasal/ai/aim9/aim9.fdm|line=9}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2015]]
{{!}} https://gitorious.org/fg/canvas-hackers-fgdata/source/f59c42134a5a77e343981dcff8278c3e2f094e87
{{!}} Switch to {{gitorious url|proj=fg|repo=canvas-hackers-fgdata|commit=f59c42134a5a77e343981dcff8278c3e2f094e87|view=summary}}
{{!}}}

Broken templates:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Template !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} {{tlx|Git link|gitorious|fg/fgdata|master|keyboard.xml|pre=$FG_ROOT/}}
{{!}} Switched to {{fgdata source|path=keyboard.xml|pre=$FG_ROOT}} to fix the Gitorious link created by the broken and depreciated {{tl|git link}} template.
{{!}}}

}}

::: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 12:06, 9 March 2016 (EST)

:::: I've added a '''notes''' column to help a little.

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:30, 9 March 2016 (EST)

=== Elimination of the dead Gitorious links ===
Thanks largely to the diversity and flexibility of the [[:Category:Repository link templates|{{obr}}repo link{{cbr}} family of templates]], I have now managed to eliminate almost every last dead Gitorious link in the FlightGear wiki! The locked Newsletter articles, user pages, and talk pages are the only exceptions. The page counts from the (Main) namespace are:
* [http://wiki.flightgear.org/index.php?target=http%3A%2F%2Fgitorious.org&namespace=0&title=Special%3ALinkSearch <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] — 37. Of these, 17 are for the front page with the news of the Gitorious to SourceForge migration, and the rest are Newsletters.
* [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org&namespace=0 <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>] — 166. Most of these links are valid and created by the {{obr}}gitorious *{{cbr}} subtemplates of {{tl|repo link}}. The remaining broken links are all in the locked Newsletters.
The Howto:* pages are not in the (Main) wiki namespace, but I've knocked those out too.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:54, 10 March 2016 (EST)

: thanks for doing all this unglamorous work - I am sorry that Gijs was apparently too busy to follow up on my suggestion to either provide you with admin access around here, or at least to help you run a Python script to do all this work in an automated, rather than manual, fashion. Hopefully, things will work out better next time. Again, thank you. Like I said, I think you should definitely be given admin access on the wiki, especially given your recent contributions - and I would gladly have my wiki status downgraded accordingly. In fact, if I was able to directly promote accounts accordingly, I would have done so months ago - however, it seems that Gijs is the only one to have those privileges, and he mentioned off-list that he's kinda busy with RL/exams etc, so it is to be expected that he's going to become a bottleneck more often - hopefully, this will be recongized as an actual issue, so that there will be more people able to promote new wiki admins. Sorry that things didn't work out better this time, and thanks so much for doing all this stuff manually. -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:49, 10 March 2016 (EST)

:: No problems! As for automating this, that would not have been possible. If you look at the changes, you'll see that each one is different <sup>[http://wiki.flightgear.org/index.php?title=Special:RecentChanges&to=20160310210655&limit=500]</sup>. I had to check each one, and update the link as required.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 16:08, 10 March 2016 (EST)

::: There's three of us actually (Curt, Simon and myself), no need to wait on me. See http://wiki.flightgear.org/index.php?title=Special%3AListUsers&username=&group=bureaucrat&limit=100 (Sek is inactive nowadays) ;-)
::: Please note that forum pms are really not the best way to contact me. I very much prefer email over forum pms as it's a lot easier to filter out the huge amounts of nonsense I'm receiving from stuff requiring actual attention.
::: Anyhow I've just promoted Bugman so he can edit locked articles.
::: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 05:06, 11 March 2016 (EST)

:::: Thank you. I'll try to preserve the original intent of the Newsletters while fixing the broken links (maybe even preserving any original URLs as Mediawiki link text, while pointing to the new URL). I will use the {{obr}}gitorious *{{cbr}} templates to point to the historical sources, and will probably use this for all of the Gitorious URLs so that we have full control over any future URL breakages via the single location of {{tl|repo link}}. For example, if they change the gitorious.org domain name to a https://archive.org subdomain (i.e. gitorious.archive.org).

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 06:40, 11 March 2016 (EST)

=== Regex parsing of template parameters? ===

For the {{tl|repo link}} template, I am currently trying to work out what to do for git branches and tags on the SourceForge infrastructure. The problem is that the presence of the character <code>/</code> within a branch or tag name requires the text <code>/~</code> to be appended to that name in the URL, for example:

* Tag <code>version/2016.1.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/version/2016.1.1/~/tree/simgear/ephemeris/ephemeris.cxx
* Branch <code>release/2016.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/release/2016.1/~/tree/simgear/ephemeris/ephemeris.cxx

I haven't found out a way to use regex to parse the <code>tag</code> or <code>branch</code> template parameters to automate this, hence I am thinking of just giving the instruction for the template user to append this text to the <code>tag</code> or <code>branch</code> parameter text themselves. However this is not ideal - a change of this behaviour on the SourceForge side requires end pages with SourceForge URLs to be updated, rather than just updating {{tl|repo link}}. I was wondering about possibility of installing the extension:

* [https://www.mediawiki.org/wiki/Extension:RegexParserFunctions Extension:RegexParserFunctions]

Though I'm not 100% sure if that will work. Or does someone else know an alternative? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:09, 22 April 2016 (EDT)

: not a solution, just a potential workaround would be checking for the most common prefix strings used in tags/branches (e.g. version, release, topic, topics) and explicitly rewrite the URL accordingly to append the /~ suffix -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 22 April 2016 (EDT)

:: That might be a solution. But I don't know how to do that without regex ;) We really only have #ifeq statements, but that has to match the whole string.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:44, 22 April 2016 (EDT)

== Discussion about quotes on the wiki ==
{{usr|Hooray}} have started a page now at [[FlightGear wiki:Quoting Guidelines]] ([http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Quoting_Guidelines&oldid=96104 perm]) for a discussion regarding guidelines for the use of quotes on the wiki. Join the discussion.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 18:17, 21 March 2016 (EDT)

In slight relation to this I have tried to make the wiki more consistently use the most common spelling and case, "Instant-Cquotes" and have changed the automatic categorization accordingly. All articles using the {{tl|FGCquote}} template can now be found in [[:Category:Articles containing Instant-Cquotes]] (currently some ~250 articles).

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 08:21, 23 March 2016 (EDT)

== Reorganizing the Git articles ==
I've noticed that the [[Category:Git|Git articles]] suffer from duplication and are in part obsolete (especially with regard to the instructions for running Git on Windows). Thus, I propose the following reorganization:
* [[Development workflow]]: reorganization to explain how the patch submission process is organized from a high-level point of view (forking the repository from SourceForge, developing, pushing the commits to the personal fork, submitting a merge request/sending a patch to the mailing list);
* [[FlightGear Git]]: leave as is;
* '''Installing and configuring Git''' - new article about installing Git and configuring it (setting the username/e-mail address); merge the contents of [[FlightGear Git on Windows]] and [[Resources WRT running git on Win32]] here;
* [[FlightGear Git for laymen]] - make it follow [[FGW:MOS]], merge the contents of [[Howto:Start using git]] here;
* [[FlightGear Git: core developers]] and [[FlightGear Git: data developers]] - I'm uncertain about what I should do with them: the only piece information that would not be written in other articles is the list of alternative methods for cloning FGData;
* [[FlightGear Git: gitiquette]] and [[FlightGear Git: tips]] - make them follow [[FGW:MOS]].
Any comments? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:11, 13 May 2016 (EDT)

: This is sorely needed! For [[FlightGear Git: core developers]] and [[FlightGear Git: data developers]], maybe these can be merged into something like [[FlightGear Git: working with the repositories]]? The only real difference is the URL, but that is a minor difference with the [[:Category:Repository link templates]]. This could be generalised into a set of instructions for working with all git repositories for the core infrastructure, including forking and merge requests, with a current focus on the SourceForge web and non-web interfaces.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 08:17, 13 May 2016 (EDT)

:: Yes, I was thinking about a similar solution as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:16, 13 May 2016 (EDT)

: For the reorganisation of the articles, it would be good to make a lot of use of the {{tl|Project infrastructure}} template. This will abstract away the SourceForge infrastructure (well some instructions will be 100% SourceForge specific, so it won't be perfect). I would like to however have [[Template talk:Project infrastructure#Slight variation of the current architecture|Johan's design]] implemented first, as it would be quite beneficial.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 18:43, 14 May 2016 (EDT)
:: Thanks, didn't know it existed. Right now I'm fixing some last-minute bugs before the release, but I'll have a look at this. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 09:05, 15 May 2016 (EDT)

== UTF-8 language pages cannot be edited ==

This is a continuation of [[FlightGear wiki:Village pump/Archive 2015#UTF-8 language pages cannot be edited]]. I can see that wiki editors are [[Zh/FlightGear Wiki|forced to create workarounds]], as the [[Main page]] in Chinese [http://wiki.flightgear.org/index.php?title=Zh/%E9%A6%96%E9%A1%B5&action=edit cannot be edited]. I think it is quite important to solve this ''"A database query error has occurred. This may indicate a bug in the software"'' issue. As the fix is quite dangerous (see {{mediawiki|Topic:S1q54kosfdkhz6w1}}), do we have a backup system? Do we have regular mysql and ftp dumps that can be backed up locally using rsync?

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 05:16, 15 May 2016 (EDT)

Development workflow

2016-05-14T21:45:51Z

Elgaton: Restructuring; work in progress

{{WIP}}
{{Git}}
This page is meant to be a high-level introduction to the '''development workflow''' of FlightGear, that is, the process developers follow to contribute their work to the project.

== The big picture ==
Everything is stored in several Git ''repositories'' (collection of files) on SourceForge. You can find a list of them in the [[FlightGear Git]] page.

Only a handful of developers have ''commit access'', that is, the right to make changes to those repositories without prior approval. This is done to ensure that only people showing a good, consistent contribution track record and good judgement are able to perform such modifications unsupervised.<ref>[http://www.flightgear.org/flightgear-policy-document FlightGear Policy Document and Roadmap]</ref> For this reason, once a developer contributes some work, it will need to be ''staged'' for approval by another contributor having commit access.

== Life of a patch ==
The contribution process can be divided in the following phases.


# '''Clone the repositories you would like to contribute to and fetch them.''' In this context, a ''clone'' is a personal copy of the original repository created for temporarily keeping your proposed modifications until they are accepted into the project. You will need to clone the original repository and download the data to your computer.
# '''Perform the desired modifications''' and publish them to your clone.
# When you are ready to get your work accepted, '''submit a merge request'''. A developer will check your contribution before merging it into the project repositories. Fix any issues that are found during the review.
# Once your work is included, '''monitor the [[FlightGear build server|build server]], the [[Mailing lists|mailing lists]] and the forum''' to check for bugs you might have inadvertently introduced.

== Scenery and aircraft contributions ==
Due (mostly) to their file size, scenery and aircraft are stored using different file management systems and, thus, do not follow the process outlined in this article.
* Scenery contributions should be submitted to the [[FlightGear Scenery Database]].
* Aircraft contributors should follow the instructions given in [[FGAddon]].

== Tips ==
* If you need to take a design decision or want to get some preliminary feedback, ask people on the {{Mailing list e-mail address|flightgear-devel}} mailing list and/or on the forum.

{{Appendix}}

[[Category:Core developer documentation]][[Category:Git]]

FlightGear Git

2016-05-13T23:18:28Z

Elgaton: Small refactoring, added repository table

{{Git}}
'''Git''' is a {{wikipedia|version control system}} used by the [[FlightGear]] project to store all the files required to build and run the simulator. This includes all the programs, the data (e.g. textures, sounds), supporting tools, etc. Git tracks updates to every file as developers from around the world work together concurrently to create new versions. The sole exception is the official [[FGAddon]] aircraft repository that is Subversion rather than Git based.

While new FlightGear features and additions are in development, they are available from Git before they are available in the standard release version. Using Git allows users to use the newest possible version of FlightGear from the latest source files, to experiment with new aircraft or other features. However, it is not a beginner's tool. Using Git can expose the user to unstable features that show ugly error messages, or crash the computer.

As of May 2016, the repositories are located at [https://sourceforge.net/p/flightgear SourceForge].

== Motivation ==
In May 2010, after a hardware failure on the [[CVS]] servers, the FlightGear project changed its version control system from CVS to Git.

Much has been written on the advantages of Git over CVS. For the FlightGear project, some advantages are:
* Much better support for branches and merging branches. This is especially important for creating bug fix releases for major releases while still allowing work on the next major release to continue. It is also very nice for a developer's personal workflow.
* Easier path for contributors to submit changes and developers to integrate them.
* Much better support for everyday tasks like searching the project history for changes, viewing changes, bisecting the project history to find the original source of a bug.

== Repositories and branches ==
The FlightGear project is split up in the repositories listed below.
{| class="wikitable"
! Name
! Contents
! Remarks
|-
| {{simgear source|text=simgear}}
| The simulation engine that FlightGear uses.
| rowspan="3" |
Those repositories have the following branches:
* ''next'': current tip of new development. This branch should always compile and run, but various things could be broken.
* ''release/*'': containing former and (if a specific branch was made for them) upcoming releases.
|-
| {{flightgear source|text=flightgear}}
| FlightGear itself.
|-
| {{fgdata source|text=fgdata}}
| All data (default aircraft, dialogs, sounds) used by FlightGear.
|-
| {{fgaddon source|text=fgaddon}}
| SVN repository that holds all official aircraft (except the [[Cessna 172P]] default plane and the [[UFO]]).
|
|-
| {{fgrun source|text=fgrun}}
| The [[FGRun]] launcher for FlightGear.
| As of May 2016, in the process of being replaced by the [[Qt5 Launcher|Qt5 launcher]].
|-
| Windows-3rd-party
| Prebuilt libraries needed to make FlightGear run on Windows.
|
|-
| {{fgmeta source|text=fgmeta}}
| FlightGear "meta" repository containing build and setup scripts for the whole project.
|
|-
| fgcom
| [[FGCom 3.0|FGCom]], a voice-over-IP application used by [[multiplayer]] controllers to provide [[Air traffic control|ATC services]].
|
|-
| {{getstart source|text=getstart}}
| Sources for the ''Getting Started'' manual included with the simulator.
|
|-
| {{openradar source|text=openradar}}
| The [[OpenRadar]] application used by multiplayer controllers.
|
|-
| {{sceneryweb source|text=sceneryweb}}
| Source code and configuration files for the [http://mapserver.flightgear.org/ Mapserver], the [https://scenery.flightgear.org/ scenery portal] and the [[TerraGear scenery build server]].
|
|-
| {{terragear source|text=terragear}}
| The [[TerraGear]] scenery building toolkit.
|
|-
| terrafs
| A Linux tool to mount the TerraSync scenery as a remote file system.
|
|-
| MacLauncher
| Old FlightGear launcher for Mac.
| Deprecated by the [[Qt5 Launcher|Qt5 launcher]].
|}

== Related content ==
* [[FlightGear Git: splitting FGData]], an initiative to split the aircraft out of the FGData repository, in order to decrease its size and thus improve access to the average user/developer.

{{Building}}

[[Category:Core developer documentation]]
[[Category:FlightGear]]
[[Category:Git]]

[[fr:FlightGear et Git]]

Development workflow

2016-05-13T23:15:02Z

Elgaton: Temporary first version

{{WIP}}
{{Git}}
This page is meant to be a high-level introduction to the '''development workflow''' of FlightGear, that is, the process developers follow to contribute their work to the project.

== The big picture ==

- Code, mailing lists, bug tracker hosted at SourceForge
- Commit access: repos not public (see policy)

== Life of a patch ==
- get the repo + fork
- edit (on main for aircraft, on branch for
- get feedback for important edits
- submit a patch (or direct commit if commit access)
- patch applied
- check build server and monitor forum+ML

== Tips ==
Ask on ML

Howto:Animated jetways (Type 1)

2016-05-13T18:32:04Z

Elgaton: Dequoting and restyling per FGW:MOS

'''Animated jetways''' are dynamic {{Wikipedia|jetway}} models that connect to your aircraft when you are pulled up at a gate. [[FlightGear]] boasts the most advanced animated jetways in the flight simulator market, beating those of Microsoft Flight Simulator and X-Plane in features — a testament to the flexibility of FlightGear. This article describes how to obtain and use the jetways and interface them with aircraft and scenery.

== Compatible airports and aircraft ==
This section lists the airports having animated jetways, as well as the aircraft and AI aircraft supporting them, as of September 2015.

The compatible airports are:
* [[London Gatwick Airport]] (EGKK)*
* [[Amsterdam Airport Schiphol]] (EHAM)
* Denver International Airport (KDEN)*
* Las Vegas McCarran International Airport (KLAS)*
* [[San Francisco International Airport]] (KSFO)
* Ted Stevens Anchorage International Airport (PANC)*
''<nowiki>*</nowiki> indicates the jetways for this airport were auto-converted and do not have gate numbers.''

The aircraft supporting animated jetways are:
* [[Boeing 717]]
* [[Boeing 747-8i]]
* [[Boeing 757-200]] and -300
* [[Boeing 767-300]]/ER
* [[Boeing 777-200ER]]
* [[Bombardier CRJ700]]

The [[Interactive traffic|AI aircraft]] supporting animated jetways are:
* [[Airbus A319]]
* [[Airbus A320]]
* [[Airbus A321]]
* [[Boeing 737]]
* [[Boeing 747-400]]
* [[McDonnell Douglas MD-80]]

The {{fgdata file|Models/Airport/Jetway/generic.xml|t=generic jetway model}} in FGData is broken, but there is [http://scenemodels.flightgear.org/app.php?c=Models&a=view&id=2211 a repaired version in the TerraSync scenery repository].

== Obtaining and installing ==
FlightGear 2.4.0 and later include the animated jetway system. Nothing extra has to be installed.

== Using the jetways ==
# Start FlightGear in any compatible aircraft.
# Fly (or spawn) to any airport equipped with animated jetways. You can tell if a jetway is animated by pressing {{key press|Ctrl|C}}; if the polygons are highlighted in yellow, then it is animated.
{{note|Ensure you have the latest scenery from [[TerraSync]] so you do not get conflicts between animated and static jetways.}}
<ol start="3">
<li>Taxi up to an animated jetway and park near it, then click it. If your aircraft is supported and parked well enough, the jetway will extend, rotate, and connect.</li>
</ol>

== Adding support in aircraft ==
# Open up the main model of your aircraft in your favorite 3D modeling software (such as [[Blender]]).
# Move the model around to account for any offsets you have in the main model file, then get the coordinates of the door.
[[File:Animated-jetway-tutorial.jpg]]
<ol start="3">
<li>Add the following code in your aircraft's -set.xml (remember to merge the tags properly):</li>
</ol>
<syntaxhighlight language="xml">
<sim>
<model>
<door>
<position-x-m type="float">X-M</position-x-m>
<position-y-m type="float">Y-M</position-y-m>
<position-z-m type="float">Z-M</position-z-m>
<jetway-hood-deg type="float">HOOD-DEG</jetway-hood-deg>
</door>
</model>
</sim>
</syntaxhighlight>
: where <tt>X-M</tt>, <tt>Y-M</tt>, and <tt>Z-M</tt> are the X/Y/Z coordinates of the door in meters and <tt>HOOD-DEG</tt> is the jetway hood rotation amount. To specify more doors, just add more door elements.
<ol start="4">
<li>Add the following code into your XML model file to enable the jetways to connect to your aircraft over the [[multiplayer]] network:</li>
</ol>
<syntaxhighlight language="xml">
<nasal>
<load>
var model = cmdarg();
model.getNode("door[0]/position-x-m", 1).setValue(X-M);
model.getNode("door[0]/position-y-m", 1).setValue(Y-M);
model.getNode("door[0]/position-z-m", 1).setValue(Z-M);
model.getNode("door[0]/jetway-hood-deg", 1).setValue(HOOD-DEG);
</load>
</nasal>
</syntaxhighlight>
: Again, replace <tt>X-M</tt>, <tt>Y-M</tt>, <tt>Z-M</tt> and <tt>HOOD-DEG</tt> with their respective values. To add more doors, duplicate the last four lines of [[Nasal]] code and replace <tt>[0]</tt> with <tt>[1]</tt> or <tt>[2]</tt>.

=== Adding support in AI aircraft ===
Follow the steps for regular aircraft above, but only add in the Nasal code.

== Adding support in scenery ==
=== Placing jetways ===
# Launch FlightGear in your favorite aircraft, such as the [[Bluebird]].
{{note|You ''cannot'' use the [[UFO]] because its scenery editing function will interfere with the jetway editor.}}
<ol start="2">
<li>Go to {{menu item|AI|Jetway Settings}} and tick the '''Enable jetway editor''' checkbox, then click the {{button|Open Editor}} button.
[[File:Animated-jetway-editor.jpg]]
<li>With the editor enabled, click anywhere on the ground to place an animated jetway, which will flash to indicate it is selected. The jetway editor is similar to the UFO scenery model editor. You can {{key press|Alt}}+click on the terrain to move the current selected jetway. {{key press|Ctrl}}+click selects the jetway closest to the click position (the new jetway will flash to indicate it is selected). {{key press|Shift}}+click deselects the current jetway.</li>
</ol>

: The dialog is used to adjust the selected jetway. The top sliders adjust position and orientation and the bottom ones adjust the jetway itself. The offsets that the bottom sliders control can be used to model jetways that are in obscure configurations. The dropdown menus at the very bottom of the dialog control various properties of the jetway, such as the model, gate number, airline sign and door number. The following models are available:
:* Generic
:* Glass
:* [[EHAM]] gate
:* [[EHAM]] 747 gate

<ol start="4">
<li>When you are finished editing your airport jetway layout, click the {{button|Export}} button. A jetway definition file will be created and written to <tt>$FG_HOME/Export/ICAO.xml</tt>, where <tt>ICAO</tt> is the ICAO code of the nearest airport. (The exact location of this file is printed to the console window.) This file should be [[FlightGear Scenery Database#Contribute|submitted to TerraSync]].</li>
</ol>

=== Auto-converting static/obsolete jetways ===
{{WIP}}

== Future development ==
Ryan A Young, the original developer of the animated jetway code, is planning to rewrite it as a C++ subsystem. This would bring several advantages:
* some hacks in the current [[Nasal]] code would be removed, and the system would be faster and more reliable;
* the model files could be streamlined and the jetways could be automatically placed on the ground, irrespective of the employed scenery;
* performance could be improved by letting the user decide how many jetways would be rendered;
* they could be integrated with AI traffic.<ref>{{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34725917/
| title = <nowiki>[Flightgear-devel] Animated jet bridges redux</nowiki>
| author = <nowiki>Ryan A Young</nowiki>
| date = Dec 29th, 2015
}}</ref>

== Related content ==
* [[Ramp Marshall]]
* {{forumref|title=The animated jetway project|t=8728|f=5}}

{{Appendix}}

[[Category:Scenery]]
[[Category:Scenery enhancement]]

Template:Forum link

2016-05-13T18:09:10Z

Elgaton: Fix query parameters present even if the arguments were not passed; make style more in line with Template:Wikipedia for uniformity

File:FlightGear icon 15px.png

2016-05-13T17:00:31Z

Elgaton: Fixed file information

=={{int:filedesc}}==
{{Information
|description={{en|1=Resized version of [[:File:FlightGear_logo.png]] for use in link templates.}}{{it|1=Versione ridimensionata di [[:File:FlightGear_logo.png]] per l'utilizzo all'interno dei modelli per i link.}}
|date=2016-05-13
|source=Resized version of [[:File:FlightGear_logo.png]]
|author=Original by [[User:Gijs]], edited by [[User:Elgaton]]
|permission=
|other versions=[[:File:FlightGear_logo.png]]
}}

=={{int:license-header}}==
{{Template:GPL}}

[[Category:FlightGear logotypes]]

File:FlightGear icon 15px.png

2016-05-13T16:57:23Z

Elgaton: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=Resized version of [[File:FlightGear_logo.png]] for use in link templates.}}{{it|1=Versione ridimensionata di [[File:FlightGear_logo.png]] per l'utilizzo all'interno dei modelli per i link.}}
|date=2016-05-13
|source=Resized version of [[File:FlightGear_logo.png]]
|author=[[User:Gijs]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{subst:Custom license marker added by UW}}
{{Template:GPL}}

[[Category:FlightGear logotypes]]

Howto:Animated jetways (Type 1)

2016-05-13T14:19:26Z

Elgaton: First set of restyling modifications

'''Animated jetways''' are dynamic {{Wikipedia|jetway}} models that connect to your aircraft when you are pulled up at a gate. [[FlightGear]] boasts the most advanced animated jetways in the flight simulator market, beating those of Microsoft Flight Simulator and X-Plane in features — a testament to the flexibility of FlightGear. This article describes how to obtain and use the jetways and interface them with aircraft and scenery.

== Current state ==
As of September 2015, only the following airports have animated jetways.
* [[London Gatwick Airport]] (EGKK)*
* [[Amsterdam Airport Schiphol]] (EHAM)
* Denver International Airport (KDEN)*
* Las Vegas McCarran International Airport (KLAS)*
* [[San Francisco International Airport]] (KSFO)
* Ted Stevens Anchorage International Airport (PANC)*
''<nowiki>*</nowiki> indicates the jetways for this airport were auto-converted and do not have gate numbers.''

The {{fgdata file|Models/Airport/Jetway/generic.xml|t=generic jetway model}} in FGData is broken, but there is [http://scenemodels.flightgear.org/app.php?c=Models&a=view&id=2211 a repaired version in the TerraSync scenery repository].

== Obtaining and installing ==
FlightGear 2.4.0 and later include the animated jetway system. Nothing extra has to be installed.

== Using the jetways ==
# Start FlightGear in any animated jetway-compatible aircraft. As of May 2016, these include the following:
#* [[Boeing 717]]
#* [[Boeing 747-8i]]
#* [[Boeing 757-200]] and -300
#* [[Boeing 767-300]]/ER
#* [[Boeing 777-200ER]]
#* [[Bombardier CRJ700]]
# Fly (or spawn) to any airport equipped with animated jetways. You can tell if a jetway is animated by pressing {{key press|Ctrl|C}}; if the polygons are highlighted in yellow, then it is animated.
{{note|Ensure you have the latest scenery from [[TerraSync]] so you do not get conflicts between animated and static jetways.}}
<ol start="3">
<li>Taxi up to an animated jetway and park near it, then click it. If your aircraft is supported and parked well enough, the jetway will extend, rotate, and connect.</li>
</ol>

== Adding support in aircraft ==
# Open up the main model of your aircraft in your favorite 3D modeling software (such as [[Blender]]).
# Move the model around to account for any offsets you have in the main model file, then get the coordinates of the door.
[[File:Animated-jetway-tutorial.jpg]]
# Add the following code in your aircraft's -set.xml (remember to merge the tags properly):
<syntaxhighlight language="xml">
<sim>
<model>
<door>
<position-x-m type="float">X-M</position-x-m>
<position-y-m type="float">Y-M</position-y-m>
<position-z-m type="float">Z-M</position-z-m>
<jetway-hood-deg type="float">HOOD-DEG</jetway-hood-deg>
</door>
</model>
</sim>
</syntaxhighlight>
: where <tt>X-M</tt>, <tt>Y-M</tt>, and <tt>Z-M</tt> are the X/Y/Z coordinates of the door in meters and <tt>HOOD-DEG</tt> is the jetway hood rotation amount. To specify more doors, just add more door elements.
<ol start="4">
<li>Add the following code into your XML model file to enable the jetways to connect to your aircraft over the [[multiplayer]] network:</li>
</ol>
<syntaxhighlight language="xml">
<nasal>
<load>
var model = cmdarg();
model.getNode("door[0]/position-x-m", 1).setValue(X-M);
model.getNode("door[0]/position-y-m", 1).setValue(Y-M);
model.getNode("door[0]/position-z-m", 1).setValue(Z-M);
model.getNode("door[0]/jetway-hood-deg", 1).setValue(HOOD-DEG);
</load>
</nasal>
</syntaxhighlight>
: Again, replace <tt>X-M</tt>, <tt>Y-M</tt>, <tt>Z-M</tt> and <tt>HOOD-DEG</tt> with their respective values. To add more doors, duplicate the last four lines of [[Nasal]] code and replace <tt>[0]</tt> with <tt>[1]</tt> or <tt>[2]</tt>.

=== Adding support in AI aircraft ===
Follow the steps for regular aircraft above, but only add in the Nasal code.

=== jetway-enabled AI Aircraft (9/2015) ===
<pre>
AI/Aircraft/A319/A319-main.xml
AI/Aircraft/A320/A320-main.xml
AI/Aircraft/737/737-main.xml
AI/Aircraft/MD80/MD80-main.xml
AI/Aircraft/A321/A321-main.xml
AI/Aircraft/747-400/747-400-main.xml
</pre>

== Adding support in scenery ==

=== Placing jetways ===

Launch FlightGear in your favorite aircraft. The author uses the [[Bluebird]]. You ''cannot'' use the [[UFO]] because its scenery-editing function will interfere with the jetway editor. Go to AI > Jetway Settings and tick the "Enable jetway editor" checkbox. Then click the "Open Editor" button.

[[File:Animated-jetway-editor.jpg]]

With the editor enabled, click anywhere on the ground to place an animated jetway, which will flash to indicate it is selected. The jetway editor is similar to the UFO's scenery model editor. You can Alt-click on the terrain to move the current selected jetway. Ctrl-click selects the jetway closest to the click position (the new jetway will flash to indicate it's selected). Shift-click deselects the current jetway.

The dialog is used to adjust the selected jetway. The top sliders adjust position and orientation, and the bottom ones adjust the jetway itself. The offsets that the bottom sliders control can be used to model jetways that are in obscure configurations. The drop-down menus at the very bottom of the dialog control various properties of the jetway, such as the model, gate number, airline sign, and door number. At the moment, the following models are available:

* Generic
* Glass
* [[EHAM]] gate
* [[EHAM]] 747 gate

When you are finished editing your airport jetway layout, click the "Export" button. A jetway definition file will be created and written to <tt>$FG_HOME/Export/ICAO.xml</tt>, where <tt>ICAO</tt> is the ICAO code of the nearest airport. (The exact location of this file is printed to the console window.) This file should be submitted to Terrasync (see [[FlightGear Scenery Database#Contribute]]).

=== Auto-converting static/obsolete jetways ===

{{WIP}}

== Future Development ==
{{FGCquote
|1= I don't know if anyone remembers the Nasal-based animated jetway code I wrote a few years ago, but I'd like to rewrite it as a clean-sheet C++ subsystem. I want to eliminate the truly atrocious Nasal hacks I used in the initial implementation and make the whole thing faster and more reliable. My objectives as of now are, 1) Implement a new FGJetwayManager subsystem to replace the existing code in jetways.nas. (I have not yet decided what to do with jetways_edit.nas - it might be fixed up instead of outright replaced.) 2) Streamline the jetway model files in fgdata. I want to do away with the generic.airline.<XYZ>.xml files because they're unnecessary clutter. The C++ code can deal with these cases. 3) As for the jetway definition files themselves (<airport>.jetways.xml), the only change I'd like to make is deprecating the "elevation-m" property for each jetway, which is currently relative to the surrounding scenery, including buildings and AI craft (due to the Nasal API). Instead, I propose fixing all jetways to the ground. Rationale: The current method is unreliable (see sunken jetways at KSFO) and I can't imagine a situation when you would need a floating jetway. 4) Performance optimiations - much of this would come from plain superior code, but I also plan to introduce a user preference for "jetway density." That is, you can choose to spawn between 0 to 100% of all jetways defined for an airport. This allows the user to reduce the overhead from rendering and animating all those jetway objects (which is probably the biggest bottleneck besides the current Nasal implementation). This is what FSX does. 5) Potential idea - integration with AI traffic. So that when AI airliners park at their gates, jetways will extend to meet them. The current Nasal code makes an attempt at this, but it's very hacky and unreliable. While I think this is a cool idea, I don't want to interfere with anyone's work on the AI subsystem. I would greatly appreciate any ideas and comments on my proposal, as well as some pointers and tips on getting started with core development. :-)
|2= {{cite web
| url = http://sourceforge.net/p/flightgear/mailman/message/34725917/
| title = <nowiki>[Flightgear-devel] Animated jet bridges redux</nowiki>
| author = <nowiki>Ryan A Young</nowiki>
| date = Dec 29th, 2015
}}
}}

== Related content ==
=== FlightGear wiki ===
* [[Ramp Marshall]]

=== Forum topics ===
* [http://forum.flightgear.org/viewtopic.php?f=5&t=8728 The animated jetway project]

[[Category:Scenery]]
[[Category:Scenery enhancement]]

FlightGear wiki:Village pump

2016-05-13T14:19:01Z

Elgaton: /* Reorganizing the Git articles */ Response

{{Archives|[[/Archive 2012|2012]]|[[/Archive 2013|2013]]|[[/Archive 2014|2014]]|[[/Archive 2015|2015]]}}
{{shortcut|FGW:VP}}
Welcome to the '''Village Pump'''. This page is used to discuss the technical issues, operations and guidelines of the [[FlightGear wiki]].

Please <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit&section=new}} add new topics]</span> to the '''bottom''' of this page.

Old discussion should be moved to a [[FlightGear wiki:Village pump/Archive YEAR]]. These discussions can then be moved to a relevant talk page if appropriate.

== Welcome template? ==
I have been thinking about suggesting a welcome template, for example named {{obr}}welcome{{cbr}}, to place on top of (at least) new users user discussion pages.

It should welcome the (new) user

In addition, it should probably mention and/or link to pages mentioning:
* The introduction page/tutorial (Hmm, I do not think I did finish that one. See [[Help talk:Tutorial]] ([http://wiki.flightgear.org/index.php?title=Help_talk:Tutorial&oldid=70843 perm])).
* Help pages
* How to use categories (in particular not like #tags, ;-) but also that image and article categories should be separate, but link to each other)
* The portals
* The style manual
* Discussion pages and where to discuss what:
** How to use discussion pages
** The wiki in general: The village pump (this page)
** Wiki articles: Article discussion pages
** Wiki user actions: User discussion pages

Maybe it should also mention that FGAddon aircraft, effects, other features etc. (except for their articles) and their bugs should be discussed on the forum, unless developers say otherwise, and that core features should be discussed on the developer mailing list and core bugs on the bug tracker.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 20:31, 30 January 2016 (EST)

: I think this is a great idea. A nice concise summary with links to help a new user navigate the FlightGear jungle would be a great addition. It should however remain very short with simple sentences - while being complete - as many users are not native speakers. So maybe there should be translations of the template with manually added links at the bottom for easy access to all the translations?

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:35, 12 February 2016 (EST)

:: Regarding an introduction article, I have come to the conclusion that a complete but long article is probably not as helpful as short but specific help pages. In essence the latter would be easier to navigate and absorb. I have therefore started to slowly split up some of the help pages and have added one more section to [[Help:Contents]].
:: I think that a welcome phrase, a link to that page and the [[FlightGear wiki:Manual of Style|style manual]] might actually suffice for a welcome template for now. It is at least better than what we currently have (i.e. more or less nothing).
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 14:47, 4 March 2016 (EST)

:: I now consider
::* A Welcome message
::* A link to this page
::* A link to the help pages
::* A link to the manual of style
::* Some final welcoming words

:: A welcome template should probably also very briefly mention a pet peeve of mine: the categories.
:: Many (if not most) image uploaders seem to treat them like tags, but if say all screenshots of aircraft (probably >2000) would end up at [[:Category:Aircraft]] (instead of under a subcategory to [[:Category:Screenshots of aircraft]]), of what use would that page be when looking for a specific one? If people would like to be able to search for an aircraft, a concise but comprehensive image description is very hard to beat.
:: How do I convey all that in a way that is, short, to the point and easy to absorb (and act by)? And where is the best place?
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:46, 8 March 2016 (EST)

:: An early draft is now at [[User:Johan G/Template:Welcome to the wiki]]
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:52, 18 April 2016 (EDT)

::: Some comments on the draft:
::: * I'm not fully sure about using a prominent box - I think it stands out a bit too much. Wikipedia {{wikipedia|Template:Welcome|uses a simple thread on the Talk page}}; as an alternative, we could use lighter colors.
::: * I've also expanded the text a bit. My proposal would be (I've put it in a box, but I'm for the "thread" solution):
<div style="background: #fff; border: 1px #585858 solid; padding: 12px; margin: 12px">
[[Image:Example.png|left]] '''Welcome to the FlightGear wiki, {{#if: {{{name|}}} | {{{name}}} | {{BASEPAGENAME}}}}'''! We hope you will enjoy your stay!

See [[Help:Contents#Reading|Reading]] to learn how wikis work. You can also [[Special:CategoryTree/Root category|browse the existing page categories]].

Should you wish to create or edit some articles, ''do so''! Here are some resources to get you started:
* [[Help:Contents#Editing|How to edit pages]]
* [[Help:Discussion pages|Discussion pages]], where we discuss and agree on potential improvements
* [[FlightGear wiki:Manual of Style|The Manual of Style]], a set of guidelines to help editors maintain a consistent style and formatting (please follow them)
* [[Help:Contents|Wiki help page]]

If you have any questions, just start a topic on the [[FlightGear wiki:Village pump|''Discuss!'' page]]. Again, welcome!
</div>
::: ...where the image on the left is an appropriately chosen icon.
::: Finally, we could use the {{mediawiki|Extension:NewUserMessage|NewUserMessage extension}} to have the wiki software automatically post the message to the new user's talk page.
::: ---- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:30, 1 May 2016 (EDT)

== Permanently removing spam bots ==
For permanently removing spam bots, has the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] Mediawiki extension been considered? I use that regularly on [http://wiki.nmr-relax.com my own wiki], though there we have also reverted to communicating to the person via email before manually granting access (probably not an option here), as all of the Mediawiki captcha methods were recently cracked.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:15, 12 February 2016 (EST)

: Oh, for the extension, we simply have a user called 'Spam bot' in a blocked state, and merge the spam bot accounts into this one, deleting the old account.
: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:20, 12 February 2016 (EST)

:: I'd use the [https://www.mediawiki.org/wiki/Extension:AbuseFilter abuse filter extension] instead (much more powerful and automated) - other users have also proposed different remedies, see [http://forum.flightgear.org/viewtopic.php?f=42&t=28734 this forum thread]. Anyway, Gijs is going to upgrade MediaWiki shortly and review the current anti-spam measures.
:: -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:26, 13 February 2016 (EST)

::: A lot of the spam bots are using their name as advertising nowadays, so the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] extension is the only one I know which will allow a user and associated name to be permanently deleted.

::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:04, 14 February 2016 (EST)

:::: The problem now is that they're also adding the information to the page title, so that it will still show up in the deletion logs [http://wiki.flightgear.org/Special:Log/delete] in other words, there's still some SEO juice associated with deleted entries ... Another idea would be to allow admins to temporarily disable wiki registrations/article creation, e.g. if more than 2 admins agree, this could be done to protect the wiki from spam attacks.

::::: Hooray, you should sign your posts ;) The bots don't target the deletion logs, as that's a little pointless. It's a Special:* page, and the default Mediawiki robots.txt file tells all search engines to not index these pages. User pages, page histories, etc. are however normally indexed.

::::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:36, 19 February 2016 (EST)

:: The point was not what the bots are targeting, but what shows up in the logs - i.e. SEO-wise - Gijs' article blacklist stuff should help with that hopefully. PS: I could not find the signature button on the mobile device I am using, and I am not too good at remembering the correct number of tildes ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:04, 19 February 2016 (EST)

== WIP vs. Under construction ==
I have been beginning to miss the under construction template[http://wiki.flightgear.org/index.php?title=Template:Under_Construction&direction=prev&oldid=46229] more and more (though I could it definitively could be improved).

I have begun to appreciate the need to differentiate between letting readers that a page is to be considered a yet to be finished construction site (though we in a way have that through the {{tl|incomplete}} template) and letting the reader (and other editors) that a page will receive a large amount of work for some hours or even days, usually the use for {{tl|WIP}}.

In summary i miss templates giving a clear distinction between conditions akin to "Under construction" and "Caution - Wet floors", rather than "being worked on" and "could need more work".

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 10:11, 17 February 2016 (EST)

== [[Fr/Pilote automatique]] ==
Bonjour,

Je viens de créer la page de traduction en français de l'article original en anglais [[Autopilot]]. Vu mes faibles compétences en matière de pilotage, vu que je n'ai pas sur ma version téléchargée d'avion avec un pilote automatique, la traduction doit souffrir quelques approximations, si ce n'est des contresens plus ennuyeux. Si quelques bonnes âmes plus qualifiées pouvaient me faire la grâce d'une relecture... merci d'avance.

Cordialement, et Hop ! --[[User:F-WTSS|F-WTSS]] ([[User talk:F-WTSS|talk]]) 15:30, 18 February 2016 (EST)

== MediaWiki updated to 1.26.2 ==
I've updated MediaWiki to the latest stable release (1.26.2) today. I've still got to update some of the extensions, so there may be regressions for now. Please report bugs if you find any. For a list of changes, see https://www.mediawiki.org/wiki/Release_notes/1.26

[[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 10:47, 19 February 2016 (EST)

: Cheers! I was hoping that it would solve the uneditable Chinese, Russian, and other non-latin character-based pages (Polish strangely as well), but unfortunately [[FlightGear_wiki:Village_pump/Archive_2015#UTF-8_language_pages_cannot_be_edited|that issue remains]].

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 10:54, 19 February 2016 (EST)

:: Hm, looks that will require quite some attention indeed. I'm afraid that'll has to wait for now.
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

=== Nasal Syntaxhighlighting ===
: Thanks for your efforts, btw: Nasal syntax highlighting is gone again.
: {{unsigned|17:22, 19 February 2016‎|Hooray}}

:: Unfortunately this time it isn't me forgetting to copy a file. The SyntaxHighlight extension no longer uses GeSHi, but has switched to Pygments. This means our Nasal mapping no longer works and has to be re-written. If anyone is interested, be my guest. See http://pygments.org/docs/lexerdevelopment/
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

::: Hi Gijs,
::: I'm interested in making a Pygments Nasal lexer, but unfortunately I won't be able to work on it until the end of March at the earliest.
::: [[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:59, 23 February 2016 (EST)

:::: Unless Gijs is facing any problems, I don't think it's necessarily needed, see my comment/suggestion in this revision: [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=93166] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:20, 23 February 2016 (EST)

:::Hi Gijs,
:::Here's the code for a Nasal lexer. Be warned, it's thoroughly untested, but has the following features:
:::* Full support for all three string types (backtick, single quote, and double quote), including escapes and formatting strings (e.g., for {{func link|sprintf}}).
:::* All kinds of numbers, including numbers in scientific notation and octal and hex numbers.
:::* All global functions and variables as of FG v2016.1.1.
:::* Some of the commonly-used <code>props.Node</code> methods.
:::* All the other things that can be expected (keywords, punctuation, etc.).
:::I have also created a lexer based on the XML lexer for XML with embedded Nasal, which I thought would be useful.
:::Regards,
:::[[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:35, 2 April 2016 (EDT)

:::http://pygments.org/docs/lexerdevelopment/#adding-and-testing-a-new-lexer
:::<syntaxhighlight lang="python" enclose="div">
# -*- coding: utf-8 -*-
"""
Lexer for Nasal.
"""

from pygments.lexer import RegexLexer, words, include, inherit, bygroups, using
from pygments.token import Text, Keyword, Name, String, Number, Operator, Punctuation, Comment
from pygments.lexers.html import XmlLexer

__all__ = ['NasalLexer', 'XMLNasalLexer']

class NasalLexer(RegexLexer):

name = 'Nasal'
aliases = ['nasal']
filenames = ['*.nas']

tokens = {
'formatters': [
(r'%[-#0 +]*(?:[0-9]+)?(?:\.[0-9]+)?[dis%couxXeEfFgG]', String.Interpol),
],
'backtick': [
(r'`', String.Backtick, '#pop'),
(r'[^`\\]+', String.Backtick),
(r'\\n|\\r|\\t|\\`|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
],
'sqstring': [
(r"'", String.Single, '#pop'),
(r"[^'\\%]+", String.Single),
(r"\\'", String.Escape),
include('formatters'),
],
'dqstring': [
(r'"', String.Double, '#pop'),
(r'[^"\\%]+', String.Double),
(r'\\n|\\r|\\t|\\"|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
include('formatters'),
],
'root': [
(r'\s+', Text),
(r'#.*?$'m, Comment.Single),
(r':|\?|[!=<>+\-*\/~&|^]=?', Operator),
(words(('or', 'and'), suffix=r'\b'), Operator.Word),
(r'[{(\[})\]\.;,]', Punctuation),
(words(('for', 'foreach', 'forindex', 'while', 'break', 'return', 'continue', 'if', 'else', 'elsif'), suffix=r'\b'), Keyword),
(words(('var', 'func'), suffix=r'\b'), Keyword.Declaration),
(words(('nil'), suffix=r'\b'), Keyword.Constant),
(words(('me', 'arg'), suffix=r'\b'), Name.Builtin.Pseudo),
(words(('new', 'del', 'getNode', 'getParent', 'getChild', 'getChildren', 'removeChild', 'removeChildren', 'removeAllChildren', 'getName', 'getIndex', 'getType', 'getAttribute', 'setAttribute', 'getValue', 'setValue', 'setIntValue', 'setBoolValue', 'setDoubleValue', 'unalias', 'alias', 'getPath', 'getBoolValue', 'remove', 'setValues', 'getValues', 'initNode'), suffix=r'\b'), Keyword.Pseudo),
(r'0o[0-7]+', Number.Oct),
(r'0x[0-9a-fA-F]+', Number.Hex),
(r'\d*(?:\.\d*)?[eE][+-]?\d+', Number.Float),
(r'\d*\.\d*', Number.Float),
(r'\b[0-9]+\b', Number.Integer),
(words(('D2R', 'R2D', 'FT2M', 'M2FT', 'IN2M', 'M2IN', 'NM2M', 'M2NM', 'KT2MPS', 'MPS2KT', 'FPS2KT', 'KT2FPS', 'LB2KG', 'KG2LB', 'GAL2L', 'L2GAL'), suffix=r'\b'), Name.Variable.Global),
(words(('abort', 'abs', 'addcommand', 'airportinfo', 'airwaysRoute', 'assert', 'carttogeod', 'cmdarg', 'courseAndDistance', 'createViaTo', 'createDiscontinuity', 'createWP', 'createWPFrom', 'defined', 'directory', 'fgcommand', 'findAirportsByICAO', 'findAirportsWithinRange', 'findFixesByID', 'findNavaidByFrequency', 'findNavaidsByFrequency', 'findNavaidsByID', 'findNavaidsWithinRange', 'finddata', 'flightplan', 'geodinfo', 'geodtocart', 'getprop', 'greatCircleMove', 'interpolate', 'isa', 'logprint', 'magvar', 'maketimer', 'md5', 'navinfo', 'parse_markdown', 'parsexml', 'print', 'printf', 'printlog', 'rand', 'registerFlightPlanDelegate', 'removecommand', 'removelistener', 'resolvepath', 'setlistener', 'setprop', 'settimer', 'srand', 'systime', 'thisfunc', 'tileIndex', 'tilePath', 'values'), suffix=r'\b'), Name.Builtin),
(words(('append', 'bind', 'call', 'caller', 'chr', 'closure', 'cmp', 'compile', 'contains', 'delete', 'die', 'find', 'ghosttype', 'id', 'int', 'keys', 'left', 'num', 'pop', 'right', 'setsize', 'size', 'sort', 'split', 'sprintf', 'streq', 'substr', 'subvec', 'typeof'), suffix=r'\b'), Name.Builtin),
(words(('_createCondition', '_fgcommand', '_interpolate', '_setlistener'), suffix=r'\b'), Keyword.Reserved),
(r'`', String.Backtick, 'backtick'),
(r"'", String.Single, 'sqstring'),
(r'"', String.Double 'dqstring'),
(r'\b_\w*?\b', Keyword.Reserved),
#(r'\b\w*?\b', Name),
]
}

class XMLNasalLexer(XmlLexer):
"""
For Nasal code embedded in XML files.
"""

name = 'XML-Nasal'
aliases = ['xml-nasal', 'xml-ns']

tokens = {
'root': [
(r'(<(?:load|unload|script)>)(<!\[CDATA\[)?(.*?)(]]>)?(</(?:load|unload|script)>)', bygroups(Name.Tag, Comment.Preproc, using(NasalLexer), Comment.Preproc, Name.Tag),
inherit,
],
}
</syntaxhighlight>

:: We can use the ECMAScript/JavaScript lexer[http://pygments.org/docs/lexers/#lexers-for-javascript-and-related-languages] for now, my suggestion would be to copy that over to a file so that we can work on a custom Nasal lexer (Syntax is almost identical, with a few different keywords, and many others being irrelevant). What is missing/different can be obtained from other lexers that are similar, e.g. [http://pygments.org/docs/lexers/#lexers-for-other-c-like-languages] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:45, 19 February 2016 (EST)

:: Okay, here's the better/quick&easy way: We have Nasal support for some fairly popular editors, like [http://wiki.flightgear.org/Howto:Syntax_highlighting_for_Nasal#Vim|vim](originally created by Melchior<ref>https://sourceforge.net/p/flightgear/flightgear/ci/next/tree/scripts/syntax/nasal.vim</ref>), listed at [[Howto:Syntax_highlighting_for_Nasal]] - there are various free converters available that will read such a syntaxhighlighting file and convert it to a pygments class, e.g. see: https://github.com/honza/vim2pygments [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:00, 19 February 2016 (EST)

==== References ====
<references />

== The repository link templates ==
=== Complete overhaul of the repository link templates ===

I have now performed a complete overhaul of the repository link templates (see {{tl|repo link/doc related}}). This was motivated by the incomplete state of these templates, the lack of standardisation, the lack of SourceForge git repository support for {{tl|repo link}}, web-interface only support, etc. I have used a lot of recursive transclusion for standardisation, so that there is a single point for updating for any FlightGear infrastructure changes. This is the master {{tl|repo link}} template. All the other templates are subtemplates which recursively transclude from this master template. I have also created a number of documentation templates for simplifying template maintenance (see {{tl|repo link/doc related‎}}, {{tl|repo link/doc specific file git‎‎}}, {{tl|repo link/doc git clone‎‎}}, and {{tl|repo link/doc commit}}). The changes were constrained to maintain backwards compatibility as much as possible. However I would like to break this to allow the following templates to be updated to transclude from the master {{tl|repo link}} template:

* {{tl|flightgear file}},
* {{tl|simgear file}},
* {{tl|fgdata file}},
* {{tl|fgaddon file}}.

If no one objects, I would like to completely break these and expand and rename the parameter set to match the other <nowiki>{{* file}}</nowiki> repository templates (e.g. {{tl|terragear file}}). My overhaul currently does not include Hooray's ideas for non command line usages, i.e. different GUIs, but it enables it to be easily added via the master template and the addition of a single parameter to any subtemplates.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 15:05, 25 February 2016 (EST)

: I don't have any objections myself, I appreciate all the work you are putting into this, and would like to thank you for helping us clean up all that mess by doing such unglamorous work ;-) I also appreciate that your changes would facilitate adding a non-CLI mode to the corresponding templates. However, I would suggest to wait for Gijs' feedback, because he's ultimately the most likely person to veto something around here ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:31, 25 February 2016 (EST)

:: Johan seems to be the one who did a lot of the initial work on these <nowiki>{{* file}}</nowiki> templates, and Red Leader with the {{tl|repo link}} template. And they were involved in the general discussions ([[http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=87148#Repository_link_templates perm]). But I know Gijs was also involved in the design.

:: For the non-CLI mode, that will need -a lot- more planning. For example a definitive list of all these modes would be useful. Should this use an optional Mediawiki pop up extension showing a link to a general page that describes the action for all different GUIs, CLI, etc.? Should we have a switch box so that the reader can switch in-text between CLI, and the numerous GUIs? Are we going to have a large set of screenshots for each GUI? If so, I would strongly recommend the [https://www.mediawiki.org/wiki/Extension:Labeled_Section_Transclusion labelled section transclusion extension] for creating a single page for one GUI with everything for that GUI, as a tutorial. Here is [http://wiki.nmr-relax.com/Relax_4.0.1 an external example where I have used this], to fragment the base release page to create [http://wiki.nmr-relax.com/Relax_release_descriptions this meta page], as well as many other meta pages.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:14, 26 February 2016 (EST)

I am also thinking of changing the name of the <nowiki>{{* file}}</nowiki> templates, as I hope to make the scope of the templates far more general. The name <nowiki>{{* source}}</nowiki> or <nowiki>{{* repo}}</nowiki> might be better. For example these will allow the repository commit, tree view, log view (and maybe rss feed), with or without a file/directory path. And I would like to generalise this to handle both the SF web-interface and non-web net protocols (git://, ssh://, svn://, etc.). It will allow for CLI instructions to be built up and embedded in <nowiki>{{#tag:source|<content>|lang=sh}}</nowiki> tags. And I will defer all infrastructure decisions in the subtemplates to the single point of {{tl|project infrastructure}}, so that if there are changes in the future, then only this single template needs to be updated to update the entire wiki.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:22, 26 February 2016 (EST)

: The {{tl|project infrastructure}} template as a single point provider of various project infrastructure names and URL pairs seem like a great idea. If it work out well it will really lessen the maintenance by having less places needing updates, while allowing the various repository templates to be simple to use, in essence by having comprehensible names and no boiler plate parameters for their users.
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 15:15, 27 February 2016 (EST)

==== Repository link update ====
For those following, I have massively expanded the capabilities of the {{tl|repo link}} template:
* The SourceForge URLs are now comprehensive.
* Full support for the new query-based URLs for the Gitorious archives.
* Functional GitLab URLs.
* Generic repository support (used to create the {{tl|openscenegraph co}} template).
* Detailed documentation and extensive examples for checking the implementation (if you find any non-supported links, please add these as examples).
* Isolation of the '''cmd''' parameter from the CLI options — this is to enable future support for non-CLI instructions based on the value of '''cmd'''.

I have also completed a large set of subtemplates of {{tl|repo link}}, see the list at {{tl|repo link/doc related}}. This includes a full set of <nowiki>{{* source}}</nowiki> templates. I have left the original <nowiki>{{* file}}</nowiki> templates, rather than renaming and modifying them, so these are now redundant. All of the <nowiki>{{* source}}</nowiki>, <nowiki>{{* commit}}</nowiki>, <nowiki>{{* clone}}</nowiki>, and <nowiki>{{* co}}</nowiki> templates transclude from the master {{tl|repo link}} template to do all of the work.

One important template is {{tl|gitorious source}}. The support for the new query-based URLs for the Gitorious archives is now quite comprehensive in {{tl|repo link}}. Therefore I have converted almost every single FlightGear wiki link to https://gitorious.org to use {{tl|gitorious source}} instead. This fixes a lot of broken links and broken git instructions. I have reduced the number of hits for gitorious.org on the wiki (searching just for "gitorious") to 22 hits. This includes 2 very outdated articles ([[FlightGear Git: aircraft authors]], [[Fr/FlightGear et Git]]), 15 locked newsletters, 1 with no longer existent Gitorious merge request links, and 4 base URL links for Hangars. This way we can maintain the Gitorious web interface links and git command instructions in a functional state by simply updating the single source of {{tl|repo link}}.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 11:38, 29 February 2016 (EST)

: I just remembered [[Special:LinkSearch]], so make that 184 broken gitorious.org links remaining. Lots more work to do :)

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:46, 29 February 2016 (EST)

For some of these templates, e.g. {{tl|repo link/doc usage}}, I'm trying to implement some logic for automatic whitespace padding for documentation formatting, but the <code><nowiki>{{#len:string}}</nowiki></code> function is not enabled. According to {{mediawiki|Wikitext_parser/Core_parser_functions#.23len}} and {{mediawiki|Extension:StringFunctions}}, the option <code>$wgPFEnableStringFunctions = true;</code> should be set (in <code>LocalSettings.php</code>). Unless there is a reason for not using this, I was wondering if someone could enable this? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 09:53, 8 March 2016 (EST)

=== Archived newsletters and dead links? ===

Do we have a policy for the dead links in the FlightGear newsletters? It is obviously good to preserve the historic state. But there are many Gitorious links that could be made functional again using the {{tl|gitorious source}} template to point to the historic Gitorious archives (including the official FlightGear repositories, rather than using {{tl|fgdata source}}, for example). The https://gitorious.org links have been converted from URL/path based to query based, so absolutely all of the old links are broken. I am steadily converting all Gitorious links to use the [[Template:repo link/doc related|{{obr}}repo link{{cbr}} family of templates]], with the exception of the newsletters.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 04:52, 8 March 2016 (EST)

: I think it could be a good idea to try update old links in those newsletters. I sometimes look back at things and tend to think that I probably are not the only one doing that.
: I wonder if the rotten links should be replaced or stricken, but I think they could just as well be replaced. The key thing is that they go to the same resource or content, not weather they have been updated or not (also, the change will be visible in the revision history after all).
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 07:11, 8 March 2016 (EST)

:: I should add that I'm using [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=http%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] and [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>]. And I am also not touching the <code>User*</code> pages, <code>*talk*</code> pages, or pages tagged as out of date or up for deletion. For the newsletters I might look at these later when the broken Gitorious links are fixed in the rest of the wiki but, as these are locked, someone else might have make the switch to {{tl|gitorious source}}, {{tl|gitorious url}}, {{tl|gitorious clone}}, and {{tl|gitorious merge request}}.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 02:53, 9 March 2016 (EST)

::: I will temporarily add a table here for the templates in the newsletters and will slowly fix them one by one together with any other admin.
{{navbox
| title = Click "show" to show -->
| state = collapsed
| navbar = plain
| list1 =
http:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!}} No equivalent link for the Gitorious archive - project pages are dead. Maybe just use http://gitorious.org/?
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!}} Functional link, equivalent to {{gitorious url|fg|flightgear|commit=5c6fe952598053fa63631fc0161d666f22a50f51}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/headtrack

http://gitorious.org/arduinocockpit
{{!}} Project pages are dead, switched to {{gitorious url|headtrack|headtrack}}

{{gitorious url|arduinocockpit|arduinocockpit}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/arduinocockpi

http://gitorious.org/headtrack
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Missing project - i.e. {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra|text=migrated to GitLab}}. Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2011]]
{{!}} http://gitorious.org/flightgear-aircraft
{{!}} Switched to {{gitorious source}} and rephrased text slightly to help readers find the repositories.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} http://gitorious.org/anders-hangar/mtb_20m/trees/master
{{!}} Switch to {{gitorious url|proj=anders-hangar|repo=mtb_20m}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} http://gitorious.org/fg/flightgear/blobs/next/scripts/java/FGClient/src/FGFSDemo.java
{{!}} Switched to {{gitorious url|proj=fg|repo=flightgear|path=scripts/java/FGClient/src/FGFSDemo.java}}. This points to the old Gitorious repository to protect against path changes in the future.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2014]]
{{!}} http://gitorious.org/nasal-support/nasal-npp
{{!}} Switched to {{gitorious url|nasal-support|nasal-npp}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2015]]
{{!}} http://gitorious.org
{{!}} Switched to {{tl|gitorious source}} without parameters for the Gitorious base URL, to future-protect it.
{{!}}}

https:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/papillon81/flightgear-custom-scenery/

https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery

https://gitorious.org/papillon81/flightgear-custom-scenery/
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter December 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Fr/Nouvelles du projet FlightGear - décembre 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2012]]
{{!}} https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/README

https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/doc/doc-en.htm
{{!}} Switched to {{fgdata source|path=Aircraft/Instruments-3d/garmin196/README|full=1}} and {{fgdata source|path=Aircraft/Instruments-3d/garmin196/doc/doc-en.htm|full=1}} to point to the current FGData locations and removed the name "Gitorious" to make the text of the Garmin 196 GPS section still relevant
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter August 2012]]
{{!}} https://gitorious.org/mil-mi-6
{{!}} Switched to {{gitorious url|proj=mil-mi-6|repo=mi6dev}}, and changed from the non-existent project page to the main repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} https://gitorious.org/fgradar
{{!}} Switched from the project page to the direct repository {{gitorious url|fgradar|fgradar}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} https://gitorious.org/fg/flightgear/commit/913727239d6776c0508d206f395e16c265413ec3

https://gitorious.org/fg/flightgear/commit/eba03b5e469824ee8f1494723fcddbbc56155a08
{{!}} Switched to {{flightgear url|commit=913727239d6776c0508d206f395e16c265413ec3}} and {{flightgear url|commit=eba03b5e469824ee8f1494723fcddbbc56155a08}}. This deliberately points to the current repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2013]]
{{!}} https://gitorious.org/fg-radi/osm2city

https://gitorious.org/scenery-france-850
{{!}} Switched to the new GitLab repository {{gitlab source|proj=fg-radi|repo=osm2city|full=1}}

and removed the no longer existent scenery-france-850 repository, replacing it with "<s>Scenery repository (Gitorious)</s>".
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Switched to {{gitorious source|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console/repl.nas|line=708}}

{{gitorious url|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console|view=tree}}

{{fgdata-old url|commit=eaaf816b772649d5b0826a1d0bdd166dbc5b968f}}

{{flightgear commit|34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353}}

{{gitorious merge request|mr=54}}

{{gitorious merge request|mr=26}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Changes match the English article.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} https://gitorious.org/fg/fgdata/flightgear?p=fg/fgdata:flightgear.git;a=blob;f=keyboard.xml

https://gitorious.org/fg/fgdata?p=fg:fgdata.git;a=commit;h=f8c56dcc52ffd3d6dfca1d39dc4a72b6b3478368

https://gitorious.org/fg/hoorays-flightgear?p=fg:hoorays-flightgear.git;a=shortlog;h=refs/heads/topics/cppbind-fgprotocol
{{!}} This first link was the broken {{tl|git link}} template (see the table below). The other two links are not in the article?!
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter June 2014]]
{{!}} https://gitorious.org/eddp-custom-scenery/eddp-custom-scenery/
{{!}} Switched to {{tl|gitorious clone}} to provide functional '''git clone''' instructions.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2014]]
{{!}} https://gitorious.org/fg/hoorays-fgdata/source/2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876:Nasal/ai/aim9/aim9.fdm#L9
{{!}} Switch to {{gitorious url|proj=fg|repo=hoorays-fgdata|commit=2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876|path=Nasal/ai/aim9/aim9.fdm|line=9}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2015]]
{{!}} https://gitorious.org/fg/canvas-hackers-fgdata/source/f59c42134a5a77e343981dcff8278c3e2f094e87
{{!}} Switch to {{gitorious url|proj=fg|repo=canvas-hackers-fgdata|commit=f59c42134a5a77e343981dcff8278c3e2f094e87|view=summary}}
{{!}}}

Broken templates:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Template !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} {{tlx|Git link|gitorious|fg/fgdata|master|keyboard.xml|pre=$FG_ROOT/}}
{{!}} Switched to {{fgdata source|path=keyboard.xml|pre=$FG_ROOT}} to fix the Gitorious link created by the broken and depreciated {{tl|git link}} template.
{{!}}}

}}

::: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 12:06, 9 March 2016 (EST)

:::: I've added a '''notes''' column to help a little.

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:30, 9 March 2016 (EST)

=== Elimination of the dead Gitorious links ===
Thanks largely to the diversity and flexibility of the [[:Category:Repository link templates|{{obr}}repo link{{cbr}} family of templates]], I have now managed to eliminate almost every last dead Gitorious link in the FlightGear wiki! The locked Newsletter articles, user pages, and talk pages are the only exceptions. The page counts from the (Main) namespace are:
* [http://wiki.flightgear.org/index.php?target=http%3A%2F%2Fgitorious.org&namespace=0&title=Special%3ALinkSearch <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] — 37. Of these, 17 are for the front page with the news of the Gitorious to SourceForge migration, and the rest are Newsletters.
* [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org&namespace=0 <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>] — 166. Most of these links are valid and created by the {{obr}}gitorious *{{cbr}} subtemplates of {{tl|repo link}}. The remaining broken links are all in the locked Newsletters.
The Howto:* pages are not in the (Main) wiki namespace, but I've knocked those out too.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:54, 10 March 2016 (EST)

: thanks for doing all this unglamorous work - I am sorry that Gijs was apparently too busy to follow up on my suggestion to either provide you with admin access around here, or at least to help you run a Python script to do all this work in an automated, rather than manual, fashion. Hopefully, things will work out better next time. Again, thank you. Like I said, I think you should definitely be given admin access on the wiki, especially given your recent contributions - and I would gladly have my wiki status downgraded accordingly. In fact, if I was able to directly promote accounts accordingly, I would have done so months ago - however, it seems that Gijs is the only one to have those privileges, and he mentioned off-list that he's kinda busy with RL/exams etc, so it is to be expected that he's going to become a bottleneck more often - hopefully, this will be recongized as an actual issue, so that there will be more people able to promote new wiki admins. Sorry that things didn't work out better this time, and thanks so much for doing all this stuff manually. -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:49, 10 March 2016 (EST)

:: No problems! As for automating this, that would not have been possible. If you look at the changes, you'll see that each one is different <sup>[http://wiki.flightgear.org/index.php?title=Special:RecentChanges&to=20160310210655&limit=500]</sup>. I had to check each one, and update the link as required.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 16:08, 10 March 2016 (EST)

::: There's three of us actually (Curt, Simon and myself), no need to wait on me. See http://wiki.flightgear.org/index.php?title=Special%3AListUsers&username=&group=bureaucrat&limit=100 (Sek is inactive nowadays) ;-)
::: Please note that forum pms are really not the best way to contact me. I very much prefer email over forum pms as it's a lot easier to filter out the huge amounts of nonsense I'm receiving from stuff requiring actual attention.
::: Anyhow I've just promoted Bugman so he can edit locked articles.
::: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 05:06, 11 March 2016 (EST)

:::: Thank you. I'll try to preserve the original intent of the Newsletters while fixing the broken links (maybe even preserving any original URLs as Mediawiki link text, while pointing to the new URL). I will use the {{obr}}gitorious *{{cbr}} templates to point to the historical sources, and will probably use this for all of the Gitorious URLs so that we have full control over any future URL breakages via the single location of {{tl|repo link}}. For example, if they change the gitorious.org domain name to a https://archive.org subdomain (i.e. gitorious.archive.org).

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 06:40, 11 March 2016 (EST)

=== Regex parsing of template parameters? ===

For the {{tl|repo link}} template, I am currently trying to work out what to do for git branches and tags on the SourceForge infrastructure. The problem is that the presence of the character <code>/</code> within a branch or tag name requires the text <code>/~</code> to be appended to that name in the URL, for example:

* Tag <code>version/2016.1.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/version/2016.1.1/~/tree/simgear/ephemeris/ephemeris.cxx
* Branch <code>release/2016.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/release/2016.1/~/tree/simgear/ephemeris/ephemeris.cxx

I haven't found out a way to use regex to parse the <code>tag</code> or <code>branch</code> template parameters to automate this, hence I am thinking of just giving the instruction for the template user to append this text to the <code>tag</code> or <code>branch</code> parameter text themselves. However this is not ideal - a change of this behaviour on the SourceForge side requires end pages with SourceForge URLs to be updated, rather than just updating {{tl|repo link}}. I was wondering about possibility of installing the extension:

* [https://www.mediawiki.org/wiki/Extension:RegexParserFunctions Extension:RegexParserFunctions]

Though I'm not 100% sure if that will work. Or does someone else know an alternative? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:09, 22 April 2016 (EDT)

: not a solution, just a potential workaround would be checking for the most common prefix strings used in tags/branches (e.g. version, release, topic, topics) and explicitly rewrite the URL accordingly to append the /~ suffix -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 22 April 2016 (EDT)

:: That might be a solution. But I don't know how to do that without regex ;) We really only have #ifeq statements, but that has to match the whole string.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:44, 22 April 2016 (EDT)

== Discussion about quotes on the wiki ==
{{usr|Hooray}} have started a page now at [[FlightGear wiki:Quoting Guidelines]] ([http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Quoting_Guidelines&oldid=96104 perm]) for a discussion regarding guidelines for the use of quotes on the wiki. Join the discussion.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 18:17, 21 March 2016 (EDT)

In slight relation to this I have tried to make the wiki more consistently use the most common spelling and case, "Instant-Cquotes" and have changed the automatic categorization accordingly. All articles using the {{tl|FGCquote}} template can now be found in [[:Category:Articles containing Instant-Cquotes]] (currently some ~250 articles).

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 08:21, 23 March 2016 (EDT)

== Reorganizing the Git articles ==
I've noticed that the [[Category:Git|Git articles]] suffer from duplication and are in part obsolete (especially with regard to the instructions for running Git on Windows). Thus, I propose the following reorganization:
* [[Development workflow]]: reorganization to explain how the patch submission process is organized from a high-level point of view (forking the repository from SourceForge, developing, pushing the commits to the personal fork, submitting a merge request/sending a patch to the mailing list);
* [[FlightGear Git]]: leave as is;
* '''Installing and configuring Git''' - new article about installing Git and configuring it (setting the username/e-mail address); merge the contents of [[FlightGear Git on Windows]] and [[Resources WRT running git on Win32]] here;
* [[FlightGear Git for laymen]] - make it follow [[FGW:MOS]], merge the contents of [[Howto:Start using git]] here;
* [[FlightGear Git: core developers]] and [[FlightGear Git: data developers]] - I'm uncertain about what I should do with them: the only piece information that would not be written in other articles is the list of alternative methods for cloning FGData;
* [[FlightGear Git: gitiquette]] and [[FlightGear Git: tips]] - make them follow [[FGW:MOS]].
Any comments? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:11, 13 May 2016 (EDT)

: This is sorely needed! For [[FlightGear Git: core developers]] and [[FlightGear Git: data developers]], maybe these can be merged into something like [[FlightGear Git: working with the repositories]]? The only real difference is the URL, but that is a minor difference with the [[:Category:Repository link templates]]. This could be generalised into a set of instructions for working with all git repositories for the core infrastructure, including forking and merge requests, with a current focus on the SourceForge web and non-web interfaces.

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 08:17, 13 May 2016 (EDT)

:: Yes, I was thinking about a similar solution as well. -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 10:16, 13 May 2016 (EDT)

Mailing lists

2016-05-13T10:15:37Z

Elgaton: /* How to subscribe to a mailing list */ Completed missing sentence

'''Mailing lists''' are used for some of the FlightGear community's communications, in particular among the core developers who are working on the flight simulator itself.

Some questions are better asked on the mailing list instead of the forum, especially those related to core development or project infrastructure, but you do not strictly have to be a core developer to subscribe and/or post to the mailing lists.

== The mailing lists ==
{| class="wikitable"
! List
! Contents

! Archive
! Subscribe
! E-mail address
! Remarks

|-
| flightgear-announce
| FlightGear announcements
| {{Mailing list archive|flightgear-announce}}
| {{Mailing list subscription link|flightgear-announce}}
| {{Mailing list e-mail address|flightgear-announce}}
|
|-
| rowspan="1" style="background: #ff6e67; color: black; vertical-align: middle;" | flightgear-bugs
| Bug tracker messages
| {{Mailing list archive|flightgear-bugs}}
| {{Mailing list subscription link|flightgear-bugs}}
| {{Mailing list e-mail address|flightgear-bugs}}
| Apparently dismissed
|-
| flightgear-builds
| Chatter from the FlightGear build servers
| {{Mailing list archive|flightgear-builds}}
| {{Mailing list subscription link|flightgear-builds}}
| {{Mailing list e-mail address|flightgear-builds}}
|
|-
| flightgear-commitlogs
| Source code change commit logs
| {{Mailing list archive|flightgear-commitlogs}}
| {{Mailing list subscription link|flightgear-commitlogs}}
| {{Mailing list e-mail address|flightgear-commitlogs}}
| As of May 2016, commit logs over 160 KB need to be approved manually by the list moderator; therefore, their delivery might be delayed.<ref>{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33913347/
|title=<nowiki>Re: [Flightgear-devel] [Flightgear-commitlogs] [FGData] FlightGear data - next generation branch next updated. 7b595eca19e1bfb83ae330c02f2eeec5e9c9da58</nowiki>
|author=<nowiki>Curtis Olson</nowiki>
|date=<nowiki>2015-04-19</nowiki>
}}</ref> In the future, bigger logs might not be sent anymore to the list in their entirety, to keep messages short and readable.<ref>{{cite web
|url=http://sourceforge.net/p/flightgear/mailman/message/33913630/
|title=<nowiki>Re: [Flightgear-devel] [Flightgear-commitlogs] [FGData] FlightGear data - next generation branch next updated. 7b595eca19e1bfb83ae330c02f2eeec5e9c9da58</nowiki>
|author=<nowiki>Edward d'Auvergne</nowiki>
|date=<nowiki>2015-04-19</nowiki>
}}</ref><ref>{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/33913846/
|title=<nowiki>Re: [Flightgear-devel] [Flightgear-commitlogs] [FGData] FlightGear data - next generation branch next updated. 7b595eca19e1bfb83ae330c02f2eeec5e9c9da58</nowiki>
|author=<nowiki>Curtis Olson</nowiki>
|date=<nowiki>2015-04-19</nowiki>
}}</ref>
|-
| rowspan="1" style="background: #ff6e67; color: black; vertical-align: middle;" | flightgear-cvslogs
| CVS commit logs
| {{Mailing list archive|flightgear-cvslogs}}
| {{Mailing list subscription link|flightgear-cvslogs}}
| {{Mailing list e-mail address|flightgear-cvslogs}}
| Apparently dismissed
|-
| flightgear-devel
| FlightGear developer discussions
| {{Mailing list archive|flightgear-devel}}
| {{Mailing list subscription link|flightgear-devel}}
| {{Mailing list e-mail address|flightgear-devel}}
| Most active list
|-
| flightgear-fgaddon-commitlogs
| Commit logs for the [[FGAddon]] repository (content developers)
| {{Mailing list archive|flightgear-fgaddon-commitlogs}}
| {{Mailing list subscription link|flightgear-fgaddon-commitlogs}}
| {{Mailing list e-mail address|flightgear-fgaddon-commitlogs}}
|
|-
| flightgear-flightmodel
| Flight model discussions
| {{Mailing list archive|flightgear-flightmodel}}
| {{Mailing list subscription link|flightgear-flightmodel}}
| {{Mailing list e-mail address|flightgear-flightmodel}}
|
|-
| flightgear-newsletter
| [[FlightGear Newsletter|Newsletter]] announcements and discussions
| {{Mailing list archive|flightgear-newsletter}}
| {{Mailing list subscription link|flightgear-newsletter}}
| {{Mailing list e-mail address|flightgear-newsletter}}
|
|-
| flightgear-scenery
| Discussion of scenery development: code, tools, GIS data, models, etc.
| {{Mailing list archive|flightgear-scenery}}
| {{Mailing list subscription link|flightgear-scenery}}
| {{Mailing list e-mail address|flightgear-scenery}}
|
|-
| flightgear-users
| FlightGear user discussions
| {{Mailing list archive|flightgear-users}}
| {{Mailing list subscription link|flightgear-users}}
| {{Mailing list e-mail address|flightgear-users}}
| Mostly replaced by [http://forum.flightgear.org the forum]
|}

== How to subscribe to a mailing list ==
To sign up for one of the above mailing lists, follow these steps:

# Click a '''Subscribe''' link in the list above to get to the mailing list subscription form.
# Enter your e-mail address in the '''Your email address:''' box. You can optionally also:
#* give your name;
#* choose to receive e-mails ''batched in a daily digest'' (merged in a single message) or not;
#* choose a password you can use to edit your subscription options in the future. If you do not enter a password, one will be automatically generated for you.
{{warning|Do not use a valuable password as it will be occasionally sent to you via e-mail (this means that someone snooping on your messages might be able to get it).}}
<ol start="3">
<li>Click the {{button|Subscribe}} button.</li>
<li>You will be sent a confirmation e-mail (usually it is delivered within ten seconds, but it can take up to a few minutes; if you do not see it, check your Spam folder). Click on the confirmation link in the message.</li>
<li>SourceForge will display you a confirmation page where you can change some settings chosen in step 2. Click on {{button|Subscribe to list ''list name''}} to complete the process.</li>
</ol>

== Posting to mailing lists ==
To protect list subscribers from spam, you are allowed to post there only after you have subscribed, and to send e-mails from the address you are subscribed with.<ref name="MLPolicy">{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=244916
|title = <nowiki>Re: Why is my post rejected from devel list?</nowiki>
|author = <nowiki>curt</nowiki>
|date = May 31st, 2015
|added = May 5th, 2016
|script_version = 0.32
}}
</ref> For the same reason, first posts are subject to moderator approval to catch the cases where people sign up for the sole purpose of posting spam.<ref name="MLPolicy" />

When posting to the lists, discuss your problem laying it out in as much detail you can and show that you are interested in the problem. If you are willing to work on it will also help, even if it is not related to coding itself. If your discussion is more than just asking for features to be added you have a better chance of getting help and you may find people there who can give you pointers on how to approach your problem. Also, be civil - avoid bringing conflicts or noise.

Keep in mind that getting a response from the lists is usually slower than the forum and that responses may take several days. Should it take more than a week, you might want to probe the interest by responding to your own message; sometimes, there might be no reply as there is none.

== Report bugs to the issue tracker ==
Bugs should preferably be {{create ticket|reported to the issue tracker}} instead of posting them to a mailing list.

You may have to {{register to sf|register a SourceForge account}} first.

== External links ==
* [http://www.flightgear.org/mail.html FlightGear mailing list details]
* [http://sourceforge.net/p/flightgear/mailman/ List of all project mailing lists on SourceForge]

{{appendix}}

[[Category:FlightGear]]
[[Category:Community]]

Talk:Mailing lists

2016-05-13T10:14:40Z

Elgaton: Moved additional info to main page as references

== Template for mailing list URLs ==
we should set up a template for the rows in the table, so that we can easily reuse/localize everything elsewhere (as per the git/repo link templates)
* address
* archives
* subscribe
* comments
* description (localized)
* status

--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:58, 20 April 2015 (EDT)

== Bug reports on mailing lists? ==
Is not that bad advice? Should not bug reports be redirected to the {{tickets|issue tracker}} in order to lessen unproductive/disruptive noise, in particular on the developer mailing list?

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 16:50, 10 May 2015 (EDT)

FlightGear wiki:Village pump

2016-05-13T10:11:59Z

Elgaton: Git articles reorganization

{{Archives|[[/Archive 2012|2012]]|[[/Archive 2013|2013]]|[[/Archive 2014|2014]]|[[/Archive 2015|2015]]}}
{{shortcut|FGW:VP}}
Welcome to the '''Village Pump'''. This page is used to discuss the technical issues, operations and guidelines of the [[FlightGear wiki]].

Please <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit&section=new}} add new topics]</span> to the '''bottom''' of this page.

Old discussion should be moved to a [[FlightGear wiki:Village pump/Archive YEAR]]. These discussions can then be moved to a relevant talk page if appropriate.

== Welcome template? ==
I have been thinking about suggesting a welcome template, for example named {{obr}}welcome{{cbr}}, to place on top of (at least) new users user discussion pages.

It should welcome the (new) user

In addition, it should probably mention and/or link to pages mentioning:
* The introduction page/tutorial (Hmm, I do not think I did finish that one. See [[Help talk:Tutorial]] ([http://wiki.flightgear.org/index.php?title=Help_talk:Tutorial&oldid=70843 perm])).
* Help pages
* How to use categories (in particular not like #tags, ;-) but also that image and article categories should be separate, but link to each other)
* The portals
* The style manual
* Discussion pages and where to discuss what:
** How to use discussion pages
** The wiki in general: The village pump (this page)
** Wiki articles: Article discussion pages
** Wiki user actions: User discussion pages

Maybe it should also mention that FGAddon aircraft, effects, other features etc. (except for their articles) and their bugs should be discussed on the forum, unless developers say otherwise, and that core features should be discussed on the developer mailing list and core bugs on the bug tracker.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 20:31, 30 January 2016 (EST)

: I think this is a great idea. A nice concise summary with links to help a new user navigate the FlightGear jungle would be a great addition. It should however remain very short with simple sentences - while being complete - as many users are not native speakers. So maybe there should be translations of the template with manually added links at the bottom for easy access to all the translations?

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:35, 12 February 2016 (EST)

:: Regarding an introduction article, I have come to the conclusion that a complete but long article is probably not as helpful as short but specific help pages. In essence the latter would be easier to navigate and absorb. I have therefore started to slowly split up some of the help pages and have added one more section to [[Help:Contents]].
:: I think that a welcome phrase, a link to that page and the [[FlightGear wiki:Manual of Style|style manual]] might actually suffice for a welcome template for now. It is at least better than what we currently have (i.e. more or less nothing).
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 14:47, 4 March 2016 (EST)

:: I now consider
::* A Welcome message
::* A link to this page
::* A link to the help pages
::* A link to the manual of style
::* Some final welcoming words

:: A welcome template should probably also very briefly mention a pet peeve of mine: the categories.
:: Many (if not most) image uploaders seem to treat them like tags, but if say all screenshots of aircraft (probably >2000) would end up at [[:Category:Aircraft]] (instead of under a subcategory to [[:Category:Screenshots of aircraft]]), of what use would that page be when looking for a specific one? If people would like to be able to search for an aircraft, a concise but comprehensive image description is very hard to beat.
:: How do I convey all that in a way that is, short, to the point and easy to absorb (and act by)? And where is the best place?
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:46, 8 March 2016 (EST)

:: An early draft is now at [[User:Johan G/Template:Welcome to the wiki]]
:: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 02:52, 18 April 2016 (EDT)

::: Some comments on the draft:
::: * I'm not fully sure about using a prominent box - I think it stands out a bit too much. Wikipedia {{wikipedia|Template:Welcome|uses a simple thread on the Talk page}}; as an alternative, we could use lighter colors.
::: * I've also expanded the text a bit. My proposal would be (I've put it in a box, but I'm for the "thread" solution):
<div style="background: #fff; border: 1px #585858 solid; padding: 12px; margin: 12px">
[[Image:Example.png|left]] '''Welcome to the FlightGear wiki, {{#if: {{{name|}}} | {{{name}}} | {{BASEPAGENAME}}}}'''! We hope you will enjoy your stay!

See [[Help:Contents#Reading|Reading]] to learn how wikis work. You can also [[Special:CategoryTree/Root category|browse the existing page categories]].

Should you wish to create or edit some articles, ''do so''! Here are some resources to get you started:
* [[Help:Contents#Editing|How to edit pages]]
* [[Help:Discussion pages|Discussion pages]], where we discuss and agree on potential improvements
* [[FlightGear wiki:Manual of Style|The Manual of Style]], a set of guidelines to help editors maintain a consistent style and formatting (please follow them)
* [[Help:Contents|Wiki help page]]

If you have any questions, just start a topic on the [[FlightGear wiki:Village pump|''Discuss!'' page]]. Again, welcome!
</div>
::: ...where the image on the left is an appropriately chosen icon.
::: Finally, we could use the {{mediawiki|Extension:NewUserMessage|NewUserMessage extension}} to have the wiki software automatically post the message to the new user's talk page.
::: ---- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 17:30, 1 May 2016 (EDT)

== Permanently removing spam bots ==
For permanently removing spam bots, has the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] Mediawiki extension been considered? I use that regularly on [http://wiki.nmr-relax.com my own wiki], though there we have also reverted to communicating to the person via email before manually granting access (probably not an option here), as all of the Mediawiki captcha methods were recently cracked.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:15, 12 February 2016 (EST)

: Oh, for the extension, we simply have a user called 'Spam bot' in a blocked state, and merge the spam bot accounts into this one, deleting the old account.
: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:20, 12 February 2016 (EST)

:: I'd use the [https://www.mediawiki.org/wiki/Extension:AbuseFilter abuse filter extension] instead (much more powerful and automated) - other users have also proposed different remedies, see [http://forum.flightgear.org/viewtopic.php?f=42&t=28734 this forum thread]. Anyway, Gijs is going to upgrade MediaWiki shortly and review the current anti-spam measures.
:: -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:26, 13 February 2016 (EST)

::: A lot of the spam bots are using their name as advertising nowadays, so the [https://www.mediawiki.org/wiki/Extension:UserMerge UserMerge] extension is the only one I know which will allow a user and associated name to be permanently deleted.

::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:04, 14 February 2016 (EST)

:::: The problem now is that they're also adding the information to the page title, so that it will still show up in the deletion logs [http://wiki.flightgear.org/Special:Log/delete] in other words, there's still some SEO juice associated with deleted entries ... Another idea would be to allow admins to temporarily disable wiki registrations/article creation, e.g. if more than 2 admins agree, this could be done to protect the wiki from spam attacks.

::::: Hooray, you should sign your posts ;) The bots don't target the deletion logs, as that's a little pointless. It's a Special:* page, and the default Mediawiki robots.txt file tells all search engines to not index these pages. User pages, page histories, etc. are however normally indexed.

::::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:36, 19 February 2016 (EST)

:: The point was not what the bots are targeting, but what shows up in the logs - i.e. SEO-wise - Gijs' article blacklist stuff should help with that hopefully. PS: I could not find the signature button on the mobile device I am using, and I am not too good at remembering the correct number of tildes ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:04, 19 February 2016 (EST)

== WIP vs. Under construction ==
I have been beginning to miss the under construction template[http://wiki.flightgear.org/index.php?title=Template:Under_Construction&direction=prev&oldid=46229] more and more (though I could it definitively could be improved).

I have begun to appreciate the need to differentiate between letting readers that a page is to be considered a yet to be finished construction site (though we in a way have that through the {{tl|incomplete}} template) and letting the reader (and other editors) that a page will receive a large amount of work for some hours or even days, usually the use for {{tl|WIP}}.

In summary i miss templates giving a clear distinction between conditions akin to "Under construction" and "Caution - Wet floors", rather than "being worked on" and "could need more work".

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 10:11, 17 February 2016 (EST)

== [[Fr/Pilote automatique]] ==
Bonjour,

Je viens de créer la page de traduction en français de l'article original en anglais [[Autopilot]]. Vu mes faibles compétences en matière de pilotage, vu que je n'ai pas sur ma version téléchargée d'avion avec un pilote automatique, la traduction doit souffrir quelques approximations, si ce n'est des contresens plus ennuyeux. Si quelques bonnes âmes plus qualifiées pouvaient me faire la grâce d'une relecture... merci d'avance.

Cordialement, et Hop ! --[[User:F-WTSS|F-WTSS]] ([[User talk:F-WTSS|talk]]) 15:30, 18 February 2016 (EST)

== MediaWiki updated to 1.26.2 ==
I've updated MediaWiki to the latest stable release (1.26.2) today. I've still got to update some of the extensions, so there may be regressions for now. Please report bugs if you find any. For a list of changes, see https://www.mediawiki.org/wiki/Release_notes/1.26

[[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 10:47, 19 February 2016 (EST)

: Cheers! I was hoping that it would solve the uneditable Chinese, Russian, and other non-latin character-based pages (Polish strangely as well), but unfortunately [[FlightGear_wiki:Village_pump/Archive_2015#UTF-8_language_pages_cannot_be_edited|that issue remains]].

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 10:54, 19 February 2016 (EST)

:: Hm, looks that will require quite some attention indeed. I'm afraid that'll has to wait for now.
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

=== Nasal Syntaxhighlighting ===
: Thanks for your efforts, btw: Nasal syntax highlighting is gone again.
: {{unsigned|17:22, 19 February 2016‎|Hooray}}

:: Unfortunately this time it isn't me forgetting to copy a file. The SyntaxHighlight extension no longer uses GeSHi, but has switched to Pygments. This means our Nasal mapping no longer works and has to be re-written. If anyone is interested, be my guest. See http://pygments.org/docs/lexerdevelopment/
:: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 12:29, 19 February 2016 (EST)

::: Hi Gijs,
::: I'm interested in making a Pygments Nasal lexer, but unfortunately I won't be able to work on it until the end of March at the earliest.
::: [[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:59, 23 February 2016 (EST)

:::: Unless Gijs is facing any problems, I don't think it's necessarily needed, see my comment/suggestion in this revision: [http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=93166] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:20, 23 February 2016 (EST)

:::Hi Gijs,
:::Here's the code for a Nasal lexer. Be warned, it's thoroughly untested, but has the following features:
:::* Full support for all three string types (backtick, single quote, and double quote), including escapes and formatting strings (e.g., for {{func link|sprintf}}).
:::* All kinds of numbers, including numbers in scientific notation and octal and hex numbers.
:::* All global functions and variables as of FG v2016.1.1.
:::* Some of the commonly-used <code>props.Node</code> methods.
:::* All the other things that can be expected (keywords, punctuation, etc.).
:::I have also created a lexer based on the XML lexer for XML with embedded Nasal, which I thought would be useful.
:::Regards,
:::[[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 16:35, 2 April 2016 (EDT)

:::http://pygments.org/docs/lexerdevelopment/#adding-and-testing-a-new-lexer
:::<syntaxhighlight lang="python" enclose="div">
# -*- coding: utf-8 -*-
"""
Lexer for Nasal.
"""

from pygments.lexer import RegexLexer, words, include, inherit, bygroups, using
from pygments.token import Text, Keyword, Name, String, Number, Operator, Punctuation, Comment
from pygments.lexers.html import XmlLexer

__all__ = ['NasalLexer', 'XMLNasalLexer']

class NasalLexer(RegexLexer):

name = 'Nasal'
aliases = ['nasal']
filenames = ['*.nas']

tokens = {
'formatters': [
(r'%[-#0 +]*(?:[0-9]+)?(?:\.[0-9]+)?[dis%couxXeEfFgG]', String.Interpol),
],
'backtick': [
(r'`', String.Backtick, '#pop'),
(r'[^`\\]+', String.Backtick),
(r'\\n|\\r|\\t|\\`|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
],
'sqstring': [
(r"'", String.Single, '#pop'),
(r"[^'\\%]+", String.Single),
(r"\\'", String.Escape),
include('formatters'),
],
'dqstring': [
(r'"', String.Double, '#pop'),
(r'[^"\\%]+', String.Double),
(r'\\n|\\r|\\t|\\"|\\\\|\\x[0-9a-fA-F]{2}', String.Escape),
include('formatters'),
],
'root': [
(r'\s+', Text),
(r'#.*?$'m, Comment.Single),
(r':|\?|[!=<>+\-*\/~&|^]=?', Operator),
(words(('or', 'and'), suffix=r'\b'), Operator.Word),
(r'[{(\[})\]\.;,]', Punctuation),
(words(('for', 'foreach', 'forindex', 'while', 'break', 'return', 'continue', 'if', 'else', 'elsif'), suffix=r'\b'), Keyword),
(words(('var', 'func'), suffix=r'\b'), Keyword.Declaration),
(words(('nil'), suffix=r'\b'), Keyword.Constant),
(words(('me', 'arg'), suffix=r'\b'), Name.Builtin.Pseudo),
(words(('new', 'del', 'getNode', 'getParent', 'getChild', 'getChildren', 'removeChild', 'removeChildren', 'removeAllChildren', 'getName', 'getIndex', 'getType', 'getAttribute', 'setAttribute', 'getValue', 'setValue', 'setIntValue', 'setBoolValue', 'setDoubleValue', 'unalias', 'alias', 'getPath', 'getBoolValue', 'remove', 'setValues', 'getValues', 'initNode'), suffix=r'\b'), Keyword.Pseudo),
(r'0o[0-7]+', Number.Oct),
(r'0x[0-9a-fA-F]+', Number.Hex),
(r'\d*(?:\.\d*)?[eE][+-]?\d+', Number.Float),
(r'\d*\.\d*', Number.Float),
(r'\b[0-9]+\b', Number.Integer),
(words(('D2R', 'R2D', 'FT2M', 'M2FT', 'IN2M', 'M2IN', 'NM2M', 'M2NM', 'KT2MPS', 'MPS2KT', 'FPS2KT', 'KT2FPS', 'LB2KG', 'KG2LB', 'GAL2L', 'L2GAL'), suffix=r'\b'), Name.Variable.Global),
(words(('abort', 'abs', 'addcommand', 'airportinfo', 'airwaysRoute', 'assert', 'carttogeod', 'cmdarg', 'courseAndDistance', 'createViaTo', 'createDiscontinuity', 'createWP', 'createWPFrom', 'defined', 'directory', 'fgcommand', 'findAirportsByICAO', 'findAirportsWithinRange', 'findFixesByID', 'findNavaidByFrequency', 'findNavaidsByFrequency', 'findNavaidsByID', 'findNavaidsWithinRange', 'finddata', 'flightplan', 'geodinfo', 'geodtocart', 'getprop', 'greatCircleMove', 'interpolate', 'isa', 'logprint', 'magvar', 'maketimer', 'md5', 'navinfo', 'parse_markdown', 'parsexml', 'print', 'printf', 'printlog', 'rand', 'registerFlightPlanDelegate', 'removecommand', 'removelistener', 'resolvepath', 'setlistener', 'setprop', 'settimer', 'srand', 'systime', 'thisfunc', 'tileIndex', 'tilePath', 'values'), suffix=r'\b'), Name.Builtin),
(words(('append', 'bind', 'call', 'caller', 'chr', 'closure', 'cmp', 'compile', 'contains', 'delete', 'die', 'find', 'ghosttype', 'id', 'int', 'keys', 'left', 'num', 'pop', 'right', 'setsize', 'size', 'sort', 'split', 'sprintf', 'streq', 'substr', 'subvec', 'typeof'), suffix=r'\b'), Name.Builtin),
(words(('_createCondition', '_fgcommand', '_interpolate', '_setlistener'), suffix=r'\b'), Keyword.Reserved),
(r'`', String.Backtick, 'backtick'),
(r"'", String.Single, 'sqstring'),
(r'"', String.Double 'dqstring'),
(r'\b_\w*?\b', Keyword.Reserved),
#(r'\b\w*?\b', Name),
]
}

class XMLNasalLexer(XmlLexer):
"""
For Nasal code embedded in XML files.
"""

name = 'XML-Nasal'
aliases = ['xml-nasal', 'xml-ns']

tokens = {
'root': [
(r'(<(?:load|unload|script)>)(<!\[CDATA\[)?(.*?)(]]>)?(</(?:load|unload|script)>)', bygroups(Name.Tag, Comment.Preproc, using(NasalLexer), Comment.Preproc, Name.Tag),
inherit,
],
}
</syntaxhighlight>

:: We can use the ECMAScript/JavaScript lexer[http://pygments.org/docs/lexers/#lexers-for-javascript-and-related-languages] for now, my suggestion would be to copy that over to a file so that we can work on a custom Nasal lexer (Syntax is almost identical, with a few different keywords, and many others being irrelevant). What is missing/different can be obtained from other lexers that are similar, e.g. [http://pygments.org/docs/lexers/#lexers-for-other-c-like-languages] [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 15:45, 19 February 2016 (EST)

:: Okay, here's the better/quick&easy way: We have Nasal support for some fairly popular editors, like [http://wiki.flightgear.org/Howto:Syntax_highlighting_for_Nasal#Vim|vim](originally created by Melchior<ref>https://sourceforge.net/p/flightgear/flightgear/ci/next/tree/scripts/syntax/nasal.vim</ref>), listed at [[Howto:Syntax_highlighting_for_Nasal]] - there are various free converters available that will read such a syntaxhighlighting file and convert it to a pygments class, e.g. see: https://github.com/honza/vim2pygments [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 16:00, 19 February 2016 (EST)

==== References ====
<references />

== The repository link templates ==
=== Complete overhaul of the repository link templates ===

I have now performed a complete overhaul of the repository link templates (see {{tl|repo link/doc related}}). This was motivated by the incomplete state of these templates, the lack of standardisation, the lack of SourceForge git repository support for {{tl|repo link}}, web-interface only support, etc. I have used a lot of recursive transclusion for standardisation, so that there is a single point for updating for any FlightGear infrastructure changes. This is the master {{tl|repo link}} template. All the other templates are subtemplates which recursively transclude from this master template. I have also created a number of documentation templates for simplifying template maintenance (see {{tl|repo link/doc related‎}}, {{tl|repo link/doc specific file git‎‎}}, {{tl|repo link/doc git clone‎‎}}, and {{tl|repo link/doc commit}}). The changes were constrained to maintain backwards compatibility as much as possible. However I would like to break this to allow the following templates to be updated to transclude from the master {{tl|repo link}} template:

* {{tl|flightgear file}},
* {{tl|simgear file}},
* {{tl|fgdata file}},
* {{tl|fgaddon file}}.

If no one objects, I would like to completely break these and expand and rename the parameter set to match the other <nowiki>{{* file}}</nowiki> repository templates (e.g. {{tl|terragear file}}). My overhaul currently does not include Hooray's ideas for non command line usages, i.e. different GUIs, but it enables it to be easily added via the master template and the addition of a single parameter to any subtemplates.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 15:05, 25 February 2016 (EST)

: I don't have any objections myself, I appreciate all the work you are putting into this, and would like to thank you for helping us clean up all that mess by doing such unglamorous work ;-) I also appreciate that your changes would facilitate adding a non-CLI mode to the corresponding templates. However, I would suggest to wait for Gijs' feedback, because he's ultimately the most likely person to veto something around here ;-) [[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 17:31, 25 February 2016 (EST)

:: Johan seems to be the one who did a lot of the initial work on these <nowiki>{{* file}}</nowiki> templates, and Red Leader with the {{tl|repo link}} template. And they were involved in the general discussions ([[http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Village_pump&oldid=87148#Repository_link_templates perm]). But I know Gijs was also involved in the design.

:: For the non-CLI mode, that will need -a lot- more planning. For example a definitive list of all these modes would be useful. Should this use an optional Mediawiki pop up extension showing a link to a general page that describes the action for all different GUIs, CLI, etc.? Should we have a switch box so that the reader can switch in-text between CLI, and the numerous GUIs? Are we going to have a large set of screenshots for each GUI? If so, I would strongly recommend the [https://www.mediawiki.org/wiki/Extension:Labeled_Section_Transclusion labelled section transclusion extension] for creating a single page for one GUI with everything for that GUI, as a tutorial. Here is [http://wiki.nmr-relax.com/Relax_4.0.1 an external example where I have used this], to fragment the base release page to create [http://wiki.nmr-relax.com/Relax_release_descriptions this meta page], as well as many other meta pages.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:14, 26 February 2016 (EST)

I am also thinking of changing the name of the <nowiki>{{* file}}</nowiki> templates, as I hope to make the scope of the templates far more general. The name <nowiki>{{* source}}</nowiki> or <nowiki>{{* repo}}</nowiki> might be better. For example these will allow the repository commit, tree view, log view (and maybe rss feed), with or without a file/directory path. And I would like to generalise this to handle both the SF web-interface and non-web net protocols (git://, ssh://, svn://, etc.). It will allow for CLI instructions to be built up and embedded in <nowiki>{{#tag:source|<content>|lang=sh}}</nowiki> tags. And I will defer all infrastructure decisions in the subtemplates to the single point of {{tl|project infrastructure}}, so that if there are changes in the future, then only this single template needs to be updated to update the entire wiki.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 03:22, 26 February 2016 (EST)

: The {{tl|project infrastructure}} template as a single point provider of various project infrastructure names and URL pairs seem like a great idea. If it work out well it will really lessen the maintenance by having less places needing updates, while allowing the various repository templates to be simple to use, in essence by having comprehensible names and no boiler plate parameters for their users.
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 15:15, 27 February 2016 (EST)

==== Repository link update ====
For those following, I have massively expanded the capabilities of the {{tl|repo link}} template:
* The SourceForge URLs are now comprehensive.
* Full support for the new query-based URLs for the Gitorious archives.
* Functional GitLab URLs.
* Generic repository support (used to create the {{tl|openscenegraph co}} template).
* Detailed documentation and extensive examples for checking the implementation (if you find any non-supported links, please add these as examples).
* Isolation of the '''cmd''' parameter from the CLI options — this is to enable future support for non-CLI instructions based on the value of '''cmd'''.

I have also completed a large set of subtemplates of {{tl|repo link}}, see the list at {{tl|repo link/doc related}}. This includes a full set of <nowiki>{{* source}}</nowiki> templates. I have left the original <nowiki>{{* file}}</nowiki> templates, rather than renaming and modifying them, so these are now redundant. All of the <nowiki>{{* source}}</nowiki>, <nowiki>{{* commit}}</nowiki>, <nowiki>{{* clone}}</nowiki>, and <nowiki>{{* co}}</nowiki> templates transclude from the master {{tl|repo link}} template to do all of the work.

One important template is {{tl|gitorious source}}. The support for the new query-based URLs for the Gitorious archives is now quite comprehensive in {{tl|repo link}}. Therefore I have converted almost every single FlightGear wiki link to https://gitorious.org to use {{tl|gitorious source}} instead. This fixes a lot of broken links and broken git instructions. I have reduced the number of hits for gitorious.org on the wiki (searching just for "gitorious") to 22 hits. This includes 2 very outdated articles ([[FlightGear Git: aircraft authors]], [[Fr/FlightGear et Git]]), 15 locked newsletters, 1 with no longer existent Gitorious merge request links, and 4 base URL links for Hangars. This way we can maintain the Gitorious web interface links and git command instructions in a functional state by simply updating the single source of {{tl|repo link}}.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 11:38, 29 February 2016 (EST)

: I just remembered [[Special:LinkSearch]], so make that 184 broken gitorious.org links remaining. Lots more work to do :)

: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 14:46, 29 February 2016 (EST)

For some of these templates, e.g. {{tl|repo link/doc usage}}, I'm trying to implement some logic for automatic whitespace padding for documentation formatting, but the <code><nowiki>{{#len:string}}</nowiki></code> function is not enabled. According to {{mediawiki|Wikitext_parser/Core_parser_functions#.23len}} and {{mediawiki|Extension:StringFunctions}}, the option <code>$wgPFEnableStringFunctions = true;</code> should be set (in <code>LocalSettings.php</code>). Unless there is a reason for not using this, I was wondering if someone could enable this? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 09:53, 8 March 2016 (EST)

=== Archived newsletters and dead links? ===

Do we have a policy for the dead links in the FlightGear newsletters? It is obviously good to preserve the historic state. But there are many Gitorious links that could be made functional again using the {{tl|gitorious source}} template to point to the historic Gitorious archives (including the official FlightGear repositories, rather than using {{tl|fgdata source}}, for example). The https://gitorious.org links have been converted from URL/path based to query based, so absolutely all of the old links are broken. I am steadily converting all Gitorious links to use the [[Template:repo link/doc related|{{obr}}repo link{{cbr}} family of templates]], with the exception of the newsletters.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 04:52, 8 March 2016 (EST)

: I think it could be a good idea to try update old links in those newsletters. I sometimes look back at things and tend to think that I probably are not the only one doing that.
: I wonder if the rotten links should be replaced or stricken, but I think they could just as well be replaced. The key thing is that they go to the same resource or content, not weather they have been updated or not (also, the change will be visible in the revision history after all).
: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 07:11, 8 March 2016 (EST)

:: I should add that I'm using [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=http%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] and [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>]. And I am also not touching the <code>User*</code> pages, <code>*talk*</code> pages, or pages tagged as out of date or up for deletion. For the newsletters I might look at these later when the broken Gitorious links are fixed in the rest of the wiki but, as these are locked, someone else might have make the switch to {{tl|gitorious source}}, {{tl|gitorious url}}, {{tl|gitorious clone}}, and {{tl|gitorious merge request}}.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 02:53, 9 March 2016 (EST)

::: I will temporarily add a table here for the templates in the newsletters and will slowly fix them one by one together with any other admin.
{{navbox
| title = Click "show" to show -->
| state = collapsed
| navbar = plain
| list1 =
http:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!}} No equivalent link for the Gitorious archive - project pages are dead. Maybe just use http://gitorious.org/?
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter May 2010]]
{{!}} http://gitorious.org/fg
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!}} Functional link, equivalent to {{gitorious url|fg|flightgear|commit=5c6fe952598053fa63631fc0161d666f22a50f51}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2010]]
{{!}} http://gitorious.org/fg/flightgear/commit/5c6fe952598053fa63631fc0161d666f22a50f51
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter January 2011]]
{{!}} http://gitorious.org/jsbsim/jsbsim
{{!}} Functional link. Switched to {{gitorious url|jsbsim|jsbsim}} to future-protect the link.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/headtrack

http://gitorious.org/arduinocockpit
{{!}} Project pages are dead, switched to {{gitorious url|headtrack|headtrack}}

{{gitorious url|arduinocockpit|arduinocockpit}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2011]]
{{!}} http://gitorious.org/arduinocockpi

http://gitorious.org/headtrack
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Missing project - i.e. {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra|text=migrated to GitLab}}. Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter March 2011]]
{{!}} http://gitorious.org/lockheed-l10-electra
{{!}} Switched to {{gitlab source|user=emilianh|repo=Lockheed-L10-Electra}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2011]]
{{!}} http://gitorious.org/flightgear-aircraft
{{!}} Switched to {{gitorious source}} and rephrased text slightly to help readers find the repositories.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} http://gitorious.org/anders-hangar/mtb_20m/trees/master
{{!}} Switch to {{gitorious url|proj=anders-hangar|repo=mtb_20m}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} http://gitorious.org/fg/flightgear/blobs/next/scripts/java/FGClient/src/FGFSDemo.java
{{!}} Switched to {{gitorious url|proj=fg|repo=flightgear|path=scripts/java/FGClient/src/FGFSDemo.java}}. This points to the old Gitorious repository to protect against path changes in the future.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter September 2013]]
{{!}} http://gitorious.org/boeing/707
{{!}} Switched to {{gitorious source|proj=boeing|repo=707}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} http://gitorious.org/fg/fgrun
{{!}} Switch to {{gitorious url|proj=fg|repo=fgrun}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2014]]
{{!}} http://gitorious.org/nasal-support/nasal-npp
{{!}} Switched to {{gitorious url|nasal-support|nasal-npp}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2015]]
{{!}} http://gitorious.org
{{!}} Switched to {{tl|gitorious source}} without parameters for the Gitorious base URL, to future-protect it.
{{!}}}

https:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Gitorious URL !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/papillon81/flightgear-custom-scenery/

https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter April 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery

https://gitorious.org/papillon81/flightgear-custom-scenery/
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}} and {{gitorious source|papillon81|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter July 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter December 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Fr/Nouvelles du projet FlightGear - décembre 2011]]
{{!}} https://gitorious.org/dvanmosselbeen/flightgear-custom-scenery
{{!}} Switched to {{gitorious source|dvanmosselbeen|flightgear-custom-scenery}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2012]]
{{!}} https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/README

https://gitorious.org/fg/fgdata/blobs/master/Aircraft/Instruments-3d/garmin196/doc/doc-en.htm
{{!}} Switched to {{fgdata source|path=Aircraft/Instruments-3d/garmin196/README|full=1}} and {{fgdata source|path=Aircraft/Instruments-3d/garmin196/doc/doc-en.htm|full=1}} to point to the current FGData locations and removed the name "Gitorious" to make the text of the Garmin 196 GPS section still relevant
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter August 2012]]
{{!}} https://gitorious.org/mil-mi-6
{{!}} Switched to {{gitorious url|proj=mil-mi-6|repo=mi6dev}}, and changed from the non-existent project page to the main repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2012]]
{{!}} https://gitorious.org/fgradar
{{!}} Switched from the project page to the direct repository {{gitorious url|fgradar|fgradar}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter March 2013]]
{{!}} https://gitorious.org/fg/flightgear/commit/913727239d6776c0508d206f395e16c265413ec3

https://gitorious.org/fg/flightgear/commit/eba03b5e469824ee8f1494723fcddbbc56155a08
{{!}} Switched to {{flightgear url|commit=913727239d6776c0508d206f395e16c265413ec3}} and {{flightgear url|commit=eba03b5e469824ee8f1494723fcddbbc56155a08}}. This deliberately points to the current repository.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2013]]
{{!}} https://gitorious.org/fg-radi/osm2city

https://gitorious.org/scenery-france-850
{{!}} Switched to the new GitLab repository {{gitlab source|proj=fg-radi|repo=osm2city|full=1}}

and removed the no longer existent scenery-france-850 repository, replacing it with "<s>Scenery repository (Gitorious)</s>".
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter October 2013]]
{{!}} https://gitorious.org/fg/galvedros-fgdata
{{!}} Switch to {{gitorious url|proj=fg|repo=galvedros-fgdata}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter November 2013]]
{{!}} https://gitorious.org/ec130/
{{!}} Switched from the project page to the direct repository {{gitorious source|ec130|ec130}}.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Switched to {{gitorious source|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console/repl.nas|line=708}}

{{gitorious url|proj=fg|repo=philosophers-fgdata|branch=nasal-console|path=Nasal/console|view=tree}}

{{fgdata-old url|commit=eaaf816b772649d5b0826a1d0bdd166dbc5b968f}}

{{flightgear commit|34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353}}

{{gitorious merge request|mr=54}}

{{gitorious merge request|mr=26}}
{{!-}}
{{!}} {{tick}}
{{!}} [[Es/FlightGear Newsletter February 2014]]
{{!}} https://gitorious.org/fg/philosophers-fgdata/source/022bef27f05d4837d720f63c6507b47466ff2a59:Nasal/console/repl.nas#L436

https://gitorious.org/fg/philosophers-fgdata/source/nasal-console:Nasal/console

https://gitorious.org/fg/fgdata/commit/eaaf816b772649d5b0826a1d0bdd166dbc5b968f

https://gitorious.org/fg/flightgear/commit/34ed79e5f88ffdfc5e651a1fe3e639cb8f4d3353

https://gitorious.org/fg/flightgear/commit/5eee5e42ae4f5cf56283b3bf5a3be46efc2b51c4

https://www.gitorious.org/fg/flightgear/merge_requests/26
{{!}} Changes match the English article.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} https://gitorious.org/fg/fgdata/flightgear?p=fg/fgdata:flightgear.git;a=blob;f=keyboard.xml

https://gitorious.org/fg/fgdata?p=fg:fgdata.git;a=commit;h=f8c56dcc52ffd3d6dfca1d39dc4a72b6b3478368

https://gitorious.org/fg/hoorays-flightgear?p=fg:hoorays-flightgear.git;a=shortlog;h=refs/heads/topics/cppbind-fgprotocol
{{!}} This first link was the broken {{tl|git link}} template (see the table below). The other two links are not in the article?!
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter June 2014]]
{{!}} https://gitorious.org/eddp-custom-scenery/eddp-custom-scenery/
{{!}} Switched to {{tl|gitorious clone}} to provide functional '''git clone''' instructions.
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter November 2014]]
{{!}} https://gitorious.org/fg/hoorays-fgdata/source/2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876:Nasal/ai/aim9/aim9.fdm#L9
{{!}} Switch to {{gitorious url|proj=fg|repo=hoorays-fgdata|commit=2857d8fc9fcfe2bb162a9eb9d3dcca4d41b3a876|path=Nasal/ai/aim9/aim9.fdm|line=9}}
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter January 2015]]
{{!}} https://gitorious.org/fg/canvas-hackers-fgdata/source/f59c42134a5a77e343981dcff8278c3e2f094e87
{{!}} Switch to {{gitorious url|proj=fg|repo=canvas-hackers-fgdata|commit=f59c42134a5a77e343981dcff8278c3e2f094e87|view=summary}}
{{!}}}

Broken templates:...
{{{!}} class="wikitable"
! Fixed !! Newsletter !! Template !! Notes
{{!-}}
{{!}} {{tick}}
{{!}} [[FlightGear Newsletter April 2014]]
{{!}} {{tlx|Git link|gitorious|fg/fgdata|master|keyboard.xml|pre=$FG_ROOT/}}
{{!}} Switched to {{fgdata source|path=keyboard.xml|pre=$FG_ROOT}} to fix the Gitorious link created by the broken and depreciated {{tl|git link}} template.
{{!}}}

}}

::: —[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 12:06, 9 March 2016 (EST)

:::: I've added a '''notes''' column to help a little.

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:30, 9 March 2016 (EST)

=== Elimination of the dead Gitorious links ===
Thanks largely to the diversity and flexibility of the [[:Category:Repository link templates|{{obr}}repo link{{cbr}} family of templates]], I have now managed to eliminate almost every last dead Gitorious link in the FlightGear wiki! The locked Newsletter articles, user pages, and talk pages are the only exceptions. The page counts from the (Main) namespace are:
* [http://wiki.flightgear.org/index.php?target=http%3A%2F%2Fgitorious.org&namespace=0&title=Special%3ALinkSearch <nowiki>Special:LinkSearch for http://gitorious.org</nowiki>] — 37. Of these, 17 are for the front page with the news of the Gitorious to SourceForge migration, and the rest are Newsletters.
* [http://wiki.flightgear.org/index.php?title=Special:LinkSearch&limit=500&offset=0&target=https%3A%2F%2Fgitorious.org&namespace=0 <nowiki>Special:LinkSearch for https://gitorious.org</nowiki>] — 166. Most of these links are valid and created by the {{obr}}gitorious *{{cbr}} subtemplates of {{tl|repo link}}. The remaining broken links are all in the locked Newsletters.
The Howto:* pages are not in the (Main) wiki namespace, but I've knocked those out too.

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:54, 10 March 2016 (EST)

: thanks for doing all this unglamorous work - I am sorry that Gijs was apparently too busy to follow up on my suggestion to either provide you with admin access around here, or at least to help you run a Python script to do all this work in an automated, rather than manual, fashion. Hopefully, things will work out better next time. Again, thank you. Like I said, I think you should definitely be given admin access on the wiki, especially given your recent contributions - and I would gladly have my wiki status downgraded accordingly. In fact, if I was able to directly promote accounts accordingly, I would have done so months ago - however, it seems that Gijs is the only one to have those privileges, and he mentioned off-list that he's kinda busy with RL/exams etc, so it is to be expected that he's going to become a bottleneck more often - hopefully, this will be recongized as an actual issue, so that there will be more people able to promote new wiki admins. Sorry that things didn't work out better this time, and thanks so much for doing all this stuff manually. -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:49, 10 March 2016 (EST)

:: No problems! As for automating this, that would not have been possible. If you look at the changes, you'll see that each one is different <sup>[http://wiki.flightgear.org/index.php?title=Special:RecentChanges&to=20160310210655&limit=500]</sup>. I had to check each one, and update the link as required.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 16:08, 10 March 2016 (EST)

::: There's three of us actually (Curt, Simon and myself), no need to wait on me. See http://wiki.flightgear.org/index.php?title=Special%3AListUsers&username=&group=bureaucrat&limit=100 (Sek is inactive nowadays) ;-)
::: Please note that forum pms are really not the best way to contact me. I very much prefer email over forum pms as it's a lot easier to filter out the huge amounts of nonsense I'm receiving from stuff requiring actual attention.
::: Anyhow I've just promoted Bugman so he can edit locked articles.
::: [[User:Gijs|Gijs]] ([[User talk:Gijs|talk]]) 05:06, 11 March 2016 (EST)

:::: Thank you. I'll try to preserve the original intent of the Newsletters while fixing the broken links (maybe even preserving any original URLs as Mediawiki link text, while pointing to the new URL). I will use the {{obr}}gitorious *{{cbr}} templates to point to the historical sources, and will probably use this for all of the Gitorious URLs so that we have full control over any future URL breakages via the single location of {{tl|repo link}}. For example, if they change the gitorious.org domain name to a https://archive.org subdomain (i.e. gitorious.archive.org).

:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 06:40, 11 March 2016 (EST)

=== Regex parsing of template parameters? ===

For the {{tl|repo link}} template, I am currently trying to work out what to do for git branches and tags on the SourceForge infrastructure. The problem is that the presence of the character <code>/</code> within a branch or tag name requires the text <code>/~</code> to be appended to that name in the URL, for example:

* Tag <code>version/2016.1.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/version/2016.1.1/~/tree/simgear/ephemeris/ephemeris.cxx
* Branch <code>release/2016.1</code>: https://sourceforge.net/p/flightgear/simgear/ci/release/2016.1/~/tree/simgear/ephemeris/ephemeris.cxx

I haven't found out a way to use regex to parse the <code>tag</code> or <code>branch</code> template parameters to automate this, hence I am thinking of just giving the instruction for the template user to append this text to the <code>tag</code> or <code>branch</code> parameter text themselves. However this is not ideal - a change of this behaviour on the SourceForge side requires end pages with SourceForge URLs to be updated, rather than just updating {{tl|repo link}}. I was wondering about possibility of installing the extension:

* [https://www.mediawiki.org/wiki/Extension:RegexParserFunctions Extension:RegexParserFunctions]

Though I'm not 100% sure if that will work. Or does someone else know an alternative? Cheers!

[[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 12:09, 22 April 2016 (EDT)

: not a solution, just a potential workaround would be checking for the most common prefix strings used in tags/branches (e.g. version, release, topic, topics) and explicitly rewrite the URL accordingly to append the /~ suffix -[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 12:59, 22 April 2016 (EDT)

:: That might be a solution. But I don't know how to do that without regex ;) We really only have #ifeq statements, but that has to match the whole string.

:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:44, 22 April 2016 (EDT)

== Discussion about quotes on the wiki ==
{{usr|Hooray}} have started a page now at [[FlightGear wiki:Quoting Guidelines]] ([http://wiki.flightgear.org/index.php?title=FlightGear_wiki:Quoting_Guidelines&oldid=96104 perm]) for a discussion regarding guidelines for the use of quotes on the wiki. Join the discussion.

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 18:17, 21 March 2016 (EDT)

In slight relation to this I have tried to make the wiki more consistently use the most common spelling and case, "Instant-Cquotes" and have changed the automatic categorization accordingly. All articles using the {{tl|FGCquote}} template can now be found in [[:Category:Articles containing Instant-Cquotes]] (currently some ~250 articles).

—[[User:Johan G|Johan G]] ([[User_talk:Johan_G|Talk]] | [[Special:Contributions/Johan_G|contribs]]) 08:21, 23 March 2016 (EDT)

== Reorganizing the Git articles ==
I've noticed that the [[Category:Git|Git articles]] suffer from duplication and are in part obsolete (especially with regard to the instructions for running Git on Windows). Thus, I propose the following reorganization:
* [[Development workflow]]: reorganization to explain how the patch submission process is organized from a high-level point of view (forking the repository from SourceForge, developing, pushing the commits to the personal fork, submitting a merge request/sending a patch to the mailing list);
* [[FlightGear Git]]: leave as is;
* '''Installing and configuring Git''' - new article about installing Git and configuring it (setting the username/e-mail address); merge the contents of [[FlightGear Git on Windows]] and [[Resources WRT running git on Win32]] here;
* [[FlightGear Git for laymen]] - make it follow [[FGW:MOS]], merge the contents of [[Howto:Start using git]] here;
* [[FlightGear Git: core developers]] and [[FlightGear Git: data developers]] - I'm uncertain about what I should do with them: the only piece information that would not be written in other articles is the list of alternative methods for cloning FGData;
* [[FlightGear Git: gitiquette]] and [[FlightGear Git: tips]] - make them follow [[FGW:MOS]].
Any comments? -- [[User:Elgaton|ElGaton]] ([[User talk:Elgaton|<tt>talk</tt> to me]]) 06:11, 13 May 2016 (EDT)

FlightGear wiki:Manual of Style

2016-05-11T17:45:06Z

Elgaton: /* Reference */ Fix link

{{shortcut|FGW:MOS}}

The '''Manual of Style''' is a style manual for all FlightGear wiki articles. It helps editors write articles with consistent, clear, and precise language, layout, and formatting. The goal is to make using this wiki easier and more intuitive. Consistent language, style, and formatting promote clarity and cohesion. Writing should be clear and concise. Plain English works best; avoid ambiguity, jargon, and vague or unnecessarily complex wording.

Discuss style issues on [[FlightGear wiki talk:Manual of Style|the talk page]].

== Article titles, headings, and sections ==
=== Article titles ===
* Use sentence case, not title case. The initial letter of a title is capitalized (except in rare cases, such as eBay), but otherwise, capital letters are used only where they would be used in a normal sentence ({{xt|List of developed airports}}, not {{!xt|List of Developed Airports}}). Also, keep in mind that the wiki software automatically capitalizes the initial letter of a namespace/page title in its address.
* Titles should be precise enough to unambiguously define the topical scope of the article ({{xt|Boeing 747}}, not {{!xt|747}}).
* The characters <code># < > [ ] | { }</code> are reserved by the wiki software and can not be used.

=== Section organization ===
An article should begin with an introductory lead section, which should not contain section headings. The remainder may be divided into sections, each with a section heading (see below) that can be nested in a hierarchy. If there are at least four section headings in the article, a navigable table of contents is generated automatically and displayed between the lead and the first heading.

=== Section headings ===
Equal signs are used to mark the enclosed text as a section heading: <code>== Title ==</code> for a primary section; <code>=== Title ===</code> for the next level (a subsection); and so on to the lowest-level subsection, with <code>===== Title =====</code>. (The highest heading level technically possible is <code>= Title =</code>; but do not use it in articles, because it is reserved for the automatically generated top-level heading at the top of the page containing the title of the whole article.) Spaces between the equal signs and the heading text are optional, and will not affect the way the heading is displayed. The heading must be typed on a separate line. Include one blank line above the heading, and optionally one blank line below it, for readability in the edit window (but not two or more consecutive blank lines, which will add unnecessary visible white space in the rendered page.)

The provisions in [[#Article titles|Article titles]] (above) generally apply to section headings as well (for example, headings are in sentence case, not title case). The following points apply specifically to section headings:
* Headings should normally not contain links, especially where only part of a heading is linked.
* Section and subsection headings should preferably be unique within a page; otherwise section links may lead to the wrong place, and automatic edit summaries can be ambiguous.
* Citations should not be placed within or on the same line as section and subsection headings.
* Headings should not contain images.

== Capital letters ==
Sentence case rather than title case is used in wiki article titles and section headings; see [[#Article titles|Article titles]] and [[#Section headings|Section headings]] above. For capitalization of list items, see [[#Bulleted and numbered lists|Bulleted and numbered lists]]. Other points concerning capitalization are summarized below.

===Do not use capitals for emphasis===
Use italics, not capitals, to denote emphasis.
:''Incorrect'': {{!xt|It is not only a LITTLE learning that is dangerous}}.
:''Correct'': {{xt|It is not only a ''little'' learning that is dangerous}}.

===Calendar items===
* '''Months, days of the week, and holidays''' start with a capital letter ({{xt|June}}, {{xt|Monday}}).

===Celestial bodies===
* When used generally, the words '''<nowiki />''sun'', ''earth'', and ''moon''<nowiki />''' do not take capitals ({{xt|The sun was peeking over the mountain top}}), except when the term names a specific astronomical body ({{xt|The Moon orbits the Earth}}).

===Compass points===
Do not capitalize '''directions''' such as ''north'', nor their related forms ({{xt|Follow the northern road}}), except where they are parts of proper names (such as {{xt|South Pole}}).

Capitalize '''names of regions''' if they have attained proper-name status, including informal conventional names ({{xt|Southern California}} or {{xt|the Western Desert}}). Do not capitalize descriptive names for regions that have not attained the status of proper names, such as {{xt|southern Poland}}.

(Composite directions may or may not be hyphenated, depending on the style adopted in the article. {{xt|Southeast Asia}} and {{xt|northwest}} are more common in American English; but {{xt|South-East Asia}} and {{xt|north-west}} in British English. In cases such as {{xt|north–south dialogue}} and {{xt|east–west orientation}} an en dash is used.)

== Abbreviations ==
=== Write out both the full version and the abbreviation at first occurrence ===
* When an abbreviation is to be used in an article, give the expression in full at first, followed immediately by the abbreviation in parentheses (round brackets). In the rest of the article the abbreviation can then be used by itself:
::{{xt|The instrument landing system (ILS) is a ground-based instrument approach system}}, at the first mention of the instrument landing system; and
::{{xt|There are three categories of ILS}}, at a subsequent mention.
* Do not apply initial capitals in a full version simply because capitals are used in the abbreviation.
::{|style="background:transparent"
|-
|''Correct'': || {{xt|There are two types of flight rules: visual flight rules (VFR) and instrument flight rules (IFR).}}
|-
|''Incorrect'': || {{!xt|There are two types of flight rules: Visual Flight Rules (VFR) and Instrument Flight Rules (IFR).}}
|}

=== Ampersand ===
The ampersand (&) substitutes for the word ''and'' (it is a form of Latin ''et''). In normal text, ''and'' should be used instead: {{xt|version 1 and 2}}, not {{!xt|version 1 & 2}}. Ampersands may be used with consistency and discretion in tables, infoboxes, and similar contexts where space is limited.

== Italics ==
=== Emphasis ===
Italics may be used ''sparingly'' to emphasize words in sentences (whereas boldface is normally not used for this purpose). Generally, the more highlighting in an article, the less its effectiveness.

=== Quotations in italics ===
Quotations must always be clearly indicated as being quotations. For quotations, use only quotation marks (for short quotations) or block quoting (for long ones), not italics. (See [[#Quotations|Quotations]] below.) This means that (1) a quotation is not italicized inside quotation marks or a block quote just because it is a quotation, and (2) italics are no substitute for proper quotation formatting.

== Quotations ==
Where the same quotation has been used elsewhere in the article, avoid duplicating it, which is regarded as poor style.

The quotation should be representative of the whole source document; editors should be very careful to avoid misrepresentation of the argument in the source. Where a quotation presents rhetorical language in place of more neutral, dispassionate tone preferred for encyclopedias, it can be a backdoor method of inserting a non-neutral treatment of a controversial subject into the wiki's narrative on the subject, and should be avoided.

Quotations should generally be worked into the article text, so as not to inhibit the pace, flow and organization of the article. Longer quotes may need to be set apart, generally through the use of wikitext templates such as {{tl|Quote}} or {{tl|Quotation}}. Longer quotations may also be hidden in the reference (footnote) to facilitate verification by other editors without sacrificing readability. For pull quotes (quotes of the article text used to highlight a section) the {{tl|Cquote}} template can be used. Quotations used only as sources to support statements contained in the article can be added with a <tt><nowiki><ref></nowiki></tt> tag containing a reference formatted with the {{tl|cite web}} template; in that case, add {{tl|Appendix}} at the end of the page so that citations can be displayed in a uniform way.

=== Original wording ===
Quotations must be verifiably attributed and the wording of the quoted text should be faithfully reproduced. If there is a significant error in the original statement, use {{xt|[''[[sic]]'']}} to show that the error was not made by the wiki editors. However, trivial spelling and typographic errors should simply be corrected without comment (for example, correct {{!xt|basicly}} to {{xt|basically}}), unless the slip is textually important.

Use [[#Ellipses|ellipses]] to indicate omissions from quoted text. Legitimate omissions include extraneous, irrelevant, or parenthetical words. Do not omit text where doing so would remove important context or alter the meaning of the text.

=== Typographic conformity ===
In most cases it is not desirable to duplicate the original formatting. Formatting and other purely typographical elements of quoted text should be adapted to the wiki's conventions without comment provided that doing so will not change or obscure the meaning of the text. These are alterations which make no difference when the text is read aloud, such as:
* Changing capitalization so that sentences begin with capital letters.
* When quoting a quotation that itself contains a quotation, single quotes may be replaced with double quotes, and vice versa. See [[#Quotations within quotations|Quotations within quotations]] below.
* Removing spaces before punctuation such as periods and colons.
* Generally preserve bold and italics (see [[#Italics|Italics]], above), but most other styling should be altered.
* Expanding abbreviations.

=== Quotations within quotations ===
For quotations within quotations, use double quote marks outermost and, working inward, alternate single with double quote marks.

=== Attribution ===
The author of a quote of a full sentence or more should be named; this is done in the main text and not in a footnote. A reader should not have to follow a footnote to learn whose words a quote is.

=== Linking ===
As much as possible, avoid linking from within quotes, which may clutter the quotation, violate the principle of leaving quotations unchanged, and mislead or confuse the reader.

=== Block quotations ===
Format a long quote (more than about 40 words or a few hundred characters, or consisting of more than one paragraph, regardless of length) as a block quotation, which the wiki's software will indent from both margins. Do not enclose block quotations in quotation marks (and especially avoid decorative quotation marks in normal use, such as those provided by the {{tl|cquote}} template, which are reserved for pull quotes; quoted sections from elsewhere in the same wiki article). Block quotations can be added with {{tl|quote}} or {{tl|quotation}}.

=== Overusing quotations ===
Long quotations crowd the actual article and remove attention from other information. Many direct quotations can be minimized in length by providing an appropriate context in the surrounding text. A summary or paraphrase of a quotation is often better where the original wording could be improved. Consider minimizing the length of a quotation by paraphrasing, by working smaller portions of quotation into the article text, or both.

Overuse happens when:

<blockquote>a quotation is used without pertinence</blockquote>

This means that a quotation is visually on the page, but its relevance is not explained anywhere.

==== Specific recommendations ====
* Using too many quotes is incompatible with the encyclopedic writing style.
* As a matter of style, quoteboxes should generally be avoided as they draw special attention to the opinion of one source, and present that opinion as though the project endorses it. Instead of using quoteboxes to highlight its notability, explain its importance before introducing the quote or in an introduction to the quote.
* The wiki is not a list or repository of loosely associated topics such as quotations.
* Do not insert any number of quotations in a stand-alone quote section.
* A quotation that does not directly relate to the topic of the article or directly support the information as it is presented should not be used.
* Intersperse quotations with original prose that comments on those quotations instead of constructing articles out of quotations with little or no original prose.
* Longer quotations may be hidden in the reference as a footnote to facilitate verification by other editors without sacrificing readability.

== Punctuation ==

=== Apostrophes ===
* Consistent use of the straight (or ''typewriter'') apostrophe ({{xt| ' }}) is recommended, as opposed to the curly (or ''typographic'') apostrophe ({{!xt| ’ }}).

=== Quotation marks ===
;Double or single
: Enclose quotations with double quotation marks ({{xt|Bob said, "Jim ate the apple."}}). Enclose quotations inside quotations with single quotation marks ({{xt|Bob said, "Did Jim say 'I ate the apple' after he left?"}}).

;Block quotes
: As already noted [[#Quotations|above]], we use quotation marks or block quotes (not both) to distinguish long quotations from other text. Multiparagraph quotations are always block-quoted. The quotations must be precise and exactly as in the source (except for certain ''allowable typographical changes'', also noted [[#Typographic conformity|above]]). The source should be cited clearly and precisely.

===Brackets and parentheses===
These rules apply to both round brackets {{xt|( )}}, often called parentheses, and square brackets {{xt|[ ]}}.

If a sentence contains a bracketed phrase, place the sentence punctuation outside the brackets {{xt|(as shown here).}} However, where one or more sentences are wholly inside brackets, place their punctuation inside the brackets. There should be no space next to the inner side of a bracket. An opening bracket should usually be preceded by a space, for example. This may not be the case if it is preceded by an opening quotation mark, another opening bracket, or a portion of a word.

There should be a space after a closing bracket, except where a punctuation mark follows (though a spaced dash would still be spaced after a closing bracket) and in unusual cases similar to those listed for opening brackets.

If sets of brackets are nested, use different types for adjacent levels of nesting; for two levels, it is customary to have square brackets appear within round brackets. This is often a sign of excessively convoluted expression; it is often better to recast, linking the thoughts with commas, semicolons, colons, or dashes.

Avoid adjacent sets of brackets. Either put the parenthetic phrases in one set separated by commas, or rewrite the sentence.

Square brackets are used to indicate editorial replacements and insertions within quotations, though this should never alter the intended meaning. They serve three main purposes.

====Sentences and brackets====
* If any sentence includes material that is enclosed in square or round brackets, it still must end—with a period, or a question or exclamation mark—''after'' those brackets. This principle applies no matter what punctuation is used within the brackets.
* However, if the entire sentence is within brackets, the closing punctuation falls within the brackets. (This sentence is an example.) This does not apply to matter that is added (or modified editorially) at the beginning of a sentence for clarity, which is usually in square brackets.

=== Ellipses ===
An ellipsis (plural ''ellipses'') is used to indicate an omission of material from quoted text or some other omission, perhaps of the end of a sentence, often in a printed record of conversation. The ellipsis is represented by '''ellipsis points''': a set of three unspaced periods, surrounded by square brackets {{xt|[...]}}.

== Dates and time ==
=== Time of day ===
Time of day is normally expressed in figures rather than being spelled out. Context determines whether the 12- or 24-hour clock is used.
* 12-hour clock times are written in the form {{xt|11:15 a.m.}} and {{xt|2:30 p.m.}}, or the form {{xt|11:15 am}} and {{xt|2:30 pm}}, with a space before the abbreviation.
* 24-hour clock times are written in the form {{xt|08:15}}, {{xt|22:55}}, with no suffix. Note that {{xt|00:00}} refers to midnight at the start of a date, and {{xt|24:00}} to midnight at the end of a date.

=== Days ===
* For full dates, use the format {{xt|10 June 1921}} or the format {{xt|June 10, 1921}}. Similarly, where the year is omitted, use {{xt|10 June}} or {{xt|June 10}}. For choice of format, see below.
* Do not use numerical date formats such as {{!xt|03/04/2005}}, as this could refer to 3 April or to March 4. If a numerical format is required (e.g. for conciseness in long lists and tables), use the YYYY-MM-DD format: {{xt|2005-04-03}}.

==== Choice of format ====
* All the dates in a given article should have the same format (day-month or month-day). These requirements do not apply to dates in quotations or titles.
* Otherwise, do not change an article from one form to another without good reason.

=== Months ===
* For month and year, write {{xt|June 1921}}, with no comma.
* Abbreviations for months, such as {{xt|Feb}}, are used only where space is extremely limited. Such abbreviations should use three letters only, and should not be followed by a period (full stop) except at the end of a sentence.

=== Years and longer periods ===
* Do not use ''the year'' before the digits ({{xt|1995}}, not {{!xt|the year 1995}}), unless the meaning would otherwise be unclear.
* Decades are written in the format {{xt|the 1980s}}, with no apostrophe. Use the two-digit form ('80s) only with an established social or cultural meaning. Avoid forms such as {{!xt|the 1700s}} that could refer to 10 or 100 years.

=== Current ===
Use of the term "current" should be avoided. What is current today may not be tomorrow; situations change over time. Instead, use date- and time-specific text.
:{|style="background:transparent"
|-
|''Incorrect'':||{{!xt|FlightGear 3.0 is currently the latest version ...}}
|-
|''Correct'':||{{xt|As of February 2014, FlightGear 3.0 is the latest version ...}}
|}

== Numbers ==
* In general, write whole numbers from one to nine as words, write other numbers that take two words or fewer to say as either figures or words (with consistency within each article), and write all other numbers as figures: {{xt|1/5}} or {{xt|one-fifth}}, {{xt|84}} or {{xt|eighty-four}}, {{xt|200}} or {{xt|two hundred}}, but {{xt|3.75}}, {{xt|544}}, {{xt|21 million}}.
* In general, use a comma to delimit numbers with five or more digits to the left of the decimal point. Numbers with four digits are at the editor's discretion: {{xt|12,345}}, but either {{xt|1,000}} or {{xt|1000}}.
* In general, use decimals rather than vulgar fractions with measurements.
* Write out "million" and "billion" on the first use. After that, unspaced "M" can be used for millions and "bn" for billions: {{xt|70M}} and {{xt|25bn}}.
* Write {{xt|3%}}, {{xt|three percent}}, or {{xt|three per cent}}, but not {{!xt|3 %}} (with a space) or {{!xt|three %}}. "Percent" is American usage, and "per cent" is British usage. In ranges of percentages written with an en dash, write only one percent sign: {{xt|3–14%}}.

==Units of measurement==
* The main unit in which a quantity is expressed should generally be an SI unit or non-SI unit officially accepted for use with the SI.
* In a direct quotation, always keep the source units. If a conversion is required, it should appear within square brackets in the quote, or else an obscure use of units can be explained in a footnote.
* Where space is limited (such as tables, infoboxes, parenthetical notes, and mathematical formulas) use unit symbols. In main text it is usually better to spell out unit names, but symbols may also be used when a unit (especially one with a long name) is used repeatedly. However, spell out the first instance of each unit in an article (for example, {{xt|the typical batch is 250 kilograms ... and then 15 kg of emulsifier is added}}), except for unit names that are hardly ever spelled out (e.g. the degree Celsius). Most unit names are not capitalized. Use "per" when writing out a unit, rather than a slash: {{xt|meter per second}}, not {{!xt|meter/second}}.
* Potentially unfamiliar unit symbols should be introduced parenthetically at their first occurrence in the article, with the full name given first: for example, {{xt|His initial betatron reached energies of 2.3 megaelectronvolts (MeV), while subsequent betatrons achieved 300 MeV.}}
* When dimensions are given, each number should be followed by a unit name or symbol (e.g. write {{xt|1 m × 3 m × 6 m}}, not {{!xt|1 × 3 × 6 m}}).
* When they form a compound adjective, values and unit names should be separated by a hyphen: for example, {{xt|a five-day race}}.
* Unit symbols are preceded by figures, not by spelled-out numbers. Values and unit symbols are separated by a non-breaking space. For example, {{xt|5 min}}. The percent sign, and units of degrees, minutes, and seconds ''for angles and coordinates'', are unspaced.
* Standard unit symbols do not require a full stop (period). However non-standard abbreviations should always be given a full stop.
* No ''s'' is appended, e.g. {{xt|km}}, {{xt|in}}, {{xt|lb}}, not {{!xt|kms}}, {{!xt|ins}}, {{!xt|lbs}}.
* Write powers of unit symbols with HTML, e.g. {{xt|<nowiki>5 km<sup>2</sup></nowiki>}} not Unicode superscripts and subscripts.
* For quantities of bytes and bits, specify whether the binary or decimal meanings of K, M, G, etc. are intended.

== Grammar and usage ==
=== First-person pronouns ===
Wiki articles must not be based on one person's opinions or experiences. The use of ''I'', ''my'', or similar forms is restricted to user pages and quotations. Also avoid ''we'', ''us'', and ''our'': {{!xt|We should note that some critics have argued against our proposal}} (personal rather than encyclopedic).

== Vocabulary ==
=== Contractions ===
Uncontracted forms such as {{xt|do not}} or {{xt|it is}} are the default in encyclopedic style; {{!xt|don't}} and {{!xt|it's}} are too informal.

=== Foreign terms ===
Foreign words should be used sparingly.

==== No common usage in English ====
Use italics for phrases in other languages and for isolated foreign words that are not current in English.

==== Common usage in English ====
Loanwords and borrowed phrases that have common usage in English ({{xt|vice versa}}) do not require italics. A rule of thumb is not to italicize words that appear unitalicized in major English-language dictionaries.

=== Technical language ===
Some topics are intrinsically technical, but editors should try to make them understandable to as many readers as possible. Minimize jargon, or at least explain it. For unavoidably technical articles a separate introductory article may be the best solution. Avoid excessive ''wikilinking'' (linking within the wiki) as a substitute for parenthetic explanations such as the one in this sentence. Do not introduce new and specialized words simply to teach them to the reader when more common alternatives will do. When the notions named by jargon are too complex to concisely explain in a few parenthetical words, write one level down. For example, consider adding a brief background section with {{tl|main}} tags pointing to the full treatment article(s) of the prerequisite notions; this approach is practical only when the prerequisite concepts are central to the exposition of the article's main topic, and when such prerequisites aren't too numerous.

=== Geographical items ===
Places should generally be referred to consistently by the same name as in the title of their article. Exceptions are made if there is a widely accepted historical English name appropriate to the given context. In cases where such a historical name is used, it should be followed by the modern name in round brackets (parentheses) on the first occurrence of the name in applicable sections of the article. This resembles linking; it should not be done to the detriment of style. On the other hand, it is probably better to provide such a variant too often than too rarely. If more than one historical name is applicable for a given context, the other names should be added after the modern English name, that is: "historical name (modern name, other historical names)".

== Images ==
* Infoboxes, images, and related content in the lead must be right-aligned.
* Use captions to clarify the relevance of the image to the article (see [[#Captions|Captions]], below).
* Each image should be inside the major section to which it relates (within the section defined by the most recent level 2 heading or at the top of the lead), not immediately above the section heading.
* Avoid sandwiching text between two images that face each other, and between an image and an infobox or similar.
* The thumbnail option may be used ("<code>thumb</code>"), or another size may be fixed. The default thumbnail width is 220 pixels; users can adjust this in their preferences. Lead images should be no wider than "upright=1.35" (by default this is 300 pixels).
* Avoid referring to images as being on the left or right. Image placement is different for viewers of the mobile version of the wiki and might change in the future. Instead, use captions to identify images.

=== Avoid entering textual information as images ===
Textual information should almost always be entered as text rather than as an image. True text can be colored and adjusted with CSS tags and templates, but text in images cannot be. Images are not searchable and are slower to download. Any important textual information in an image should also appear in the image's alt text, caption, or other nearby text.

=== Captions ===
Photographs and other graphics should always have captions, unless they are "self-captioning" images or when they are unambiguous depictions of the subject of the article.

==== Formatting of captions ====
* Captions normally start with a capital letter.
* Most captions are not complete sentences, but merely sentence fragments that should not end with a period. If any complete sentence occurs in a caption, all sentences and any sentence fragments in that caption should end with a period.
* The text of captions should not be specially formatted (with italics, for example), except in ways that would apply if it occurred in the main text.
* Captions should be succinct; more information about the image can be included on its description page, or in the main text.
* Captions for technical charts and diagrams may be substantially longer than those for other images. Captions for technical images should fully describe all the elements of the image, and the image's significance.

== Bulleted and numbered lists ==
* Do not use lists if a passage is read easily as plain paragraphs.
* Use proper wikimarkup- or template-based list code ''(see [[Help:Formatting#Lists and indentation]])''.
* Do not leave blank lines between items in a bulleted or numbered list unless there is a reason to do so, since this causes the wiki software to interpret each item as beginning a new list.
** Indents (such as this) are permitted if the elements are "Children" items
* Use numbers rather than bullets only if:
** A need to refer to the elements by number may arise; or
** The sequence of the items is critical.
* Use the same grammatical form for all elements in a list, and do not mix sentences and sentence fragments as elements.
** For example, when the elements are:
*** ''Complete sentences'', each one is formatted with sentence case (its first letter is capitalized) and a final period (full stop).
*** ''Sentence fragments'', the list is typically introduced by a lead fragment ending with a colon.
*** ''Titles of works'', they retain the original capitalization of the titles.
*** ''Other elements'', they are formatted consistently in either sentence case or lower case.

== Links ==
=== Wikilinks ===
'''Make [[Help:Formatting#Links|links]] only where they are relevant and helpful in the context:''' Excessive use of hyperlinks can be distracting and may slow the reader down. Redundant links clutter the page and make future maintenance harder. High-value links that ''are'' worth pursuing should stand out clearly.

'''Linking to sections:''' A hash sign (#) followed by the appropriate heading will lead to a relevant part of a page. For example, <code><nowiki>[[FlightGear#History]]</nowiki></code> links to a particular section of the article [[FlightGear]].

'''Initial capitalization:''' The wiki software does not require that wikilinks begin with an upper-case character. Only capitalize the first letter where this is naturally called for.

'''Linking in discussion pages:''' When adding a wikilink to a discussion page, it is preferable to use [[Help:Formatting#Permalinks_and_links_to_diffs|permalinks]] instead of ordinary links, since the content may have changed a lot before the next reader reads the comment. To highlight a specific edit, it might also be useful to link to a [[Help:Formatting#Permalinks_and_links_to_diffs|diff]].

=== External links ===
Do not use external links in the body of an article. Articles can include an ''external links'' section at the end, pointing to further information outside the wiki as distinct from citing sources. The standard format is a primary heading, <code>==External links==</code>, followed by a bulleted list of links. Identify the link and briefly indicate its relevance to the article: avoid linking to commercial and unrelated web sites, in essence ''spam''. For example:
:<code><nowiki>* [http://flightgear.org Official website]</nowiki></code>
:<code><nowiki>* [https://sourceforge.net/p/flightgear/codetickets/ Bug tracker]</nowiki></code>
These will appear as:
:* [http://flightgear.org Official website]
:* [https://sourceforge.net/p/flightgear/codetickets/ Bug tracker]

== Miscellaneous ==
=== Keep markup simple ===
The simplest markup is often the easiest to edit, the most comprehensible, and the most predictable. Markup may appear differently in different browsers. Use HTML and CSS markup sparingly; in particular, do not use the CSS <code>float</code> or <code>line-height</code> properties because they break rendering on some browsers when large fonts are used.

An HTML entity is sometimes better than the equivalent Unicode character, which may be difficult to identify in edit mode; for example, <code>&Alpha;</code> is understood where <code>Α</code> (the upper-case form of Greek <code>α</code>) may not be.

=== Use templates ===
Make use of [[:Category:Templates|existing templates]] whenever possible to ensure articles are styled in a uniform way. See [[Help:Templates|the Templates Help page]] for a quick introduction to templates.

=== Formatting issues ===
Modifications in font size, blank space, and color (see [[#Color coding|Color coding]], below) are an issue for the wiki site-wide style sheet, and should be reserved for special cases only.

Typically, the use of custom font styles will:
* reduce consistency, since the text will no longer look uniform;
* reduce usability, since it might be impossible for people with custom style sheets (for accessibility reasons, for example) to override it, and it might clash with a different skin as well as inconvenience people with color blindness (see below); and
* cause disputes, since other editors may disagree aesthetically with the choice of style.

Outside article text, different font sizes are routinely used in navigation templates and infoboxes, tables (especially in larger ones), and some other contexts where alternatives are not available (such as table captions). Specify font sizes ''relatively'' (for example in CSS with <code>font-size: 80%</code>) rather than ''absolutely'' (like <code>font-size: 8pt</code>).

==== Color coding ====
Information should be accessible to all. Do not use color ''alone'' to mark differences in text: they may be invisible to people with color blindness. Also, black-and-white printouts, older computer displays with fewer colors, and monochrome displays (older PDAs and cell phones) cannot show such distinctions.

Choose colors that can be distinguished by the readers with the commonest form of colorblindness (red–green), such as <span style="background: white; color: maroon">maroon</span> and <span style="background: white; color: teal">teal</span>; and ''additionally'' mark the differences with change of font or some other means (<span style="background: white; font-family: Georgia, serif; color: maroon; font face: Times New Roman">maroon and alternative font face</span>, <span style="background: white; color: teal">teal</span>). Avoid low contrast between text and background colors. Viewing the page with [http://colorfilter.wickline.org/ Wickline] can help with the choice of colors.

In addition to vision accessibility problems, usage of only color to encode attributes in tables instead of a separate sortable column, disables the use of the powerful wiki sortability feature on that attribute for all readers. Even for readers with unimpaired color vision, excessive background shading of table entries impedes readability and recognition of wikilinks. Background color should be used only as a ''supplementary'' visual cue, and should be subtle (consider using lighter, less-dominant pastel hues) rather than a glaring spotlight.

===Invisible comments===
Editors use invisible comments to communicate with each other in the body of the text of an article. These comments are visible only in the wiki source—that is, in edit source mode, not in read mode.

Invisible comments are useful for flagging an issue or leaving instructions about part of the text, where this is more convenient than raising the matter on the talk page. They should be used judiciously, because they can clutter the wiki source for other editors. Check that your invisible comment does not change the formatting, for example by introducing white space in read mode.

To leave an invisible comment, enclose the text you intend to be read only by editors between <code></code>. For example: {{xt|<code><nowiki></nowiki></code>}}

== Reference ==
This document contains a selection of relevant sections from {{wikipedia|Wikipedia:Manual of Style}}.

== Related content ==
* [[FlightGear wiki:FlightGear screenshot categories]]
* {{tl|informative template}} – ''Template documentation guidelines.''

[[Category:Wiki style guides]]

FlightGear wiki:Manual of Style

2016-05-11T17:42:23Z

Elgaton: /* Reference */ Use template for Wikipedia link

{{shortcut|FGW:MOS}}

The '''Manual of Style''' is a style manual for all FlightGear wiki articles. It helps editors write articles with consistent, clear, and precise language, layout, and formatting. The goal is to make using this wiki easier and more intuitive. Consistent language, style, and formatting promote clarity and cohesion. Writing should be clear and concise. Plain English works best; avoid ambiguity, jargon, and vague or unnecessarily complex wording.

Discuss style issues on [[FlightGear wiki talk:Manual of Style|the talk page]].

== Article titles, headings, and sections ==
=== Article titles ===
* Use sentence case, not title case. The initial letter of a title is capitalized (except in rare cases, such as eBay), but otherwise, capital letters are used only where they would be used in a normal sentence ({{xt|List of developed airports}}, not {{!xt|List of Developed Airports}}). Also, keep in mind that the wiki software automatically capitalizes the initial letter of a namespace/page title in its address.
* Titles should be precise enough to unambiguously define the topical scope of the article ({{xt|Boeing 747}}, not {{!xt|747}}).
* The characters <code># < > [ ] | { }</code> are reserved by the wiki software and can not be used.

=== Section organization ===
An article should begin with an introductory lead section, which should not contain section headings. The remainder may be divided into sections, each with a section heading (see below) that can be nested in a hierarchy. If there are at least four section headings in the article, a navigable table of contents is generated automatically and displayed between the lead and the first heading.

=== Section headings ===
Equal signs are used to mark the enclosed text as a section heading: <code>== Title ==</code> for a primary section; <code>=== Title ===</code> for the next level (a subsection); and so on to the lowest-level subsection, with <code>===== Title =====</code>. (The highest heading level technically possible is <code>= Title =</code>; but do not use it in articles, because it is reserved for the automatically generated top-level heading at the top of the page containing the title of the whole article.) Spaces between the equal signs and the heading text are optional, and will not affect the way the heading is displayed. The heading must be typed on a separate line. Include one blank line above the heading, and optionally one blank line below it, for readability in the edit window (but not two or more consecutive blank lines, which will add unnecessary visible white space in the rendered page.)

The provisions in [[#Article titles|Article titles]] (above) generally apply to section headings as well (for example, headings are in sentence case, not title case). The following points apply specifically to section headings:
* Headings should normally not contain links, especially where only part of a heading is linked.
* Section and subsection headings should preferably be unique within a page; otherwise section links may lead to the wrong place, and automatic edit summaries can be ambiguous.
* Citations should not be placed within or on the same line as section and subsection headings.
* Headings should not contain images.

== Capital letters ==
Sentence case rather than title case is used in wiki article titles and section headings; see [[#Article titles|Article titles]] and [[#Section headings|Section headings]] above. For capitalization of list items, see [[#Bulleted and numbered lists|Bulleted and numbered lists]]. Other points concerning capitalization are summarized below.

===Do not use capitals for emphasis===
Use italics, not capitals, to denote emphasis.
:''Incorrect'': {{!xt|It is not only a LITTLE learning that is dangerous}}.
:''Correct'': {{xt|It is not only a ''little'' learning that is dangerous}}.

===Calendar items===
* '''Months, days of the week, and holidays''' start with a capital letter ({{xt|June}}, {{xt|Monday}}).

===Celestial bodies===
* When used generally, the words '''<nowiki />''sun'', ''earth'', and ''moon''<nowiki />''' do not take capitals ({{xt|The sun was peeking over the mountain top}}), except when the term names a specific astronomical body ({{xt|The Moon orbits the Earth}}).

===Compass points===
Do not capitalize '''directions''' such as ''north'', nor their related forms ({{xt|Follow the northern road}}), except where they are parts of proper names (such as {{xt|South Pole}}).

Capitalize '''names of regions''' if they have attained proper-name status, including informal conventional names ({{xt|Southern California}} or {{xt|the Western Desert}}). Do not capitalize descriptive names for regions that have not attained the status of proper names, such as {{xt|southern Poland}}.

(Composite directions may or may not be hyphenated, depending on the style adopted in the article. {{xt|Southeast Asia}} and {{xt|northwest}} are more common in American English; but {{xt|South-East Asia}} and {{xt|north-west}} in British English. In cases such as {{xt|north–south dialogue}} and {{xt|east–west orientation}} an en dash is used.)

== Abbreviations ==
=== Write out both the full version and the abbreviation at first occurrence ===
* When an abbreviation is to be used in an article, give the expression in full at first, followed immediately by the abbreviation in parentheses (round brackets). In the rest of the article the abbreviation can then be used by itself:
::{{xt|The instrument landing system (ILS) is a ground-based instrument approach system}}, at the first mention of the instrument landing system; and
::{{xt|There are three categories of ILS}}, at a subsequent mention.
* Do not apply initial capitals in a full version simply because capitals are used in the abbreviation.
::{|style="background:transparent"
|-
|''Correct'': || {{xt|There are two types of flight rules: visual flight rules (VFR) and instrument flight rules (IFR).}}
|-
|''Incorrect'': || {{!xt|There are two types of flight rules: Visual Flight Rules (VFR) and Instrument Flight Rules (IFR).}}
|}

=== Ampersand ===
The ampersand (&) substitutes for the word ''and'' (it is a form of Latin ''et''). In normal text, ''and'' should be used instead: {{xt|version 1 and 2}}, not {{!xt|version 1 & 2}}. Ampersands may be used with consistency and discretion in tables, infoboxes, and similar contexts where space is limited.

== Italics ==
=== Emphasis ===
Italics may be used ''sparingly'' to emphasize words in sentences (whereas boldface is normally not used for this purpose). Generally, the more highlighting in an article, the less its effectiveness.

=== Quotations in italics ===
Quotations must always be clearly indicated as being quotations. For quotations, use only quotation marks (for short quotations) or block quoting (for long ones), not italics. (See [[#Quotations|Quotations]] below.) This means that (1) a quotation is not italicized inside quotation marks or a block quote just because it is a quotation, and (2) italics are no substitute for proper quotation formatting.

== Quotations ==
Where the same quotation has been used elsewhere in the article, avoid duplicating it, which is regarded as poor style.

The quotation should be representative of the whole source document; editors should be very careful to avoid misrepresentation of the argument in the source. Where a quotation presents rhetorical language in place of more neutral, dispassionate tone preferred for encyclopedias, it can be a backdoor method of inserting a non-neutral treatment of a controversial subject into the wiki's narrative on the subject, and should be avoided.

Quotations should generally be worked into the article text, so as not to inhibit the pace, flow and organization of the article. Longer quotes may need to be set apart, generally through the use of wikitext templates such as {{tl|Quote}} or {{tl|Quotation}}. Longer quotations may also be hidden in the reference (footnote) to facilitate verification by other editors without sacrificing readability. For pull quotes (quotes of the article text used to highlight a section) the {{tl|Cquote}} template can be used. Quotations used only as sources to support statements contained in the article can be added with a <tt><nowiki><ref></nowiki></tt> tag containing a reference formatted with the {{tl|cite web}} template; in that case, add {{tl|Appendix}} at the end of the page so that citations can be displayed in a uniform way.

=== Original wording ===
Quotations must be verifiably attributed and the wording of the quoted text should be faithfully reproduced. If there is a significant error in the original statement, use {{xt|[''[[sic]]'']}} to show that the error was not made by the wiki editors. However, trivial spelling and typographic errors should simply be corrected without comment (for example, correct {{!xt|basicly}} to {{xt|basically}}), unless the slip is textually important.

Use [[#Ellipses|ellipses]] to indicate omissions from quoted text. Legitimate omissions include extraneous, irrelevant, or parenthetical words. Do not omit text where doing so would remove important context or alter the meaning of the text.

=== Typographic conformity ===
In most cases it is not desirable to duplicate the original formatting. Formatting and other purely typographical elements of quoted text should be adapted to the wiki's conventions without comment provided that doing so will not change or obscure the meaning of the text. These are alterations which make no difference when the text is read aloud, such as:
* Changing capitalization so that sentences begin with capital letters.
* When quoting a quotation that itself contains a quotation, single quotes may be replaced with double quotes, and vice versa. See [[#Quotations within quotations|Quotations within quotations]] below.
* Removing spaces before punctuation such as periods and colons.
* Generally preserve bold and italics (see [[#Italics|Italics]], above), but most other styling should be altered.
* Expanding abbreviations.

=== Quotations within quotations ===
For quotations within quotations, use double quote marks outermost and, working inward, alternate single with double quote marks.

=== Attribution ===
The author of a quote of a full sentence or more should be named; this is done in the main text and not in a footnote. A reader should not have to follow a footnote to learn whose words a quote is.

=== Linking ===
As much as possible, avoid linking from within quotes, which may clutter the quotation, violate the principle of leaving quotations unchanged, and mislead or confuse the reader.

=== Block quotations ===
Format a long quote (more than about 40 words or a few hundred characters, or consisting of more than one paragraph, regardless of length) as a block quotation, which the wiki's software will indent from both margins. Do not enclose block quotations in quotation marks (and especially avoid decorative quotation marks in normal use, such as those provided by the {{tl|cquote}} template, which are reserved for pull quotes; quoted sections from elsewhere in the same wiki article). Block quotations can be added with {{tl|quote}} or {{tl|quotation}}.

=== Overusing quotations ===
Long quotations crowd the actual article and remove attention from other information. Many direct quotations can be minimized in length by providing an appropriate context in the surrounding text. A summary or paraphrase of a quotation is often better where the original wording could be improved. Consider minimizing the length of a quotation by paraphrasing, by working smaller portions of quotation into the article text, or both.

Overuse happens when:

<blockquote>a quotation is used without pertinence</blockquote>

This means that a quotation is visually on the page, but its relevance is not explained anywhere.

==== Specific recommendations ====
* Using too many quotes is incompatible with the encyclopedic writing style.
* As a matter of style, quoteboxes should generally be avoided as they draw special attention to the opinion of one source, and present that opinion as though the project endorses it. Instead of using quoteboxes to highlight its notability, explain its importance before introducing the quote or in an introduction to the quote.
* The wiki is not a list or repository of loosely associated topics such as quotations.
* Do not insert any number of quotations in a stand-alone quote section.
* A quotation that does not directly relate to the topic of the article or directly support the information as it is presented should not be used.
* Intersperse quotations with original prose that comments on those quotations instead of constructing articles out of quotations with little or no original prose.
* Longer quotations may be hidden in the reference as a footnote to facilitate verification by other editors without sacrificing readability.

== Punctuation ==

=== Apostrophes ===
* Consistent use of the straight (or ''typewriter'') apostrophe ({{xt| ' }}) is recommended, as opposed to the curly (or ''typographic'') apostrophe ({{!xt| ’ }}).

=== Quotation marks ===
;Double or single
: Enclose quotations with double quotation marks ({{xt|Bob said, "Jim ate the apple."}}). Enclose quotations inside quotations with single quotation marks ({{xt|Bob said, "Did Jim say 'I ate the apple' after he left?"}}).

;Block quotes
: As already noted [[#Quotations|above]], we use quotation marks or block quotes (not both) to distinguish long quotations from other text. Multiparagraph quotations are always block-quoted. The quotations must be precise and exactly as in the source (except for certain ''allowable typographical changes'', also noted [[#Typographic conformity|above]]). The source should be cited clearly and precisely.

===Brackets and parentheses===
These rules apply to both round brackets {{xt|( )}}, often called parentheses, and square brackets {{xt|[ ]}}.

If a sentence contains a bracketed phrase, place the sentence punctuation outside the brackets {{xt|(as shown here).}} However, where one or more sentences are wholly inside brackets, place their punctuation inside the brackets. There should be no space next to the inner side of a bracket. An opening bracket should usually be preceded by a space, for example. This may not be the case if it is preceded by an opening quotation mark, another opening bracket, or a portion of a word.

There should be a space after a closing bracket, except where a punctuation mark follows (though a spaced dash would still be spaced after a closing bracket) and in unusual cases similar to those listed for opening brackets.

If sets of brackets are nested, use different types for adjacent levels of nesting; for two levels, it is customary to have square brackets appear within round brackets. This is often a sign of excessively convoluted expression; it is often better to recast, linking the thoughts with commas, semicolons, colons, or dashes.

Avoid adjacent sets of brackets. Either put the parenthetic phrases in one set separated by commas, or rewrite the sentence.

Square brackets are used to indicate editorial replacements and insertions within quotations, though this should never alter the intended meaning. They serve three main purposes.

====Sentences and brackets====
* If any sentence includes material that is enclosed in square or round brackets, it still must end—with a period, or a question or exclamation mark—''after'' those brackets. This principle applies no matter what punctuation is used within the brackets.
* However, if the entire sentence is within brackets, the closing punctuation falls within the brackets. (This sentence is an example.) This does not apply to matter that is added (or modified editorially) at the beginning of a sentence for clarity, which is usually in square brackets.

=== Ellipses ===
An ellipsis (plural ''ellipses'') is used to indicate an omission of material from quoted text or some other omission, perhaps of the end of a sentence, often in a printed record of conversation. The ellipsis is represented by '''ellipsis points''': a set of three unspaced periods, surrounded by square brackets {{xt|[...]}}.

== Dates and time ==
=== Time of day ===
Time of day is normally expressed in figures rather than being spelled out. Context determines whether the 12- or 24-hour clock is used.
* 12-hour clock times are written in the form {{xt|11:15 a.m.}} and {{xt|2:30 p.m.}}, or the form {{xt|11:15 am}} and {{xt|2:30 pm}}, with a space before the abbreviation.
* 24-hour clock times are written in the form {{xt|08:15}}, {{xt|22:55}}, with no suffix. Note that {{xt|00:00}} refers to midnight at the start of a date, and {{xt|24:00}} to midnight at the end of a date.

=== Days ===
* For full dates, use the format {{xt|10 June 1921}} or the format {{xt|June 10, 1921}}. Similarly, where the year is omitted, use {{xt|10 June}} or {{xt|June 10}}. For choice of format, see below.
* Do not use numerical date formats such as {{!xt|03/04/2005}}, as this could refer to 3 April or to March 4. If a numerical format is required (e.g. for conciseness in long lists and tables), use the YYYY-MM-DD format: {{xt|2005-04-03}}.

==== Choice of format ====
* All the dates in a given article should have the same format (day-month or month-day). These requirements do not apply to dates in quotations or titles.
* Otherwise, do not change an article from one form to another without good reason.

=== Months ===
* For month and year, write {{xt|June 1921}}, with no comma.
* Abbreviations for months, such as {{xt|Feb}}, are used only where space is extremely limited. Such abbreviations should use three letters only, and should not be followed by a period (full stop) except at the end of a sentence.

=== Years and longer periods ===
* Do not use ''the year'' before the digits ({{xt|1995}}, not {{!xt|the year 1995}}), unless the meaning would otherwise be unclear.
* Decades are written in the format {{xt|the 1980s}}, with no apostrophe. Use the two-digit form ('80s) only with an established social or cultural meaning. Avoid forms such as {{!xt|the 1700s}} that could refer to 10 or 100 years.

=== Current ===
Use of the term "current" should be avoided. What is current today may not be tomorrow; situations change over time. Instead, use date- and time-specific text.
:{|style="background:transparent"
|-
|''Incorrect'':||{{!xt|FlightGear 3.0 is currently the latest version ...}}
|-
|''Correct'':||{{xt|As of February 2014, FlightGear 3.0 is the latest version ...}}
|}

== Numbers ==
* In general, write whole numbers from one to nine as words, write other numbers that take two words or fewer to say as either figures or words (with consistency within each article), and write all other numbers as figures: {{xt|1/5}} or {{xt|one-fifth}}, {{xt|84}} or {{xt|eighty-four}}, {{xt|200}} or {{xt|two hundred}}, but {{xt|3.75}}, {{xt|544}}, {{xt|21 million}}.
* In general, use a comma to delimit numbers with five or more digits to the left of the decimal point. Numbers with four digits are at the editor's discretion: {{xt|12,345}}, but either {{xt|1,000}} or {{xt|1000}}.
* In general, use decimals rather than vulgar fractions with measurements.
* Write out "million" and "billion" on the first use. After that, unspaced "M" can be used for millions and "bn" for billions: {{xt|70M}} and {{xt|25bn}}.
* Write {{xt|3%}}, {{xt|three percent}}, or {{xt|three per cent}}, but not {{!xt|3 %}} (with a space) or {{!xt|three %}}. "Percent" is American usage, and "per cent" is British usage. In ranges of percentages written with an en dash, write only one percent sign: {{xt|3–14%}}.

==Units of measurement==
* The main unit in which a quantity is expressed should generally be an SI unit or non-SI unit officially accepted for use with the SI.
* In a direct quotation, always keep the source units. If a conversion is required, it should appear within square brackets in the quote, or else an obscure use of units can be explained in a footnote.
* Where space is limited (such as tables, infoboxes, parenthetical notes, and mathematical formulas) use unit symbols. In main text it is usually better to spell out unit names, but symbols may also be used when a unit (especially one with a long name) is used repeatedly. However, spell out the first instance of each unit in an article (for example, {{xt|the typical batch is 250 kilograms ... and then 15 kg of emulsifier is added}}), except for unit names that are hardly ever spelled out (e.g. the degree Celsius). Most unit names are not capitalized. Use "per" when writing out a unit, rather than a slash: {{xt|meter per second}}, not {{!xt|meter/second}}.
* Potentially unfamiliar unit symbols should be introduced parenthetically at their first occurrence in the article, with the full name given first: for example, {{xt|His initial betatron reached energies of 2.3 megaelectronvolts (MeV), while subsequent betatrons achieved 300 MeV.}}
* When dimensions are given, each number should be followed by a unit name or symbol (e.g. write {{xt|1 m × 3 m × 6 m}}, not {{!xt|1 × 3 × 6 m}}).
* When they form a compound adjective, values and unit names should be separated by a hyphen: for example, {{xt|a five-day race}}.
* Unit symbols are preceded by figures, not by spelled-out numbers. Values and unit symbols are separated by a non-breaking space. For example, {{xt|5 min}}. The percent sign, and units of degrees, minutes, and seconds ''for angles and coordinates'', are unspaced.
* Standard unit symbols do not require a full stop (period). However non-standard abbreviations should always be given a full stop.
* No ''s'' is appended, e.g. {{xt|km}}, {{xt|in}}, {{xt|lb}}, not {{!xt|kms}}, {{!xt|ins}}, {{!xt|lbs}}.
* Write powers of unit symbols with HTML, e.g. {{xt|<nowiki>5 km<sup>2</sup></nowiki>}} not Unicode superscripts and subscripts.
* For quantities of bytes and bits, specify whether the binary or decimal meanings of K, M, G, etc. are intended.

== Grammar and usage ==
=== First-person pronouns ===
Wiki articles must not be based on one person's opinions or experiences. The use of ''I'', ''my'', or similar forms is restricted to user pages and quotations. Also avoid ''we'', ''us'', and ''our'': {{!xt|We should note that some critics have argued against our proposal}} (personal rather than encyclopedic).

== Vocabulary ==
=== Contractions ===
Uncontracted forms such as {{xt|do not}} or {{xt|it is}} are the default in encyclopedic style; {{!xt|don't}} and {{!xt|it's}} are too informal.

=== Foreign terms ===
Foreign words should be used sparingly.

==== No common usage in English ====
Use italics for phrases in other languages and for isolated foreign words that are not current in English.

==== Common usage in English ====
Loanwords and borrowed phrases that have common usage in English ({{xt|vice versa}}) do not require italics. A rule of thumb is not to italicize words that appear unitalicized in major English-language dictionaries.

=== Technical language ===
Some topics are intrinsically technical, but editors should try to make them understandable to as many readers as possible. Minimize jargon, or at least explain it. For unavoidably technical articles a separate introductory article may be the best solution. Avoid excessive ''wikilinking'' (linking within the wiki) as a substitute for parenthetic explanations such as the one in this sentence. Do not introduce new and specialized words simply to teach them to the reader when more common alternatives will do. When the notions named by jargon are too complex to concisely explain in a few parenthetical words, write one level down. For example, consider adding a brief background section with {{tl|main}} tags pointing to the full treatment article(s) of the prerequisite notions; this approach is practical only when the prerequisite concepts are central to the exposition of the article's main topic, and when such prerequisites aren't too numerous.

=== Geographical items ===
Places should generally be referred to consistently by the same name as in the title of their article. Exceptions are made if there is a widely accepted historical English name appropriate to the given context. In cases where such a historical name is used, it should be followed by the modern name in round brackets (parentheses) on the first occurrence of the name in applicable sections of the article. This resembles linking; it should not be done to the detriment of style. On the other hand, it is probably better to provide such a variant too often than too rarely. If more than one historical name is applicable for a given context, the other names should be added after the modern English name, that is: "historical name (modern name, other historical names)".

== Images ==
* Infoboxes, images, and related content in the lead must be right-aligned.
* Use captions to clarify the relevance of the image to the article (see [[#Captions|Captions]], below).
* Each image should be inside the major section to which it relates (within the section defined by the most recent level 2 heading or at the top of the lead), not immediately above the section heading.
* Avoid sandwiching text between two images that face each other, and between an image and an infobox or similar.
* The thumbnail option may be used ("<code>thumb</code>"), or another size may be fixed. The default thumbnail width is 220 pixels; users can adjust this in their preferences. Lead images should be no wider than "upright=1.35" (by default this is 300 pixels).
* Avoid referring to images as being on the left or right. Image placement is different for viewers of the mobile version of the wiki and might change in the future. Instead, use captions to identify images.

=== Avoid entering textual information as images ===
Textual information should almost always be entered as text rather than as an image. True text can be colored and adjusted with CSS tags and templates, but text in images cannot be. Images are not searchable and are slower to download. Any important textual information in an image should also appear in the image's alt text, caption, or other nearby text.

=== Captions ===
Photographs and other graphics should always have captions, unless they are "self-captioning" images or when they are unambiguous depictions of the subject of the article.

==== Formatting of captions ====
* Captions normally start with a capital letter.
* Most captions are not complete sentences, but merely sentence fragments that should not end with a period. If any complete sentence occurs in a caption, all sentences and any sentence fragments in that caption should end with a period.
* The text of captions should not be specially formatted (with italics, for example), except in ways that would apply if it occurred in the main text.
* Captions should be succinct; more information about the image can be included on its description page, or in the main text.
* Captions for technical charts and diagrams may be substantially longer than those for other images. Captions for technical images should fully describe all the elements of the image, and the image's significance.

== Bulleted and numbered lists ==
* Do not use lists if a passage is read easily as plain paragraphs.
* Use proper wikimarkup- or template-based list code ''(see [[Help:Formatting#Lists and indentation]])''.
* Do not leave blank lines between items in a bulleted or numbered list unless there is a reason to do so, since this causes the wiki software to interpret each item as beginning a new list.
** Indents (such as this) are permitted if the elements are "Children" items
* Use numbers rather than bullets only if:
** A need to refer to the elements by number may arise; or
** The sequence of the items is critical.
* Use the same grammatical form for all elements in a list, and do not mix sentences and sentence fragments as elements.
** For example, when the elements are:
*** ''Complete sentences'', each one is formatted with sentence case (its first letter is capitalized) and a final period (full stop).
*** ''Sentence fragments'', the list is typically introduced by a lead fragment ending with a colon.
*** ''Titles of works'', they retain the original capitalization of the titles.
*** ''Other elements'', they are formatted consistently in either sentence case or lower case.

== Links ==
=== Wikilinks ===
'''Make [[Help:Formatting#Links|links]] only where they are relevant and helpful in the context:''' Excessive use of hyperlinks can be distracting and may slow the reader down. Redundant links clutter the page and make future maintenance harder. High-value links that ''are'' worth pursuing should stand out clearly.

'''Linking to sections:''' A hash sign (#) followed by the appropriate heading will lead to a relevant part of a page. For example, <code><nowiki>[[FlightGear#History]]</nowiki></code> links to a particular section of the article [[FlightGear]].

'''Initial capitalization:''' The wiki software does not require that wikilinks begin with an upper-case character. Only capitalize the first letter where this is naturally called for.

'''Linking in discussion pages:''' When adding a wikilink to a discussion page, it is preferable to use [[Help:Formatting#Permalinks_and_links_to_diffs|permalinks]] instead of ordinary links, since the content may have changed a lot before the next reader reads the comment. To highlight a specific edit, it might also be useful to link to a [[Help:Formatting#Permalinks_and_links_to_diffs|diff]].

=== External links ===
Do not use external links in the body of an article. Articles can include an ''external links'' section at the end, pointing to further information outside the wiki as distinct from citing sources. The standard format is a primary heading, <code>==External links==</code>, followed by a bulleted list of links. Identify the link and briefly indicate its relevance to the article: avoid linking to commercial and unrelated web sites, in essence ''spam''. For example:
:<code><nowiki>* [http://flightgear.org Official website]</nowiki></code>
:<code><nowiki>* [https://sourceforge.net/p/flightgear/codetickets/ Bug tracker]</nowiki></code>
These will appear as:
:* [http://flightgear.org Official website]
:* [https://sourceforge.net/p/flightgear/codetickets/ Bug tracker]

== Miscellaneous ==
=== Keep markup simple ===
The simplest markup is often the easiest to edit, the most comprehensible, and the most predictable. Markup may appear differently in different browsers. Use HTML and CSS markup sparingly; in particular, do not use the CSS <code>float</code> or <code>line-height</code> properties because they break rendering on some browsers when large fonts are used.

An HTML entity is sometimes better than the equivalent Unicode character, which may be difficult to identify in edit mode; for example, <code>&Alpha;</code> is understood where <code>Α</code> (the upper-case form of Greek <code>α</code>) may not be.

=== Use templates ===
Make use of [[:Category:Templates|existing templates]] whenever possible to ensure articles are styled in a uniform way. See [[Help:Templates|the Templates Help page]] for a quick introduction to templates.

=== Formatting issues ===
Modifications in font size, blank space, and color (see [[#Color coding|Color coding]], below) are an issue for the wiki site-wide style sheet, and should be reserved for special cases only.

Typically, the use of custom font styles will:
* reduce consistency, since the text will no longer look uniform;
* reduce usability, since it might be impossible for people with custom style sheets (for accessibility reasons, for example) to override it, and it might clash with a different skin as well as inconvenience people with color blindness (see below); and
* cause disputes, since other editors may disagree aesthetically with the choice of style.

Outside article text, different font sizes are routinely used in navigation templates and infoboxes, tables (especially in larger ones), and some other contexts where alternatives are not available (such as table captions). Specify font sizes ''relatively'' (for example in CSS with <code>font-size: 80%</code>) rather than ''absolutely'' (like <code>font-size: 8pt</code>).

==== Color coding ====
Information should be accessible to all. Do not use color ''alone'' to mark differences in text: they may be invisible to people with color blindness. Also, black-and-white printouts, older computer displays with fewer colors, and monochrome displays (older PDAs and cell phones) cannot show such distinctions.

Choose colors that can be distinguished by the readers with the commonest form of colorblindness (red–green), such as <span style="background: white; color: maroon">maroon</span> and <span style="background: white; color: teal">teal</span>; and ''additionally'' mark the differences with change of font or some other means (<span style="background: white; font-family: Georgia, serif; color: maroon; font face: Times New Roman">maroon and alternative font face</span>, <span style="background: white; color: teal">teal</span>). Avoid low contrast between text and background colors. Viewing the page with [http://colorfilter.wickline.org/ Wickline] can help with the choice of colors.

In addition to vision accessibility problems, usage of only color to encode attributes in tables instead of a separate sortable column, disables the use of the powerful wiki sortability feature on that attribute for all readers. Even for readers with unimpaired color vision, excessive background shading of table entries impedes readability and recognition of wikilinks. Background color should be used only as a ''supplementary'' visual cue, and should be subtle (consider using lighter, less-dominant pastel hues) rather than a glaring spotlight.

===Invisible comments===
Editors use invisible comments to communicate with each other in the body of the text of an article. These comments are visible only in the wiki source—that is, in edit source mode, not in read mode.

Invisible comments are useful for flagging an issue or leaving instructions about part of the text, where this is more convenient than raising the matter on the talk page. They should be used judiciously, because they can clutter the wiki source for other editors. Check that your invisible comment does not change the formatting, for example by introducing white space in read mode.

To leave an invisible comment, enclose the text you intend to be read only by editors between <code></code>. For example: {{xt|<code><nowiki></nowiki></code>}}

== Reference ==
This document contains a selection of relevant sections from {{wikipedia|Wikipedia:Manual_of_Style}}.

== Related content ==
* [[FlightGear wiki:FlightGear screenshot categories]]
* {{tl|informative template}} – ''Template documentation guidelines.''

[[Category:Wiki style guides]]