~ubuntu-branches/ubuntu/oneiric/moin/oneiric-security

« back to all changes in this revision

Viewing changes to wiki/underlay/pages/HelpOnLinking/revisions/00000001

  • Committer: Bazaar Package Importer
  • Author(s): Jamie Strandboge
  • Date: 2010-03-30 12:55:34 UTC
  • mfrom: (0.1.17 sid)
  • Revision ID: james.westby@ubuntu.com-20100330125534-4c2ufc1rok24447l
Tags: 1.9.2-2ubuntu1
* Merge from Debian testing (LP: #521834). Based on work by Stefan Ebner.
  Remaining changes:
 - Remove python-xml from Suggests field, the package isn't anymore in
   sys.path.
 - Demote fckeditor from Recommends to Suggests; the code was previously
   embedded in moin, but it was also disabled, so there's no reason for us
   to pull this in by default currently. Note: This isn't necessary anymore
   but needs a MIR for fckeditor, so postpone dropping this change until
   lucid+1
* debian/rules:
  - Replace hardcoded python2.5 with python* and hardcore python2.6 for ln
* debian/control.in: drop versioned depends on cdbs

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
 
 
9
 
= Linking Rules =
10
 
 * Targets can be:
11
 
  * Local Pages:
12
 
   * either absolute: '''`a page name`''' or '''`main page/sub page`'''
13
 
   * or relative: '''`/some sub page`''' or '''`../some sister page`'''
14
 
  * Interwiki Pages: '''`OtherWiki:a pagename there`'''
15
 
  * URLs: '''`http://server/path`'''
16
 
  * Pages and URLs may include an anchor ('''`...#anchorname`''').
17
 
 * Use '''`[[target]]`''' if you want to ''link'' to some target object.
18
 
 * Use '''`{{target}}`''' if you want to ''transclude'' (embed/include/show) some target object (often an image).
19
 
 * Use '''`target|text`''' instead of just '''`target`''' to make it use the given text (e.g. as link text for links or as alt text for images).
20
 
 * Use '''`target|text|params`''' instead of just '''`target`''' to give additional params.
21
 
 
22
 
 * Use '''`target|{{imagetarget}}`''' if you want to show an image instead of a text.
23
 
 
24
 
URLs, interwiki pages, email addresses and CamelCase pagenames are recognized as targets even without using brackets.
25
 
 
26
 
= Quick Reference =
27
 
||'''Description'''              ||'''Example'''                                ||'''Comment'''                 ||
28
 
||internal link                ||`WikiName`                                  ||Camel``Case page name         ||
29
 
||internal free link           ||`[[free link]]`                             ||any page name                 ||
30
 
||internal link to sub page    ||`/SubPage` or `[[/sub page]]`               ||                              ||
31
 
||internal link to sister page ||`../SisterPage` or `[[../SisterPage|link text]]` ||                             ||
32
 
||internal link with linktext  ||`[[SomePage|some Page]]`                    ||                              ||
33
 
||internal link with linktext & parameter ||`[[SomePage|some Page|target="_blank"]]` || see below for parameter configurations ||
34
 
||internal link using a graphic as button ||`[[SomePage|{{attachment:samplegraphic.png}}]]` ||               ||
35
 
||internal link using graphic button, open new window ||`[[SomePage|{{attachment:samplegraphic.png}}|target="_blank"]]` ||               ||
36
 
||link to attachment           ||`[[attachment:image.png]]`                ||links to attachment image     ||
37
 
||link to attachment of another page||`[[attachment:SomePage/image.png]]` ||links to image attached to a different page ||
38
 
||interwiki link               ||`Otherwiki:somepage`                        ||requires uppercase wikiname   ||
39
 
||interwiki free link          ||`[[otherwiki:somepage]]`                    ||any wikiname in the map works ||
40
 
||external link                ||`http://example.net/`                        ||                              ||
41
 
||external link with linktext  ||`[[http://example.net/|example site]]`       ||                              ||
42
 
||external link with linktext, open new window ||`[[http://example.net/|example site|target="_blank"]]` || see below for parameter configurations ||
43
 
||external link using a graphic as button ||`[[http://example.net/|{{attachment:samplegraphic.png}}]]` ||               ||
44
 
||external link using graphic button, open new window ||`[[http://example.net/|{{attachment:samplegraphic.png}}|target="_blank"]]` ||               ||
45
 
||border of internal link      ||{{{WikiName``s}}}                  ||2 backticks - for when a !WikiName ends in the middle of a word||
46
 
||avoid an internal link       ||`!WikiName`                                 ||configurable function         ||
47
 
 
48
 
<<BR>>
49
 
 
50
 
||'''Transclusion/Embedding''' ||'''Syntax''' ||'''Comment''' ||
51
 
||embed an attached graphics ||`{{attachment:image.png}}` ||show attached image file `image.png` ||
52
 
||embed an attached graphics and give alt text ||`{{attachment:image.png|alt text}}` ||show attached image file `image.png` with alternative text saying `alt text` (recommended for accessibility) ||
53
 
||embed an attached graphics and define alignment ||`{{attachment:image.png|alt text|align="position"}}` ||show attached image file `image.png` with alternative text `alt text` and  aligned to ''position'', where ''position'' can be one of '''top''', '''middle''', '''bottom''', '''right''' or '''left''' (do not omit alt text) ||
54
 
||embed an attached graphics and resize it ||`{{attachment:image.png|alt text|width=100}}` ||show attached image file `image.png` with alternative text `alt text` and resize it to 100px width (do not omit alt text) ||
55
 
||embed an external graphics ||`{{http://example.net/image.png}}` ||show target image inline ||
56
 
||embed an external graphics and give alt text ||`{{http://example.net/image.png|alt text}}` ||show target image inline with alternative text saying `alt text` (recommended for accessibility) ||
57
 
||embed an external graphics and define alignment ||`{{http://example.net/image.png|alt text|align="position"}}` ||show target image inline with alternative text `alt text` and aligned to ''position'', where ''position'' can be one of '''top''', '''middle''', '''bottom''', '''right''', or '''left''' (do not omit alt text) ||
58
 
||embed an external graphics and resize it ||`{{http://example.net/image.png|alt text|width=100}}` ||show target image inline with alternative text `alt text` and resize it to 100px width (do not omit alt text) ||
59
 
 
60
 
= Explanations =
61
 
 
62
 
== URLs ==
63
 
If you enter URLs into normal text, there is the problem of detecting what belongs to the URL and what not. There are four ways to force the ending of an URL:
64
 
 * put a space after the URL,
65
 
 * use the Wiki:SixSingleQuotes escaping,
66
 
 * use the double bracketed URL syntax.
67
 
 
68
 
The supported URL schemes are: `http`, `https`, `ftp`, `file` and some others. The administrator of your wiki can extend the supported schemes by using the {{{url_schemas}}} variable (see HelpOnConfiguration).
69
 
 
70
 
In addition to the standard schemes, there are MoinMoin-specific ones: `attachment` and `drawing`, these are related to file attachments and are explained on HelpOnActions/AttachFile.
71
 
== Spaces ==
72
 
You can always use the double brackets (or double braces) syntax to use page or file names with spaces.
73
 
 
74
 
This will even work for interwiki links, if the target wiki understands standard url quoting (space will become %20).
75
 
 
76
 
== Anchors ==
77
 
To ''insert'' anchors into a page you need the ''Anchor'' macro (see HelpOnMacros): `<<Anchor(anchorname)>>`, where "anchorname" is the actual identifier of the anchor.
78
 
 
79
 
To link to an anchor on the same wiki page use `[[#anchorname]]` or `[[#anchorname|label text]]`.
80
 
 
81
 
To link to an anchor on another wiki page write `[[PageName#anchorname]]` or `[[PageName#anchorname|label text]]`, where "Page``Name" is the name of the other page and "anchorname" is the identifier of the anchor on that page.
82
 
 
83
 
/!\ On some Wikis, a link to the page RecentChanges might refer to the same page as this link: [[recentchanges]]. This is especially true for Windows and Mac OS X systems because they are not case-sensitive normally.
84
 
 
85
 
== Preventing Automatically Generated Links ==
86
 
 
87
 
To keep a word like Page``Name from automatically being turned into a link, use {{{Page``Name}}}.  (The problem with doing this is that it will prevent a simple search for the word "Wiki``Name" from matching {{{Wiki``Name}}} in a page, due to the inserted characters.)
88
 
 
89
 
You can also suppress WikiName linking by putting an exclamation mark (''bang'') before the WikiName, i.e. `!WikiName`. This is available by default, but can be disabled with the configuration option `bang_meta = False`.  Using this method will not interfere with most searches for the escaped `WikiName`, with the exception of certain quoted phrases and regular expressions.
90
 
 
91
 
To prevent automatic URL linking, use either {{{`http://...`}}} or `{{{http://...}}}`.
92
 
 
93
 
== Using link parameters ==
94
 
Sometimes you may want to give additional parameters for a link, influencing how it looks like, how it behaves and how exactly it links to the target - this is what the '''params''' part of `[[target|text|params]]` is for.
95
 
 
96
 
=== Setting attributes of the <a> tag ===
97
 
Available attributes: class, title, target, accesskey (see some html reference if you want to know what they mean).
98
 
 
99
 
Example: `[[http://moinmo.in/|MoinMoin Wiki|class=green dotted,accesskey=1]]`
100
 
 
101
 
Renders as: [[http://moinmo.in/|MoinMoin Wiki|class=green dotted,accesskey=1]]
102
 
 
103
 
(!) Pressing the access key should jump to that link target (for Firefox 2.x and the example above it is Alt-Shift-1).
104
 
 
105
 
=== Creating a query string for the target URL ===
106
 
What is possible for this depends on the target site.
107
 
 
108
 
Example: `[[MoinMoin:MoinMoinWiki|MoinMoin Wiki|&action=diff,&rev1=1,&rev2=2]]`
109
 
 
110
 
Renders as: [[MoinMoin:MoinMoinWiki|MoinMoin Wiki|&action=diff,&rev1=1,&rev2=2]]
111
 
 
112
 
(!) Please remember:
113
 
 * If you want to give a key=value item for the query string, don't forget the ampersand (&).
114
 
 * Giving query string items does not work when you give a URL as target (but for links to pages or attachments).
115
 
 * If you give a URL as target, you can include a query string directly in that target, no need for params.
116
 
 * You don't need to encode and url_quote the query string stuff, moin does this automatically for you.
117
 
 
118
 
== Images ==
119
 
You may use
120
 
{{{
121
 
{{attachment:imagefile.png|text describing image|width=100}}
122
 
}}}
123
 
to have the attached file `imagefile.png` displayed with a width of 100px; the graphics' height will be reduced/ enlarged proportionally (e.g. if `imagefile.png` was actually 200px width and 400px height, height would be reduced in this example to 200px). You may also use
124
 
{{{
125
 
{{attachment:imagefile.png|text describing image|height=100}}
126
 
}}}
127
 
to have the attached file `imagefile.png` displayed with a height of 100px, and the graphics' width will be reduced/ enlarged proportionally. Use
128
 
{{{
129
 
{{attachment:imagefile.png|text describing image|width=100,height=150}}
130
 
}}}
131
 
to have the attached file `imagefile.png` displayed with a width of 100px and a height of 150px. Please do not omit the alternative text in neither case.
132
 
 
133
 
Note this does not alter the attached file itself, in only makes the browser scale the image down/ up to the value given while displaying it.
134
 
 
135
 
=== Thumbnails ===
136
 
You may combine the transclusion with the linking syntax, leading to an image displayed in reduced size that links to itself in actual size, e.g.
137
 
{{{
138
 
[[attachment:imagefile.png|{{attachment:imagefile.png|text describing image|width=100}}]]
139
 
}}}
140
 
 
141
 
== Other stuff ==
142
 
 
143
 
For more information on the possible markup, see HelpOnEditing. For details on how to link to subpages, see HelpOnEditing/SubPages.
144
 
 
145
 
<<FootNote>>
146
 
 
147
 
= Examples =
148
 
== Markup ==
149
 
{{{
150
 
 * http://moinmo.in/
151
 
 * [[http://moinmo.in/]]
152
 
 * [[http://moinmo.in/|MoinMoin Homepage]]
153
 
 * InterWiki
154
 
  * Self:InterWiki
155
 
  * MeatBall:InterWiki
156
 
  * [[MeatBall:InterWiki|InterWiki page on MeatBall]]
157
 
  * [[MoinMoin:page with spaces]] (doesn't exist)
158
 
 * email
159
 
  * user@example.com
160
 
  * mailto:user@example.com?subject=test
161
 
  * [[mailto:user@example.com?subject=test|Email me]]
162
 
 * [[InterWiki|InterWiki page in this wiki]]
163
 
 * [[#anchorname|Link to anchor on this page]]
164
 
 * [[OtherPage#anchorname|Link to anchor on other page in current wiki with label text]]
165
 
 * {{http://moinmo.in/moin_static/common/moinmoin.png}}
166
 
 * {{http://moinmo.in/moin_static/common/moinmoin.png|moinmoin logo}}
167
 
}}}
168
 
 
169
 
== Display ==
170
 
 * http://moinmo.in/
171
 
 * [[http://moinmo.in/]]
172
 
 * [[http://moinmo.in/|MoinMoin Homepage]]
173
 
 * InterWiki
174
 
  * Self:InterWiki
175
 
  * MeatBall:InterWiki
176
 
  * [[MeatBall:InterWiki|InterWiki page on MeatBall]]
177
 
  * [[MoinMoin:page with spaces]] (doesn't exist)
178
 
 * email
179
 
  * user@example.com
180
 
  * mailto:user@example.com?subject=test
181
 
  * [[mailto:user@example.com?subject=test|Email me]]
182
 
 * [[InterWiki|InterWiki page in this wiki]]
183
 
 * [[#anchorname|Link to anchor on this page]]
184
 
 * [[OtherPage#anchorname|Link to anchor on other page in current wiki with label text]]
185
 
 * {{http://moinmo.in/moin_static/common/moinmoin.png}}
186
 
 * {{http://moinmo.in/moin_static/common/moinmoin.png|moinmoin logo}}
187
 
 
188
 
= If you used moin before... =
189
 
Don't worry, it is much easier and better predictable now:
190
 
 * It is always two brackets (for links) or two curly braces (for transclusion/embedding) now.
191
 
 * Because of that, macros use '''`<<MacroName(...)>>`''' syntax now.
192
 
 * Use brackets or braces syntax if some target has blanks chars (no _ and no %20 any more!).
193
 
 * Use the pipe char (|) to separate target and text (and params).
194
 
 * '''`wiki:`''' is gone, just use interwiki without it.
195
 
 * '''`inline:`''' is now '''`{{attachment:...}}`'''.
196
 
 * Interwiki links now only use `WikiName:PageName` (''not:'' `WikiName/PageName`)
197
 
 * It has less magic now (and will just do what you say!):
198
 
  * Underscore (_) is a normal character and different from blank.
199
 
  * If you want an underscore, use an underscore - if you want a blank, use a blank.
200
 
  * If you link to an image, it will just link to an image (not show/embed it!).
201
 
 * For early moin 1.6 users: no quoting with double-quotes any more, use outer double brackets/braces to quote.
202
 
 
203
 
(!) This markup is inspired by creole wiki markup standard (and is also quite similar to what mediawiki engine uses).