pseudohikiparser 0.0.3 → 0.0.4.develop

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32c71494df02c4ef6701259bd2f7731e2ec14508
-  data.tar.gz: fb7bceffb5fc2f9d67c6959bd71485862e71bff2
+  metadata.gz: 685e26157a454005d4d71337bbe18cac722efa11
+  data.tar.gz: a8edea51f0aa148d8e78647b0f36702226c742f0
 SHA512:
-  metadata.gz: 2a3a20edf96dba9d41d837dc44009f4b1bb6eb6136476abd08cfaf882bcde8a213ded999647f2a067548b7b3f089e768390399d7e8f69fdccdbb6f4bcdff871b
-  data.tar.gz: 14cb9c5b77e7e4cdc9f153e91c0c8d2f4ae85a292637dcfa5c55d0982ef5b3adb3faa92e140184f318e33b76c00e1106affabf252c270d38e3d4aeca1e369ca5
+  metadata.gz: 5b8daca9efc17ba0da4cb70aa5e6f44960ee6e2b82205e84e690106e765655c75079d49033b929a8f77e0e8db5be4df1216ce1bc0ba602ce4a81f9d9c22802f0
+  data.tar.gz: 913060555b63ba9f2aff1e98ef2ee025a64dc442270a70285f9626ea87196be665bac45731c018e251cf9d86fe237844d3ba1c2b53fb8218e6772ddc247345ca

data/README.ja.md

@@ -1,7 +1,7 @@
 PseudoHikiParser
 ================
 
