98 lines
No EOL
8 KiB
HTML
98 lines
No EOL
8 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<title>CLiki: Text Formatting</title>
|
|
<link rel="alternate" type="application/atom+xml" title="ATOM feed of edits to current article"
|
|
href="https://www.cliki.net/site/feed/article.atom?title=Text%20Formatting">
|
|
<link rel="stylesheet" href="static/css/style.css">
|
|
<link rel="stylesheet" href="static/css/colorize.css">
|
|
</head>
|
|
|
|
<body>
|
|
<span class="hidden">CLiki - Text Formatting</span>
|
|
<div id="content"><div id="content-area"><div id="article-title">Text Formatting</div><div id="article">CLiki pages consist of a whitelisted subset of HTML markup with a small set of special markup rules for <a href="CLiki.html" class="category">CLiki</a>-specific features.<p>Two consecutive newlines in the body of an article are treated as the start of a new paragraph, and a <p> element is inserted in their place.<p>The current list of allowed HTML elements and attributes can be viewed in the CLiki source code: <a href="https://gitlab.common-lisp.net/vsedach/cliki2/blob/master/src/markup.lisp">https://gitlab.common-lisp.net/vsedach/cliki2/blob/master/src/markup.lisp</a><p><h2>Special CLiki Markup</h2><p><ul>
|
|
<li>Internal links: _(Foo) renders as <a href="Foo.html" class="internal">Foo</a>. Cliki page titles aren't case-sensitive, but Cliki will remember the way the title was written when you first created the page, and formats it that way forevermore. So, please make some effort to use capitals where appropriate.<p></li>
|
|
<li>Topic markers: *(Foo) declares this page to be relevant to topic Foo. The page will then show up in any topic lists (see below) for Foo. Topic markers are the main tool to organize CLiki, and are critical to making your article easy to find. Usually there will be a topic page called Foo that contains a list of all the pages in topic Foo.<p></li>
|
|
<li>
|
|
<a href="CLHS.html" class="internal">CLHS</a> 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. For example _H(destructuring-bind) becomes a link to <a href="https://www.cliki.net/site/HyperSpec/Body/mac_destructuring-bind.html" class="hyperspec">destructuring-bind</a>.<p></li>
|
|
<li>Topic lists: /(SLIME) renders a list of all pages with the topic marker *(SLIME) as:
|
|
<ul>
|
|
<li>
|
|
<a href="ABCL.html" class="internal">ABCL</a> -
|
|
<a href="http://abcl.org">Armed Bear Common Lisp</a> (aka ABCL) is a
|
|
</li>
|
|
<li>
|
|
<a href="cl-syntax.html" class="internal">cl-syntax</a> -
|
|
CL-SYNTAX provides Reader Syntax Conventions for Common Lisp and <a href="SLIME.html" class="category">SLIME</a>
|
|
</li>
|
|
<li>
|
|
<a href="Editing Lisp Code with Emacs.html" class="internal">Editing Lisp Code with Emacs</a> -
|
|
Keyboard tips
|
|
</li>
|
|
<li>
|
|
<a href="Mark Davidson.html" class="internal">Mark Davidson</a> -
|
|
I have been working with these infernal machines for over 22 years, and have dabbled with Lisp over time..
|
|
</li>
|
|
<li>
|
|
<a href="reattatchabe slime.html" class="internal">reattatchabe slime</a> -
|
|
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
|
|
</li>
|
|
<li>
|
|
<a href="SLIME Features.html" class="internal">SLIME Features</a> -
|
|
This is an evolving description of the features available in <a href="SLIME.html" class="category">SLIME</a>
|
|
</li>
|
|
<li>
|
|
<a href="SLIME-HOWTO.html" class="internal">SLIME-HOWTO</a> -
|
|
This is a collection of information about using <a href="SLIME.html" class="category">SLIME</a> - a proto-manual
|
|
</li>
|
|
<li>
|
|
<a href="Swank.html" class="internal">Swank</a> -
|
|
Swank is distributed as part of <a href="SLIME.html" class="category">SLIME</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul><p><h2><pre> and <code> tags</h2><p>HTML <pre> and <code> tags are treated specially. All text occuring in these elements is treated literally, including any other HTML markup. So:<p><pre><a href="foo.com">links</a> cannot be inserted in <pre> tags, for example</pre><p><code> tags can be used to colorize code (via the <a href="colorize.html" class="internal">colorize</a> library) by providing the lang attribute, like so:<p><pre><code lang="common-lisp"> ...code... </code></pre><p>Some example code looks like:<p><div class="code"><span class="nonparen"><span class="paren1">(<span class="nonparen"><a href="https://www.cliki.net/site/HyperSpec/Body/mac_defun.html" class="symbol"><i><span class="symbol">defun</span></i></a> foo <span class="paren2">(<span class="nonparen">x y</span>)</span>
|
|
<span class="paren2">(<span class="nonparen"><a href="https://www.cliki.net/site/HyperSpec/Body/fun_expcm_expt.html" class="symbol">expt</a> x <span class="paren3">(<span class="nonparen"><a href="https://www.cliki.net/site/HyperSpec/Body/any_mod.html" class="symbol">mod</a> x y</span>)</span></span>)</span></span>)</span>
|
|
</span></div><p>The currently supported language types are: lisp, scheme, elisp, common-lisp, basic-c, c, c++, java<p><h2>Escaping</h2><p>To escape the special CLiki markup, e.g., on this page when describing how to use the search tag, e.g.<p><pre>
|
|
/(SLIME)
|
|
</pre><p>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:<p><pre>
|
|
/<!-- -->(SLIME)
|
|
</pre><p>will be rendered as<p> /(SLIME)<p>Characters like ampersands and pointy brackets that have special meaning in HTML can be encoded using regular HTML escape codes: < is &lt; and & is &amp;. HTML pound-escaping is also supported: &#37; renders as %.<p><h2>Article conventions</h2><p>When linking to libraries and software packages, please specify the license under which the software is distributed using <a href="https://spdx.org/licenses/">SPDX license identifiers</a>.</div></div>
|
|
<div id="footer" class="buttonbar"><ul><li><a href="Text Formatting.html">Current version</a></li>
|
|
<li><a href="https://www.cliki.net/site/history?article=Text%20Formatting">History</a></li>
|
|
<li><a href="https://www.cliki.net/site/backlinks?article=Text%20Formatting">Backlinks</a></li><li><a href="https://www.cliki.net/site/edit-article?title=Text%20Formatting&from-revision=3769544013">Edit</a></li><li><a href="https://www.cliki.net/site/edit-article?create=t">Create</a></li></ul></div>
|
|
</div>
|
|
<div id="header-buttons" class="buttonbar">
|
|
<ul>
|
|
<li><a href="https://www.cliki.net/">Home</a></li>
|
|
<li><a href="https://www.cliki.net/site/recent-changes">Recent Changes</a></li>
|
|
<li><a href="CLiki.html">About</a></li>
|
|
<li><a href="Text Formatting.html">Text Formatting</a></li>
|
|
<li><a href="https://www.cliki.net/site/tools">Tools</a></li>
|
|
</ul>
|
|
<div id="search">
|
|
<form action="https://www.cliki.net/site/search">
|
|
<label for="search_query" class="hidden">Search CLiki</label>
|
|
<input type="text" name="query" id="search_query" value="" />
|
|
<input type="submit" value="search" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<div id="pageheader">
|
|
<div id="header">
|
|
<span id="logo">CLiki</span>
|
|
<span id="slogan">the common lisp wiki</span>
|
|
<div id="login"><form method="post" action="https://www.cliki.net/site/login">
|
|
<label for="login_name" class="hidden">Account name</label>
|
|
<input type="text" name="name" id="login_name" class="login_input" />
|
|
<label for= "login_password" class="hidden">Password</label>
|
|
<input type="password" name="password" id="login_password" class="login_input" />
|
|
<input type="submit" name="login" value="login" id="login_submit" /><br />
|
|
<div id="register"><a href="https://www.cliki.net/site/register">register</a></div>
|
|
<input type="submit" name="reset-pw" value="reset password" id="reset_pw" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body></html> |