Text Formatting

Most of the weird and wonderful markup syntax of the original Wiki is omitted, as HTML markup is allowed. This is easily abusable: I'd rather receive patches to fix it than I would see the problem demonstrated.

We have our own special markup too, of course: this consists of a funny character followed by an argument in parens.

Escaping

To escape the special CLiki markup, e.g., on this page when describing how to use the search tag, e.g.

  reattatchabe slime - Here is a little makedef file to start/stop a lisp application and allow the developer to attach to the running process with attachtty or slime
SLIME - SLIME is the Superior Lisp Interaction Mode for Emacs
SLIME Features - This is an evolving description of the features available in SLIME
SLIME Tips - This page is for collecting tips for avoiding problems with and making the best use of SLIME, the Emacs-based Lisp development environment
SLIME-HOWTO - This is a collection of information about using SLIME - a proto-manual
SLIME-PPCRE - This is a contribution to SLIME that allows for finding and replacing regexps using cl-ppcre (you need iterate too) in all the source components of a specific asdf system, or all systems known to asdf::*defined-systems* or, finally, a given list of systems

where we don't actually want the search results to be displayed, you must insert some text between the special markup character and the open paren. HTML comments work well. For example, the following:

  /<!-- -->("SLIME" :attribute :title :match :substring :case-sensitive nil)

will be rendered as

/("SLIME" :attribute :title :match :substring :case-sensitive nil)

Special CLiki Markup

Internal links: _(Foo) renders as Foo. Cliki page titles aren't case-sensitive, and spaces and underscores are treated equivalently, but Cliki will remember the way the title was written when you first created the page, and format it that way forevermore. So, please make some effort to use capitals where appropriate. In keeping with the precedent set by Ward's Wiki, links to pages that don't exist are displayed less obtrusively than links to pages that do.
Topic markers: *(Foo) declares this page to be relevant to topic Foo. This means that (a) this page will be linked in the footer of any page called Foo, (b) it will be listed on pages which include a topic search for Foo. Usually there will be a page called Foo that contains such a search
CLHS references: #H(FOO), where FOO is a standard CL symbol, will expand into a link to the appropriate Hyperspec page. Thanks to Eric Marsden for the code that does this. It presently goes to the Xanalys site, because the ALU site was down when I tried it. For example #H(destructuring-bind) becomes a link to destructuring-bind.
Searches: /("SLIME" :attribute :title :match :substring :case-sensitive nil) renders as:
- reattatchabe slime - Here is a little makedef file to start/stop a lisp application and allow the developer to attach to the running process with attachtty or slime
- SLIME - SLIME is the Superior Lisp Interaction Mode for Emacs
- SLIME Features - This is an evolving description of the features available in SLIME
- SLIME Tips - This page is for collecting tips for avoiding problems with and making the best use of SLIME, the Emacs-based Lisp development environment
- SLIME-HOWTO - This is a collection of information about using SLIME - a proto-manual
- SLIME-PPCRE - This is a contribution to SLIME that allows for finding and replacing regexps using cl-ppcre (you need iterate too) in all the source components of a specific asdf system, or all systems known to asdf::*defined-systems* or, finally, a given list of systems
:attribute is (or :title :topic :body), :match is (or :exact :substring), :case-sensitive is (or nil t). The search code is still in development: title searches work, topics work only for exact matches (and ignore the setting of case-sensitive), body text doesn't at all.
CLiki Style encourages the use of inverted pyramid style, to work most conveniently with the CLiki Bot, and because searches are able to display also the first sentence or first paragraph of the page found.

As a convenience, text is assumed to start a new paragraph -- will be rendered preceded by a P tag -- if preceded by a blank line and not starting with a left-angle bracket. This seems to work passably well unless you want to start a paragraph with marked-up text. You'll just have to add the P tag yourself in that case

Don't expect to be able to type SGML entities (e.g. ampersand-l-t-semicolon), and have them work, as they tend to be translated into the actual characters they represent (e.g. less-than sign). This is listed on the CLiki bugs page, but is unlikely to get fixed any time soon.

Page in this topic: topic markers

Also linked from: cclan-get CLHS CLiki CLiki Content CLiki Sandbox

CLiki pages can be edited by anyone at any time. Imagine a fearsomely comprehensive disclaimer of liability. Now fear, comprehensively