mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 15:22:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update wikipage How to contribute to documentation. (Signed-off-by:jocelyn).

Browse Source 
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1440 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2015-09-28 12:22:22 +00:00
parent 99f2ac2dc2
commit dab54e8402
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/trunk/contribute/documentation.wiki
View File

@@ -1,16 +1,18 @@
[[Property:title|How to contribute to documentation]] [[Property:title|How to contribute to documentation]]
[[Property:link_title|To documentation]] [[Property:link_title|To documentation]]
[[Property:weight|1]] [[Property:weight|1]]
[[Property:uuid|aab3d23e-ef56-4324-b885-067b14a3009b]] [[Property:uuid|6AF9325E-69F2-4516-89A5-9370D6684423]]
= Current documentation system = = Current documentation system =
* The documentation is written using wikitext syntax. * The documentation is written using wikitext syntax (similar to wikipedia).
* Each documentation page is stored in a wiki file on disk. * Each documentation page is stored in a wiki file on disk.
* Those files come from the subversion repository: [https://svn.eiffel.com/eiffel-org/trunk/documentation/current] . * Those files come from the subversion repository: [https://svn.eiffel.com/eiffel-org/trunk/documentation/current] .
* The outline of book are following the underlying directory structure, and each wiki file can have properties that hold metadata such as: * The outline of book are following the underlying directory structure, and each wiki file can have properties that hold metadata such as:
:<nowiki>[[Property:title|The page title]]</nowiki> :<nowiki>[[Property:title|The page title]]</nowiki>
:<nowiki>[[Property:link_title|short title]]</nowiki> :<nowiki>[[Property:link_title|short title]]</nowiki>
:<nowiki>[[Property:weight|5]]</nowiki> :<nowiki>[[Property:weight|5]]</nowiki>
* '''link_title''' is used to have a short title in menu, or various links.
* '''weight''' is used to order sibling pages (lower weight goes before, upper weight goes after).
= To contribute = = To contribute =
* First, you can post comment on any page (see comment form at the bottom of each page). * First, you can post comment on any page (see comment form at the bottom of each page).
@@ -37,4 +39,4 @@
= Live editing on this site = = Live editing on this site =
* If you are a trusted editor, you can edit the documentation directly. * If you are a trusted editor, you can edit the documentation directly.
* To be a trusted editor, please request it via the [/contact] page (don't forget to mention who you are and why you should be a trusted editor). * To be a trusted editor, please request it via the [/contact] page (do not forget to mention who you are and why you think you should be a trusted editor).