| Kürzel | Wiedergabe | Kommentar |
|---|---|---|
| 1 Überschrift | Überschrift 1 (Hauptüberschrift) | |
| 1.1 Überschrift | Überschrift 1.1 | |
| - Text | ein Listeneintrag (mit -), mehrere Einträge ergeben eine Liste | |
| * Text | ein Listeneintrag (mit *) | |
| 1. Text | eine numerierte Liste | |
| a. Text | alphabetisch sortierte Liste | |
| A. Text | mit Großbuchstaben alphabetisch sortierte Liste | |
| i. Text | mit römischen Zahlen numerierte Liste | |
| I. Text | mit großbuchstabigen römischen Zahlen numerierte Liste | |
| g. Text | griechisch numerierte Liste | |
| h. Text | hiragana (japanisch) numerierte Liste | |
| k. Text | katakana (japanisch) numerierte Liste | |
| j. Text | hebräisch numerierte Liste | |
| __fett__ | fett | einfacher fett gedruckter Text |
| ~~kursiv~~ | kursiv | einfacher kursiver Text |
| --durchgestrichen-- | durchgestrichener Text | |
| (Leerzeile) | erzeugt einen neuen Absatz | |
| \\ | erzeugt einen Zeilenumbruch, bitte sparsam benutzen! | |
| [start] | start | interner Link zu einem anderen Dokument |
| http://snipsnap.org/ | erzeugt einen Link auf eine externe Site, Sonderzeichen die nach dieser URL kommen und nicht Teil davon sind müssen mit Leerzeichen getrennt werden | |
| \X | X | Sonderzeichen X escapen (z.B. {![]() |
| 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. |
| big | No Parameters. | Represents text with larger letters. |
| 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. |
| color | 1: color as name or in hexa decimal (optional) | Get text with specific color. |
| 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. |
| gallery | title: Specify a title for your gallery. (optional) column: Specify the number of columns for your table. (optional) | Creates a gallery of thumbnails from all the images that are attached to a page. |
| 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. |
| index | 1: Lister to render snips (optional) | Displays a list of all snips of the system. Comment snips are filtered out. |
| info | title: the title of the information box. (optional) icon: if "false", dont display the icon. (optional) | Prints an informational note to the user. |
| 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. |
| 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. |
| marker | 1: color as name or in hexa decimal (optional) | Marks text with specific color like a text marker. |
| note | title: the title of the note. (optional) icon: if "false", dont display the icon. (optional) | Prints a simple note to the user. |
| online-time | No Parameters. | Displays the time since SnipSnap is online. |
| panel | title: the title of the panel. (optional) link: link the icon to a snip. If no icon defined, the title will liked to a snip. (optional) width: with of the panel (e.g 50% or 399px). (optional) icon: Icon witch dispayed in the left site. (optional) | Prints a nice panel to the user. |
| popup | 1/href: The name of the page, or the URL. width: The width of the new window. (optional) height: The height of the new window. (optional) scrollbars: If false, the scrollbar will be hidden. (optional) menubar: If false, the menubar will be hidden. (optional) location: If false, the location bar will be hidden. (optional) statusbar: If false, the status bar will be hidden. (optional) resizable: If false, the window will not be resizable. (optional) target: The title of the target window. Use this to open multiple links in the same popup window. (optional) tip: The tip to display while the mouse is hovering over the link. (optional) icon: If false, the link will not have an 'open new window' icon. (optional) | Links to a page or URL, popping it up into a new window. |
| 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. |
| redirect | href: The name of the page, or the URL. timeout: The timeout in seconds. (optional) | Redirect to a other snip page. |
| rfc | 1: the RFC number to link to | Generates links to RFCs. |
| 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-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. |
| thumbnail | 1/image: Specify the image that should be display as thumbnail. width: Specify the width in pixel of the thumbnail. (optional) height: Specify the height in pixel of the thumbnail. (optional) border: Display a border around the thumbnail (true|false). (optional) | Display a thumbnails of an images that's attached to a page. |
| tip | title: the title of the tip. (optional) icon: if "false", dont display the icon. (optional) | Prints a helpful tip for the user. |
| user-count | No Parameters. | Display the number of users. |
| version | No Parameters. | Display the SnipSnap version number. |
| warning | title: the title of the warning. (optional) icon: if "false", dont display the icon. (optional) | Prints a warning note to the user. |
| weblog | 1: amount of posts to show ?2: the actual weblog snip (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. |