====== Contribute to DiscoveryNG manual ====== This manual is **open to contribution** by everyone that like to improve its content. This is why we choose a wiki!! Everyone can change a page once [[:home?do=register|registered]] to the site. To help who doesn't know how to edit a page, there's the [[wiki:syntax|wiki syntax]] page to learn a lot of trick. We have also installed a lot of plugins, one of the most useful is [[https://www.dokuwiki.org/plugin:wrap|wrap]], to create and place inside the page information box. We suggest to use it when you insert a [[#Formatting convetions|note]]. ===== How to contribute ===== You can contribute in a number of ways: * **for those who already know [[wiki:syntax|wiki syntax]]**, you can start create or improve pages.\\ Also, when you find a FIXME icon maybe you should stop and try to improve that content. * **for those who doesn't knwo at all a wiki**, you can start editing pages:\\ - adding links between pages\\ - adding screenshots (DiscoveryNG images)\\ - adding FIXME tag when you think there are page to fix\\ - improving readability through bold, headings, underline, emphasis :) * **for those who doesn't want to edit pages**, but want to share guidelines or learning materials on DiscoveryNG (like F.A.Q. or tutorials), you can send an email to //assistenza@comperio.it// with [DISCOVERYNG Manual] in the object and the material attached. You can send plain text, .odt, .pdf etc [[?do=search&id=FIXME|Find pages to FIX]]. ===== Formatting conventions ===== **Headings**, should be used from the first level (H1), this allow the automatic generation of the TOC on the top of the page. When you must describe a long list of elemets (like the search field), you should use a table with two column (value and description). **NOTES** are for suggestions, alerts or related contents and should be formatted as follow == Note title == note content For the notes we choosed a DokuWiki plugin called [[https://www.dokuwiki.org/plugin:wrap|wrap]]. So, depending on note type, instead of //info//, you can use: //important//, //tip//, //help//, //download//, //todo//, //alert//. For **FAQ** and **GUIDE** links should be used the following syntax :?: **GUIDE:** [[link to the guide]] :?: **FAQ:** [[link to the FAQ]]