Calligra/Wiki editing hints

Jump to: navigation, search

Contents

Wiki links

As you know we have moved to community.kde.org wiki from wiki.koffice.org. This adds one little complexity: our root page is now a subpage http://community.kde.org/Calligra.

So our absolute links have to include Calligra prefix, e.g. [[Calligra/Stage]].

Hints that may help you inserting links: Links like these look ugly in writing: Calligra/Stage. So better absolute link would be [[Calligra/Stage|Stage]]. BUT if you want to link to a child (subpage) or even deeper, you can use simpler syntax. For example on the Calligra page, you can link to Stage subpage by entering:

[[/Stage/]]

Proper "Stage" word appears in the resulting text.

Similarly, a grandchild page link:

[[/Stage/Todo|Todo]]

Enabling navigation

Currently the default Oxygen skin of the wiki does not support breadcrumbs i.e. navigation links across subpages. If you value usability more than look, log in and temporarily set skin in Preferences to Monobook. Works only when you are signed in.

Using templates

To improve readibility of your wiki pages you can now "tag" them by adding boxes of appropriate type. The markup behind this is called wiki templates.

Inserting information about unfinished content

Use:

{{Improve}}

.. to get this:

Warning.png
 
Warning
This section needs improvements: Please help us to

cleanup confusing sections and fix sections which contain a todo


You can add more info to the box. Example:

{{Improve|Let's all chip in to compile a list of icons.}}

Here's the result:

Warning.png
 
Warning
This section needs improvements: Please help us to

cleanup confusing sections and fix sections which contain a todo


Let's all chip in to compile a list of icons.

Inserting notes

Use:

{{Note|This is stable API}}

.. to get this:

Note-box-icon.png
 
Note
This is stable API


Inserting other general warnings

Use:

{{Warning|Don't do it!}}

.. to get this:

Warning.png
 
Warning
Don't do it!


Links to bugs in the KDE's Bugzilla

Use:

{{Bug|12345}}

.. to get automatic link like this: Bug #12345

Random notes

  • Page names. Use natural language with spaces - wiki will replace them with _ in URLs. Use hierarchical names, e.g. Icons/KOffice wide icons instead of flat structured KOffice wide icons. Then, create parent page, e.g. Icons for Icons/KOffice_wide_icons. You will get a nice link to the parent on the top of the subpage, allowing navigation. Many levels are allowed in the hierarchy.
  • Use a single line containing __TOC__ to control where do you want to display table of contents.

This page was last modified on 8 December 2010, at 10:45. This page has been accessed 1,420 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