ExponentCMS Docs:About Documenting

From ExponentCMS Docs

Documenters: About Documenting

This page is for Documenters of this Wiki. It contains guidelines for adding and editing Documentation to this website.

Structure

The site is broken down into 8 categories: 7 categories contain information about Exponent — Getting Started, FAQ, Tutorials, Editors, Administrators, Designers, Developers — and are located in the MediaWiki Main Namespace. The 8th category contains info about documenting Exponent — Documenters — and is located in the Mediawiki ExponentCMSDocs Namespace so that it's search index is isolated from the primary content. See the Categories page for details.

Navigation

Each of the 8 Category pages can be accessed from the sections links in the Left-Menu. There is also a template generated Right-Menu. The top of this menu contains links to the 8 Category pages. The bottom menu contains links to pages within a given category. See the Navigation page for details.

Whenever you add a new page to a section, you should add a link to the new content page to the relevant section sub-menu. This will make the page available to users via a menu link and also add a link from the Category page, along with the page description you include.

You should also ensure that the page you create contains the relevant section template information at the top of the content. The exact format varies for each category. Without this code, the Right-Menu will not appear.

Resource Links

Links to external websites and other Exponent resources will vary depending on individual requirements. In general, links which are relevant to the entire Category should be added to the Category Links Template for the specific category. This will make them available on all pages of the relevant section. If you create a new content page you should be sure to include the Category Link Template for that section at the bottom of the page.

Links which are specific to the content you are documenting should be embedded in the content as/when needed. Please ensure that long URLs are truncated for display. Please verify all links before verifying the page as complete.

See the Resource Links Templates section of the Templates page for a list of templates for each section.

Content Approval

Always get someone else to verify any content you have added to the site! This is to ensure that we only publish fully fact-checked information.

There are a set of three Content Approval Templates which you should tag all first level (H1) content with as part of the verification process. When you first enter content it should be tagged with the Content Warning approval template. Once you've fact checked someone else's content, you should tag it with the Content Checked approval template. Finally, a senior Documenter should then proof read the content and then mark it with the Content Approved approval template.

See the Content Approval section of the Templates page for details of the relevant templates.

Content Alerts

Use the Content Alert Template to mark Content Suggestions which may cause problems or contain serious advice. See the Alert Template section on the Templates page.

Images and Files

Always ensure that any file you upload for use on the website contains licensing information. See the Images page for details of how to use images and other uploaded files as content. See the Images Icons page for details of how to uses images for navigation icons.

User Management

Userlogin 

Special:Userlogin&type=signup — Sysops can add new users.

Set user rights 

Special:Userrights — Stewards only. Give and remove user access rights (e.g. sysop, bureaucrat, checkuser).