/usr/share/doc/ruby-redcloth/rdoc/files/README_rdoc.html is in ruby-redcloth 4.2.8-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | <?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>File: README.rdoc</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="fileHeader">
<h1>README.rdoc</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>README.rdoc
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Mon Sep 05 22:57:52 +0000 2011</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<h1><a href="../classes/RedCloth.html">RedCloth</a> - Textile parser for Ruby</h1>
<table>
<tr><td valign="top">Homepage:</td><td><a href="http://redcloth.org">redcloth.org</a>
</td></tr>
<tr><td valign="top">Author:</td><td>Jason Garber
</td></tr>
<tr><td valign="top">Copyright:</td><td>(c) 2011 Jason Garber
</td></tr>
<tr><td valign="top">License:</td><td>MIT
</td></tr>
</table>
<p>
(See <a href="http://redcloth.org/textile">redcloth.org/textile</a>/ for a
Textile reference.)
</p>
<h1><a href="../classes/RedCloth.html">RedCloth</a></h1>
<p>
<a href="../classes/RedCloth.html">RedCloth</a> is a Ruby library for
converting Textile into HTML.
</p>
<h2>Installing</h2>
<p>
<a href="../classes/RedCloth.html">RedCloth</a> can be installed via
RubyGems:
</p>
<pre>
gem install RedCloth
</pre>
<p>
It will install the appropriate Ruby, JRuby, or Win32 gem. If using JRuby,
version 1.1.5 or greater is required.
</p>
<h2>Compiling</h2>
<p>
If you just want to use <a href="../classes/RedCloth.html">RedCloth</a>,
you do NOT need to build/compile it. It is compiled from C sources
automatically when you install the gem on the ruby platform. Precompiled
binary gems are provided for JRuby and Win32 platforms.
</p>
<p>
<a href="../classes/RedCloth.html">RedCloth</a> can be compiled with
<tt>rake compile</tt>. Ragel 6.3 or greater is required. Again, Ragel is
NOT needed to simply use <a href="../classes/RedCloth.html">RedCloth</a>.
</p>
<h3>Supported platforms</h3>
<p>
By default, the rake compile task builds a native C extension (MRI 1.8 or
1.9) or Java extension (JRuby 1.3). A pure Ruby version can also be
generated, but it‘s super slow and Ruby 1.8-only. The JRuby and
pure-Ruby extensions don‘t support multi-byte characters.
Cross-compiling for win32 uses rake-compiler.
</p>
<p>
The RedCloth::EXTENSION_LANGUAGE constant indicates in which language your
copy of <a href="../classes/RedCloth.html">RedCloth</a> is compiled.
</p>
<h3>Compiling gems</h3>
<p>
To compile MRI, JRuby, and win32 gems, you need rvm and rake-compiler.
These and other dependencies can be installed with bundler. Then rake
build:all takes care of compiling and packaging all gems.
</p>
<pre>
1. gem install bundler
2. bundle install
3. rake-compiler cross-ruby VERSION=1.8.6-p398
4. rake-compiler cross-ruby VERSION=1.9.1-p243
5. rake build:all
</pre>
<h2>Bugs</h2>
<p>
Please submit bugs to <a
href="http://jgarber.lighthouseapp.com/projects/13054-redcloth/overview">jgarber.lighthouseapp.com/projects/13054-redcloth/overview</a>
</p>
<h2>Using <a href="../classes/RedCloth.html">RedCloth</a></h2>
<p>
<a href="../classes/RedCloth.html">RedCloth</a> is simply an extension of
the String class that can handle Textile formatting. Use it like a String
and output HTML with its RedCloth#to_html method.
</p>
<p>
Simple use:
</p>
<pre>
text = "This is *my* text."
RedCloth.new(text).to_html
</pre>
<p>
Multi-line example:
</p>
<pre>
doc = RedCloth.new <<EOD
h2. Test document
Just a simple test.
EOD
puts doc.to_html
</pre>
<h2>What is Textile?</h2>
<p>
Textile is a simple formatting style for text documents, loosely based on
some HTML conventions.
</p>
<h2>Sample Textile Text</h2>
<pre>
h2. This is a title
h3. This is a subhead
This is a bit of paragraph.
bq. This is a blockquote.
</pre>
<h1>Writing Textile</h1>
<p>
A Textile document consists of paragraphs. Paragraphs can be specially
formatted by adding a small instruction to the beginning of the paragraph.
</p>
<pre>
h3. Header 3.
bq. Blockquote.
# Numeric list.
* Bulleted list.
</pre>
<h2>Quick Phrase Modifiers</h2>
<p>
Quick phrase modifiers are also included, to allow formatting of small
portions of text within a paragraph.
</p>
<pre>
_emphasis_
__italicized__
*strong*
**bold**
??citation??
-deleted text-
+inserted text+
^superscript^
~subscript~
@code@
%(classname)span%
==notextile== (leave text alone)
</pre>
<h2>Links</h2>
<p>
To make a hypertext link, put the link text in "quotation marks"
followed immediately by a colon and the URL of the link.
</p>
<p>
Optional: text in (parentheses) following the link text, but before the
closing quotation mark, will become a title attribute for the link, visible
as a tool tip when a cursor is above it.
</p>
<p>
Example:
</p>
<pre>
"This is a link (This is a title)":http://www.textism.com
</pre>
<p>
Will become:
</p>
<pre>
<a href="http://www.textism.com" title="This is a title">This is a link</a>
</pre>
<h2>Images</h2>
<p>
To insert an image, put the URL for the image inside exclamation marks.
</p>
<p>
Optional: text that immediately follows the URL in (parentheses) will be
used as the Alt text for the image. Images on the web should always have
descriptive Alt text for the benefit of readers using non-graphical
browsers.
</p>
<p>
Optional: place a colon followed by a URL immediately after the closing !
to make the image into a link.
</p>
<p>
Example:
</p>
<pre>
!http://www.textism.com/common/textist.gif(Textist)!
</pre>
<p>
Will become:
</p>
<pre>
<img src="http://www.textism.com/common/textist.gif" alt="Textist" />
</pre>
<p>
With a link:
</p>
<pre>
!/common/textist.gif(Textist)!:http://textism.com
</pre>
<p>
Will become:
</p>
<pre>
<a href="http://textism.com"><img src="/common/textist.gif" alt="Textist" /></a>
</pre>
<h2>Defining Acronyms</h2>
<p>
HTML allows authors to define acronyms via the tag. The definition appears
as a tool tip when a cursor hovers over the acronym. A crucial aid to clear
writing, this should be used at least once for each acronym in documents
where they appear.
</p>
<p>
To quickly define an acronym in Textile, place the full text in
(parentheses) immediately following the acronym.
</p>
<p>
Example:
</p>
<pre>
ACLU(American Civil Liberties Union)
</pre>
<p>
Will become:
</p>
<pre>
<acronym title="American Civil Liberties Union">ACLU</acronym>
</pre>
<h2>Adding Tables</h2>
<p>
In Textile, simple tables can be added by separating each column by a pipe.
</p>
<pre>
|a|simple|table|row|
|And|Another|table|row|
</pre>
<p>
Styles are applied with curly braces.
</p>
<pre>
table{border:1px solid black}.
{background:#ddd;color:red}. |a|red|row|
</pre>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|