org-parse 0.1.1

data/test/data/html-export.org

@@ -0,0 +1,342 @@
+OrgParse HTML export specification
+
+* texts before 1st headline
+** default
+  最初のテキストラインが、待った無しでタイトルになり、
+  残りの部分は、普通にHTMLに変換される。
+  : title
+  :
+  : xxxx
+  : * 1st headline
+  の場合、
+  : <h1>title</h1>
+  : 
+  : xxxx
+  : <h2>1st headline</h2>
+  の様に変換。[fn::実際はセクションヘッダには<div>やら何やらくっつく]
+  ヘッドラインから始まる場合は、ファイル名(StructParser の引数で指定されたテキスト)がタイトルになる。
+** #+TITLE: xxxx
+   : #+TITLE: xxxx
+   が指定されている場合は、xxxx がタイトルになる。
+
+** Options: skip:t
+   : #+OPTIONS: skip:t
+   が指定されていると、最初のセクション以前のテキストは捨てられる。
+   タイトルには、ファイル名（StructParser に渡された値) が使われる。
+
+   この場合も、
+   : #+TITLE: xxxx
+   で、タイトルを指定出来る。
+** #+TEXT: xxxx
+   skip: t が指定されている場合、
+   : #+TEXT: xxxx
+   : #+TEXT: xxxx
+   の様に、書くと、それが、最初のセクションの前に挿入される。
+** Mark up
+   タイトルに対してもインライン要素としての解釈は実行される
+* sections
+  #+BEGIN_VERSE
+    セクション 1
+      セクション 1.1
+    セクション 2
+  #+END_VERSE
+  の様に、下位レベルのセクションは、上位レベルのセクションに含まれる
+
+  セクションのタイトルは、'*' -> <h2> から始まり、'****' 以降は、UL 
+  として出力される。
+  <h> と <ul> の閾値は、#+OPTIONS: H:n で指定出来る。
+  （デフォルトは、n=3)
+** paragraphs 
+  セクションは、パラグラフから始まる？
+
+  paragraph 1
+
+  paragraph 2
+    indent deeper
+indent shallower
+
+  paragraph 3
+** list
+** blocks
+** Verse
+   verse ブロック内では、改行が保存される。\\
+   <p class="verse"> 〜 </p> でくくる。\\
+
+   インデントは、ブロック指定行のインデントを基準に、
+   各行のインデント * 2 の &nbsp; に置き換わる。
+   #+begin_Verse
+    verse line1
+      verse line2
+    verse line3
+   verse line4
+   #+end_verse
+** Example
+   example ブロックは、<pre class="example"></pre>でくくる
+
+   インデントは、 *ブロック* 先頭行のインデント位置からの
+   インデントに変換される。[[blocks.html]]
+   #+begin_example
+   # *非破壊的*
+     def expand_tab( str )
+       str.gsub(/([^\t]{8})|([^\t]*)\t/n) { [$+].pack("A8") }
+     end
+
+** example の内部は、解釈されないわけね
+
+     # 破壊的 [[link]]
+     def expand_tab!( str )
+       1 while str.sub!(/(^[^\t]*)\t(\t*)/) { $1 + ' ' * (8-$1.size%8+8*$2.size) }
+     end
+
+     # 破壊的 (2)
+     def expand_tab!( str )
+       1 while str.sub!(/\t(\t*)/) {' ' * (8-$~.begin(0)%8+8*$1.size) }
+     end
+   #+end_example
+
+   #+BEGIN_EXAMPLE -t -w 40
+     (defun org-xor (a b)
+        "Exclusive or."
+        (if a (not b) b))
+   #+END_EXAMPLE
+
+
+** Quote
+   #+BEGIN_QUOTE
+     blockquote も書ける
+   #+END_QUOTE
+** section 3
+  - list1
+    - list1-1
+- list2
+
+* options
+     - H:         set the number of headline levels for export
+     - num:       turn on/off section-numbers
+     - toc:       turn on/off table of contents, or set level limit (integer)
+     - \n:        turn on/off line-break-preservation (DOES NOT WORK)
+     - @:         turn on/off quoted HTML tags
+     - ::         turn on/off fixed-width sections
+     - |:         turn on/off tables
+     - ^:         turn on/off TeX-like syntax for sub- and superscripts.  If
+                  you write "^:{}", a_{b} will be interpreted, but
+                  the simple a_b will be left as it is.
+     - -:         turn on/off conversion of special strings.
+     - f:         turn on/off footnotes like this[1].
+     - todo:      turn on/off inclusion of TODO keywords into exported text
+     - pri:       turn on/off priority cookies
+     - tags:      turn on/off inclusion of tags, may also be not-in-toc
+     - <:         turn on/off inclusion of any time/date stamps like DEADLINES
+     - *:         turn on/off emphasized text (bold, italic, underlined)
+     - TeX:       turn on/off simple TeX macros in plain text
+     - LaTeX:     turn on/off LaTeX fragments
+     - skip:      turn on/off skipping the text before the first heading
+     - author:    turn on/off inclusion of author name/email into exported file
+     - creator:   turn on/off inclusion of creator info into exported file
+     - timestamp: turn on/off inclusion creation time into exported file
+     - d:         turn on/off inclusion of drawers
+* footnote
+  [[./footnote.org]]
+* Section node
+  Section node は、Headline から始まり、次のHeadline（又は文末）の直前までを、
+  子要素に含むノードである。
+
+  #+BEGIN_EXAMPLE
+    Section node
+        Headline
+        some other nodes
+  #+END_EXAMPLE
+
+  COMMENT から始まるヘッドラインを持つ Section は、全体をコメントとして扱う。
+
+* Brock nodes
+  行単位の範囲を持つ要素。
+
+** Headline node
+   /^\*+ / から始まる行。'*' の数がセクションのレベルを表す。
+   
+   セクションの開始を示す。
+*** Tags
+    ヘッドラインには、TAGを付けることが出来る。
+** Paragraph node
+   ヘッドラインの次の行から始まり、セクションの最後か、１行以上の空行で終わる部分は、
+   段落として扱う。段落中で、改行させたい場合には、行末に"\\"を置く。
+
+   : #+BEGIN_VERSE 〜 #+END_VERSE
+   で囲われた部分は、改行が保存される。
+   [[file:./verse.org][verse example]] [[./verse.html][html]]
+
+   #+BEGIN_EXAMPLE
+     <p class="verse">
+     ...<br/>
+     &nbsp;&nbsp;...<br/>
+     </p>
+   #+END_EXAMPLE
+
+   の様に、展開される様だ。
+
+** Whiteline node
+   空行のノード。
+   パラグラフや、その他のブロックの終端を示す。
+   
+   インデントのチェックが必要か?
+
+** Block nodes
+   #+begin 〜 #+end ブロック。
+*** EXAMPLE
+   #+BEGIN_EXAMPLE
+     : #+BEGIN_EXMPLE
+     :  ...
+     : #+END_EXAMPLE
+   #+END_EXAMPLE
+
+   you can also start the example lines with a colon followed by a space. 
+   There may also be additional whitespace before the colon: 
+
+   :   : example
+
+   EXAMPL ブロックは、<pre> タグに変換される
+*** SRC
+   #+BEGIN_SRC emacs-lisp eiffel
+     (+ 1 2)
+   #+END_SRC
+   
+#+BEGIN_COMMENT
+     ここは、コメントブロックだよ
+#+END_COMMENT
+*** VERSE
+   #+begin_verse
+     このブロック内では、改行が
+     保存される。
+
+     行頭のインデントは、html の場合、&&nbsp; に変換される
+   #+end_verse
+
+   行頭のインデントは、~#+BEGIN_VERSE~　のインデント + 1 をベースとして、
+   (各行のインデント - ベース) * 2 = &nbsp; の数となる。
+
+*** HTML
+  [[Quote HTML]]
+
+  #+HTML: <literal html code>
+
+  #+BEGIN_HTML
+    <h2> ここには、自由に</h2>
+    <p>HTML tag が書ける。</p>
+  #+END_HTML
+
+** Plain Lists
+   [[./lists.org][lists.org]] [[./lists.html][html]]
+
+*** Unordered list
+   先頭が[-+*]で始まる行は、順序無リストアイテムの開始を示し、
+   これに続く、インデントが開始マークより大きい行、又は、空行は
+   このアイテムに含まれる。
+
+   リストは、ネスト出来る。
+
+   空行のインデントは、チェックされない。
+*** Ordered list
+   先頭が、"数字." 又は "数字)" で始まる行は、番号付きリストを表す。
+*** Description list
+   : - XXXX :: mmmmm
+   の形式の行は、説明付きリストを表す。
+
+** Comment line
+   #+ これは、コメント行
+# これもコメント行
+   だけど、
+   # これは、コメント行では無い。 でも、 #+ ここからは？　やっぱり地の文。
+** COMMENT comment block
+   このセクションは、全体がコメントとして扱われる。
+   (出力には含まれない)
+
+** Option node
+   : #+TITLE
+   等の、オプション設定を行う行
+*** #+ATTR_HTML
+    If you want to specify attributes for links, 
+    you can do so using a special #+ATTR_HTML line 
+    to define attributes 
+    that will be added to the <a> or <img> tags. 
+
+    Here is an example that sets title and style attributes for a link: 
+       :   #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
+       :   [[http://orgmode.org]]
+
+
+** Horizontal line
+------
+  '-'が5個以上のみの行は、<hr/> に変換される
+* Inline nodes
+  行内で完結している諸要素
+** Footnotes
+** Emphasis and monospace
+    - *bold*
+    - /italic/
+    - _underlined_
+    - =code=
+    - ~verbatim~
+    - +strike through+
+   *bold and /italic/* _underlined and *bold*_ ~verbatim without *bold*~
+   =code without *bold*=
+   *bold [[link][link]]* =code is [[link][link]] allowed= *bold =code* code=
+   *bold in *bold* is* not bold *1234* 
+   *bold [[link]]*, [[link][ *bold* ]]
+
+** Quoting HTML tags
+  [[Quote HTML]]
+  @<br/> @<b>bold@</b> の様にすることが出来る
+** Linkとイメージ
+   リンクの、拡張子が画像ファイルの場合、<img>タグに展開される
+
+   - [ [image file] ] の場合、<img src="image file"> に展開される
+   - [ [link][image file] ] の場合、<a href="link"><img src="image file"></a> に展開される
+   - img を表示する際に、#+CAPTION: xxxx が指定されている場合、\\
+     #+BEGIN_VERSE
+       <div class="figure">
+       <p><img src="lily20100228t.jpg" alt="lily20100228t.jpg"></p>
+       <p>寝起きのリリー君</p>
+       </div>
+     #+END_VERSE
+     に展開される
+   - [ [xxx][yyy] ] の場合、<a href="xxx">yyy</a> に展開される
+
+*** Link format
+    : [[link][description]]  or  [[link]]
+
+    [[index.html][desc *bold* ]] <- description part は修飾出来る。
+
+*** Internal links
+*** External links
+    外部へのリンク
+     * http://www.astro.uva.nl/~dominik          on the web
+     * file:/home/dominik/images/jupiter.jpg     file, absolute path
+     * /home/dominik/images/jupiter.jpg          same as above
+     * file:papers/last.pdf                      file, relative path
+     * ./papers/last.pdf                         same as above
+ 
+*** Images
+    [[file:images.org]] [[file:images.html]]
+**** そのままの大きさで表示
+    : [[lily20100228t.jpg]]
+    [[lily20100228t.jpg]]
+**** サムネールとリンク
+    : [[lily20100228.jpg][lily20100228t.jpg]]    
+    [[file:lily20100228.jpg][lily20100228t.jpg]]
+
+* Table of contents
+ サポートは後回しにするかね。
+
+* OPTIONS
+:#+OPTIONS: skip:t
+#+OPTIONS: H:4
+: #+TEXT: head block
+: #+TEXT: this area is <b> *literal* </b>
+: #+TITLE: sample dayo
+#+AUTHOR: knb
+#+EMAIL: knb@artif.org
+#+STYLE: <link rel="stylesheet" type="text/css" href="css/eiffel.css" />
+* test files
+- [[texts before 1st headline]] [[file:text-bef-hl.org]] [[text-bef-hl.html][html]]
+- [[#+TITLE: xxxx]] [[file:title.org]] [[file:title.html][html]]

data/test/data/images.html

@@ -0,0 +1,179 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!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"
+lang="en" xml:lang="en">
+<head>
+<title>images</title>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
+<meta name="generator" content="Org-mode"/>
+<meta name="generated" content="2010-03-11 16:03:23 JST"/>
+<meta name="author" content="Kensei Nakamura"/>
+<meta name="description" content=""/>
+<meta name="keywords" content=""/>
+<style type="text/css">
+ <!--/*--><![CDATA[/*><!--*/
+  html { font-family: Times, serif; font-size: 12pt; }
+  .title  { text-align: center; }
+  .todo   { color: red; }
+  .done   { color: green; }
+  .tag    { background-color: #add8e6; font-weight:normal }
+  .target { }
+  .timestamp { color: #bebebe; }
+  .timestamp-kwd { color: #5f9ea0; }
+  p.verse { margin-left: 3% }
+  pre {
+	border: 1pt solid #AEBDCC;
+	background-color: #F3F5F7;
+	padding: 5pt;
+	font-family: courier, monospace;
+        font-size: 90%;
+        overflow:auto;
+  }
+  table { border-collapse: collapse; }
+  td, th { vertical-align: top; }
+  dt { font-weight: bold; }
+  div.figure { padding: 0.5em; }
+  div.figure p { text-align: center; }
+  .linenr { font-size:smaller }
+  .code-highlighted {background-color:#ffff00;}
+  .org-info-js_info-navigation { border-style:none; }
+  #org-info-js_console-label { font-size:10px; font-weight:bold;
+                               white-space:nowrap; }
+  .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
+                                 font-weight:bold; }
+  /*]]>*/-->
+</style>
+<script type="text/javascript">
+<!--/*--><![CDATA[/*><!--*/
+ function CodeHighlightOn(elem, id)
+ {
+   var target = document.getElementById(id);
+   if(null != target) {
+     elem.cacheClassElem = elem.className;
+     elem.cacheClassTarget = target.className;
+     target.className = "code-highlighted";
+     elem.className   = "code-highlighted";
+   }
+ }
+ function CodeHighlightOff(elem, id)
+ {
+   var target = document.getElementById(id);
+   if(elem.cacheClassElem)
+     elem.className = elem.cacheClassElem;
+   if(elem.cacheClassTarget)
+     target.className = elem.cacheClassTarget;
+ }
+/*]]>*///-->
+</script>
+</head>
+<body>
+<div id="content">
+
+<h1 class="title">images</h1>
+
+
+<div id="table-of-contents">
+<h2>Table of Contents</h2>
+<div id="text-table-of-contents">
+<ul>
+<li><a href="#sec-1">1 そのままの大きさで表示 </a>
+<ul>
+<li><a href="#sec-1.1">1.1 サムネールとリンク </a></li>
+<li><a href="#sec-1.2">1.2 属性の指定 </a></li>
+<li><a href="#sec-1.3">1.3 Image とリンク </a></li>
+<li><a href="#sec-1.4">1.4 Image と デスクリプション </a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-1" class="outline-2">
+<h2 id="sec-1"><span class="section-number-2">1</span> そのままの大きさで表示 </h2>
+<div class="outline-text-2" id="text-1">
+
+<pre class="example">
+[[file:lily20100228t.jpg]]
+</pre>
+
+<p><a href="#sec-1"><img src="lily20100228t.jpg"/></a>
+</p>
+</div>
+
+<div id="outline-container-1.1" class="outline-3">
+<h3 id="sec-1.1"><span class="section-number-3">1.1</span> サムネールとリンク </h3>
+<div class="outline-text-3" id="text-1.1">
+
+<pre class="example">
+[[lily20100228.jpg][lily20100228t.jpg]]    
+</pre>
+
+<p><a href="lily20100228.jpg"><img src="lily20100228t.jpg"/></a>
+</p></div>
+
+</div>
+
+<div id="outline-container-1.2" class="outline-3">
+<h3 id="sec-1.2"><span class="section-number-3">1.2</span> 属性の指定 </h3>
+<div class="outline-text-3" id="text-1.2">
+
+<pre class="example">
+#+CAPTION: 寝起きのリリー君
+[[file:lily20100228t.jpg]]
+</pre>
+
+
+<div class="figure">
+<p><img src="lily20100228t.jpg"  alt="lily20100228t.jpg" /></p>
+<p>寝起きのリリー君</p>
+</div>
+<pre class="example">
+#+ATTR_HTML: alt="寝起きのリリー君の写真" title="起きて!" align="right"
+[[file:lily20100228.jpg][file:lily20100228t.jpg]]
+</pre>
+
+<p><a href="lily20100228.jpg"><img src="lily20100228t.jpg" align="right" alt="寝起きのリリー君の写真" title="起きて!" /> </a>
+テキストは、右側に回りこみ。
+</p>
+<pre class="example">
+#+ATTR_HTML: alt="寝起きのリリー君の写真" title="起きて!" align="right" size="75x100"
+[[file:lily20100228.jpg]]
+</pre>
+
+<p><img src="lily20100228.jpg" alt="寝起きのリリー君の写真" title="起きて!" width="30" height="40" />
+</p></div>
+
+</div>
+
+<div id="outline-container-1.3" class="outline-3">
+<h3 id="sec-1.3"><span class="section-number-3">1.3</span> Image とリンク </h3>
+<div class="outline-text-3" id="text-1.3">
+
+<p><a href="./index.html"><img src="lily20100228t.jpg"/></a>
+</p></div>
+
+</div>
+
+<div id="outline-container-1.4" class="outline-3">
+<h3 id="sec-1.4"><span class="section-number-3">1.4</span> Image と デスクリプション </h3>
+<div class="outline-text-3" id="text-1.4">
+
+<pre class="example">
+[[lily20100228t.jpg][リリー君]]
+</pre>
+
+<p><a href="#sec-1">リリー君</a>
+</p></div>
+</div>
+</div>
+<div id="postamble">
+<p class="author"> Author: Kensei Nakamura
+<a href="mailto:kensei@dalmore.artifarm.com">&lt;kensei@dalmore.artifarm.com&gt;</a>
+</p>
+<p class="date"> Date: 2010-03-11 16:03:23 JST</p>
+<p class="creator">HTML generated by org-mode 6.34c in emacs 23</p>
+</div>
+</div>
+</body>
+</html>

data/test/data/images.org

@@ -0,0 +1,30 @@
+images
+
+* そのままの大きさで表示
+    : [[file:lily20100228t.jpg]]
+    [[lily20100228t.jpg]]
+** サムネールとリンク
+    : [[lily20100228.jpg][lily20100228t.jpg]]    
+    [[file:lily20100228.jpg][lily20100228t.jpg]]
+** 属性の指定
+   : #+CAPTION: 寝起きのリリー君
+   : [[file:lily20100228t.jpg]]
+    #+CAPTION: 寝起きのリリー君
+    [[file:lily20100228t.jpg]]
+    : #+ATTR_HTML: alt="寝起きのリリー君の写真" title="起きて!" align="right"
+    : [[file:lily20100228.jpg][file:lily20100228t.jpg]]
+    #+ATTR_HTML: alt="寝起きのリリー君の写真" title="起きて!" align="right"
+    [[file:lily20100228.jpg][file:lily20100228t.jpg]]
+    写真は右寄せ。
+    右寄せの解除は、<br clear="both"/>
+    @<br clear="both"/>
+    : #+ATTR_HTML: alt="寝起きのリリー君の写真" title="起きて!" width="30" height="40"
+    : [[file:lily20100228.jpg]]
+    #+ATTR_HTML: alt="寝起きのリリー君の写真" title="起きて!" width="30" height="40"
+    [[file:lily20100228.jpg]]
+    小さく表示
+** Image とリンク
+   [[./index.html][file:lily20100228t.jpg]]
+** Image と デスクリプション
+   : [[lily20100228t.jpg][リリー君]]
+   [[lily20100228t.jpg][リリー君]]