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 | Parameters | Description |
|---|---|---|
| anchor | 1: anchor text | Places a HTML anchor tag in the snip. |
| api | 1: class name, e.g. java.lang.Object or java.lang.Object@Java131 2: mode, e.g. Java12, Ruby, defaults to Java" (optional) | Generates links to Java or Ruby API documentation. |
| api-docs | No Parameters. | Displays a list of known online API documentations and mappings. |
| asin | 1: ASIN number of the DVD or CD | Generates links to DVD/CD dealers or comparison services. Configuration is read from conf/asinservices.txt. |
| backlinks | Renders a list of backlinks for the snip. | Renders a list of backlinks for the snip. |
| calendar | No Parameters. | Displays a monthly calendar view with links to postings. |
| code | 1: syntax highlighter to use, defaults to java (optional) | 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. |
| collapsingBlock | title: title for the block visible: if the block stats visible (optional) | Macro based on javascript that allows you to hide and show a block of text |
| field | 1: name of the input field 2: initial value of the input field (optional) 3: target of the link (optional) 4: button text (creates a button) (optional) | Display a form input field and submit button. |
| file-path | 1: a Windows or UNIX file path | Displays a file system path. The file path should use slashes. Defaults to Windows. |
| graph | 1: Graph-Type (horizontal, vertical, mindmap, explorer, uml) | Render a graph like an organigram or mindmap. |
| hello | 1: name to print | Say hello example macro. |
| image | img: URL (must have external images enabled) oder name des attachments alt: alternative text (optional) ext: extension of the image, if omitted in "img" (optional) align: alignment of the image (left, right, flow-left, flow-right) (optional) target: links image to the target (optional) | Displays an image file. |
| image-container | No Parameters. | Puts floating images into a div container |
| index | 1: Lister to render snips (optional) | Displays a list of all snips of the system. Comment snips are filtered out. |
| inter-wiki | No Parameters. | Displays a list of known InterWiki mappings. |
| isbn | 1: ISBN number of a book or magazine | Generates links to book dealers or comparison services. Configuration is read from conf/bookservices.txt. |
| label-search | type: Lister to render found snips (AtoZ, Vertical, Simple) name: Name of a Label to search for value: Value of the label too look for | Show all snips that have a certain label. |
| last-login | 1: login name | Show the last login of the user. |
| last-visit | 1: login name | Show the last login of the user. |
| latestPosts | name: the weblog snipname. Defaults to start (optional) number: the number os posts to display. Defaults to 10 (optional) | Display the title with link for posts of a weblog |
| layout-div | class: CSS class name (optional) id: CSS id (optional) | Creates a div container around its contents. |
| link | 1: The text to appear as a link (optional) 2: The URL to generate a hyperlink to 3: none if the external link image should not appear (optional) | Generate a weblink. |
| list-of-macros | No Parameters. | Displays a list of available macros. |
| list-of-users | 1: type of listing (Vertical, AtoZ) (optional) 2: "nosize" ignores size of list (optional) | Display a list of all users. |
| logins | Displays all currently logged in users and guests. | Displays all currently logged in users and guests. |
| mailto | 1: an Email address | Displays an email address. |
| navigationmenu | orientation: Orientation (horizontal, vertical) (optional) title: Menu title (optional) debug: true/false (optional) | Displays a navigation menu. |
| note | 1: the text of the footnote | Render a footnote. |
| online-time | No Parameters. | Displays the time since SnipSnap is online. |
| pullQuote | No Parameters. | |
| quote | 1: source text (optional) 2: displayed description (default is "Source") (optional) | Display quotations. |
| recent-changes | 1: number of snips to show, defaults to 10 (optional) 2: Lister to render users (Vertical, AtoZ ...) (optional) | Displays a list of recently changes snips. |
| recent-weblog | 1: Lister to render weblogs (optional) 2: number of weblogs to show, defaults to 10 (optional) | Shows a list of recently changed weblogs. Only works if weblogs ping your site. |
| rfc | 1: the RFC number to link to | Generates links to RFCs. |
| scaled-album | img: Image name of attachment or in zip file (optional) thumb: maximum size of inline image (optional) size: maximum size of linked image, original for no scaling (optional) alt: alternate text (optional) float: none, left or right (default is left) (optional) snip: name of snip where images are attached (optional) zip: name of zip file attachment that contains images (optional) range: all, or range in the form n-m, optionally repeated with commas (examples: 1-3 or 2-5,6-7) (optional) caption: text displayed under image(s), auto, or use the macro body as caption (optional) target: name of window to display image in, display in current window if not defined (optional) | Displays one or more scaled images packaged in a zip file. |
| scaled-image | img: Image name of attachment or in zip file (optional) thumb: maximum size of inline image (optional) size: maximum size of linked image, original for no scaling (optional) alt: alternate text (optional) float: none, left or right (default is left) (optional) snip: name of snip where images are attached (optional) zip: name of zip file attachment that contains images (optional) range: all, or range in the form n-m, optionally repeated with commas (examples: 1-3 or 2-5,6-7) (optional) caption: text displayed under image(s), auto, or use the macro body as caption (optional) target: name of window to display image in, display in current window if not defined (optional) | Displays one or more scaled images packaged in a zip file. |
| scaled-image-settings | thumb: maximum size of inline image (optional) size: maximum size of linked image, original for no scaling (optional) alt: alternate text (optional) float: float direction (optional) snip: name of snip where images are attached (optional) zip: name of zip file attachment that contains images (optional) target: name of window to display image in, display in current window if not defined (optional) debug: debugging true/false (optional) | Macro for setting options for ScaledImageMacro. |
| search | 1: search term to look up 2: number of hits to show, defaults to 10 (optional) | Search for snips containing the phrase or term specified. |
| since-last-visit | 1: login name 2: Lister to render snips (Vertical, AtoZ) (optional) | Show all snips that have been changed since the last visit of the user. |
| snip-count | No Parameters. | Display the number of snips. |
| snip-count-by-user | 1: a login name | Display the number of snips an user wrote. |
| snip-fragment | snip: name of snip (optional) | Extracts a summary of snip |
| snip-tree | 1: the namespace to start with | Displays a tree view of a name space. |
| snip-xref | 1: snip that is referenced 2: number of hits to show, defaults to 10 (optional) | Search for snips linking to the given snip. |
| sniplinks | 1: the width of the sniplink table (optional) | Renders a table of sniplinks for the snip. |
| snips-by-hotness | 1: number of snips to show, defaults to 10 (optional) | Displays a list of snips sorted by their "hotness" (view count). |
| snips-by-user | 1: a login name | Show all snips created by a specified user. |
| table | No Parameters. | Displays a table. |
| timeLine | 1: year (>1900, if the year= qualified param is used, this can be ommitted) 2: type= (all or weblog) 3: weblogsnip= ( list all weblog entries of the weblog snip specified here) | Display the SnipSpace entries in a timeline. Parameter are year, type (all or weblog) and weblogsnip (snip name) |
| user-count | No Parameters. | Display the number of users. |
| version | No Parameters. | Display the SnipSnap version number. |
| weblog | count: amount of posts to show (optional) snip: the actual weblog snip (optional) numberOfParagraphs: number of paragraphs before cutting the post and put a Read More link. (optional) | Renders the sub-snips from the namespace as a weblog. |
| xref | 1: class name, e.g. java.lang.Object or java.lang.Object@Nanning" 2: line number (optional) | Generates links to Java Xref source code. |
| youtube | id: youtube video identification align: css class for alignment (optional) | Macro to embed a youtube video on snipsnap |
Powered by SnipSnap 1.0b1-snipit
