Difference between revisions of "Community:Information"

From BaseX Documentation
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 13: Line 13:
 
If you have not signed up yet: this is the moment to [[Special:UserLogin|create your account]].  
 
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 choose from a list of pages that might need some maintenance:
+
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:WantedPages|Most wanted articles]]  
 
* [[Special:ShortPages|List of short articles]]
 
* [[Special:ShortPages|List of short articles]]
Line 32: Line 32:
  
 
;Article Title
 
;Article Title
:Please make sure article titles are singular nouns wherever possible.
+
:Please make sure article titles are upper-case and singular nouns wherever possible.
  
 
;Categories
 
;Categories
: Try to categorize your article via <nowiki>[[Category:Name]]</nowiki>
+
:Try to categorize your article via <nowiki>[[Category:Name]]</nowiki>.
  
 
;Code Examples
 
;Code Examples
:Please use the <nowiki>[[Category:Code Examples]]</nowiki>
+
:Please use the <nowiki>[[Category:Code Examples]]</nowiki>.
  
 
;Syntax Highlighting
 
;Syntax Highlighting
:Please surround your code with: <nowiki><pre class="brush:{xml|xquery|java}>…</pre></nowiki>and the code is  automatically highlighted
+
:You can highlight your code as follows: <nowiki><syntaxhighlight lang="{xml|xquery|java}>…</syntaxhighlight></nowiki>
  
 
==Writing Articles==
 
==Writing Articles==
  
 
Please see [[Help:Editing]] for some information on ''Wiki Syntax''.
 
Please see [[Help:Editing]] for some information on ''Wiki Syntax''.

Latest revision as of 15:34, 27 February 2020

Welcome to our community information page. This is the location to discuss all kinds of editor related information.

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: <syntaxhighlight lang="{xml|xquery|java}>…</syntaxhighlight>

Writing Articles[edit]

Please see Help:Editing for some information on Wiki Syntax.