====== Greenstone Manuals ======

===== Importing =====

To import the XML form of a manual into the Wiki run the PHP importing script from the command line:<code>cd <gsdl-docs>/php
php gs-manual-import.php -m [user|install|develop|paper]</code>

===== Exporting =====

Export of a manual into XML form is handled by clicking one of the two links at the top of the top level manual page (where cover metadata is listed). Exporting the draft version of a manual will produce XML from the latest version of pages regardless of approval, while the approved version of a manual includes only the most recently approved versions of pages.

===== Editing The Manuals =====

  * You need to be registered and logged in
  * You can only edit English versions of manuals - due to limitations in the translation process software
  * Feel free to 'discuss' any non-English change requests
  * In general use the [[wiki:syntax|Dokuwiki syntax]]
  * There are a number of rules that must be followed when editing
    * All text strings that require translation should be preceded by a unique identifier, of the form:<code><!-- id:uniqueidentifier -->Text string</code>If not provided the export system will do its best to generate one, and will also ensure that any identifier given is indeed unique (by adding a numeric suffix as necessary)
    * If you want HTML comment markers to appear verbatim in the displayed text you have to use a special notation to prevent them being confused with actual HTML comments (that are hidden in the text), like so:<code>%!-- The comment uses percents instead of angle brackets --%</code>
    * Special notation for figure captions:<code><imgcaption figure_x|The caption></code>The caption may also include subcaptions, which are assumed to start with (a), (b), (c) etc:<code><imgcaption figure_y|Another caption (a) with subcaption></code>Finally, you can include unique identifiers for caption strings using the same notation as for HTML comments:<code><imgcaption figure_z|%!-- id:cap8 --%Last caption %!-- id:cap8sub1 --%(z) and its subcaption></code>
    * Table captions have a special notation similar to figures:<code><tblcaption table_x|The caption></code>
    * To reference a figure you link to its caption using the notation:<code><imgref figure_x></code>The reference to a table caption is once again similar:<code><tblref table_x></code>Please note that references to figures and tables only work within the same page
    * Table and Figures may be preceded by:<code>==START==</code>and followed by<code>==END==</code> headings in order to provide convenient edit links