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.
Wiki policy[edit]
<translate> PLEASE READ THESE TERMS OF SERVICE CAREFULLY. BY ACCESSING THIS WEBSITE YOU ARE AGREEING TO ITS TERMS OF SERVICE. IF YOU DO NOT AGREE TO THESE TERMS OF SERVICE, DO NOT USE THIS WEBSITE OR REGISTER AS A USER OF THIS WEBSITE. ALL TERMS OF SERVICE ARE DEFINED FURTHER BELOW THIS NOTICE.
This terms of service document covers usage of the Joomla! Documentation Wiki at docs.joomla.org. The English version of this document is the authoritative version. Translated versions of this document are informative only.
Failure to abide by these terms of service 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 terms of service at any time. A change of these terms of service will be posted by an announcement. Continued use of this website after a modification to our terms of service will constitute your acceptance of its changes. </translate>
Editorial style guides[edit]
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[edit]
Please use [Words to watch]
Words to Watch are words commonly misspelled or which may have variations that depend on the Joomla! style guide choices.
Summary style[edit]
- Sections of long articles should be spun off into their own articles leaving a summary in its place
- Summary sections are linked to the detailed article with a {{main}} or comparable template
- To preserve links to the edit history of the moved text, the first edit summary of the new article links back to the original: add "spin-off of [[Original large article]]" into the Summary: field.
Documentation policies[edit]
Licensing[edit]
<translate> The contents of this wiki are subject to copyright law and are made available under the Joomla! Electronic Documentation License (JEDL) unless otherwise stated. You may find the JEDL Frequently Asked Questions useful in determining if your proposed use of this material is allowed. If you have any questions regarding licensing of this material please contact legal@opensourcematters.org. If you wish to report a possible violation of the license terms for the material on this site then please contact legal@opensourcematters.org.</translate>
Structure[edit]
Brief list of subjects that will be covered on dedicated pages.
- Categories help users navigate the Joomla! Documentation via multiple taxonomies
- Categories are for defining characteristics, and should be specific, neutral, inclusive and follow certain conventions.
Hatnotes[edit]
Hatnotes are short notes placed at the top of an article before the primary topic, generally either to provide disambiguation of closely related terms or 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).