Help:Wiki Community

Before you continue reading, join the wiki as a user. We do not require for you to do this, but encourage you to register.

Why we need YOU! The Xen.org Wiki has existed for some time and as with many Wiki's contains a lot of content that is out-of-date, or not relevant any more. We decided to migrate to a new MediaWiki based wiki, which allows us a fresh start. We hope to be able to mobilize Xen community members and are planning a number of regular activities and approaches: Regular Document Days on IRC Recognize community members for their contributions Make new Wiki much more manageable by using Categories and other proven Wiki tools Help migrate pages from the old Wiki: Migration Instructions from Old to New Xen Wiki

Wiki Conventions

We want to make it as easy as possible for users to use and find content in the new Wiki and also ensure that the Wiki remains up-to-ate.

Useful Built-in Wiki Pages

These pages will help editors spot pages that need work.

Changes	Missing Content	Manage Pages
Recent Changes	Wanted Pages »» Create page	Uncategorized Pages »» Categorize
Related Changes	Wanted Files »» Upload file	Action Needed »» Needs deletion, refactor, review, ...
	Wanted Categories »» Create category	Needs formatting »» Easy fix for a beginner
	Wanted Templates »» Create template	TODO Item »» Contains TODO item

Managing Pages via Templates

Templates to help manage content
Template	When to use
Template:Needs_Archive	Indicates that this page needs to be archived. Please specify a reason why.
Template:Needs_Additions	Indicates that this page is incomplete and can benefit from additions and improvements. Please specify what should be added.
Template:Needs_Delete	Indicates that this page needs to be deleted. Please specify a reason why.
Template:Needs_Formatting	Indicates that this page has some formatting issues. Please detail the issue.
Template:Needs_Refactor	Indicates that this page needs to be refactored, such as merging or splitting. Please be concrete about the reason and proposed ocurse of action.
Template:Needs_Review	Indicates that this page needs to be reviewed. If specific parts of the page need reviewing or are incorrect, please state in the macro.
Template:Needs_Rewrite	Indicates that this page needs to be rewritten; in other words it is useful but contains lots of errors. Please provide more information in the macro.
Template:Needs_Recategorize	Indicates that this page needs to be properly categorized. Please specify a reason why.
Template:TODO	This is a generic template that indicates that something needs to be done to this page. Should only be used if the more specific templates are not applicable.
Other more generic templates
Template	When to use
Template:Info	This is a generic info box, which highlights some information about this page.
Template:InfoLeft	Same as Info only that not centered
Template:Warning	This is a generic warning box, which highlights some information about this page that typically warns the user of something.

Also see:

• Help on Templates
• Example on how to use any of the above templates:

  {{Info|This is an infobox with this text in the box}}

• Another example:

  {{Needs_Archive|This page is out-of-date: this project completed in 2009.}}

Categories

We use categories to help manage Wiki pages:

• Each Wiki page should be at least in one category
• Our category pages are not normally just indexes, but have a hand-edited header, which highlight important information.

Creating new pages

• Please make sure that you choose ONE of the following categories on a new page
  • Technology: Xen, XCP, XenARM, PVOPS
  • Audience: Beginners, Users, Developers,Project, Community
  • Documentation Type: Manual, Overview, FAQ, HowTo, Tutorial, Example, Compatibility, Glossary, Index (pick what fits best)
  • Life span: choose category Transient if the document is transient (e.g. describes an event)
  • External: choose category RefToExternalArticle if the is a stub linking to an external article
• For other categories, please check Categories for Authors for more detail
• If your article is important, please go to the most relevant category and add the article to the hand-maintained content
• Help on categories: Help:Categories

Creating a new Category

• Please do NOT just create an empty category
• Add content the top the category: examples are Category:Host_Install and Category:Arch_Linux
• Please describe the new category in
  • Categories for Users
  • Categories for Authors

Improving Accessibility of topics with Trails

Trails are sequences of documents (or indeed sections of documents) that are suggested to be read in a certain order. Note that trails are automatically added to the Category:Trail.

Usage of Trails Trailbox Syntax Trail Syntax Using both templates together

Archiving Pages

Pages are archived in the following way:

• Add [[Category:Archived]] to the page
• Rename the page from <pagename> to Archived/<pagename>
  • If you do not have the right to rename pages, add [[Template:Needs_Archive]] to the page
• Ensure you do the same with all sub-pages and translations
• Keep all categories as they are
• If you cannot rename the page, then mark it with {{Needs_Archive|Reason why}}, such that a wiki adminstrator can rename the page

Multi-language Help and Conventions

For more information, see Multi-language Conventions

Use of Discussions: Talk pages

Every wiki page has an associated talk page which can be used for discussion and communicating with other users. Talk pages can be accessed by clicking the “discussion” tab at the top of the page. Simply edit the page as normal to add your comment.

We encourage the use of talk pages. However, it would be good if you followed these Guidelines What to discuss:

• Keep focused on the task of building a wiki article: remember that editing the article itself is often a more effective means of communicating.
• Use discussion pages only to support this process: the topic of conversation should generally revolve around what needs to be done to make the associated article better.
• Talk pages are good in particular, if you suspect something is wrong with the content, but you do not quite know how to fix the page.

Conventions:

• Always use the {{comment}} template using {{Comment|~~~~:}} your comment text for commenting. Using the template makes it easier to find and address any comments made on talk pages. If you do not use this notation, your comment may be lost if it is not addressed immediately. Note that ~~~~ will render to something like [[User:Example|Simon Brown]] 21:55, 3 September 1991 (UTC)
• Start a new discussion with a ==level 2 heading== at the bottom of the page (or use the “+” tab).
• Indent replies with colons (:) at the beginning of the line.

Also See:

• More on Talk Pages (examples, etc.)

Language:	English