all repos — markup @ 3e48ce096ff373fedc82d4eaf200a78a7569e15b

The code we use to render README.your_favorite_markup

test/markups/README.org (view raw)

  1#+TITLE:     org-ruby
  2#+AUTHOR:    Brian Dewey
  3#+EMAIL:     bdewey@gmail.com
  4#+DATE:      2009-12-21
  5#+DESCRIPTION: 
  6#+KEYWORDS: 
  7#+LANGUAGE:  en
  8#+OPTIONS:   H:3 num:t toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
  9#+OPTIONS:   TeX:t LaTeX:nil skip:nil d:nil todo:nil pri:nil tags:not-in-toc
 10#+EXPORT_EXCLUDE_TAGS: exclude
 11#+STARTUP:    showall
 12
 13 | Status:   | Under Development                 |
 14 | Location: | [[http://github.com/bdewey/org-ruby]] |
 15 | Version:  | 0.5.1                             |
 16
 17* Description
 18
 19  Helpful Ruby routines for parsing orgmode files. The most
 20  significant thing this library does today is convert orgmode files
 21  to textile. Currently, you cannot do much to customize the
 22  conversion. The supplied textile conversion is optimized for
 23  extracting "content" from the orgfile as opposed to "metadata."
 24
 25
 26* History
 27
 28** 2009-12-30: Version 0.5.1
 29
 30   - Minor enhancement: Recognize lines starting with ":" as examples.
 31   - Minor enhancement: Recognize #+BEGIN_SRC as source blocks
 32   - Minor enhancement: Add "src" and "example" classes to <pre> blocks.
 33
 34
 35** 2009-12-30: Version 0.5.0
 36
 37   - Parse (but not necessarily *use*) in-buffer settings. The following
 38     in-buffer settings *are* used:
 39     - Understand the #+TITLE: directive.
 40     - Exporting todo keywords (option todo:t)
 41     - Numbering headlines (option num:t)
 42     - Skipping text before the first headline (option skip:t)
 43     - Skipping tables (option |:nil)
 44     - Custom todo keywords
 45     - EXPORT_SELECT_TAGS and EXPORT_EXLUDE_TAGS for controlling parts of
 46       the tree to export
 47   - Rewrite "file:(blah).org" links to "http:(blah).html" links. This
 48     makes the inter-links to other org-mode files work.
 49   - Uses <th> tags inside table rows that precede table separators.
 50   - Bugfixes:
 51     - Headings now have HTML escaped.
 52
 53** 2009-12-29: Version 0.4.2
 54
 55   - Got rid of the extraneous newline at the start of code blocks.
 56   - Everything now shows up in code blocks, even org-mode metadata.
 57   - Fixed bugs:
 58     - Regressed smart double quotes with HTML escaping. Added a test
 59       case and fixed the regression.
 60
 61** 2009-12-29: Version 0.4.1
 62   - HTML is now escaped by default
 63   - org-mode comments will show up in a code block.
 64
 65** 2009-12-29: Version 0.4
 66
 67   - The first thing output in HTML gets the class "title"
 68   - HTML output is now indented
 69   - Proper support for multi-paragraph list items.
 70
 71     See? This paragraph is part of the last bullet.
 72     
 73   - Fixed bugs:
 74     - "rake spec" wouldn't work on Linux. Needed "require 'rubygems'".
 75
 76** 2009-12-27: Version 0.3
 77
 78   - Uses rubypants to get better typography (smart quotes, elipses, etc...).
 79   - Fixed bugs:
 80     - Tables and lists did not get properly closed at the end of file
 81     - You couldn't do inline formatting inside table cells
 82     - Characters in PRE blocks were not HTML escaped.
 83   
 84** 2009-12-26: Version 0.2
 85
 86   - Added =to_html= output on the parser.
 87   - Added support for the full range of inline markup: *bold*,
 88     /italic/, =code=, ~verbatim~, _underline_, +strikethrough+.
 89   - Lots of refactoring to make the code more maintainable.
 90
 91** 2009-12-23: Version 0.1
 92
 93   - Added support for block code, like this:
 94
 95     #+BEGIN_EXAMPLE
 96     def flush!
 97     @logger.debug "FLUSH ==========> #{@output_type}"
 98     if (@output_type == :blank) then
 99       @output << "\n"
100     elsif (@buffer.length > 0) then
101       if @cancel_modifier then
102         @output << "p. " if @output_type == :paragraph
103         @cancel_modifier = false
104       end
105       @output << @paragraph_modifier if (@paragraph_modifier and not sticky_modifier?)
106       @output << @buffer.textile_substitution << "\n"
107     end
108     @buffer = ""
109   end
110   #+END_EXAMPLE
111
112   - Major code cleanup: Created the =OutputBuffer= class that
113     greatly simplified a lot of the messiness of =textile=
114     conversion.
115   - Added support for line breaks within list items.