summaryrefslogtreecommitdiff
path: root/TWiki/WikiWord.mdwn
diff options
context:
space:
mode:
authorPeter Thoeny <web-hurd@gnu.org>2001-01-30 23:51:33 +0000
committerPeter Thoeny <web-hurd@gnu.org>2001-01-30 23:51:33 +0000
commitcb4ad0051fffa0c65af830d85f5eedc20cb12639 (patch)
tree1350a67c9e1f091d0fdef34cc81777f07c453f85 /TWiki/WikiWord.mdwn
parent11e9a00de9fd7e43d231f7cfc6e599b9f5a83a83 (diff)
none
Diffstat (limited to 'TWiki/WikiWord.mdwn')
-rw-r--r--TWiki/WikiWord.mdwn13
1 files changed, 9 insertions, 4 deletions
diff --git a/TWiki/WikiWord.mdwn b/TWiki/WikiWord.mdwn
index 4457a568..5dcf9bff 100644
--- a/TWiki/WikiWord.mdwn
+++ b/TWiki/WikiWord.mdwn
@@ -7,7 +7,7 @@ WikiWords are styled like this because:
* It makes Wiki hyperlinks instantly recognizable
* It leads to interesting Wiki topics
* It avoids the need to fiddle with HTML tags
-* It avoids over-general topics, because at least two words are required
+* It avoids over-general topics because at least two words are required
**Syntax of a WikiWord**
@@ -21,7 +21,7 @@ WikiWords are styled like this because:
* [[WikiWord]]
* [[GoodStyle]]
* [[AVeryLongWikiTopicNameIsAlsoPossible]]
-* [[ProblemY2K]]
+* [[YearTwoThousand]]
**Bad examples for WikiWords:**
@@ -34,5 +34,10 @@ WikiWords are styled like this because:
* Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
* To stop a WikiWord from being turned into a hyperlink, insert the text `<nop>` immediately before the WikiWord.
* A topic is usually presented in the singular. Plural WikiWords are automatically linked to the singular topic, i.e. the link [[WikiWords]] links to the topic [[WikiWord]].
-* Sometimes you have to be creative to find a good WikiName. For example, if you want to create a topic about the year 2000 problem, you could go for [[FixY2K]] or [[YearTwoK]] or [[YearTwoThousand]], but not Year2K or Y2K or Y2000.
-* Turn acronyms into WikiWords, i.e. take [[FaqIndex]] for a "FAQ index" topic.
+* Sometimes you have to be creative to find a good WikiName. Examples:
+ * To create a topic about the the **Bread Slicer 1.2** product, use `BreadSlicer1dot2` or `BreadSlicer1pt2`, but not `BreadSlicer1.2`.
+ * To create a topic about **year 2000**, you could go for `YearTwoK` or `YearTwoThousand`, but not `Year2K` or `Y2K` or `Y2000`.
+* Turn acronyms into WikiWords, i.e. take `FaqIndex` for a "FAQ index" topic.
+* You can create nicer looking links by using double square brackets, i.e. write <code>[[TWiki access control]]</code> to get a link to [[TWikiAccessControl]] that looks like [[TWikiAccessControl]].
+
+**_Related Topics:_** [[WikiSyntax]], [[TextFormattingRules]]