Difference between revisions of "Starfleet Commander:Project Help pages"
(Created page with "==Proposed tasks== ::''This proposals needs consensus. See the [[{{TALKPAGENAME}}|talk]] page for more.'' #Create help pages with content from the PD [http://www.mediawiki.org/wi...") |
m |
||
| Line 1: | Line 1: | ||
| − | == | + | {{Under construction|page|SFC Wiki Draft Icon.png}} |
| − | ::''This | + | {| cellpadding="5" cellspacing="5" style="width:100%; border:1px solid #ddcef2; margin-bottom:0.5em; vertical-align:top; background-color:#fefede;" |
| − | + | |[[Image:PD-icon-info.png|right|130px|Help pages are released without copyrights (public domain)]] | |
| − | + | '''Project:Help pages,''' is a project to create a set of concise user help pages for the {{ns:Project}} wiki users, i.e. for visitors to this website which is powered by MediaWiki. The project covers all content in the Help namespace. The main entry point for this <s>is</s> <ins>will be</ins> <nowiki>[[Help:Contents]]</nowiki> when finished. As for the project time it is [[Help:Contents/Sandbox]]. | |
| + | |||
| + | This help documentation is under the Public Domain, and contributors must be clear about the differences in licenses. The help pages do not contain information for server administrators, about how to install, configure, or maintain MediaWiki software. See the 'Goals' below, for a detailed statement of what we are trying to achieve. | ||
| + | |||
| + | {{information}}Please '''do not''' copy and paste content from {{meta|Help:Contents|Meta-Wiki's Handbook}} help pages, or from the {{mediawiki|Manual:Contents|MediaWiki Manual}} help pages in here. They were written under the GFDL license and are ''not'' in the public domain. | ||
| + | |} | ||
| + | |||
| + | |||
| + | __TOC__ | ||
| + | == Goal == | ||
| + | |||
| + | The idea is to provide a set of pages which is adapted to this wiki installation. This will include basic user information and 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. | ||
| + | |||
| + | == License == | ||
| + | Contributions to the Help pages are released as '''public domain''' (rather than the usual [[GNU Free Documentation License]]). This is necessary in order to allow people to easily copy the text into their own wiki installations. Please ensure you understand the following before contributing: | ||
| + | |||
| + | * Every page in the Help namespace must contain the line <code><nowiki>{{PD Help Page}}</nowiki></code> to indicate the license. | ||
| + | * No content can be copied from elsewhere into these pages, except if you are the author or have permission from the authors. Content that is already public domain can be copied here, but this does '''NOT''' include most 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. | ||
| + | |||
| + | == Target readership - Normal users == | ||
| + | |||
| + | The help pages are very much targeted at normal visitors to a wiki website. | ||
| + | |||
| + | === ''Not'' server administrators === | ||
| + | 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 [[Project:Manual|Manual]]. | ||
| + | |||
| + | The only small exception to this is the 'Admin tips' boxes (described below). | ||
| + | |||
| + | === Information for sysop / bureaucrat users less prominent === | ||
| + | The help pages would not be complete, without also describing what 'sysop' users can do, however these more advanced features are not available to majority of a target audience (the majority of wiki users). As such, we should keep this information a little bit separate, so that normal users are not confronted with information which is not relevant to them. Within the bulk of the Help pages we will make brief mentions of things which require sysop privileges, 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 [[Project Talk:PD help|under discussion]]'' | ||
| + | |||
| + | == Editorial guidelines == | ||
| + | * 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 <nowiki>{{SITENAME}}</nowiki> syntax anywhere. MediaWiki is the name of the software we are describing. This is the software that powers the destination wiki, 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 <nowiki>{{SITENAME}}</nowiki>), but we are ''not'' going to swap this in everywhere where 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 <code><nowiki>Pagetitle/language-code</nowiki></code>. | ||
| + | |||
| + | * Unless you have the perfect solution for navigation in this manual, please refrain from creating navigation templates and create '''content''' first. | ||
| + | |||
| + | * Do not use extensions such as [[Extension:Cite]], since they are not installed on all MediaWiki installations. | ||
| + | |||
| + | === Formatting === | ||
| + | * Formatting should be consistent. Use <code><nowiki>{{Prettytable}}</nowiki></code> for any tables you create, highlight cells or rows with <code><nowiki>{{Hl1}}</nowiki></code> etc. (see [[Template talk:Prettytable]]) | ||
| + | |||
| + | * All wiki markup and code should be put in <code><nowiki><code></nowiki></code> or <code><nowiki><pre></nowiki></code> tags. Help for inserting: <code><nowiki>{{subst:nw|text}}</nowiki></code>. | ||
| + | |||
| + | * All references to menu texts and descriptions should appear in ''italic''. | ||
| + | |||
| + | === Screenshot Images === | ||
| + | |||
| + | ''There is some discussion about whether we want screenshot images on the help pages. See the [[Project talk:PD help|talk page here]], and also [[Project:Current issues#MW Screenshots - Image license]]'' | ||
| + | |||
| + | Screenshots are ''deprecated'' until this is decided. i.e. don't add any more, but don't delete the existing ones. | ||
| + | |||
| + | '''Advantages of screenshot images''' | ||
| + | * An image says more than words. For friendly user help, it is important to provide illustrations. | ||
| + | * Some users are visual learners. Images help to include them. | ||
| + | * Images help users locate things on the screen. | ||
| + | * Images provide feedback by matching what's on the screen with the screenshot. | ||
| + | |||
| + | '''Disadvantages of screenshot images''' | ||
| + | * MediaWiki has a built-in import/export feature, but this doesn't work with images. | ||
| + | * Licensing issues. Can MediaWiki screenshots be licensed PD? | ||
| + | * We can get by without them. Nothing we describe in the help pages ''requires'' an image to illustrate. | ||
| + | * Images increase overall file size. | ||
| + | * Layout/colour differences between the installation (+selected skin) and the screenshots may be confusing. | ||
| + | |||
| + | == Admin tips == | ||
| + | If something in Help can be configured by a server administrator, you can insert an admin tip with <code><nowiki>{{Admin tip|tip=text}}</nowiki></code>. | ||
| + | |||
| + | ==Category== | ||
| + | All pages in the "Help:" namespace are by definition part of this wiki's public domain Help documentation project and should be categorized [[:Category:Help]]. | ||
| + | |||
| + | The former category for pages in the "Help:" namespace, this public domain Help documentation project, was [[:Category:Help pages]]. In keeping with simplicity the category is now simply [[:Category:Help]] and all pages <s>have been</s> <ins>should be</ins> updated. | ||
| + | |||
| + | == See also == | ||
| + | * '''[[Project:Language policy]]''' if you are interested in working on non-English versions of the help pages. | ||
| + | |||
| + | [[Category:Policy|Project help pages]] | ||
Revision as of 22:23, 24 September 2011
|
This page is under construction or some major changes are in progress. |
 Project:Help pages, is a project to create a set of concise user help pages for the Starfleet Commander wiki users, i.e. for visitors to this website which is powered by MediaWiki. The project covers all content in the Help namespace. The main entry point for this This help documentation is under the Public Domain, and contributors must be clear about the differences in licenses. The help pages do not contain information for server administrators, about how to install, configure, or maintain MediaWiki software. See the 'Goals' below, for a detailed statement of what we are trying to achieve. i Information: Please do not copy and paste content from Meta-Wiki's Handbook help pages, or from the MediaWiki Manual help pages in here. They were written under the GFDL license and are not in the public domain. |
Goal
The idea is to provide a set of pages which is adapted to this wiki installation. This will include basic user information and 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.
License
Contributions to the Help pages are released as public domain (rather than the usual GNU Free Documentation License). This is necessary in order to allow people to easily copy the text into their own wiki installations. Please ensure you understand the following before contributing:
- Every page in the Help namespace must contain the line
{{PD Help Page}}to indicate the license. - No content can be copied from elsewhere into these pages, except if you are the author or have permission from the authors. Content that is already public domain can be copied here, but this does NOT include most 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.
Target readership - Normal users
The help pages are very much targeted at normal visitors to a wiki website.
Not server administrators
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).
Information for sysop / bureaucrat users less prominent
The help pages would not be complete, without also describing what 'sysop' users can do, however these more advanced features are not available to majority of a target audience (the majority of wiki users). As such, we should keep this information a little bit separate, so that normal users are not confronted with information which is not relevant to them. Within the bulk of the Help pages we will make brief mentions of things which require sysop privileges, 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
Editorial guidelines
- 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 software that powers the destination wiki, 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}}), but we are not going to swap this in everywhere where 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.
- Unless you have the perfect solution for navigation in this manual, please refrain from creating navigation templates and create content first.
- Do not use extensions such as Extension:Cite, since they are not installed on all MediaWiki installations.
Formatting
- Formatting should be consistent. Use
{{Prettytable}}for any tables you create, highlight cells or rows with{{Hl1}}etc. (see Template talk:Prettytable)
- 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.
Screenshot Images
There is some discussion about whether we want screenshot images on the help pages. See the talk page here, and also Project:Current issues#MW Screenshots - Image license
Screenshots are deprecated until this is decided. i.e. don't add any more, but don't delete the existing ones.
Advantages of screenshot images
- An image says more than words. For friendly user help, it is important to provide illustrations.
- Some users are visual learners. Images help to include them.
- Images help users locate things on the screen.
- Images provide feedback by matching what's on the screen with the screenshot.
Disadvantages of screenshot images
- MediaWiki has a built-in import/export feature, but this doesn't work with images.
- Licensing issues. Can MediaWiki screenshots be licensed PD?
- We can get by without them. Nothing we describe in the help pages requires an image to illustrate.
- Images increase overall file size.
- Layout/colour differences between the installation (+selected skin) and the screenshots may be confusing.
Admin tips
If something in Help can be configured by a server administrator, you can insert an admin tip with {{Admin tip|tip=text}}.
Category
All pages in the "Help:" namespace are by definition part of this wiki's public domain Help documentation project and should be categorized Category:Help.
The former category for pages in the "Help:" namespace, this public domain Help documentation project, was Category:Help pages. In keeping with simplicity the category is now simply Category:Help and all pages have been should be updated.
See also
- Project:Language policy if you are interested in working on non-English versions of the help pages.
