Changed a file comment and reformatted redcloth_for_tex.rb
This commit is contained in:
Alexey Verkhovsky
parent
590af3ae4f
commit
6f943a01d4
1 changed files with 640 additions and 787 deletions
|
|
@ -1,154 +1,8 @@
|
|||
# vim:ts=4:sw=4:
|
||||
# = RedCloth - Textile for Ruby
|
||||
#
|
||||
# (c) 2003 why the lucky stiff (and his puppet organizations.)
|
||||
#
|
||||
# (see http://www.textism.com/tools/textile/ for Textile)
|
||||
#
|
||||
# Based on (and also inspired by) both:
|
||||
#
|
||||
# PyTextile: http://diveintomark.org/projects/textile/textile.py.txt
|
||||
# Textism for PHP: http://www.textism.com/tools/textile/
|
||||
#
|
||||
#
|
||||
# == What is Textile?
|
||||
#
|
||||
# Textile is a simple formatting style for text
|
||||
# documents, loosely based on some HTML conventions.
|
||||
#
|
||||
# === Sample Textile Text
|
||||
#
|
||||
# h2. This is a title
|
||||
#
|
||||
# h3. This is a subhead
|
||||
#
|
||||
# This is a bit of paragraph.
|
||||
#
|
||||
# bq. This is a blockquote.
|
||||
#
|
||||
# === Writing Textile
|
||||
#
|
||||
# A Textile document consists of paragraphs. Paragraphs
|
||||
# can be specially formatted by adding a small instruction
|
||||
# to the beginning of the paragraph.
|
||||
#
|
||||
# h[n]. Header of size [n].
|
||||
# bq. Blockquote.
|
||||
# # Numeric list.
|
||||
# * Bulleted list.
|
||||
#
|
||||
# === Quick Phrase Modifiers
|
||||
#
|
||||
# Quick phrase modifiers are also included, to allow formatting
|
||||
# of small portions of text within a paragraph.
|
||||
#
|
||||
# _emphasis_
|
||||
# __italicized__
|
||||
# *strong*
|
||||
# **bold**
|
||||
# ??citation??
|
||||
# -deleted text-
|
||||
# +inserted text+
|
||||
# ^superscript^
|
||||
# ~subscript~
|
||||
# @code@
|
||||
# %(classname)span%
|
||||
#
|
||||
# ==notextile== (leave text alone)
|
||||
#
|
||||
# === Links
|
||||
#
|
||||
# To make a hypertext link, put the link text in "quotation
|
||||
# marks" followed immediately by a colon and the URL of the link.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# "This is a link (This is a title) ":http://www.textism.com
|
||||
#
|
||||
# Will become:
|
||||
#
|
||||
# <a href="http://www.textism.com" title="This is a title">This is a link</a>
|
||||
#
|
||||
# === Images
|
||||
#
|
||||
# To insert an image, put the URL for the image inside exclamation marks.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# Optional: place a colon followed by a URL immediately after the
|
||||
# closing ! to make the image into a link.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# !http://www.textism.com/common/textist.gif(Textist)!
|
||||
#
|
||||
# Will become:
|
||||
#
|
||||
# <img src="http://www.textism.com/common/textist.gif" alt="Textist" />
|
||||
#
|
||||
# With a link:
|
||||
#
|
||||
# !/common/textist.gif(Textist)!:http://textism.com
|
||||
#
|
||||
# Will become:
|
||||
#
|
||||
# <a href="http://textism.com"><img src="/common/textist.gif" alt="Textist" /></a>
|
||||
#
|
||||
# === Defining Acronyms
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# To quickly define an acronym in Textile, place the full text in (parentheses)
|
||||
# immediately following the acronym.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# ACLU(American Civil Liberties Union)
|
||||
#
|
||||
# Will become:
|
||||
#
|
||||
# <acronym title="American Civil Liberties Union">ACLU</acronym>
|
||||
#
|
||||
# === Adding Tables
|
||||
#
|
||||
# In Textile, simple tables can be added by seperating each column by
|
||||
# a pipe.
|
||||
#
|
||||
# |a|simple|table|row|
|
||||
# |And|Another|table|row|
|
||||
#
|
||||
# Attributes are defined by style definitions in parentheses.
|
||||
#
|
||||
# table(border:1px solid black).
|
||||
# (background:#ddd;color:red). |{}| | | |
|
||||
#
|
||||
# === Using RedCloth
|
||||
#
|
||||
# RedCloth is simply an extension of the String class, which can handle
|
||||
# Textile formatting. Use it like a String and output HTML with its
|
||||
# RedCloth#to_html method.
|
||||
#
|
||||
# doc = RedCloth.new "
|
||||
#
|
||||
# h2. Test document
|
||||
#
|
||||
# Just a simple test."
|
||||
#
|
||||
# puts doc.to_html
|
||||
# This is RedCloth (http://www.whytheluckystiff.net/ruby/redcloth/)
|
||||
# converted by David Heinemeier Hansson to emit Tex
|
||||
|
||||
class String
|
||||
#
|
||||
# Flexible HTML escaping
|
||||
#
|
||||
def texesc!( mode )
|
||||
gsub!( '&', '\\\\&' )
|
||||
gsub!( '%', '\%' )
|
||||
|
|
@ -877,4 +731,3 @@ class RedClothForTex < String
|
|||
8364, 8364, 0, 0xffff
|
||||
]
|
||||
end
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue