Difference between revisions of "Help:Wiki Structure"

Jump to: navigation, search
(explaination of our wiki structure)
 
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
 
This page explains the methods used to maintain KDE's developer wiki.
 
This page explains the methods used to maintain KDE's developer wiki.
  
Line 6: Line 7:
 
;[[Contribute]]
 
;[[Contribute]]
 
;[[Development]]
 
;[[Development]]
;[[Development/Architecture]]
+
:[[Development/Architecture]]
;[[Development/Tutorials]]
+
:[[Development/FAQs]]
;[[Development/FAQs]]
+
:[[Development/Further Information]]
;[[Development/Languages]]
+
:[[Development/Guidelines]]
;[[Development/Tools]]
+
:[[Development/Languages]]
;[[Development/Books]]
+
:[[Development/Tools]]
;[[Development/Guidelines]]
+
:[[Development/Tutorials]]
 
;[[Getting Started]]
 
;[[Getting Started]]
 
;[[ISV]]
 
;[[ISV]]
Line 18: Line 19:
 
;[[Projects]]
 
;[[Projects]]
 
;[[Schedules]]
 
;[[Schedules]]
 +
;[[KDE System Administration]]
  
All other pages/articles belong to one of those pages (or their sub-pages) which means we heavily use sub-pages to maintain the structure and a hierarchy to not loose the overview.
+
All other pages/articles belong to one of those pages (or their sub-pages) which means we heavily use sub-pages to maintain the structure and a hierarchy to not lose the overview.
  
 
=== Sub-pages ===
 
=== Sub-pages ===
Line 26: Line 28:
 
  [[Development/Tutorials]]
 
  [[Development/Tutorials]]
  
Using sub-pages has several advantages
+
Using sub-pages has several advantages:
 
* they automatically provide us with a '''hierarchy''' which is reflected in the URL itself
 
* they automatically provide us with a '''hierarchy''' which is reflected in the URL itself
 
* automatically generated ''backlinks'' provide easy navigation
 
* automatically generated ''backlinks'' provide easy navigation
  
 
As an example, look at the page
 
As an example, look at the page
  [[Development/Architecture/KDE 3 Architecture/Library Structure]]
+
  [[Development/Architecture/KDE3/Library Structure]]
 
you can see following the links on the very top of the page:
 
you can see following the links on the very top of the page:
  < [[Development]] | [[Development/Architecture|Architecture]] | [[Development/Architecture/KDE 3 Architecture|KDE 3 Architecture]]  
+
  < [[Development]] | [[Development/Architecture|Architecture]] | [[Development/Architecture/KDE3|KDE3]]
  
 
== Categories ==
 
== Categories ==
In short, a [http://meta.wikimedia.org/wiki/Help:Category category] is a '''tag''' which appears at the very bottom of an article. As such, categories provide automatic indexes that are useful as tables of contents. Together with links and templates they help to structure a project.
+
In short, a [http://meta.wikimedia.org/wiki/Help:Category category] is a '''tag''' which appears at the very bottom of an article. As such, categories provide automatic indexes that are useful as tables of contents. Together with links and templates they help structure a project.
 +
 
 +
* [[Special:Categories|List of categories]]
 +
* [[Special:Unusedcategories|List of unused categories]] - Feel free to use them
  
* [[http://developernew.kde.org/Special:Categories|List of categories]]
+
Be sure to read the category page (e.g. [[:Category:Documentation]]) before tagging a page with it to make sure you're using it correctly.
  
 
== Important special pages ==
 
== Important special pages ==

Latest revision as of 16:23, 13 July 2012

This page explains the methods used to maintain KDE's developer wiki.

Contents

[edit] Top pages

The most important pages on this wiki are the top or root pages (in alphabetical order):

Contribute
Development
Development/Architecture
Development/FAQs
Development/Further Information
Development/Guidelines
Development/Languages
Development/Tools
Development/Tutorials
Getting Started
ISV
Policies
Projects
Schedules
KDE System Administration

All other pages/articles belong to one of those pages (or their sub-pages) which means we heavily use sub-pages to maintain the structure and a hierarchy to not lose the overview.

[edit] Sub-pages

A sub-page is a parent-child relation. In the following example Development is the parent of Tutorials, or the other way round: The page Tutorials is a sub-page (or a child) of Development

Development/Tutorials

Using sub-pages has several advantages:

  • they automatically provide us with a hierarchy which is reflected in the URL itself
  • automatically generated backlinks provide easy navigation

As an example, look at the page

Development/Architecture/KDE3/Library Structure

you can see following the links on the very top of the page:

< Development | Architecture | KDE3

[edit] Categories

In short, a category is a tag which appears at the very bottom of an article. As such, categories provide automatic indexes that are useful as tables of contents. Together with links and templates they help structure a project.

Be sure to read the category page (e.g. Category:Documentation) before tagging a page with it to make sure you're using it correctly.

[edit] Important special pages

There are several special pages which help us to maintain a clean wiki:

Issues which should be fixed as soon as possible
Special:Lonelypages
Special:BrokenRedirects
Special:DoubleRedirects
Issues which should be fixed in time
Special:Wantedpages
Special:Wantedcategories

This page was last modified on 13 July 2012, at 16:23. This page has been accessed 13,050 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal