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 | Parameter | Beschreibung |
|---|---|---|
| anchor | 1: anchor text | Places a HTML anchor tag in the snip. |
| api | 1: Klassennamen, auf den verwiesen werden soll, z.B. java.lang.Object oder java.lang.Object@Java131 2: API Typ, z.B. Java12, Ruby (Standard ist "Java") (optional) | Erzeugt einen Verweis zur API Dokumentation. |
| api-docs | Keine Parameter. | Generiert eine Liste aller bekannten API Dokumentationstypen. |
| asin | 1: ASIN Nummer einer DVD oder CD | Erzeugt einen Verweis zu Diensten, die DVD- und CD-Preise vergleichen oder verkaufen. |
| backlinks | Renders a list of backlinks for the snip. | Renders a list of backlinks for the snip. |
| calendar | Keine Parameter. | Displays a monthly calendar view with links to postings. |
| code | 1: Formatierer, Standard ist java (optional) | Zeigt den eingeschlossenen Quelltext farbig hervorgehoben und formatiert an. Dies funktioniert z.B. mit Java, XML oder SQL. Der Typ "none" lässt den Text wie er geschrieben ist. Dies ist praktisch für unbekannte Typen. |
| create-div | 1: class name of the div 2: Java compatible HTML text | |
| div | 1: css class name of the div block | Creates a div block with the provided class name around HTML text |
| echo | 1: some text (including variables) to echo 2...: ... | Echoes the parameters and resolves content of variables, echoes content |
| 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: Ein Dateisystempfad | Zeigt einen Dateisystempfad korrekt an, indem Schrägstriche durch Backslashes ersetzt werden. |
| filtered-overview | 1: How many snips to display | |
| form | 1: action url title: form title header | Create a html form. Example:{form:../exec/myaction|title=Send me a message} {form-field:text|input|Text}text{form-field} {form-field:submit|submit}Send{form-field} {form} |
| form-field | 1: parameter name 2: input, textarea, hidden, password or submit 3: description (not needed for hidden) 4: rows (for textarea only) (optional) content: value | Make an input form field element. Content between tags becomes field value. |
| 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. |
| icon | icon name (ok,nok,neutral,...) | Shows one of the icons (snip Icons/*.gif): |
| 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. |
| import-content | 1: URL to import the content from. Relative links in the content are replaced with this URL. If this URL ends with .html/.htm, relative links are replaced with URL without the .html/.htm page 2: URL to the downloads (optional: only use it if you don't host your project on java.net) | Imports webcontent from java.net page. It shows the content from the "Description" header bis page footer |
| index | 1: Lister to render snips (optional) | Displays a list of all snips of the system. Comment snips are filtered out. |
| inter-wiki | Keine Parameter. | Zeigt eine Liste der bekannten Interwikikürzel. |
| isbn | 1: ISBN Nummer eines Buches oder Magazins | Erzeugt einen Verweis zu Vergleichsdiensten, die Bücher- und Magazinpreise vergleichen oder verkaufen. |
| 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 | 0 / text: displayed text 1 / url: linked url 2 / img: none to omit external link image 3 / target: default is "_blank". "none" omits target. Other targets are used as is. (optional) | link to (external) file/document |
| list-of-macros | Keine Parameter. | Zeigt eine Liste aller Verfügbaren Macros an.. |
| 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. |
| mail-to-admins | 1: from mail-address 2: subject content: message body | Send a mail to all admins. Example: {mail-to-admins:$mailaddress|This is a subject about $subject} This is a message body for topic {$topic}. This one contains a new line. Regards {$name}. {mail-to-admins} |
| mail-to-user | 1: from mail-address 2: to-username 3: subject content: message body | Send a mail to a user. Example: {mail-to-user:$mailaddress|$user|This is a subject about $subject} This is a message body for topic {$topic}. This one contains a new line. Regards {$name}. {mail-to-user} |
| mailto | 1: email adresse | Erzeigt einen Verweis auf eine Emailadresse. |
| note | 1: the text of the footnote | Render a footnote. |
| online-time | Keine Parameter. | Displays the time since SnipSnap is online. |
| overview | 1: How many snips to display | |
| pre | content: text to be preformatted | Renders a preformatted html text. |
| quote | 1: Quelle (optional) 2: Quellenbeschreibung (Standard ist "Quelle") (optional) | Zeigt den eingeschlossenen Text als Zitat an. |
| 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-changes-detail | 1: number of snips to show, defaults to 10 (optional) | Displays a detailled list of recently changes snips (including change time and user). |
| recent-weblog | count: number of weblogs to show, defaults to 10 (optional) month: number of month to show, defaults to 3 (optional) | Shows a list of recently changed weblogs. Only works if weblogs ping your site. |
| rfc | 1: RFC Nummer auf den Verwiesen werden soll. | Erzeugt einen Verweis zu einem RFC. |
| 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. |
| search-content | 1: search string | |
| search-snips-with-labels | 1: the category to search 2...: ... | Lists all Snips that are labelled with all the arguments |
| search-table | Labelnames separated by | "All Labels" if you want all labels that exist | Renders a table that contains links to snips which fullfill the search criteria. |
| set-labels | Labels to add, separated with | | Sets labels of category type to the snip |
| show-all-category-labels | boolean true for vertical alignment, false for horizontal alignment. Default is true; | Lists all category labels |
| show-blogs | The number of blogs to be displayed The snip the blogs belong to the class name of the div the title is rendered | Shows a list with the blog titles that belong to a certain snip |
| show-labels | none | Show all snips that have a certain label. |
| since-last-login-of-user | Displays a detailled list of snips changed since last visit of currently logged in user (including change time and user). | |
| 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 | Keine Parameter. | Display the number of snips. |
| snip-count-by-user | 1: a login name | Display the number of snips an user wrote. |
| snip-subtree | 1: Namespace prefix 2: Sort order of the snips separated by semicolon (optional) | Show a subtree of snips below the given namespace prefix with an optional sort order. If the snip has an attachment called snip_properties.gif it is appended to the snip names. |
| 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 | Keine Parameter. | Zeigt eine Tabelle an. |
| user-count | Keine Parameter. | Display the number of users. |
| version | Keine Parameter. | Display the SnipSnap version number. |
| weblog | 1: amount of posts to show (optional) | Renders the sub-snips from the namespace as a weblog. |
| xref | 1: Klassenname, z.B. java.lang.Object oder java.lang.Object@Nanning" 2: Zeilennummer (optional) | Erzeugt einen Verweis auf XRef Dokumentation. |
Install (relpasc) 2006-05-26 #1 (acraczelsitl) snipsnap-notfound (ricdarac) 2006-03-06 #1 (cnanodelalb) 2005-07-08 #1 (racoloorrel) 2005-07-08 #1 (racoloorrel) 2006-03-06 #1 (cnanodelalb) 2005-11-17 #1 (dronlisi) admin (acelerdarc) Ketan (ketan .ketan1) Ketan (nanmemsnne) Ketan (msfhusm)
Powered by SnipSnap 1.0b1-uttoxeter