Permalink
Browse files

Initial version.

  • Loading branch information...
0 parents commit b57760f25195d80b7d93ad49767a968c66807c6b @Aupajo committed Dec 30, 2010
@@ -0,0 +1,23 @@
+Copyright (c) 2008 Pete Nicholls
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
@@ -0,0 +1,60 @@
+h1. Human Textile Reference
+
+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 demo on the "labs page":http://labs.metanation.com/human-textile-reference/.
+
+It's perfect for including as a pop-up help window next to your textarea.
+
+h2. Notes
+
+h3. Size
+
+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.
+
+h3. JavaScript
+
+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).
+
+h3. Sass
+
+Included stylesheet is compiled using "Sass":http://sass-lang.com/. If you want to make modifications, alter @sass/textile-reference.css@. You can output the compressed version with:
+
+<pre>
+<code>
+sass sass/textile-reference.scss textile-reference/stylesheets/textile-reference.css -t compressed
+</code>
+</pre>
+
+If you're developing, you can use Sass' @--watch@ option.
+
+h2. How To Use
+
+Clone the repository or "download":http://github.com/Aupajo/human-textile-reference/downloads.
+
+Copy the @textile-reference/@ directory to your project.
+
+Add a help link to the reference:
+
+h3. HTML Snippet
+
+<pre>
+<code>
+You can format your text using
+<a href="textile-reference/index.html"
+ onclick="window.open(this.href,'textile_reference','height=400,width=600,scrollbars=1'); return false;">Textile</a>.
+</code>
+</pre>
+
+h3. Rails Snippet
+
+<pre>
+<code>
+ You can format your text using
+ <%= link_to 'Textile', 'textile-reference/index.html', :popup => ['textile_reference', 'height=400,width=600,scrollbars=1'] %>
+</code>
+</pre>
@@ -0,0 +1,131 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <title>Usage Example</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <style type="text/css">
+ <!--
+
+ body {
+ color: #333;
+ font: 10pt/1.6em Georgia, serif;
+ margin: 1em auto;
+ width: 740px;
+ }
+
+
+ a:link, a:visited {
+ color: #e2231b;
+ }
+
+ a:hover {
+ color: #f5c07;
+ }
+
+ a:active {
+ color: #910;
+ }
+
+ h1 {
+ font-size: 1.8em;
+ }
+
+ h2 {
+ font-size: 1.4em;
+ margin-top: 0;
+ }
+
+ code {
+ font: 0.9em Monaco, Courier, monospace;
+ }
+
+ .example {
+ background-color: #fffebd;
+ border: 1px solid #ffda78;
+ display: block;
+ padding: 1em;
+ margin-bottom: 2em;
+ }
+
+ .directory {
+ background-color: #eef;
+ padding: 0.2em;
+ }
+
+ .tag {
+ color: #c00;
+ }
+
+ .attribute {
+ color: #eb8422;
+ }
+
+ .value {
+ color: #456cb7;
+ }
+
+ .contents {
+ color: #080e21;
+ }
+
+ #shameless {
+ border-top: 1px dashed #ccc;
+ font-size: 0.9em;
+ color: #999;
+ padding-top: 2em;
+ text-align: center;
+ }
+
+ #shameless a {
+ color: #777;
+ }
+
+ -->
+ </style>
+ </head>
+ <body>
+
+ <h1>Usage Example</h1>
+
+ <h2>Instructions</h2>
+
+ <ol>
+ <li>Copy the <code class="directory">markdown-reference/</code> directory to your project.</li>
+ <li>Include a quick help link to the reference.</li>
+ </ol>
+
+ <h2>Example</h2>
+
+ <div class="example">
+ You can format your text using <a href="markdown-reference/index.html" onclick="window.open(this.href,'markdown_reference','height=400,width=600,scrollbars=1');return false;">Markdown</a>.
+ </div>
+
+ <h2>Code Snippets</h2>
+
+ <h3>HTML</h3>
+
+ <code class="example">
+ You can format your text using<br />
+ <span class="tag">&lt;a
+ <span class="attribute">href=</span><span class="value">"markdown-reference/index.html"</span>
+ <span class="attribute">onclick=</span><span class="value">"window.open(this.href,'markdown_reference','height=400,width=600,scrollbars=1'); return false;"&gt;</span></span><span class="contents">Markdown</span><span class="tag">&lt;/a&gt;</span>.
+ </code>
+
+ <h3>Rails</h3>
+
+ <code class="example">
+ You can format your text using<br />
+ <span class="tag">&lt;%= link_to <span class="attribute">'Markdown'</span>,
+ <span class="attribute">'markdown-reference/index.html'</span>,
+ <span class="attribute">:popup =&gt;</span>
+ [<span class="value">'markdown_reference'</span>,
+ <span class="value">'height=400,width=600,scrollbars=1'</span>]
+ %&gt;</span>
+ </code>
+
+ <p id="shameless">
+ Want to help out? Check out the <a href="http://github.com/Aupajo/human-markdown-reference/tree/master">repository on GitHub</a>!
+ </p>
+
+ </body>
+</html>
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.

0 comments on commit b57760f

Please sign in to comment.