Difference between revisions of "Help:Contents"

From Xen
(Removed TODOs)
(Navigation)
 
(39 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= Getting started with the Wiki =
+
This wiki is a major documentation resource for Xen.org project. It is freely editable by everyone and participation is actively encouraged by anyone who can see a way to improve it. Below you will find details about the wiki itself, including how to find what you are looking for and how to create an account and start editing. So don't hesitate: improve something today!
The Xen Wiki uses [http://www.mediawiki.org MediaWiki] and quite a few resources
+
----
* [http://www.mediawiki.org/wiki/Help:Contents MediWiki Help Contents]
+
{{WarningLeft|The Xen Wiki has been subject to a severe spam attack in the last few months. To solve this and keep the wiki usable for everyone, we had to lock down the wiki and create an editors group. We already put a better CAPTCHA mechanism in place as a first step. Please [http://xenproject.org/component/content/article/100-misc/145-request-to-be-made-a-wiki-editor.html fill out this form] and we will add you to the group.}}
* [http://upload.wikimedia.org/wikipedia/commons/8/89/Cheatsheet-mediawiki.pdf Cheat Sheet]
+
----
 +
{{Trailbox|Get Started with the Wiki|Wiki_Get_Started
 +
|{{Trail|MediaWiki Help|
 +
* [http://upload.wikimedia.org/wikipedia/commons/8/89/Cheatsheet-mediawiki.pdf MediaWiki Cheat Sheet]
 +
* {{Button|[http://www.mediawiki.org/wiki/Help:Formatting MediaWiki Markup]|style=btn-green btn-small}}
 +
* [http://www.mediawiki.org/wiki/Help:Contents MediaWiki Help Contents]
 +
* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
 +
* [http://www.mediawiki.org/wiki/Books_about_MediaWiki Books about MediaWiki]
 +
}}|{{Trail|Join Our Community|
 +
* [[Special:UserLogin|Create an account or log in]]
 +
* {{Button|[http://xenproject.org/component/content/article/100-misc/145-request-to-be-made-a-wiki-editor.html Become an editor]|style=btn-green btn-small}}
 +
* [[Sandbox|Play with the Sandbox]]
 +
* [[#help|Get Involved!]]
 +
}}|{{Trail|Find what you need|
 +
* [[Main_Page|Main Page]]
 +
* [[#search|Via Search]]<br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{{Button|[[Help:Set up Search Correctly|Set up Search Correctly]]|style=btn-danger btn-small}}
 +
* [[#categories|Via Categories]] ([[Categories_for_Users|Index]])
 +
* [[#navigation|Via Navigation]]
 +
}}<br>{{Trail|Book & Bookmarks|
 +
''These tools are useful to create collections of pages you find interesting and to export them to PDF files''
 +
* [https://meta.wikimedia.org/wiki/Book_tool/Help/Books Book Tools]
 +
}}
 +
|{{Trail|Information for Authors|
 +
* [[Wiki_Community|Wiki Conventions]]
 +
* {{Button|[[:Category:Templates|Templates in this Wiki]]|style=btn-green btn-small}} <br>''For better formatting, syntax highlighting, nice tables, ...''
 +
* [[Xen Project Document Days]]
 +
* [[Categories for Authors]]
 +
* [[Xen:Multi-language Conventions|Multi-language Conventions]]
 +
* [[:Category:Wiki Management|Wiki Management Tools]]
 +
* [[Help:Talk_Pages|Talk Pages]]
 +
}}<br>{{Trail|Tools|
 +
* [http://labs.seapine.com/htmltowiki.cgi Online HTML to Wiki Converter]
 +
* [http://wordmediawikiaddin.codeplex.com/ Word Add-in For MediaWiki]
 +
}}
 +
}}
 +
----
 +
__TOC__
  
= Conventions for our Wiki =
+
== Stuff you should know ==
 +
* We do require users to register with the wiki before you can edit pages (in response to problems with spammers)
 +
* We do not currently protect ANY Wiki pages. We will monitor the situation and may change policy in future.
  
{{Info|For more information on Wiki conventions check out our guide on the '''[[Wiki_Community|Wiki Community]]''' page.}}
+
{{Anchor|help}}
 +
== How you can help ==
 +
* [[Talk:Xen_Document_Days/TODO|Let us know what information is missing]]
 +
* [[Category_talk:RefToExternalArticle|Let us know if you come across information about Xen that we should link to]]
 +
* [[Xen_Project Document_Days|Participate in Xen Project Document Days]]
 +
* [[Wiki_Community|Become a wiki author and write documentation]]
  
== Wiki Users ==
+
== Navigating the Wiki ==
* We do not currently require users to register with the wiki before you can edit pages
+
Common topics are accessible from the [[Main_Page|main page]].
* However, we do encourage our users to create an account such
 
* We will monitor whether there is an issue and may change access control in future
 
  
== Protecting Wiki Pages ==
+
{{Anchor|search}}
We do not currently protect Wiki pages. We will monitor the situation and may change policy in future.
+
=== Search ===
 +
[[Image:Navigation.png|thumb|right|Navigation bar]]
 +
<div style="border:1px solid #ababff; background: #fdfdff; padding: 1em; margin: 1.1em 1em 1em 0em; font-size:105%">
 +
Put your keyword in the searchbox.
 +
* '''{{int:searcharticle}}''' - (or ''Enter'' on keyboard) will take you automatically to the article, if it exists.
 +
* '''{{int:searchbutton}}''' - will search the text of all pages on the wiki (with some restrictions, see below).
 +
* [[mediawikiwiki:Help:Searching|More help on search]]
 +
</div>
  
== Categories ==
+
{{Anchor|categories}}
We use categories to help manage Wiki pages: each Wiki page should be at least in one category. For more information on Category conventions see '''[[Wiki_Community#Improving Navigation through Categories|Improving Navigation through Categories]]'''.
 
  
== Page Management Templates==
+
=== Categories ===
We use a set of templates to manage and highlight the state of Wiki pages. For more information on Page Manegment conventions see '''[[Wiki_Community#Managing Pages via Templates|Managing Pages via Templates]]'''.
+
<div style="border:1px solid #ababff; background: #fdfdff; padding: 1em; margin: 1.1em 1em 1em 0em; font-size:105%">
 +
We use categories to help manage Wiki pages:
 +
* '''[[Categories for Users|Category Index]]''' lists the key managed categories in the wiki
 +
* Our category pages are not normally just indexes, but have a hand-edited header, which highlight important information.
 +
</div>
 +
 
 +
{{Anchor|navigation}}
 +
 
 +
=== Navigation ===
 +
The main categories that are used in the Wiki's navigation structure on the left. Pages in these categories will be automatically added to the index.
 +
 
 +
[[Category:Community]]
 +
[[Category:Wiki Management]]

Latest revision as of 07:46, 29 January 2020

This wiki is a major documentation resource for Xen.org project. It is freely editable by everyone and participation is actively encouraged by anyone who can see a way to improve it. Below you will find details about the wiki itself, including how to find what you are looking for and how to create an account and start editing. So don't hesitate: improve something today!


Icon Ambox.png The Xen Wiki has been subject to a severe spam attack in the last few months. To solve this and keep the wiki usable for everyone, we had to lock down the wiki and create an editors group. We already put a better CAPTCHA mechanism in place as a first step. Please fill out this form and we will add you to the group.

Get Started with the Wiki
MediaWiki Help
Join Our Community
Find what you need

      Set up Search Correctly


Book & Bookmarks

These tools are useful to create collections of pages you find interesting and to export them to PDF files

Information for Authors

Tools

Stuff you should know

  • We do require users to register with the wiki before you can edit pages (in response to problems with spammers)
  • We do not currently protect ANY Wiki pages. We will monitor the situation and may change policy in future.

How you can help

Navigating the Wiki

Common topics are accessible from the main page.

Search

Navigation bar

Put your keyword in the searchbox.

  • Go - (or Enter on keyboard) will take you automatically to the article, if it exists.
  • Search - will search the text of all pages on the wiki (with some restrictions, see below).
  • More help on search

Categories

We use categories to help manage Wiki pages:

  • Category Index lists the key managed categories in the wiki
  • Our category pages are not normally just indexes, but have a hand-edited header, which highlight important information.

Navigation

The main categories that are used in the Wiki's navigation structure on the left. Pages in these categories will be automatically added to the index.