SnipSnap text may contain the following filter rules and macros
to format text. This includes simple filters for bold and italic as well as special
macros for tables and source code.
| Mnemonic | Rendering | Comment |
|---|---|---|
| 1 Title | a style 1 heading (major heading) | |
| 1.1 Title | a style 1.1 heading (minor heading) | |
| - text | a list item (with -), several lines create a single list | |
| * text | a list item (with *) | |
| 1. text | an enumerated list | |
| a. text | alphabetical enumerated list | |
| A. text | uppercase alphabetical enumerated list | |
| i. text | roman enumerated list | |
| I. text | uppercase roman enumerated list | |
| g. text | greek enumerated list | |
| h. text | hiragana (japanese) enumerated list | |
| k. text | katakana (japanese) enumerated list | |
| j. text | hebrew enumerated list | |
| __bold__ | bold | simple bold text |
| ~~italics~~ | italics | simple italic text |
| --strike-- | | strike through text |
| (empty line) | produces a new paragraph | |
| \\ | creates a line break, please use sparingly! | |
| [start] | start | internal link to another document |
| http://snipsnap.org/ | SnipSnap | links to an external resource are made as follows: {link:NAME OF LINK|http://www.xyz.com}. for example, the link to the left was formed by typing {link:SnipSnap|http://snipsnap.org} special characters that come after the URL and are not part of it must be separated with a space. |
| \X | X | escape special character X (i.e. {) |
| Macro | Description | Parameters |
|---|---|---|
| anchor | Places a HTML anchor tag in the snip. | |
| api | Generates links to Java or Ruby API documentation. | |
| api-docs | Displays a list of known online API documentations and mappings. | |
| backlinks | Renders a list of backlinks for the snip. | |
| calendar | Displays a monthly calendar view with links to postings. | |
| code | Displays a chunk of code with syntax highlighting, for example Java, XML and SQL. The none type will do nothing and is useful for unknown code types. | |
| field | Display a form inout field and submit button. | |
| file-path | Displays a file system path. Defaults to windows. | |
| hello | Say hello example macro. | |
| image | Displays an image file. | |
| index | Displays a list of all snips of the system. Comment snips are filtered out. | |
| inter-wiki | Displays a list of known InterWikis. | |
| isbn | Generates links to book dealers or comparison services. Configuration is read from conf/bookservices.txt. | |
| last-login | Show the last login of the user. | |
| last-visit | Show the last login of the user, which usually is the last logout time. | |
| link | Generate a weblink. | |
| list-of-macros | Displays a list of available macros. | |
| list-of-users | Displays a list of all users. | |
| logins | Displays all currently logged in users and guests. | |
| note | Render a footnote. Not fully implemented and does not work. | |
| quote | Display quotations. | |
| recent-changes | Displays a list of recently changes snips. | |
| recent-weblog | Displays a list of recently changed weblogs. Only works when the weblogs ping your site. | |
| search | Search for snips containing the word. | |
| since-last-visit | Show all snips that have been changed since the last visit of the user. | |
| snip-count | Display the number of snips. | |
| sniplinks | Renders a table of sniplinks for the snip. | |
| snips-by-hotness | Displays a list of snips sorted by their "hotness" (view count). | |
| snips-by-user | Show all snips created by a specified user. | |
| table | Displays a table. | |
| user-count | Display the number of users. | |
| version | Displays the SnipSnap version. | |
| weblog | Renders the sub-snips of the snip as a weblog. |
Index of entries
RAP2
Eng. 242 site. Formatting codes in snipsnap-help.


Powered by SnipSnap 0.3.2a