The Human Textile Reference is a set of short, easy to understand HTML pages you can include in any project that uses Textile.
Important: This is not designed to be a complete reference. Just a quick guide for the layman.
You can view a live demo.
It’s perfect for including as a pop-up help window next to your textarea.
The author of this reference recommends using Markdown over Textile as it’s easier to learn and requires less change to normal writing styles.
See also: the Human Markdown Reference.
Download or clone this repository.
Copy the textile-reference/ directory to your project.
Add a help link to the reference:
You can format your text using
<a href="textile-reference/en/index.html"
onclick="window.open(this.href,'textile_reference','height=400,width=600,scrollbars=1'); return false;">Textile</a>.
You can format your text using
<%= link_to 'Textile', 'textile-reference/en/index.html', :popup => ['textile_reference', 'height=400,width=600,scrollbars=1'] %>
English and German are currently supported.
Just change textile-reference/en/index.html to textile-reference/de/index.html (on most servers you can also drop the index.html).
The reference sections include:
- Text formatting
- Links and images
- Headings
- Lists
- Tables
- Special characters
The Human Textile Reference is licensed under the MIT licence and is freely available for you to use or modify for any project.
It’s extremely lightweight; one HTML file, one minified CSS file, two images. If your web server has GZip compression switched on it should total 2.2KB.
The guide uses JavaScript to toggle the different categories. If the browser’s JavaScript is disabled, every category will be shown expanded, which is fine.
It uses jQuery 1.4.4 from the Google’s AJAX CDN (the request should be a cache hit, so you’ll incur no extra wait time).
Included stylesheet is compiled using Sass. If you want to make modifications, alter sass/textile-reference.scss. You can output the compressed version with:
sass sass/textile-reference.scss textile-reference/stylesheets/textile-reference.css -t compressed
If you’re developing, you can use Sass’ --watch option.