Difference: WikiWord (1 vs. 7)

Revision 704 Oct 2006 - Main.TWikiContributor

Line: 1 to 1
 

What is a WikiWord?

A WikiWord consists of two or more words with initial capitals, run together. WikiWords are topic names. A TWiki topic name always has a fixed format: two or more words with initial capitals, run together. Like the name of the current topic: WikiWord. When you type the name of a topic, you create a link to that topic. You type WebHome and on saving the page this becomes WebHome. It's as easy as that.
Line: 19 to 19
 

Syntax of a WikiWord

  • Uppercase letter(s)
Changed:
<
<
  • Lowercase letter(s)
>
>
  • Lowercase letter(s) or numbers(s)
 
  • Uppercase letter(s)
  • Optional lowercase or uppercase letter(s) or number(s)
Line: 31 to 31
 
  • ReleaseVersion5dot3?
  • AVeryLongWikiTopicNameIsAlsoPossible?: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed
  • YearTwoThousand?
Added:
>
>
  • Nine2Five?: Note that numbers are considered to be lowercase letters in WikiWords
 

Bad examples of WikiWords:

  • Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence
Changed:
<
<
  • T5Wiki?: Name with number before the uppercase, lowercase, uppercase sequence
  • Md5sumsAfterBurning?: Name with number before the uppercase, lowercase, uppercase sequence
>
>
  • 5TWiki: Name beginning with a number
 
  • Know-How: Name with dashes in between

Variations in linking

Line: 47 to 47
 
  • To link to a topic in another web, write: Sandbox.WebSearch - this becomes: WebSearch
  • To show the web name in the link use bracket notation: [[Sandbox.WebHome]] - this becomes: Sandbox.WebHome
  • To link to a topic on another Wiki site, use: TWiki:Main/WebHome - this becomes: TWiki:Main/WebHome (sites are defined in the InterwikiPlugin)
