~ubuntu-branches/ubuntu/natty/moin/natty-updates

« back to all changes in this revision

Viewing changes to wiki/underlay/pages/HelpOnConfiguration(2f)SupplementationPage/revisions/00000001

  • Committer: Bazaar Package Importer
  • Author(s): Jonas Smedegaard
  • Date: 2008-06-22 21:17:13 UTC
  • mfrom: (0.9.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080622211713-fpo2zrq3s5dfecxg
Tags: 1.7.0-3
Simplify /etc/moin/wikilist format: "USER URL" (drop unneeded middle
CONFIG_DIR that was wrongly advertised as DATA_DIR).  Make
moin-mass-migrate handle both formats and warn about deprecation of
the old one.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
## Please edit system and help pages ONLY in the master wiki!
 
2
## For more information, please see MoinMoin:MoinDev/Translation.
 
3
##master-page:Unknown-Page
 
4
##master-date:Unknown-Date
 
5
#acl -All:write Default
 
6
#format wiki
 
7
#language en
 
8
= Supplementation Page =
 
9
Supplementation pages are just an additional pages that can be associated to your normal wiki pages by a link in the theme.
 
10
 
 
11
One usage of this feature is to have one "discussion page" additionally to each of your wiki pages. Then each wiki page will have a link to the "discussion page" by default.
 
12
 
 
13
== Configuration by the wiki admin ==
 
14
 
 
15
A wiki administrator can choose to enable this feature for all pages by putting this into wikiconfig:
 
16
{{{
 
17
    supplementation_page = True  # default is False
 
18
}}}
 
19
 
 
20
The name of the supplementation page and the template used for these pages can be set like this:
 
21
{{{
 
22
    supplementation_page_name = u'Discussion'  # this is the default
 
23
    supplementation_page_template = u'DiscussionTemplate'  # this is the default
 
24
}}}
 
25
 
 
26
== Control by the wiki user ==
 
27
A wiki user can control if he likes to have the supplementation feature on a per-page basis by using a processing instruction at the top of the page content:
 
28
{{{
 
29
#pragma supplementation-page on
 
30
}}}
 
31
 
 
32
Usage with '''off''' disables the feature on that page.
 
33
 
 
34
== Hints for using supplementation pages ==
 
35
 * Clean pages vs. good context:
 
36
  * You can use this to keep your wiki pages clean from discussions or comments (they shall be put on the supplementation page).
 
37
  * Separating discussions / comments has also some negative impact as you will have to provide context. If you don't do this, it might be unclear to what you are referring. If you could just comment ''near'' the context you are commenting, it would be less clean, but somewhat clearer/easier.
 
38
 * There is only one ''fixed'' supplementation_page_name (default: 'Discussion'):
 
39
  * If you just have a single language in your wiki, this is no big issue, you just set that page name to whatever you want. Either keep the default english name 'Discussion' or choose it wisely.
 
40
  * If you have multiple languages in your wiki, it is recommended to use a pagename that everybody can understand and be happy with (e.g. the english name 'Discussion', just keep the default).
 
41
 
 
42
There is also another, quite different "commenting feature" described on HelpOnComments.