Obsolete:Moodle Docs development: Difference between revisions

Latest revision as of 13:27, 30 June 2014

Links to Moodle Docs

Moodle 1.6 has a button on each page that links to pages in the wiki with the same path as the pages in Moodle e.g. the Forums index page links to mod/forum/index. You can see this already on the Moodle demo site.

Link pages

Moodle Docs in other languages

Moodle documentation is required in every language! MoodleDocs in other languages will enable many people to be involved in creating documentation. :-)

Documentation for developers

Developers have made really good use of Moodle Docs and as a result there are a large number of developer documentation pages. These pages are to be moved into a new MediaWiki namespace, Development - see bug [https://tracker.moodle.org/browse/MDLSITE-35 MDLSITE-35]

Moodle Docs navigation

Categories provide a way of automatically displaying a set of pages in alphabetical order.
Templates enable additional navigation e.g. Template:Themes.
A navigation trail may be added manually e.g. UTF-8 introduction.

@@ Line 1: / Line 1: @@
-==Links to MoodleDocs==
+{{MoodleDocs development}}
-Moodle 1.6 will have a button on each page that links to pages in the wiki with the same path as the pages in Moodle e.g. the Forums index page will link to [[mod/forum/index]]. You can see this already on [http://moodle.org/ moodle.org].
+==Links to Moodle Docs==
-Currently all the links are to teacher or administrator documentation. Links to student documentation are also required.
+Moodle 1.6 has a button on each page that links to pages in the wiki with the same path as the pages in Moodle e.g. the Forums index page links to [[mod/forum/index]]. You can see this already on the [http://demo.moodle.com/ Moodle demo site].
-==MoodleDocs in other languages==
+*[[MoodleDocs:Link pages|Link pages]]
-*Moodle documentation is required in every language! Let's start with one or two additional languages - ''any voluteers please email docs AT moodle DOT org!''
+==Moodle Docs in other languages==
-*MoodleDocs in other languages will enable many people to be involved in creating documentation, rather than just a few.
-*Each version will contain the language code in the URL e.g. docs.moodle.org/es/..., docs.moodle.org/de/... etc.
-*[http://moodle.org/help.php?file=index.html Moodle help files] will remain in each [[MoodleDocs and lang packs|language pack]] for those using Moodle locally without an Internet connection.
-*All documentation contributions should be encouraged, including creating new pages i.e. contributors should not be restricted to only translating English pages.
-*Essential documentation should be decided upon and assigned to a [[:Category:Core|core category]]. All these pages should be translated.
-*[[:Category:Core|Core category]] pages will have interlanguage links.
-*'''Translation will be multi-directional''' i.e. not just translation from English into other languages (e.g. a Spanish developer writes documentation in Spanish which is then translated into other languages).
-*MediaWiki page titles are the same as the last part of the URL, however these may be translated by moving the page and so creating a redirect e.g. docs.moodle.org/nl/Metacourses moved to docs.moodle.org/nl/Koepelcursus. (This would only be used for certain pages, not Moodle file path named pages.)
-*Features to consider using: [[Special:Export|Export pages]] and [[Special:Import|Import pages]]
-===Language links===
+Moodle documentation is required in every language! MoodleDocs in other languages will enable many people to be involved in creating documentation. :-)
-*[http://en.wikipedia.org/wiki/Wikipedia:Interlanguage_links Wikipedia:Interlanguage links]
-*[http://meta.wikimedia.org/wiki/Meta:Conventions_for_multilingualism Meta:Conventions for multilingualism]
-*[http://meta.wikimedia.org/wiki/Help:Interwiki_linking Help:Interwiki linking]
-*[http://prevolution.org/mediawikifarm  Multiple Sites using one codebase]
-===Other multilingual documentation wikis===
+*[[MoodleDocs:Language planning|Moodle Docs language planning]]
-*[http://developer.mozilla.org/en/docs/Main_Page Mozilla Developer Center]
+*[[MoodleDocs:Language packs and Moodle Docs|Moodle Docs and language pack content]]
-*[http://textpattern.net/wiki/index.php?title=Main_Page The TextBook Project]
+*[[MoodleDocs:Starting MoodleDocs|Starting Moodle Docs in another language]]
-*[http://susewiki.org/index.php?title=Main_Page SUSE Wiki]
-==MoodleDocs navigation==
+==Documentation for developers==
-*[[Special:Categories|Categories]] provide a way of automatically displaying a set of pages in alphabetical order.
+* Developers have made really good use of Moodle Docs and as a result there are a large number of developer documentation pages. These pages are to be moved into a new MediaWiki namespace, ''Development'' - see [http://tracker.moodle.org/browse/MDLSITE-35 bug MDLSITE-35]
-*Templates enable additional navigation, either on the right e.g. [[Template:Themes]] or above the categories at the bottom of the page e.g. [[Left-align quiz]].
+==Moodle Docs navigation==
+* [[Special:Categories|Categories]] provide a way of automatically displaying a set of pages in alphabetical order.
+* Templates enable additional navigation e.g. [[Template:Themes]].
+* A navigation trail may be added manually e.g. [[UTF-8 introduction]].
 ==See also==
 *[[Documentation philosophy]]
+*[[Special:Export]] a MoodleDoc page(s) to another MediaWiki
-==External links==
+[[es:MoodleDocs:Desarrollo de Moodle Docs]]
-*[http://meta.wikimedia.org/wiki/How_to_become_a_MediaWiki_hacker How to become a MediaWiki hacker] ;-)
-*[http://meta.wikimedia.org/wiki/Category:Mediawiki_Extensions Category:Mediawiki Extensions]
-*[http://meta.wikimedia.org/wiki/Interwiki_bot Interwiki bot] for maintaining the links from an article in one language to all of the versions of that article in other languages
-[[Category:Developer]]
-[[Category:MoodleDocs|Development]]