TextFormattingRules (28 vs. 29)

Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...	View r29 > r28 ...
Main AmLegalHist CompPrivConst EngLegalHist LawContempSoc LawNetSoc TWiki

 TextFormattingRules 29 - 02 Dec 2001 - Main.MikeMannix
 Line: 1 to 1
  
 Changed: 
<
<  Appendix C: Text Formatting Rules 
>
>  TWiki Text Formatting 
  Working in TWiki is as easy as typing in text - exactly like email. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all layed out below - refer back to this page in a pop-up window from the Edit screen.

Line: 289 to 289
  

 Changed: 
<
< 
>
> #SquareBrackets
  Forced Links:

 You can create a forced internal link by enclosing words in double square brackets. 
Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ.  You can also refer to a different web and use anchors.
   
Line: 390 to 389
   
 [[Square bracket rules]] let you easily create non-WikiWord links.
 
 Changed: 
<
<  TWiki Variables 

Variables are names that are enclosed in percent signs % that are expanded on the fly.
 

 %TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
 
 

 %WEB% : The current web, is TWiki.
 
 

 %TOPIC% : The current topic name, is TextFormattingRules.
 
 

 %ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
 
 

 %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
 
 

 There are many more variables, see TWikiVariables.
 

 Common Editing Errors 

TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ:
 

 Q: Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is? 
 A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '&lt;' instead of '<', and '&gt;' instead of '>'. 
 Example: Type 'prog &lt;filename&gt;' to get 'prog <filename>'.
 
 
 

 Q: Why is the '&' character sometimes not displayed? 
 A: The '&' character has a special meaning in HTML, it starts a so called character entity, ex: '&copy;' is the © copyright character. You need to escape '&' to see it as it is, so write '&amp;' instead of '&'. 
 Example: Type 'This &amp; that' to get 'This & that'.
 
 
>
>  TWikiPlugin Formatting Extensions 
  
 Changed: 
<
<  TWiki Plugins 
>
> Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.
  
 Changed: 
<
< Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on here:
>
> Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:
   SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
 ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
 AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
 BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
 CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
 CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
 CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$): 
 EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
 FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
 FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
 FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
 GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
 IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
 InterwikiPlugin (Dakar, $Rev: 11935$): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
 JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
 NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
 PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
 RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
 RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
 SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
 SmiliesPlugin (Dakar, 8154): Render smilies as icons, like  for  :-) or  for = :eek:=
 TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
 TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
 TreePlugin (1.7): Dynamic generation of TWiki topic trees 
 TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
 VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
 WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors

Check on current Plugin status and settings for this site in TWikiPreferences.
 Changed: 
<
< -- MikeMannix?  - 02 Oct 2001 
>
> -- MikeMannix?  - 02 Dec 2001
-<
<
+ Appendix C: Text Formatting Rules
->
>
+ TWiki Text Formatting
 Working in TWiki is as easy as typing in text - exactly like email. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all layed out below - refer back to this page in a pop-up window from the Edit screen.
-<
<
->
>
+#SquareBrackets
 #SquareBrackets
 Forced Links:

 You can create a forced internal link by enclosing words in double square brackets. 
Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ.  You can also refer to a different web and use anchors.
  [[Square bracket rules]] let you easily create non-WikiWord links.
-<
<
+ TWiki Variables 

Variables are names that are enclosed in percent signs % that are expanded on the fly.
 

 %TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
 
 

 %WEB% : The current web, is TWiki.
 
 

 %TOPIC% : The current topic name, is TextFormattingRules.
 
 

 %ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
 
 

 %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
 
 

 There are many more variables, see TWikiVariables.
 

 Common Editing Errors 

TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ:
 

 Q: Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is? 
 A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '&lt;' instead of '<', and '&gt;' instead of '>'. 
 Example: Type 'prog &lt;filename&gt;' to get 'prog <filename>'.
 
 
 

 Q: Why is the '&' character sometimes not displayed? 
 A: The '&' character has a special meaning in HTML, it starts a so called character entity, ex: '&copy;' is the © copyright character. You need to escape '&' to see it as it is, so write '&amp;' instead of '&'. 
 Example: Type 'This &amp; that' to get 'This & that'.
->
>
+ TWikiPlugin Formatting Extensions
-<
<
+ TWiki Plugins
->
>
+Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.
-<
<
+Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on here:
->
>
+Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:
  SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
 ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
 AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
 BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
 CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
 CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
 CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$): 
 EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
 FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
 FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
 FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
 GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
 IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
 InterwikiPlugin (Dakar, $Rev: 11935$): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
 JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
 NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
 PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
 RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
 RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
 SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
 SmiliesPlugin (Dakar, 8154): Render smilies as icons, like  for  :-) or  for = :eek:=
 TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
 TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
 TreePlugin (1.7): Dynamic generation of TWiki topic trees 
 TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
 VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
 WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors

Check on current Plugin status and settings for this site in TWikiPreferences.
-<
<
+-- MikeMannix?  - 02 Oct 2001
->
>
+-- MikeMannix?  - 02 Dec 2001

Revision 29	r29 - 02 Dec 2001 - 08:07:19 - MikeMannix?
Revision 28	r28 - 02 Oct 2001 - 07:37:03 - MikeMannix?

This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.

Syndicate this site RSS ATOM