CL
iki
the common lisp wiki
Home
Recent Changes
About CLiki
Text Formatting
Create New Page
Edit ``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. <h2>Escaping</h2> To escape the special CLiki markup, e.g., on this page when describing how to use the search tag, e.g. <pre> /("SLIME" :attribute :title :match :substring :case-sensitive nil) </pre> 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: <pre> /<!-- -->("SLIME" :attribute :title :match :substring :case-sensitive nil) </pre> will be rendered as /<!-- -->("SLIME" :attribute :title :match :substring :case-sensitive nil) <h2>Special CLiki Markup</h2> <ul> <li>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. <li>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 <li>_(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 :(CLHS "destructuring-bind"). <li>Searches: /<!-- -->("SLIME" :attribute :title :match :substring :case-sensitive nil) renders as: /("SLIME" :attribute :title :match :substring :case-sensitive nil) <p> :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 <tt>case-sensitive</tt>), 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. </ul> 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.
Please supply your name and a summary of changes for the Recent Changes page. If you are making a minor alteration to a page you recently edited, you can avoid making another Recent Changes entry by leaving the Summary box blank
Summary of changes:
Captcha (enter the word "lisp" here):
Your name:
Check this box to fill in your name automatically next time
(uses a cookie)