Moertel Consulting's Community Projects
Moertel Consulting's Community Projects
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/ | http://snipsnap.org/ | creates a link to an external resource, 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. | 1: anchor text |
| api | Generates links to Java or Ruby API documentation. | 1: class name, e.g. java.lang.Object or java.lang.Object@Java131 2: mode, e.g. Java12, Ruby, defaults to Java (optional) |
| api-docs | Displays a list of known online API documentations and mappings. | none |
| asin | Generates links to DVD/CD dealers or comparison services. Configuration is read from conf/asinservices.txt | 1: asin number |
| backlinks | Renders a list of backlinks for the snip. | unexplained, lazy programmer, probably funzel |
| calendar | Displays a monthly calendar view with links to postings. | unexplained, lazy programmer, probably funzel |
| 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. | 1: syntax highlighter to use, defaults to java (optional) |
| field | Display a form input field and submit button. | unexplained, lazy programmer, probably funzel |
| file-path | Displays a file system path. The file path should use slashes. Defaults to windows. | 1: file path |
| graph | Render a graph like an organigram or mindmap. | unexplained, lazy programmer, probably funzel |
| hello | Say hello example macro. | 1: name to print |
| image | Displays an image file. | unexplained, lazy programmer, probably funzel |
| index | Displays a list of all snips of the system. Comment snips are filtered out. | 1: Lister to render snips (optional) |
| inter-wiki | Displays a list of known InterWiki mappings. | none |
| isbn | Generates links to book dealers or comparison services. Configuration is read from conf/bookservices.txt. | 1: isbn number |
| label-search | Show all snips that have a certain label. | 1: labels that should be searched |
| last-login | Show the last login of the user. | 1: login name |
| last-visit | Show the last login of the user, which usually is the last logout time. | 1: login name |
| link | Generate a weblink. | unexplained, lazy programmer, probably funzel |
| list-of-macros | Displays a list of available macros. | unexplained, lazy programmer, probably funzel |
| list-of-users | Displays a list of all users. | unexplained, lazy programmer, probably funzel |
| logins | Displays all currently logged in users and guests. | 1: Lister to render users (optional) |
| mailto | Displays an email address. | 1: mail address |
| note | Render a footnote. Not fully implemented and does not work. | unexplained, lazy programmer, probably funzel |
| online-time | Displays the time since SnipSnap is online. | none |
| quote | Display quotations. | 1: source (optional) 2: displayed description, default is Source (optional) |
| recent-changes | Displays a list of recently changes snips. | 1: number of snips to show, defaults to 10 (optional) 2: Lister to render users (optional) |
| recent-weblog | Displays a list of recently changed weblogs. Only works when the weblogs ping your site. | 1: Lister to render weblogs (optional) 2: number of weblogs to show, defaults to 10 (optional) |
| rfc | Generates links to RFCs. | unexplained, lazy programmer, probably funzel |
| search | Search for snips containing the word. | 1: string to search 2: number of hits to show, defaults to 10 (optional) |
| since-last-visit | Show all snips that have been changed since the last visit of the user. | 1: login name 2: Lister to render snips (optional) |
| snip-count | Display the number of snips. | none |
| snip-count-by-user | Display the number of snips an user wrote. | 1: login name |
| snip-tree | Show a tree of snips from the namespace. | 1: Namespace prefix |
| sniplinks | Renders a table of sniplinks for the snip. | unexplained, lazy programmer, probably funzel |
| snips-by-hotness | Displays a list of snips sorted by their "hotness" (view count). | 1: number of snips to show, defaults to 10 (optional) |
| snips-by-user | Show all snips created by a specified user. | 1: login name |
| table | Displays a table. | none |
| user-count | Display the number of users. | none |
| version | Displays the SnipSnap version. | none |
| weblog | Renders the sub-snips from the namespace as a weblog. | 1: number of shown posts (optional) |
| xref | Generates links to Java Xref source code. | 1: class name, e.g. java.lang.Object or java.lang.Object@Nanning 2: line number (optional) |
Powered by SnipSnap 0.5.1a
