MoodleDocs:Style guide: Difference between revisions
From MoodleDocs
m (→Screenshots) |
Helen Foster (talk | contribs) (→Categories: dev namespace categorisation) |
||
| Line 3: | Line 3: | ||
==Categories== | ==Categories== | ||
* | *A page may be added to one or more category by typing <code><nowiki>[[Category:Category name]]</nowiki></code>, for example <code><nowiki>[[Category:Teacher]]</nowiki></code>, at the bottom of the page. | ||
*To ensure that pages in the Development namespace are listed in alphabetical order on a category page, the page name should be include in the category link i.e. <code><nowiki>[[Category:Developer|New page name]]</nowiki></code>. | |||
*[[Special:Categories&article=MoodleDocs%3AStyle_guide|Categories]] lists all Moodle Docs categories. | *[[Special:Categories&article=MoodleDocs%3AStyle_guide|Categories]] lists all Moodle Docs categories. | ||
Revision as of 09:04, 18 June 2007
Categories
- A page may be added to one or more category by typing
[[Category:Category name]], for example[[Category:Teacher]], at the bottom of the page. - To ensure that pages in the Development namespace are listed in alphabetical order on a category page, the page name should be include in the category link i.e.
[[Category:Developer|New page name]]. - Categories lists all Moodle Docs categories.
Screenshots
- You are encouraged to illustrate documentation with screenshots. Please use the official Moodle demo site, or any other site or course using one of the standard themes, and ensure that the screenshot is as small as possible.
- Screenshots should be GIF, JPEG or PNG format, with 72ppi resolution, and maximum width 800px.
- Screenshots may be uploaded using the toolbox Upload file link.
- Please name screenshots descriptively to avoid confusion.
- To include the screenshot in an article, use a link in the form
[[Image:Screenshot.jpg]]or[[Image:Screenshot.png|alt text]]. - Please do not apply effects such as borders, watermarks or drop shadows to screenshots. This will allow others to add or replace screenshots over time and still maintain a consistent look and feel to articles.
- For help on image placement and adding an image caption, please refer to the Wikipedia Picture tutorial.
Templates
- In MediaWiki, a template is a page which can be inserted into another page. For example, the Moodle Docs help block on this page is a template.
- A template may be added to a page by typing
{{Name}}for Template:Name. - All pages (Template namespace) lists all Moodle Docs templates.
- Please refer to the MediaWiki Template help for further information.
