JDOC

Policies and guidelines

From Joomla! Documentation

Policies and guidelines express standards that have community consensus, though to differing degrees: policies are considered a standard that all users should follow, whereas guidelines are more advisory in nature. Both need to be approached with common sense. A user who acts against the spirit of them may be reprimanded, even if technically no rule has been violated. Those who edit in good faith, are civil, seek consensus, and work towards the goal of creating great documentation for the Joomla! project(s) should find a welcoming environment.

Abstracts of current key policies and guidelines are given in the next sections including links to their full text.

Contents

Wiki policy

<translate> This policy covers usage of the Joomla! Documentation Wiki at docs.joomla.org. Failure to abide by this policy may result in editing or removal of your contributions. We reserve the right to ban abusers from this site either for a specific time period or indefinitely. We reserve the right to change this policy at any time. </translate>

Editorial style guides

The guides in this chapter should help authors and editors to preserve a consistant styling and naming of the wiki-based documentation. You can also download the general Editorial Style Guide (PDF) that applies to all Joomla! Documentation.

Words to watch

Words to Watch are words commonly misspelled or which may have variations that depend on the Joomla! style guide choices.

Hatnotes

Hatnotes look like this.

Hatnotes are short notes placed at the top of an article before the primary topic, generally either 1) to provide disambiguation of closely related terms or 2) to summarise a topic, and explain its boundaries. "Hatnote" is also a polite term to refer to improper disambiguation links which exceed standard length, link directly to trivial topics instead of a disambiguation page.

This style guideline is intended to make this process more efficient by giving article pages a consistent look, and avoiding distracting information (such as extraneous links).