Help:Wiki structure

From oVirtWiki

Jump to: navigation, search

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 are designed to use MediaWiki while making life easier for contributors and readers.

Contents

Page naming

Use this for naming new pages and areas.

General naming rules

These rules are for pages and sections.

  • Do not nest pages in sub-folders, e.g. Topic/FAQ
  • Use natural language naming (as opposed to nesting)
  • Use capital letters only for the initial word in a title or section title: "Like this"
    • 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]].

Pages are not organized by nesting, they are organized using #Categories.

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.

  • Name pages within a single, flat namespace; do not use directory-like hierarchies:
    • no : [[CodeRepository/CommitHowTo]]
    • yes : [[How to commit code to the repository]]

Project and special interest pages for contributors

These are pages focused on contributors who are working in one or more areas of oVirt. Some content may be end-user focused but belong within the project for reference.

The content here must be without nesting, putting all pages in an appropriate Category:Foo Project category.

  • Content must be in a flat namespace with spaces
    • no : Node/Packages/Distributions/Version
    • no : VDSM/Package_Maintainer_Generic_Job_Description
    • yes : Node_package_versions_in_different_distributions; Generic_job_description_for_VDSM_package_maintainers

How to use a category page as a project main page

Project pages may want to use their related category page as the project wiki main page. One advantage of this is all pages and sub-categories appear on that page below the project content.

To use a category page as a main project page for the example oVirt Foobar project:

  1. Put these URLs in to the address field of two different browser tabs:
  2. In the tab for the Category:Foobar page, click on the create link, or choose edit this page from the page body.
    1. In the body of the page put in the content you need. You can start with the Category:Project wiki template, which is a template for a category used as a project page.
    2. Be sure to put the [[Category:Project]] category at the bottom of the project page content so the project is now a wiki sub-category of all oVirt projects.
    3. Save the page, noting in the Summary: this is a new project category and main page.
  3. In the tab for the Foobar page, click on the create link, or choose edit this page from the page body.
    1. In the body of the page create a redirect to the project category page, then save the page: 
#REDIRECT [[:Category:Foobar]]

Now you can use the easier link http://ovirt.org/wiki/Foobar, which redirects to the category page http://ovirt.org/wiki/Category:Foobar .

Namespaces

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

Automatically searchable namespaces

  • Main:
  • 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.

Categories

  • Use as many categories as needed that make sense:
  • The category pages are the aggregation pages. Point to them prominently as the way to find all of something on a topic/within a category.
  • New category names should follow the same natural language rules as individual pages but are usually plural:
    • VDSM meeting logs
    • Evangelists in North America
    • 2012 events
    • Workshop agenda for 1 November

To link to categories from another page, put a ':' in front of the word Category: 

[[:Category:Project]]

(Remixed from https://fedoraproject.org/wiki/Help:Wiki_structure and used under the CC BY SA 3.0.)

Retrieved from "http://www.ovirt.org/wiki/Help:Wiki_structure"
Personal tools