Project:PD help: Difference between revisions

Project:PD help is a project to create a set of concise user help pages for MediaWiki users, i.e. for visitors to a website which is powered by MediaWiki. The project covers all content in the Help namespace. The main entry point for this is Help:Contents . This help documentation is separate from the Manual (the GFDL and CC BY-SA-licensed MediaWiki administrator's manual). Contributors, please be clear about the differences! The PD help pages do not contain information for server administrators, about how to install, configure, or maintain MediaWiki software. See the 'Goal' section below, for a detailed statement of what we are trying to achieve. Please do not copy and paste content from Meta-Wiki's Help pages in here. They were written under the GFDL and CC BY-SA licenses and are not in the public domain.

The goal is to provide a set of pages, which can be copied into a fresh wiki installation or included in the MediaWiki distribution. This will include basic user information, along with other Meta information, in a reasonably concise form. The basic concept is to create a compressed "User Guide", not a reference work. It should focus on what users want and not explain other functions.

Contributions to the PD Help, are released as public domain via the CC0 waiver. This is necessary in order to allow users to easily copy the text into their own wiki installations. Please ensure you understand the following before contributing:

• Every page in the PD Help, must contain the line {{PD Help Page}} to indicate the license.
• No content can be copied from elsewhere into these pages. The only exceptions being:

1. The content being copied is your own personal (e.g. the author), or you have documented permission from the original author(s).
2. Content that is already in the Public Domain can be copied here; however, this does NOT include the majority of published web pages!

• You are relinquishing all rights to the information you contribute here. Although you will continue to have your contributions listed and attributed on this site, others can copy the text without giving credit, and can modify it as they see fit.

The help pages are very much targeted at normal visitors to a wiki website.

We are not aiming to duplicate the full MediaWiki documentation. Information targeted at server administrators, detailing installation, configuration, or maintenance of MediaWiki, belongs in the Manual.

The only small exception to this, is the 'Admin tips' boxes (described below).

The Help pages would not be complete without also describing what 'sysop' users can do. However, these advanced features are not available to a majority of the target audience (most wiki users). As such, this information is to be kept slightly separate from the majority of the contents, so that normal users are not confronted with information which is not relevant to them.

Within the bulk of the Help pages, brief mentions of actions which require sysop privileges may be deemed necessary; but, detailed descriptions of sysop procedures should be tucked away on less prominently linked pages, or should be left out of the Help pages, altogether.

This section is under discussion

• Create links between the pages, but avoid linking to other namespaces on MediaWiki.org. Keep the links internal to the public domain help pages, or make external links (full URL) to relevant resources, e.g. on meta.wikimedia.org. This is to facilitate easier copying of the text into fresh wiki installations. Do not use interwiki links, as these may not exist in the target wiki.
• We probably don't want to swap in the {{SITENAME}} syntax anywhere. MediaWiki is the name of the software we are describing. This is the Content Management Software (CMS), that enables the destination wiki to run, so anywhere where our text is referring to the software (everywhere throughout help), it should be left as a literal string "MediaWiki". If, for some reason, the help text is mentioning the name of the site, then this would be an appropriate exception (use {{SITENAME}}). However, we are not going to swap this in everywhere we mention the word MediaWiki.
• Translations should be done after the English version of a page has reached a stable status. The naming convention is Pagetitle/language-code (e.g. Help:Editing/pt).
• Unless you have the perfect solution for navigation in this manual, please refrain from creating navigation templates, and focus content creation first.
• Do not use extensions such as Cite, since they are not installed on all MediaWiki installations.

• Formatting should be consistent. Use class="wikitable" for any tables you create, highlight cells or rows with {{Hl1}} etc.
• All wiki markup and code should be put in ‎<code> or ‎<pre> tags. Help for inserting: {{subst:nw|text}}.
• All references to menu texts and descriptions should appear in italic.

Screenshots are useful. PD help pages should contain only public-domain screenshots; avoid any logos from being included in screenshots, and upload them to Commons with {{MediaWiki screenshot}} (for GPL), and {{CC-zero}} (for the user's work) license templates.

Images are shipped with the documentation or accessed from Commons with InstantCommons .

If something in Help can be configured by a server administrator, you may insert an 'admin tip' with {{Admin tip }}.

All pages in the "Help:" namespace are, by definition, part of this public domain Help documentation project and should be categorized Category:Help . Help pages for MediaWiki extensions, should be categorized in its subcategory Category:Extension help .

The former category for pages in the "Help:" namespace, this public domain Help documentation project, was Category:PD help. In keeping with simplicity, the category is now simply Category:Help and all pages have been updated.

• Project:Language policy  — If you are interested in working on non-English versions of the help pages.
• Project:PD help/export  — Discusses a proposed method of creating usable dumps of the Help: namespace. This is still at the discussion stage and is not yet functional.