Contributing to this Wiki

De Wiki de Calcul Québec
(Redirigé depuis Contributing to this Wiki)
Aller à : Navigation, rechercher
Cette page est une traduction de la page Pour contribuer à ce Wiki et la traduction est complétée à 100 % et à jour.

Autres langues :anglais 100% • ‎français 100%

Please consult the User's guide for more information on using Media Wiki. You can also look at the MediaWiki FAQ.

What to document?

Here are a few suggestions for contributions that are relevant for the Calcul Québec Wiki.

Software

Does your research group use specialized software? You can document its use to ease the integration of new group members, or even to allow other research groups to benefit from your experience.

Problems

Have you encountered a specific problem that has not been documented? It could be interesting to document how it was solved, in case other users encounter the same difficulty.

Optimization

Have you tested the performance of your software and found the optimal settings for one or more servers? Why not share this experience with others?

Improve the documentation

Is the existing documentation vague or not precise? Do the explanations lack clarity? Would it be good to add an example? Why not get involved and improve the pages that are already there? You found a typo or a grammatical mistake? Please do not hesitate to correct it.

Translation

It is possible that some Wiki pages are only in French, or only in English. Translations always welcome!

Please find a list of pages to translate here:


How to document?

Standards and basic syntax

This Wiki uses MediaWiki. The following table describes the main syntax for Calcul Québec.

Description You type You obtain
Link to a wiki page Using double square brackets :
[[This is a link to an internal page]]
  • If the page does not exist, click on the proposed link to create the page.

This is a link to an internal page

Link to a wiki page with a new displayed text Using double square brackets and the vertical bar :
[[This is a link to an internal page|Click here]]
  • If the page does not exist, click on the proposed link to create the page.

Click here

Link to an external page Use single square brackets :
[http://www.google.com Google's web site]
[mailto:support@calculquebec.ca To reach our team of analysts]
  • Words that are placed after the address are displayed as the text of the link. If there is no text there, the link is displayed as is.

Google's web site
To reach our team of analysts

Text in italics
''italic''

italic

Bold text
'''bold'''

bold

Blocking wiki syntax
<nowiki> "inactive'' syntax </nowiki>

''inactive'' syntax

At the top of different levels

== Level 2 ==

=== Level 3 ===

==== Level 4 ====

  • There is no level 1, that's the page's title.
  • On articles with more than 4 headings, a summary is automatically created.

Level 2

Level 3

Level 4

Horizontal dash
Text above
----
Text below

Text above


Text below

Bulleted lists
* Start every list with an asterisk (*).
** Multiple asterisks together go down
*** levels.
* Line breaks<br />do not break levels.
*** But a jump in level creates an empty space.
All other beginnings finish the list.
  • Start every list with an asterisk (*).
    • Multiple asterisks together go down
      • levels.
  • Line breaks
    do not break levels.
      • But a jump in level creates an empty space.

All other beginnings finish the list.

Numbered lists
# Start every list with a number sign (#).
## Multiple pound signs together go down
### levels.
# Empty lines

# finish the list and start a new one.
All other beginnings finish the list.
  1. Start every list with a number sign (#).
    1. Multiple pound signs together go down
      1. levels.
  2. Empty lines
  1. finish the list and start a new one.

All other beginnings finish the list.

Indented text
: single indent
:: double indent
single indent
double indent

MediaWIki ignores single line breaks. To start a new paragraph, leave a line empty. You can also start a new line using the HTML tag <br />.

For more detail see Formatting with MediaWiki.

Before submitting changes, please click on the Show Preview button to verify if you did not make any mistakes. Please also insert a small summary of changes in the Summary box, so that one can easily find your contribution in the page's history.


Templates that are available

Various templates are available to improve the documentation's readability. Here are some things that you could do :

  1. Include source code in the wiki
  2. Include a source file in the wiki
  3. Create a bilingual page
  4. Include a command in the wiki
  5. Include a set of tabs in the wiki

Vandalism

All wiki modifications are identified with your user account. The wiki also preserves a history of all modifications. Users that are found to vandalize pages (massive removal of content, adding illicit or non-relevant content, defamation, etc.) will see their account immediately suspended.

Outils personnels
Espaces de noms

Variantes
Actions
Navigation
Ressources de Calcul Québec
Outils
Partager