Difference between revisions of "Community:Information"
m (Created page with "Welcome to our community information page. This is the location to discuss all kinds of editor related information. ==About the documentation project== We decided to open the do...") |
m (Text replacement - "syntaxhighlight" to "pre") |
||
(13 intermediate revisions by 3 users not shown) | |||
Line 3: | Line 3: | ||
==About the documentation project== | ==About the documentation project== | ||
− | We decided to open the documentation process to our community. To us this a natural consequence from all the positive experience we made during the last years. | + | We decided to open the documentation process to our community. To us this is a natural consequence from all the positive experience we made during the last years. |
We know, | We know, | ||
− | * writing good documentation | + | * writing good documentation is essential for both our users & developers |
* constant feedback helps improving so please feel free and discuss our articles or file requests for new ones | * constant feedback helps improving so please feel free and discuss our articles or file requests for new ones | ||
− | * some of you have very profound knowledge of BaseX and its infrastructure. You are very welcome to contribute Articles & Edits. | + | * some of you have very profound knowledge of BaseX and its infrastructure. You are very welcome to contribute Articles & Edits. |
− | == | + | == Where to start == |
− | + | If you have not signed up yet: this is the moment to [[Special:UserLogin|create your account]]. | |
− | |||
− | |||
− | * | + | You may now start by either creating articles or choosing from a list of pages that might need some maintenance: |
+ | *[[Special:WantedPages|Most wanted articles]] | ||
+ | * [[Special:ShortPages|List of short articles]] | ||
+ | *[[Special:DeadendPages| List of pages that have no outgoing links]] | ||
+ | |||
+ | ===Wanted Articles=== | ||
+ | You may also add links to Topics you would like to see in our documentation: | ||
+ | |||
+ | Surround a word with double brackets:<br/> | ||
+ | <nowiki>[[Wanted Topic]]</nowiki> and that word will be highlighted in red. | ||
+ | |||
+ | ===Guidelines for new Articles === | ||
+ | |||
+ | For now we only have few guidelines we used when creating new articles. Feel free to extend or change this list. | ||
+ | |||
+ | ;Don't be afraid | ||
+ | :We happily accept your contributions. | ||
+ | |||
+ | ;Article Title | ||
+ | :Please make sure article titles are upper-case and singular nouns wherever possible. | ||
+ | |||
+ | ;Categories | ||
+ | :Try to categorize your article via <nowiki>[[Category:Name]]</nowiki>. | ||
+ | |||
+ | ;Code Examples | ||
+ | :Please use the <nowiki>[[Category:Code Examples]]</nowiki>. | ||
+ | |||
+ | ;Syntax Highlighting | ||
+ | :You can highlight your code as follows: <nowiki><pre lang="{xml|xquery|java}>…</pre></nowiki> | ||
+ | |||
+ | ==Writing Articles== | ||
+ | |||
+ | Please see [[Help:Editing]] for some information on ''Wiki Syntax''. |
Latest revision as of 18:39, 1 December 2023
Welcome to our community information page. This is the location to discuss all kinds of editor related information.
Contents
About the documentation project[edit]
We decided to open the documentation process to our community. To us this is a natural consequence from all the positive experience we made during the last years.
We know,
- writing good documentation is essential for both our users & developers
- constant feedback helps improving so please feel free and discuss our articles or file requests for new ones
- some of you have very profound knowledge of BaseX and its infrastructure. You are very welcome to contribute Articles & Edits.
Where to start[edit]
If you have not signed up yet: this is the moment to create your account.
You may now start by either creating articles or choosing from a list of pages that might need some maintenance:
Wanted Articles[edit]
You may also add links to Topics you would like to see in our documentation:
Surround a word with double brackets:
[[Wanted Topic]] and that word will be highlighted in red.
Guidelines for new Articles[edit]
For now we only have few guidelines we used when creating new articles. Feel free to extend or change this list.
- Don't be afraid
- We happily accept your contributions.
- Article Title
- Please make sure article titles are upper-case and singular nouns wherever possible.
- Categories
- Try to categorize your article via [[Category:Name]].
- Code Examples
- Please use the [[Category:Code Examples]].
- Syntax Highlighting
- You can highlight your code as follows: <pre lang="{xml|xquery|java}>…</pre>
Writing Articles[edit]
Please see Help:Editing for some information on Wiki Syntax.