TechDocs/Wiki/UserGuide

Cleanup

  • - This page is hard to read and/or its content needs to be updated. Please improve this page and remove this box when you are done.

    - This page should be merged with TechDocs/Wiki/NewUserGuide

This page is meant to be the first reference for new users in the FSFE, regardless if you're a volunteer or Fellow of the FSFE. Please have a look at it before starting using the wiki or any other services, and you won't regret it! :-)

You are also encouraged to read the wiki FAQ.

User accounts

Each user automatically has an account on this wiki: just use your usual username and password to login.

Each wiki user has his or her own user page at http://wiki.fsfe.org/Fellows/yourname . You can create this page using this form:

Enter your username here:

The manual approach:

Please note that Fellow usernames (like all names on the wiki) are case-sensitive.

You can add a fancy link to your userpage (like the one at the top of the screen) by writing Fellows:yourname (yes, with a colon instead of a slash).

Editing pages

If you never used a wiki, you are encouraged to have a look at the basic moinmoin syntax, which is explained at length in the HelpOnEditing page (see also the HelpForBeginners and the WikiCourse pages).

Here we just list some suggestions about some of the most useful Moinmoin features:

Useful tools

Editors

You can edit wiki pages with Moinmoin web-based editors: the text-based one and the GUI-based one.

Alternatively, you can use your favourite text editor, using one of the following tools.

Policy

A wiki gives users a lot of freedom to create and organize information.

To ease collaboration, we try to follow some common rules.

Page names

Moinmoin supports both CamelCase syntax for page names and the free link syntax.

One advantage of using short camel-case page names is that CamelCase words are automatically displayed as links by Moinmoin.

One advantage of longer non-camel-case page names is that you can use a more convenient free link syntax in situations like:

"GNU is part of the [[history_of_free_software]]."

instead of

"GNU is part of the [[History/FreeSoftware|history of free software]]."

So far the majority of users seems to like the free link solution more than the camel case one; anyway, both are technically acceptable, we recommend choosing one and keeping consistency in all pages that are somehow related.

Translated pages

Pages translated from an original page should append _xx (or replace _en) where xx is the language code for the language of the translation. This should then help the Wiki show available languages for the original page and for all the different translations. Remember to add a language declaration in the page content as described in this help section.

For example, a French translation of the Advocacy page should be called Advocacy_fr, and a French translation of the Advocacy_faq_en page should be called Advocacy_faq_fr. In the content of such pages, a declaration should be provided as follows:

#language fr

Overriding the page title

Each page has a title which appears in the green box at the top of each page's content, and this title is typically derived from the page name. Thus, the UserGuide page has the title "User Guide". In some circumstances it can be desirable to override this automatically generated title with one of your own choosing. For example, when providing a translated page, it is probably highly desirable to use a title in the language employed by the translation.

To override the page title - for example, for the SupportPrograms_de translated page, where the automatically generated title is "Support Programs (Deutsch)" - add the following style of declaration to the very top of the page content:

 #pragma title Unterstützerprogramme

When the page is displayed, the overridden title will appear in the green box at the top of the page's content.

Hierarchical titles

It is also possible to define hierarchical titles. For example:

 #pragma title groups
 #pragma title Rhein/Main

This produces a title of "groups » Rhein/Main", permitting the definition of a hierarchical title and usage of the / character in the title without it being interpreted as a special hierarchical separator. (A page name of groups/Rhein/Main will normally produce the title "groups » Rhein » Main" because / is generally regarded as providing a new level in the page name hierarchy.)

Subpages

Moinmoin offers the ''subpage'' feature (which is sometimes called namespaces in some other wikis).

Some advantages of using subpages:

Here are the subpage-namespaces that we are already using:

Some other subpages that we could consider using:

A little gotcha that might confuse newbies: when you create a link to a subpage, if you start the page name with a slash (/NewPage) the link will point to a subpage of the current page, not of the "root" page (if you want the latter behaviour, just drop the initial slash). Yes, it works just the opposite way of a usual filesystem. Ask Moinmoin why :-)

Categories

Moinmoin offers the category feature. To learn how to use it, please read HelpOnCategories.

At the moment we are using the following categories:

Licensing policy

See LicensingPolicy

TechDocs/Wiki/UserGuide (last edited 2017-04-01 11:31:30 by sabet)