-PseudoHikiParserは[Hiki](http://hikiwiki.org/en/)に似た記法で書かれたテキストをHTMLその他のファイル形式に変換するコンバータです。
+PseudoHikiParserは[Hiki](https://github.com/hiki/hikidoc)に似た記法で書かれたテキストをHTML・Markdownその他のファイル形式に変換するコンバータです。
 
 このツールは次の目的を念頭において作成中です。
 
@@ -148,6 +148,45 @@ The first paragraph
 
 HtmlFormat以外にはXhtmlFormat、Xhtml5Format、PlainTextFormat、MarkDownFormatが用意されています。
 
+#### WikiNames
+
+もしWikiNameを利用したければ、PseudoHiki::AutoLink::[WikiName](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/autolink.rb#L11)クラスのインスタンスをBlockParser.newの引数、もしくはBlockParser.parseの第2引数として渡してやる必要があります。
+
+```ruby
+require 'pseudohiki/blockparser'
+require 'pseudohiki/htmlformat'
+require 'pseudohiki/autolink' # PseudoHiki::AutoLink::WikiName is defined in this file.
+
+text = <<TEXT
+a line with an ^EscapedWikiName and a WikiName.
+TEXT
+
+puts "--- with default options:"
+wiki_name_link = PseudoHiki::AutoLink::WikiName.new
+tree = PseudoHiki::BlockParser.parse(text, wiki_name_link)
+puts PseudoHiki::XhtmlFormat.format(tree)
+
+puts "--- when :escape_wiki_name option is set to true:"
+escape_wiki_name_link = PseudoHiki::AutoLink::WikiName.new({:escape_wiki_name => true})
+escaped_tree = PseudoHiki::BlockParser.parse(text, escape_wiki_name_link)
+puts PseudoHiki::XhtmlFormat.format(escaped_tree)
+```
+
+は次のように出力します。
+
+```
+--- with default options:
+<p>
+a line with an ^<a href="EscapedWikiName">EscapedWikiName</a> and a <a href="WikiName">WikiName</a>.
+</p>
+--- when :escape_wiki_name option is set to true:
+<p>
+a line with an EscapedWikiName and a <a href="WikiName">WikiName</a>.
+</p>
+```
+
+またもしデフォルトの動作が気に入らなければ、AutoLink::[WikiName](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/autolink.rb#L11)を置き換えるクラスあるいはモジュールを用意することもできます。
+
 ### PseudoHiki::Formatクラス
 
 PseudoHiki::BlockParser.parseで作られた構文木を使い回す必要がなければ、以下のPseudoHiki::Formatのクラスメソッドも利用可能です。
@@ -176,12 +215,12 @@ TEXT
 puts PseudoHiki::Format.to_html(hiki_text)
 ```
 
-## オリジナルの[Hiki記法](http://rabbit-shocker.org/en/hiki.html)にある機能の実装状況
+## オリジナルの[Hiki記法](https://github.com/hiki/hikidoc/blob/master/TextFormattingRules.ja.md)にある機能の実装状況
 
 * パラグラフ - 使いものになる
 * リンク
-  * WikiNames - 未サポート(実装予定なし)
-  * ページへのリンク - これも未サポート
+  * WikiNames - オプションとして提供されているが十分にテストされていない
+  * ページへのリンク - 未サポート
   * 任意のURLへのリンク - 一応使えるはず
 * 整形済みテキスト - 使いものになる
 * 文字の修飾 - 一部をサポート
@@ -254,7 +293,7 @@ And {{ and }} sould be rendered as two left curly braces and two right curly bra
 
 ```html
 <a href="http://www.example.org/image.png"><img alt="thumbnail of an image" src="http://www.example.org/image_thumb.png">
-</a></p>
+</a>
 ```
 
 ### 実験的な機能
@@ -287,13 +326,87 @@ paragraph
 </div>
 ```
 
+#### セクションの定義
+
+ドキュメントの一部を`//@begin[section\_name]`と`//@end[section\_name]`で囲むと、HtmlFormatとその派生クラスではこれらのタグが classまたはid属性の設定された\<div\>あるいは\<section\>要素に変換されます。
+
+```
+!! title
+
+paragraph 0
+
+//@begin[main-part]
+
+!!! main part subtitle 1
+
+paragraph 1
+
+!!! main part subtitle 2
+
+paragraph 2
+
+//@end[main-part]
+
+//@begin[additional-part]
+
+!!! additional part subtitle
+
+paragraph 3
+
+//@end[additional-part]
+
+```
+
+は次のように変換されます。
+
+```html
+<div class="section h2">
+<h2> title
+</h2>
+<p>
+paragraph 0
+</p>
+<div class="section main-part">
+<div class="section h3">
+<h3> main part subtitle 1
+</h3>
+<p>
+paragraph 1
+</p>
+<!-- end of section h3 -->
+</div>
+<div class="section h3">
+<h3> main part subtitle 2
+</h3>
+<p>
+paragraph 2
+</p>
+<!-- end of section h3 -->
+</div>
+<!-- end of section main-part -->
+</div>
+<div class="section additional-part">
+<div class="section h3">
+<h3> additional part subtitle
+</h3>
+<p>
+paragraph 3
+</p>
+<!-- end of section h3 -->
+</div>
+<!-- end of section additional-part -->
+</div>
+<!-- end of section h2 -->
+</div>
+```
+
 ### 未実装の機能
 
 ## Visitorクラス
 
 以下のクラスのうちの一部は、部分的にしか実装されていないかテストが十分ではないことにご注意ください。
 
-### [HtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L8), [XhtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L263)
+### [HtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L8), [XhtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L312)
 
 これらのクラスのクラスメソッド(HtmlFormat|XhtmlFormat).formatは[HtmlElement](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/htmlelement.rb)オブジェクトを木にしたものを返すため、以下の例のように後から手を加えることができます。
 
@@ -337,11 +450,11 @@ paragraph 2 that contains <a class="pdf" href="http://www.example.org/example.pd
 </div>
 ```
 
-### [Xhtml5Format](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L268)
+### [Xhtml5Format](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L318)
 
 HTML5への変換用のVisitorクラスです。
 
-現時点では\<section\>要素の扱い以外に[XhtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L263)との違いは余りありません。
+現時点では\<section\>要素の扱い以外に[XhtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L312)との違いは余りありません。
 
 ### [PlainTextFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/plaintextformat.rb)  
 
@@ -433,3 +546,14 @@ The first paragraph
 |_cell 1_|cell2   |
 ```
 
+#### 制限事項
+
+このVisitorクラスではきちんと構成されていないリストを変換できません。リストの項目は階層に従った入れ子になっていなければならず、もし入れ子のレベルに飛びがあると変換結果がおかしくなります。
+
+以下が最初のレベルを飛ばしてしまいきちんと構成されていないリストの例です。
+
+```
+**First item
+**Second item
+```
+

data/README.md

@@ -1,7 +1,7 @@
 PseudoHikiParser
 ================
 
-PseudoHikiParser is a converter of texts written in a [Hiki](http://hikiwiki.org/en/) like notation, into HTML or other formats. 
+PseudoHikiParser is a converter of texts written in a [Hiki](https://github.com/hiki/hikidoc) like notation, into HTML, Markdown or other formats.
 
 I am writing this tool with following objectives in mind,
 
@@ -148,6 +148,45 @@ In the example above, HtmlFormat is a visitor class that converts the parsed tex
 
 Other than HtmlFormat, XhtmlFormat, Xhtml5Format, PlainTextFormat and MarkDownFormat are available.
 
+#### WikiNames
+
+If you want to use WikiNames, you have to pass an instance of PseudoHiki::AutoLink::[WikiName](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/autolink.rb#L11) as the argument of BlockParser.new or the second argument of BlockParser.parse.
+
+```ruby
+require 'pseudohiki/blockparser'
+require 'pseudohiki/htmlformat'
+require 'pseudohiki/autolink' # PseudoHiki::AutoLink::WikiName is defined in this file.
+
+text = <<TEXT
+a line with an ^EscapedWikiName and a WikiName.
+TEXT
+
+puts "--- with default options:"
+wiki_name_link = PseudoHiki::AutoLink::WikiName.new
+tree = PseudoHiki::BlockParser.parse(text, wiki_name_link)
+puts PseudoHiki::XhtmlFormat.format(tree)
+
+puts "--- when :escape_wiki_name option is set to true:"
+escape_wiki_name_link = PseudoHiki::AutoLink::WikiName.new({:escape_wiki_name => true})
+escaped_tree = PseudoHiki::BlockParser.parse(text, escape_wiki_name_link)
+puts PseudoHiki::XhtmlFormat.format(escaped_tree)
+```
+
+will print
+
+```
+--- with default options:
+<p>
+a line with an ^<a href="EscapedWikiName">EscapedWikiName</a> and a <a href="WikiName">WikiName</a>.
+</p>
+--- when :escape_wiki_name option is set to true:
+<p>
+a line with an EscapedWikiName and a <a href="WikiName">WikiName</a>.
+</p>
+```
+
+And if you don't like the default behavior, you may prepare a class/module that substitutes AutoLink::[WikiName](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/autolink.rb#L11).
+
 ### class PseudoHiki::Format
 
 If you don't need to reuse a tree parsed by PseudoHiki::BlockParser.parse, you can use following class methods of PseudoHiki::Format.
@@ -176,12 +215,12 @@ TEXT
 puts PseudoHiki::Format.to_html(hiki_text)
 ```
 
-## Development status of features from the original [Hiki notation](http://rabbit-shocker.org/en/hiki.html)
+## Development status of features from the original [Hiki notation](https://github.com/hiki/hikidoc/blob/master/TextFormattingRules.md)
 
 * Paragraphs - Usable
 * Links
-  * WikiNames - Not supported (and would never be)
-  * Linking to other Wiki pages - Not supported as well
+  * WikiNames - Provided as an option but not tested well
+  * Linking to other Wiki pages - Not supported
   * Linking to an arbitrary URL - Maybe usable
 * Preformatted text - Usable
 * Text decoration - Partly supported
@@ -254,12 +293,12 @@ will be rendered as
 
 ```html
 <a href="http://www.example.org/image.png"><img alt="thumbnail of an image" src="http://www.example.org/image_thumb.png">
-</a></p>
+</a>
 ```
 
 ### Experimental
 
-The following feature is just experimental and available only in [develop branch](https://github.com/nico-hn/PseudoHikiParser/tree/develop).
+The following features are just experimental and available only in [develop branch](https://github.com/nico-hn/PseudoHikiParser/tree/develop).
 
 #### Decorator for blocks
 
@@ -274,7 +313,7 @@ For example,
 paragraph
 ```
 
-will be renderes as
+will be rendered as
 
 ```html
 <div class="class_name">
@@ -287,13 +326,87 @@ paragraph
 </div>
 ```
 
+#### Defining sections
+
+When a certain part of a document is enclosed by `//@begin[section\_name]` and `//@end[section\_name]`, HtmlFormat and its subclasses will convert the tags into \<div\> or \<section\> elements with id or class attributes.
+
+```
+!! title
+
+paragraph 0
+
+//@begin[main-part]
+
+!!! main part subtitle 1
+
+paragraph 1
+
+!!! main part subtitle 2
+
+paragraph 2
+
+//@end[main-part]
+
+//@begin[additional-part]
+
+!!! additional part subtitle
+
+paragraph 3
+
+//@end[additional-part]
+
+```
+
+will be rendered as
+
+```html
+<div class="section h2">
+<h2> title
+</h2>
+<p>
+paragraph 0
+</p>
+<div class="section main-part">
+<div class="section h3">
+<h3> main part subtitle 1
+</h3>
+<p>
+paragraph 1
+</p>
+<!-- end of section h3 -->
+</div>
+<div class="section h3">
+<h3> main part subtitle 2
+</h3>
+<p>
+paragraph 2
+</p>
+<!-- end of section h3 -->
+</div>
+<!-- end of section main-part -->
+</div>
+<div class="section additional-part">
+<div class="section h3">
+<h3> additional part subtitle
+</h3>
+<p>
+paragraph 3
+</p>
+<!-- end of section h3 -->
+</div>
+<!-- end of section additional-part -->
+</div>
+<!-- end of section h2 -->
+</div>
+```
+
 ### Not Implemented Yet
 
 ## Visitor classes
 
 Please note that some of the following classes are implemented partly or not tested well.
 
-### [HtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L8), [XhtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L263)
+### [HtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L8), [XhtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L312)
 
 Their class method (HtmlFormat|XhtmlFormat).format returns a tree of [HtmlElement](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/htmlelement.rb) objects, and you can traverse the tree as in the following example.
 
@@ -337,11 +450,11 @@ paragraph 2 that contains <a class="pdf" href="http://www.example.org/example.pd
 </div>
 ```
 
-### [Xhtml5Format](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L268)
+### [Xhtml5Format](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L318)
 
 This visitor is for HTML5.
 
-Currently there aren't many differences with [XhtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L263) exept for the treatment of \<section\> elements.
+Currently there aren't many differences with [XhtmlFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L312) except for the handling of \<section\> elements.
 
 ### [PlainTextFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/plaintextformat.rb)  
 
@@ -433,3 +546,14 @@ The first paragraph
 |_cell 1_|cell2   |
 ```
 
+#### Limitations
+
+You can not convert malformed lists with this visitor class. That means list items must be nested hierarchically and if you skip a level in the sequence of items, the result of coversions will be corrupted.
+
+The following is an example of malformed list in which the first level is skipped:
+
+```
+**First item
+**Second item
+```
+

data/lib/htmlelement.rb

@@ -24,8 +24,8 @@ class HtmlElement
     LATIN1 = "ISO-8859-1"
   end
 
-  DOCTYPE = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-  "http://www.w3.org/TR/html4/loose.dtd">'.split(/\r?\n/o).join($/)+"#{$/}"
+  @doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+  "http://www.w3.org/TR/html4/loose.dtd">'.gsub(/\r?\n/o, $/) + $/
 
   ESC = {
     '&' => '&amp;',
@@ -35,9 +35,9 @@ class HtmlElement
   }
 
   DECODE = ESC.invert
-  CharEntityPat = /#{DECODE.keys.join("|")}/
-  
-  Html5Tags = %w(article section hgroup aside nav menu header footer figure details legend)
+  @char_entity_pat = /#{DECODE.keys.join("|")}/
+
+  HTML5_TAGS = %w(article section hgroup aside nav menu header footer figure details legend)
 
   ELEMENT_TYPES = {
     :BLOCK => %w(html body div table colgroup thead tbody ul ol dl head p pre blockquote style),
@@ -45,40 +45,40 @@ class HtmlElement
     :LIST_ITEM_TYPE_BLOCK => %w(li col),
     :EMPTY_BLOCK => %w(img meta link base input hr)
   }
-  
+
   ELEMENTS_FORMAT = {
-    :INLINE => "<%s%s>%s</%s>",
-    :BLOCK => "<%s%s>#{$/}%s</%s>#{$/}",
-    :HEADING_TYPE_BLOCK => "<%s%s>%s</%s>#{$/}",
-    :LIST_ITEM_TYPE_BLOCK => "<%s%s>%s#{$/}",
-    :EMPTY_BLOCK => "<%s%s>#{$/}"
+    :INLINE => "<%1$s%2$s>%3$s</%1$s>",
+    :BLOCK => "<%1$s%2$s>#{$/}%3$s</%1$s>#{$/}",
+    :HEADING_TYPE_BLOCK => "<%1$s%2$s>%3$s</%1$s>#{$/}",
+    :LIST_ITEM_TYPE_BLOCK => "<%1$s%2$s>%3$s#{$/}",
+    :EMPTY_BLOCK => "<%1$s%2$s>#{$/}"
   }
 
   attr_reader :tagname
   attr_accessor :parent, :children
 
   def self.doctype(encoding="UTF-8")
-    self::DOCTYPE%[encoding]
+    format(@doctype, encoding)
   end
 
   def self.create(tagname, content=nil, attributes={})
-    if self::Html5Tags.include? tagname
+    if self::HTML5_TAGS.include? tagname
       attributes["class"] = tagname
       tagname = "div"
     end
-    self.new(tagname, content, attributes)
+    new(tagname, content, attributes)
   end
 
-  def HtmlElement.comment(content)
+  def self.comment(content)
     "<!-- #{content} -->#{$/}"
   end
 
-  def HtmlElement.urlencode(str)
-    str.toutf8.gsub(/[^\w\.\-]/o) {|utf8_char| utf8_char.unpack("C*").map {|b| '%%%02X'%[b] }.join }
+  def self.urlencode(str)
+    str.toutf8.gsub(/[^\w\.\-]/o) {|utf8_char| utf8_char.unpack("C*").map {|b| format('%%%02X', b) }.join }
   end
 
-  def HtmlElement.urldecode(str)
-    utf = str.gsub(/%\w\w/) {|ch| [ch[-2,2]].pack('H*') }.toutf8
+  def self.urldecode(str)
+    utf = str.gsub(/%\w\w/) {|ch| [ch[-2, 2]].pack('H*') }.toutf8
     return utf.tosjis if $KCODE =~ /^s/io
     return utf.toeuc if $KCODE =~ /^e/io
     utf
@@ -93,15 +93,15 @@ class HtmlElement
     tagformats
   end
 
-  def HtmlElement.escape(str)
+  def self.escape(str)
     str.gsub(/[&"<>]/o) {|pat| ESC[pat] }
   end
 
-  def HtmlElement.decode(str)
-    str.gsub(CharEntityPat) {|ent| DECODE[ent]}
+  def self.decode(str)
+    str.gsub(@char_entity_pat) {|ent| DECODE[ent] }
   end
 
-  TagFormats = self.assign_tagformats
+  TagFormats = assign_tagformats
 
   def initialize(tagname, content=nil, attributes={})
     @parent = nil
@@ -133,25 +133,25 @@ class HtmlElement
   def [](attribute)
     @attributes[attribute]
   end
-  
+
   def format_attributes
-    @attributes.collect do |attr,value|
-      ' %s="%s"'%[attr,HtmlElement.escape(value.to_s)]
+    @attributes.collect do |attr, value|
+      " #{attr}=\"#{HtmlElement.escape(value.to_s)}\""
     end.sort.join
   end
   private :format_attributes
 
   def add_end_comment_for_div_or_section
     if @tagname == "div" or @tagname == "section" and @end_comment_not_added
-      id_or_class = self["id"]||self["class"]
-      self.push HtmlElement.comment("end of #{id_or_class}") if id_or_class
+      id_or_class = self["id"] || self["class"]
+      push HtmlElement.comment("end of #{id_or_class}") if id_or_class
       @end_comment_not_added = false
     end
   end
 
   def to_s
     add_end_comment_for_div_or_section
-    self.class::TagFormats[@tagname]%[@tagname, format_attributes, @children, @tagname]
+    format(self.class::TagFormats[@tagname], @tagname, format_attributes, @children)
   end
   alias to_str to_s
 
@@ -160,26 +160,26 @@ class HtmlElement
     @children.traverse(&block)
   end
 end
-  
+
 class XhtmlElement < HtmlElement
-  DOCTYPE = '<?xml version="1.0" encoding="%s"?>
+  @doctype = '<?xml version="1.0" encoding="%s"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'.split(/\r?\n/o).join($/)+"#{$/}"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'.gsub(/\r?\n/o, $/) + $/
 
-  ELEMENTS_FORMAT = self.superclass::ELEMENTS_FORMAT.dup
-  ELEMENTS_FORMAT[:LIST_ITEM_TYPE_BLOCK] = "<%s%s>%s</%s>#{$/}"
-  ELEMENTS_FORMAT[:EMPTY_BLOCK] = "<%s%s />#{$/}"
+  ELEMENTS_FORMAT = superclass::ELEMENTS_FORMAT.dup
+  ELEMENTS_FORMAT[:LIST_ITEM_TYPE_BLOCK] = "<%1$s%2$s>%3$s</%1$s>#{$/}"
+  ELEMENTS_FORMAT[:EMPTY_BLOCK] = "<%1$s%2$s />#{$/}"
 
-  TagFormats = self.assign_tagformats
+  TagFormats = assign_tagformats
 end
 
 class Xhtml5Element < XhtmlElement
-  DOCTYPE = '<?xml version="1.0" encoding="%s"?>
-<!DOCTYPE html>'.split(/\r?\n/o).join($/)+"#{$/}"
+  @doctype = '<?xml version="1.0" encoding="%s"?>
+<!DOCTYPE html>'.gsub(/\r?\n/o, $/) + $/
 
-  ELEMENT_TYPES = self.superclass::ELEMENT_TYPES.dup
-  ELEMENT_TYPES[:BLOCK] = self.superclass::ELEMENT_TYPES[:BLOCK] + self.superclass::Html5Tags
-  Html5Tags = %w(main)
+  ELEMENT_TYPES = superclass::ELEMENT_TYPES.dup
+  ELEMENT_TYPES[:BLOCK] = superclass::ELEMENT_TYPES[:BLOCK] + superclass::HTML5_TAGS
+  HTML5_TAGS = %w(main)
 
-  TagFormats = self.assign_tagformats
+  TagFormats = assign_tagformats
 end

data/lib/pseudohiki/autolink.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require 'pseudohiki/blockparser'
+
+module PseudoHiki
+  module AutoLink
+    # WIKI_NAME_RE is borrowed from hikidoc
+    WIKI_NAME_RE = /\^?\b(?:[A-Z]+[a-z\d]+){2,}\b/
+    ESCAPE_CHAR = "^"
+
+    class WikiName
+      @default_options = {
+        :url => true,
+        :wiki_name => true,
+        :escape_wiki_name => true
+      }
+
+      def self.default_options
+        @default_options
+      end
+
+      def initialize(options={})
+        @options = WikiName.default_options.dup.merge!(options)
+        @auto_linker = @options[:url] ? URL : Off
+      end
+
+      def auto_link_url?
+        @options[:url]
+      end
+
+      def escaped_wiki_name?(wiki_name)
+        @options[:escape_wiki_name] and wiki_name.start_with?(ESCAPE_CHAR)
+      end
+
+      def in_link_tag?(preceding_str)
+        URL.in_link_tag?(preceding_str)
+      end
+
+      def add_tag(url)
+        if escaped_wiki_name?(url)
+          url[1..-1]
+        elsif url.start_with?(ESCAPE_CHAR)
+          "^[[#{url[1..-1]}]]"
+        else
+          "[[#{url}]]"
+        end
+      end
+
+      def link_wiki_name(line)
+        return line if WIKI_NAME_RE !~ line or VERBATIM_LEAF_HEAD_RE =~ line
+        line.gsub(WIKI_NAME_RE) {|url| in_link_tag?($`) ? url : add_tag(url) }
+      end
+
+      def link(line)
+        line = @auto_linker.link(line)
+        @options[:wiki_name] ? link_wiki_name(line) : line
+      end
+    end
+  end
+end