MoodleDocs:Starting MoodleDocs: Difference between revisions

Revision as of 15:51, 30 July 2007

Starting Moodle Docs in another language

Would you like Moodle Docs in your language?

Moodle Docs in a new language needs:

An administrator (or two)

The administrator should understand MediaWiki features such as page redirects, categories, templates and disambiguation pages. Please browse this wiki to discover how these features work.

Lots of people wishing to contribute

Please find out how many people are interested by discussing Moodle Docs in your moodle.org community discussion course.

If you wish to start Moodle Docs in your language, are willing to take on administrator responsibility, and know of lots of people wishing to contribute, please contact the Moodle Documentation Steward, Helen Foster, to arrange for a wiki https://docs.moodle.org/xx to be set up.

Once your documentation wiki is set up, please announce it in your moodle.org community discussion course. Suggestions of what to do next are described below. Whilst everyone in your community may login and contribute to the documentation, system messages pages i.e. pages in the MediaWiki namespace are locked so that only administrators may edit them.

Initial pages

Create a Main Page with appropriate links. You may wish to focus initially on the teacher or the administrator documentation.
Transfer the information from the files in your language pack docs directory to Moodle Docs, updating the information as necessary (see Language packs and Moodle Docs for details of where up-to-date information from the en language pack docs directory may be found in Moodle Docs). Files in your language pack docs directory may then be deleted from CVS (see tracker report [https://tracker.moodle.org/browse/MDL-4912 MDL-4912 /docs folder needs to be reviewed and files removed]).
Update the main navigation block and create the documentation block by translating MediaWiki:Sidebar.
Translate MediaWiki:Noarticletext to provide links to the English documentation for pages which do not yet exist in your language.

Inter-language linking

Add inter-language links to pages by typing [[xx:Corresponding page title in the new language]] in the English MoodleDocs, and [[en:Corresponding page title in English]] in the new language Moodle Docs, at the bottom of the page, below the category link. Inter-language links will appear automatically in the "In other languages" block.

Further links to the English documentation

Optional: Provide further links to English documentation pages by typing [[:en:English page title]] (adding an extra : before en:) e.g. en:Release Notes.

Note: MediaWiki:Noarticletext automatically provides links for every page in Moodle to the corresponding English documentation page if they do not yet exist in your language.

Moodle Docs pages

Translate the following, including page names:

System messages

Translate the following system messages:

MediaWiki:Loginprompt
MediaWiki:Enotif body, MediaWiki:Enotif subject, MediaWiki:Enotif lastvisited, MediaWiki:Enotif newpagetext, MediaWiki:Changed, MediaWiki:Created (notification email)
MediaWiki:Emailauthenticated

Depending upon the language, certain additional system messages may require translating, for example:

Link pages

Create a set of link pages, leaving the names as file paths and simply adding translated categories.
Move all link pages to provide translated page names.

Publicity

Announce Moodle Docs in the moodle.org community discussion course.
Add an RSS feed block to the community discussion course.

@@ Line 26: / Line 26: @@
 * Add inter-language links to pages by typing <code><nowiki>[[xx:Corresponding page title in the new language]]</nowiki></code> in the English MoodleDocs, and <code><nowiki>[[en:Corresponding page title in English]]</nowiki></code> in the new language Moodle Docs, at the bottom of the page, below the category link. Inter-language links will appear automatically in the "In other languages" block.
+==Further links to the English documentation==
+* Optional: Provide further links to English documentation pages by typing <code><nowiki>[[:en:English page title]]</nowiki></code> (adding an extra <code>:</code> before <code>en:</code>) e.g. [[:en:Release Notes]].
+Note: [[MediaWiki:Noarticletext]] automatically provides links for every page in Moodle to the corresponding English documentation page if they do not yet exist in your language.
 ==Moodle Docs pages==
@@ Line 33: / Line 39: @@
 * [[Help:Contents]]
 * [[MoodleDocs:Guidelines for contributors]]
-* [[MoodleDocs:Protected page]] (please respect protected pages)
-* Optional: [[Special%3AAllpages&from=&namespace=4|Additional Moodle Docs pages]]
 ==System messages==
-Translate the following:
+Translate the following system messages:
 * [[MediaWiki:Loginprompt]]
 * [[MediaWiki:Enotif body]], [[MediaWiki:Enotif subject]], [[MediaWiki:Enotif lastvisited]], [[MediaWiki:Enotif newpagetext]], [[MediaWiki:Changed]],  [[MediaWiki:Created]] (notification email)