Wiki Guidelines

From PsiWiki

This document describes:

  • restrictions which should be considered when adding/updating information in the Wiki
  • Psi wiki features

Contents

[edit]

Global Restrictions

  • updates/comments/etc. can be done only by registered & logged in users
  • the Main Page of the Wiki has been locked to prevent spamming. If you think that some page requires linking on the Main Page, feel free to contact one of the the Wiki administrators.
  • use edit this page link only to make updates/correction to the content
  • use the discussion link (top of the page, next to the article link) if you want to talk/comment about the content of a page. Please do not insert you comments/questions/suggestions/etc. in the text.
[edit]

Structure

See #Linking Guidelines below on linking the documentation.

  • Category:User Guide - a category which unites information about Psi, such as:
    • Jabber Terminology and Psi
    • User Interface
    • Features
  • User Guide - a merged document containing many documents in Category:User Guide
  • Installation Guide - contains information about installing Psi on various platforms
  • Tutorial - contains limited information about using Psi, suitable for new users
[edit]

Linking Guidelines

Do not, under any circumstance, link to sections in the merged User Guide. Please locate first the article containing the same information in the User Guide Category. Link to that article instead.

  • this makes finding information (sections) a lot easier in case it is relocated
  • any specific-topic articles load a lot faster than the merged User Guide article
[edit]

Templates

The short story: Templates are ways of including formatted text inside articles. The long story can be found here.

The Psi Wiki has the following templates defined by now:

  • {{stub}} - this will add a notice to the page mentioning that it is not finished (example)
  • {{todo|todo content text}} - this will add a box for specifying TODOs for the content of a page (the text cannot contain links):

TODO: todo content text

[edit]

InterWiki Links

More information about InterWiki Linking can be found here.

Psi Wiki supports the following special interwiki links:

  • [[FS:FlySprayNumber]] - links to Task #FlySprayNumber in FlySpray, our Bug Tracking Manager
  • [[JEP:####]] - links to JEP number #### (you need to prepend the number with zeros to have exactly 4 digits)
[edit]

Tips and Tricks

The 'Tips and Tricks' page contains all the tips displayed in Tip of the Day by Psi. We've got this in the wiki for anyone to contribute and improve the current list.

The content of the page is parsed using a script to generate C++ code to be included in the Psi sources. This requires a certain pattern to be met in order for the process to work correctly.

The Wiki code which should be replicated for any other future tips and tricks listed here is the following:

<div style="padding: .4em .9em .4em; border: 1px solid rgb(170, 170, 170); color: #000; background: rgb(249, 249, 249); margin-bottom: .9em ">
CONTENT OF THE TIP/TRICK
<br /><br /><em>Contributed by Contributor Name</em>
</div>

Observations:

  • The "Contributor Name" line can be missing entirely (including the two "<br />" tags).
  • The content must not include <div> tags.

A sample piece of code is also included at the end of the page source, as a comment. It can be copied and used as a base for adding a new Tip/Trick.

[edit]

Other Wikis

Here are some great examples of other successful and well-organized Mediawiki wikis. We would do well to emulate their best practices.

Retrieved from "http://psi-im.org/wiki/Wiki_Guidelines"