How to write/edit manual pages

  1. Login. If you do not have login name and password, please write to any participant of the SPARX project. Anybody can add a new participant to the list of users.

  2. Please remember that the documentation is a shared project. So, please correct obvious mistakes but consult other before making far reaching changes in the documentation.
  3. If you plan to add a new manual page, follow these steps.

    1. direct your browser to http://sparx-em.org/sparxwiki/my_new_manual_page (with rare exception, my_new_manual_page should be the name of the function that it describes)

    2. you will see a page with a number of choices, select SparxDocTemplate.

    3. fill out the template, please do not modify the lines = Title =, but feel free to remove some of them, if they do not correspond to what you have to write
    4. in order to make the page more appealing, feel free to use tricks that are listed below the box in which you edit

    5. use the Preview button to verify your composition of the page
    6. use button Save Changes when you are done
    7. the page will appear in the final form. To make further corrections, use button Edit on the left and goto v.
  4. Another method to add a new manual page by modify an existing manual page

    • i. display page you are going to use as a template
    • ii. use Edit button on the left
    • iii. copy and paset the content into any basic text editor
    • iv. direct your browser to http://sparx-em.org/sparxwiki/my_new_manual_page

    • v. you will see a page with a number of choices, select Create New Empty Page.

    • vi. Copy and paste into the new empty page whatever you stored in your text editor
    • vii. make changes as you see fit
    • viii. use the Preview button to verify your composition of the page
    • ix. use button Save Changes when you are done
    • x. the page will appear in the final form. To make further corrections, use button Edit on the left and goto viii.
  5. In order to modify an existing page

    • i. display page you are going to use as a template
    • ii. use Edit button on the left
    • iii. make changes as you see fit
    • iv. use the Preview button to verify your composition of the page
    • v. use button Save Changes when you are done
    • vi. the page will appear in the final form. To make further corrections, use button Edit on the left and goto iii.
  6. In order to rename an existing page (this is a rare case of using an incorrect name or change the name of the underlying function)

    • i. display page you are going to rename
    • ii. use Rename page button on the left

If you would like to use equations

  1. download and install MathPlayer http://www.dessci.com/en/products/mathplayer/

  2. look at http://sparx-em.org/sparxwiki/SampleMath for a short example or check manual pages (option Edit) to see how the equations were coded.

  3. for syntax description, see http://www1.chapman.edu/~jipsen/mathml/asciimath.html, but please keep in mind that equations must be surrounded by three sets of curly paranthesis (to see it use Edit button and examine the source of this page).

  4. ` "Example", le "turned into special symbol" `

HowtoManualPages (last edited 2014-09-05 19:30:40 by penczek)