Changed:
<
<
  • To link to a part on the same page, write a dash and the name of the header, with spaces replaced by underscores (and ! removed): [[#Good_examples_of_WikiWords]] becomes: #Good_examples_of_WikiWords. You can also link to a part on another page: TWiki.WebHome#Disclaimer becomes: WebHome#Disclaimer.
>
>
  • To link to a part on the same page, write a "#" followed by the name of an anchor. The anchor is a "#" followed by a name which must be a WikiName. Example #MyAnchor. You can also link to an anchor on another page: TWiki.WebHome#MyAnchor.
  • To link to a header on the same page, write a "#" followed by the header text, with spaces replaced by underscores (and ! removed): [[#Good_examples_of_WikiWords]] becomes: #Good_examples_of_WikiWords. You can also link to a header on another page: TWiki.WebHome#Disclaimer becomes: WebHome#Disclaimer.
 

Hints

  • Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
  • Be specific. All topics in a web share one name space. For example, instead of FunctionalSpec write BreadSlicerFunctionalSpec because other projects might also have a functional spec topic.
  • To stop a WikiWord from being turned into a hyperlink, insert an exclamation point immediately before the WikiWord. For example, write !SunOS to get SunOS.
Changed:
<
<
  • Create topics with singular names. Plural WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord.
>
>
  • Create topics with singular names. Plural WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord (works only in English).
 
  • 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.
Changed:
<
<
    • To create a topic about year 2000, you could go for YearTwoK or YearTwoThousand, but not Year2K or Y2K or Y2000.
>
>
    • Numbers are considered lowercase which makes Year2K and Y2K WikiWords but not Y2000 and Y2k.
 
  • Turn acronyms into WikiWords, i.e. take FaqIndex for a "FAQ index" topic.
  • It is possible to turn off the auto-linking of WikiWords and to rely only on the bracket notation. See NOAUTOLINK setting in TWikiPreferences#Default_Web_Preferences.
  • ALERT! When linking to a WebHome topic in another web, the link will be rendered as the name of the web, e.g. Sandbox.WebHome becomes Sandbox.

Revision 627 Mar 2005 - Main.TWikiContributor

Line: 1 to 1
 

What is a WikiWord?

A WikiWord consists of two or more words with initial capitals, run together. WikiWords are topic names. A TWiki topic name always has a fixed format: two or more words with initial capitals, run together. Like the name of the current topic: WikiWord. When you type the name of a topic, you create a link to that topic. You type WebHome and on saving the page this becomes WebHome. It's as easy as that.

Revision 527 Mar 2005 - Main.TWikiContributor

Line: 1 to 1
Changed:
<
<
A WikiWord consists of two or more words with initial capitals, run together.

When you type a WikiWord, you establish a hyperlink. It's as easy as that.

WikiWords are styled like this because:

>
>

What is a WikiWord?

A WikiWord consists of two or more words with initial capitals, run together. WikiWords are topic names. A TWiki topic name always has a fixed format: two or more words with initial capitals, run together. Like the name of the current topic: WikiWord. When you type the name of a topic, you create a link to that topic. You type WebHome and on saving the page this becomes WebHome. It's as easy as that.

When you type a WikiWord, you establish a hyperlink. It's as easy as that.

WikiWord linking is easy to use:

  • You don't have to know the full path to where the topic is stored - you just type the name
  • You don't need to write HTML
  • Without HTML, the topic text is easier to read when editing
  • Easy linking leads to interesting texts with links placed in context
 
Added:
>
>
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
Changed:
<
<
Syntax of a WikiWord
>
>

Syntax of a WikiWord

 
  • Uppercase letter(s)
  • Lowercase letter(s)
  • Uppercase letter(s)
  • Optional lowercase or uppercase letter(s) or number(s)
Changed:
<
<
Good examples for WikiWords:
>
>

Good examples of WikiWords

 
Added:
>
>
  • VersionFiveDotThree?
  • ReleaseVersion5dot3?
 
  • AVeryLongWikiTopicNameIsAlsoPossible?: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed
  • YearTwoThousand?
Changed:
<
<
Bad examples for WikiWords:
>
>

Bad examples of WikiWords:

 
  • Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence
  • T5Wiki?: Name with number before the uppercase, lowercase, uppercase sequence
  • Md5sumsAfterBurning?: Name with number before the uppercase, lowercase, uppercase sequence
  • Know-How: Name with dashes in between
Changed:
<
<
Hints
>
>

Variations in linking

When you write the name of a topic, it becomes a link. There are more ways

  • To write a custom link label, use bracket notation: [[TWikiAccessControl][access control]] - this becomes: access control
  • To link to a topic in another web, write: Sandbox.WebSearch - this becomes: WebSearch
  • To show the web name in the link use bracket notation: [[Sandbox.WebHome]] - this becomes: Sandbox.WebHome
  • To link to a topic on another Wiki site, use: TWiki:Main/WebHome - this becomes: TWiki:Main/WebHome (sites are defined in the InterwikiPlugin)
  • To link to a part on the same page, write a dash and the name of the header, with spaces replaced by underscores (and ! removed): [[#Good_examples_of_WikiWords]] becomes: #Good_examples_of_WikiWords. You can also link to a part on another page: TWiki.WebHome#Disclaimer becomes: WebHome#Disclaimer.
 
Changed:
<
<
  • Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
>
>

Hints

  • Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
 
  • Be specific. All topics in a web share one name space. For example, instead of FunctionalSpec write BreadSlicerFunctionalSpec because other projects might also have a functional spec topic.
Changed:
<
<
  • HELP To stop a WikiWord from being turned into a hyperlink, insert the text <nop> immediately before the WikiWord.
  • It is recommended to create topics with singular names. Plural WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord.
>
>
  • To stop a WikiWord from being turned into a hyperlink, insert an exclamation point immediately before the WikiWord. For example, write !SunOS to get SunOS.
  • Create topics with singular names. 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. 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.
Changed:
<
<
  • Turn acronyms into WikiWords, i.e. take FaqIndex for a "FAQ index" topic.
  • You can specify any link label by using double square brackets, e.g. write [[TWikiAccessControl][access control]] to get a link to TWikiAccessControl that looks like access control.
  • ALERT! The topic is assumed to be in the current TWiki web. Prepending the name of a TWiki web and a period links to a topic in another web.
>
>
  • Turn acronyms into WikiWords, i.e. take FaqIndex for a "FAQ index" topic.
  • It is possible to turn off the auto-linking of WikiWords and to rely only on the bracket notation. See NOAUTOLINK setting in TWikiPreferences#Default_Web_Preferences.
  • ALERT! When linking to a WebHome topic in another web, the link will be rendered as the name of the web, e.g. Sandbox.WebHome becomes Sandbox.
 Related Topics: WikiSyntax, TextFormattingRules

Revision 418 Jan 2003 - Main.PeterThoeny

Line: 1 to 1
 A WikiWord consists of two or more words with initial capitals, run together.

When you type a WikiWord, you establish a hyperlink. It's as easy as that.

Line: 21 to 21
 
Changed:
<
<
  • AVeryLongWikiTopicNameIsAlsoPossible?
>
>
  • AVeryLongWikiTopicNameIsAlsoPossible?: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed
 
  • YearTwoThousand?

Bad examples for WikiWords:

Changed:
<
<
  • Web: Name with no uppercase letter in between
  • T5Wiki?: Name with number before the first lowercase letter
>
>
  • Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence
  • T5Wiki?: Name with number before the uppercase, lowercase, uppercase sequence
  • Md5sumsAfterBurning?: Name with number before the uppercase, lowercase, uppercase sequence
 
  • Know-How: Name with dashes in between

Hints

  • Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
  • Be specific. All topics in a web share one name space. For example, instead of FunctionalSpec write BreadSlicerFunctionalSpec because other projects might also have a functional spec topic.
Changed:
<
<
  • 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.
>
>
  • HELP To stop a WikiWord from being turned into a hyperlink, insert the text <nop> immediately before the WikiWord.
  • It is recommended to create topics with singular names. 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. 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 specify any link label by using double square brackets, e.g. write [[TWikiAccessControl][access control]] to get a link to TWikiAccessControl that looks like access control.
Added:
>
>
  • ALERT! The topic is assumed to be in the current TWiki web. Prepending the name of a TWiki web and a period links to a topic in another web.
 Related Topics: WikiSyntax, TextFormattingRules

Revision 311 May 2002 - Main.PeterThoeny

Line: 1 to 1
 A WikiWord consists of two or more words with initial capitals, run together.

When you type a WikiWord, you establish a hyperlink. It's as easy as that.

Line: 32 to 33
 Hints

  • Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
Added:
>
>
  • Be specific. All topics in a web share one name space. For example, instead of FunctionalSpec write BreadSlicerFunctionalSpec because other projects might also have a functional spec topic.
 
  • 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. 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.
Changed:
<
<
>
>
  • You can specify any link label by using double square brackets, e.g. write [[TWikiAccessControl][access control]] to get a link to TWikiAccessControl that looks like access control.
 Related Topics: WikiSyntax, TextFormattingRules

Revision 230 Jan 2001 - Main.PeterThoeny

Line: 7 to 7
 
  • It makes Wiki hyperlinks instantly recognizable
  • It leads to interesting Wiki topics
  • It avoids the need to fiddle with HTML tags
Changed:
<
<
  • 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
Line: 21 to 21
 
Changed:
<
<
  • ProblemY2K?
>
>
  • YearTwoThousand?
 Bad examples for WikiWords:
Line: 34 to 34
 
  • 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.
Changed:
<
<
  • 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 [[TWiki access control]] to get a link to TWikiAccessControl that looks like TWiki access control.

Related Topics: WikiSyntax, TextFormattingRules

Revision 101 Jul 2000 - Main.PeterThoeny

Line: 1 to 1
Added:
>
>
A WikiWord consists of two or more words with initial capitals, run together.

When you type a WikiWord, you establish a hyperlink. It's as easy as that.

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

Syntax of a WikiWord

  • Uppercase letter(s)
  • Lowercase letter(s)
  • Uppercase letter(s)
  • Optional lowercase or uppercase letter(s) or number(s)

Good examples for WikiWords:

Bad examples for WikiWords:

  • Web: Name with no uppercase letter in between
  • T5Wiki?: Name with number before the first lowercase letter
  • Know-How: Name with dashes in between

Hints

  • 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.
 
This website uses only proprietary and third party technical cookies to ensure the correct operation of its web pages and to improve its services.
By continuing to navigate the website you consent to the use of cookies. To learn more, or deny your consent, consult the privacy policy
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.