From Fedora Project Wiki

(making this page final. Let's roll it out and see if it makes sense.)
Line 1: Line 1:
{{Draft}}
 
 
{{Policy page}}
 
{{Policy page}}
  
Making wiki pages?  Want to know how to name them in the New World of MediaWiki?  This page tells you how we want the wiki structured, when it comes to creating new pages or moving around old content.
+
Making wiki pages?  Want to know how to name them in MediaWiki?  This page tells you how we want the wiki structured, when it comes to creating new pages or moving around old content.
  
Consistency is good, it instills a sense of confidence in to the reader.  These rules and the [[Help:Editing]] rules are designed to use MediaWiki features, match Fedora Project needs,  
+
Consistency is good, it instills a sense of confidence in to the reader.  These rules and the [[Help:Editing]] rules are designed to use MediaWiki features and match Fedora Project needs, while making life easier for contributors ''and'' readers.
  
 
== Page naming ==
 
== Page naming ==
  
 
Use this for naming new pages and areas.  Also use it for planning where to move nested content migrated from the [http://fedoraproject.org/wikiold/ old wiki].
 
Use this for naming new pages and areas.  Also use it for planning where to move nested content migrated from the [http://fedoraproject.org/wikiold/ old wiki].
 +
 +
=== General naming rules ===
 +
 +
These rules are for pages and sections.
 +
 +
* Do not nest pages in sub-folders, e.g. Topic/FAQ
 +
** ''Exception:''  Sub-projects with existing ProjectName/ nesting may choose to continue using one-level of nesting.  All pages below that one level should be made to otherwise follow these rules
 +
* Use natural language naming (as opposed to nesting)
 +
* Use capital letters only for the initial word in a title or section title:  "Like this"
 +
** ''Exceptions:'' Sub-project names, proper nouns, and the titles of formal, full documentation guides that are converting to XHTML/XML
 +
** Example:  Join_the_Foo_Project; Setting-up-USB-boot-media; FAQ_on_SELinux; Standing_in_the_middle_of_the_field#With_my_eyes_wide_open.
  
 
=== End-user focused pages ===
 
=== End-user focused pages ===
  
These are pages focused on end-users of all levels, beginner to highly experienced.  These are pages not specifically under a subProject or [[SIGs|SIG]].
+
These are pages focused on end-users of all levels, beginner to highly experienced.  These are pages not specifically under a sub-project or [[SIGs|SIG]].
  
 
* Name pages within a single, flat namespace; do not use directory-like hierarchies:
 
* Name pages within a single, flat namespace; do not use directory-like hierarchies:
** '''no''' : SIGs/Foo/Meetings
+
** '''no''' : FedoraLiveCD/USBHowTo
** '''yes''' : Foo_SIG_Meetings
+
** '''yes''' : How_to_boot_a_live_Fedora_image_from_USB
  
 
=== Project and SIG focused pages for contributors ===
 
=== Project and SIG focused pages for contributors ===
Line 30: Line 40:
 
** '''yes''' : EPEL/Package_Maintainer_Generic_Job_Description
 
** '''yes''' : EPEL/Package_Maintainer_Generic_Job_Description
  
=== Section naming ===
+
== Namespaces ==
  
* Capitalize first letter of first word, leave the rest lower case:  "Like this"
+
A MediaWiki namespace is a special word followed by a colon, that puts the content in a different naming areain the wiki.
  
== Namespaces ==
+
=== Automatically searchable namespaces ===
  
The following namespaces are automatically searchable:
 
 
* Main:
 
* Main:
* FedoraProject:
+
* FedoraProject: (default namespace)
 
* Help:
 
* Help:
 
* Category:
 
* Category:
 +
 +
=== User: namespace ===
  
 
The ''User:'' namespace is somewhere you can put drafts and other personal material that you do not want searched and indexed by engines like Google.  For instance, the user ''jpublic'' can build any wiki materials as desired under ''User:Jpublic'', using subpages.  If you need to know what pages you've built under your personal ''User:'' namespace, use the [[Special:Prefixindex]] page.
 
The ''User:'' namespace is somewhere you can put drafts and other personal material that you do not want searched and indexed by engines like Google.  For instance, the user ''jpublic'' can build any wiki materials as desired under ''User:Jpublic'', using subpages.  If you need to know what pages you've built under your personal ''User:'' namespace, use the [[Special:Prefixindex]] page.
 +
 +
=== Archive: namespace ===
 +
 +
Move old content to this namespace.  This gets it out of the regular search index but keeps it available for future needs.
 +
 +
If you are archiving old content while renaming a set of pages, do not give the page a new, natural language name in the Archive: namespace.  It should remain under its old name in the new namespace, to make it easier to find in historical contexts.  For example, FooProject/Some/OldStuff moves to Archive:FooProject/Some/OldStuff .
 +
 +
{{admon/tip|Put pages in an archive category|Put archhived pages an appropriate category, such as [[:Category:Docs Project archive]].}}
 +
 +
=== Meeting: namespace ===
 +
 +
Use this namespace for naturally named pages related to project and SIG meetings.  For example, [[Meeting:Docs_IRC_log_20080806]].
 +
 +
{{admon/tip|Put pages in a meeting category|Put the meeting in an appropriate category, such as [[:Category:Docs Project meeting logs]].}}
  
 
== Categories ==
 
== Categories ==
Line 52: Line 77:
 
** "Useful end-user docs are found in the [[Category:Documentation]]."
 
** "Useful end-user docs are found in the [[Category:Documentation]]."
 
** "To learn more about the [[DocsProject|Documentation Project]], refer to the [[:Category:DocsProject]].
 
** "To learn more about the [[DocsProject|Documentation Project]], refer to the [[:Category:DocsProject]].
 +
 +
[[Category:Wiki policy]]  [[Category:Documentation]]

Revision as of 15:05, 6 September 2008

Warning.png
This is a page that describes policies of the Fedora Project.
For policy pages, accuracy and clarity are important. You are encouraged to edit the wiki to improve it. If you have any substantive changes to make to this page, use the talk page to discuss the changes with other page maintainers. Do this before making the changes.

Making wiki pages? Want to know how to name them in MediaWiki? This page tells you how we want the wiki structured, when it comes to creating new pages or moving around old content.

Consistency is good, it instills a sense of confidence in to the reader. These rules and the Help:Editing rules are designed to use MediaWiki features and match Fedora Project needs, while making life easier for contributors and readers.

Page naming

Use this for naming new pages and areas. Also use it for planning where to move nested content migrated from the old wiki.

General naming rules

These rules are for pages and sections.

  • Do not nest pages in sub-folders, e.g. Topic/FAQ
    • Exception: Sub-projects with existing ProjectName/ nesting may choose to continue using one-level of nesting. All pages below that one level should be made to otherwise follow these rules
  • Use natural language naming (as opposed to nesting)
  • Use capital letters only for the initial word in a title or section title: "Like this"
    • Exceptions: Sub-project names, proper nouns, and the titles of formal, full documentation guides that are converting to XHTML/XML
    • Example: Join_the_Foo_Project; Setting-up-USB-boot-media; FAQ_on_SELinux; Standing_in_the_middle_of_the_field#With_my_eyes_wide_open.

End-user focused pages

These are pages focused on end-users of all levels, beginner to highly experienced. These are pages not specifically under a sub-project or SIG.

  • Name pages within a single, flat namespace; do not use directory-like hierarchies:
    • no : FedoraLiveCD/USBHowTo
    • yes : How_to_boot_a_live_Fedora_image_from_USB

Project and SIG focused pages for contributors

These are pages focused on contributors who are working in one or more areas of Fedora. Some content may be end-user focused but belong within the project/SIG for reference. The content here is divided by one nesting level.

  • Put pages in the single nested level
    • no : SIGs/ISV/Join
    • yes : ISV_SIG/Join
  • Content within the single nesting should be in a flat namespace
    • no : EPEL_FAQ_/PackageMaintainer/GenericJobDescription
    • yes : EPEL/FAQ
    • yes : EPEL/Package_Maintainer_Generic_Job_Description

Namespaces

A MediaWiki namespace is a special word followed by a colon, that puts the content in a different naming areain the wiki.

Automatically searchable namespaces

  • Main:
  • FedoraProject: (default namespace)
  • Help:
  • Category:

User: namespace

The User: namespace is somewhere you can put drafts and other personal material that you do not want searched and indexed by engines like Google. For instance, the user jpublic can build any wiki materials as desired under User:Jpublic, using subpages. If you need to know what pages you've built under your personal User: namespace, use the Special:Prefixindex page.

Archive: namespace

Move old content to this namespace. This gets it out of the regular search index but keeps it available for future needs.

If you are archiving old content while renaming a set of pages, do not give the page a new, natural language name in the Archive: namespace. It should remain under its old name in the new namespace, to make it easier to find in historical contexts. For example, FooProject/Some/OldStuff moves to Archive:FooProject/Some/OldStuff .

Idea.png
Put pages in an archive category
Put archhived pages an appropriate category, such as Category:Docs Project archive.

Meeting: namespace

Use this namespace for naturally named pages related to project and SIG meetings. For example, Meeting:Docs_IRC_log_20080806.

Idea.png
Put pages in a meeting category
Put the meeting in an appropriate category, such as Category:Docs Project meeting logs.

Categories