PseudoHikiParser - 源码 - 源码 - 免费下载

PseudoHikiParser

文件大小： unknow

源码售价： 5 个金币积分规则积分充值

资源说明：

PseudoHikiParser
================

PseudoHikiParser parses texts written in a [Hiki](https://github.com/hiki/hikidoc) like notation, and converts them into HTML, Markdown or other formats.

I am writing this tool with following objectives in mind,

* provide some additional features that do not exist in the original Hiki notation
  * make the notation more line oriented
  * allow to assign ids to elements such as headings
* support several formats other than HTML
  * The visitor pattern is adopted for the implementation, so you only have to add a visitor class to support a certain format.

And, it would not be compatible with the original Hiki notation.

## License

BSD 2-Clause License

## Installation

```
gem install pseudohikiparser
```

or if you also want to try out experimental features,

```
gem install pseudohikiparser --version 0.0.6.develop
```

## Usage

### Samples

* [A sample text](https://github.com/nico-hn/PseudoHikiParser/blob/develop/samples/wikipage.txt) in Hiki notation

And results of conversion

* [HTML 4.01](http://htmlpreview.github.com/?https://github.com/nico-hn/PseudoHikiParser/blob/develop/samples/wikipage.html)
* [XHTML 1.0](http://htmlpreview.github.com/?https://github.com/nico-hn/PseudoHikiParser/blob/develop/samples/wikipage_with_toc.html)
* [HTML5](http://htmlpreview.github.com/?https://github.com/nico-hn/PseudoHikiParser/blob/develop/samples/wikipage_html5_with_toc.html)
* [GFM](https://github.com/nico-hn/PseudoHikiParser/blob/develop/samples/wikipage.md)

You will find these samples in [develop branch](https://github.com/nico-hn/PseudoHikiParser/tree/develop/samples).

### pseudohiki2html

_(Please note that pseudohiki2html is currently provided as a showcase of PseudoHikiParser, and the options will be continuously changed at this stage of development.)_

After the installation of PseudoHikiParser, you can use a command: **pseudohiki2html**.

Type the following lines at the command prompt:

```
pseudohiki2html <





-




 The first heading


The first paragraph





```

And if you specify a file name with `--output` option:

```
pseudohiki2html --output first_example.html <
 The first heading


The first paragraph

``` In the example above, HtmlFormat is a visitor class that converts the parsed text into HTML 4.01 format. 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 = < true}) escaped_tree = PseudoHiki::BlockParser.parse(text, escape_wiki_name_link) puts PseudoHiki::XhtmlFormat.format(escaped_tree) ``` will print ``` --- with default options:

a line with an ^EscapedWikiName and a WikiName.

--- when :escape_wiki_name option is set to true:

a line with an EscapedWikiName and a WikiName.

``` 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. |Method name |Result of conversion | |------------|------------------------| |to\_html |HTML 4.01 | |to\_xhtml |XHTML 1.0 | |to\_html5 |HTML 5 | |to\_plain |plain text | |to\_markdown|Markdown | |to\_gfm |Github Flavored Markdown| For example, the script below returns the same result as the example of [PseudoHiki::BlockParser](#class-pseudohikiblockparser) ```ruby #!/usr/bin/env ruby require 'pseudohikiparser' hiki_text = < element but \ element. * Headings - Usable * Horizontal lines - Usable * Lists - Usable * Quotations - Usable * Definitions - Usable * Tables - Usable * Comments - Usable * Plugins - Not supported (and will not be compatible with the original one) ## Additional Features ### Assigning ids If you add [name\_of\_id], just after the marks that denote heading or list type items, it becomes the id attribute of resulting html elements. Below is an example. ``` !![heading_id]heading *[list_id]list ``` will be rendered as ```html

heading

list

``` ### Escaping tags for inline decorations _(Please note that this is just an experimental feature.)_ Tags for inline decorations are escaped when they are enclosed in plugin tags: ``` For example, {{''}} and {{==}} can be escaped. And {{ {}} and {{} }} should be rendered as two left curly braces and two right curly braces respectively. ``` will be rendered as ``` For example, '' or == can be escaped. And {{ and }} sould be rendered as two left curly braces and two right curly braces respectively. ``` ### Nesting of link tags If a link tag is nested inside another link tag, the outer tag is always treated as a link even when its url is for an image. So you can make a link from a thumbnail as in the following example. ``` [[[[thumbnail of an image|http://www.example.org/image_thumb.png]]|http://www.example.org/image.png]] ``` will be rendered as ```html

``` ### Experimental The following features are just experimental and available only in [develop branch](https://github.com/nico-hn/PseudoHikiParser/tree/develop). #### Decorator for blocks By lines that begin with '//@', you can assign certain attributes to its succeeding block. For example, ``` //@class[class_name] !!A section with a class name paragraph ``` will be rendered as ```html

A section with a class name

paragraph

``` #### 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 \ or \ 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

title

paragraph 0

main part subtitle 1

paragraph 1

main part subtitle 2

paragraph 2

additional part subtitle

paragraph 3

``` ### 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#L320) 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. ```ruby #!/usr/bin/env ruby require 'pseudohikiparser' hiki_text = <

heading

paragraph 1 that contains a link to a html file

paragraph 2 that contains a link to a pdf file

``` ### [Xhtml5Format](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/htmlformat.rb#L326) 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#L320) except for the handling of \ elements. ### [PlainTextFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/plaintextformat.rb) This visitor removes markups from its input and returns plain texts. Below are examples ``` :tel:03-xxxx-xxxx ::03-yyyy-yyyy :fax:03-xxxx-xxxx ``` will be rendered as ``` tel: 03-xxxx-xxxx 03-yyyy-yyyy fax: 03-xxxx-xxxx ``` And ``` ||cell 1-1||>>cell 1-2,3,4||cell 1-5 ||cell 2-1||^>cell 2-2,3 3-2,3||cell 2-4||cell 2-5 ||cell 3-1||cell 3-4||cell 3-5 ||cell 4-1||cell 4-2||cell 4-3||cell 4-4||cell 4-5 ``` will be rendered as ``` cell 1-1 cell 1-2,3,4 == == cell 1-5 cell 2-1 cell 2-2,3 3-2,3 == cell 2-4 cell 2-5 cell 3-1 || || cell 3-4 cell 3-5 cell 4-1 cell 4-2 cell 4-3 cell 4-4 cell 4-5 ``` ### [MarkDownFormat](https://github.com/nico-hn/PseudoHikiParser/blob/develop/lib/pseudohiki/markdownformat.rb) This visitor is for (Git Flavored) Markdown and just in experimental stage. The following are a sample script and its output: ```ruby #!/usr/bin/env ruby require 'pseudohiki/markdownformat' md = PseudoHiki::MarkDownFormat.create gfm = PseudoHiki::MarkDownFormat.create(gfm_style: true) hiki = < header 1header 2 cell 1cell2 -------------------- ## The first heading The first paragraph |header 1|header 2| |--------|--------| |_cell 1_|cell2 | ``` #### Limitations You cannot 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 ```