hikidoc 0.0.1

data/COPYING

@@ -0,0 +1,28 @@
+Copyright (c) 2005, Kazuhiko <kazuhiko@fdiary.net>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+    * Neither the name of the HikiDoc nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,85 @@
+! HikiDoc
+
+!! Introduction
+
+'HikiDoc' is a text-to-HTML conversion tool for web writers. HikiDoc
+allows you to write using an easy-to-read, easy-to-write plain text
+format, then convert it to structurally valid HTML (or XHTML).
+
+!! Requirements
+
+HikiDoc requires Ruby 1.8.2 or later.
+
+!! Download
+
+Get from the subversion repository http://hikidoc.rubyforge.org/svn/ .
+
+ (eg.)
+ svn co http://hikidoc.rubyforge.org/svn/trunk/ hikidoc
+
+!! Installation 
+
+Run the 'setup.rb' script like so:
+
+ $ ruby setup.rb config
+ $ ruby setup.rb setup
+ # ruby setup.rb install
+
+!! Syntax
+
+See [[TextFormattingRules]].
+
+!! Mailing list
+
+To subscribe the HikiDoc ML, please send the following mail. English
+posts are also welcome.
+  
+ To: hikidoc@ml.fdiary.net
+ Cc: kazuhiko@fdiary.net
+ Subject: subscribe        <- any subject
+ 
+ Hello.                    <- any body
+
+HikiDoc ML's archive is available at http://www.fdiary.net/ml/hikidoc/ .
+
+!! Related softwares
+
+The following softwares use the HikiDoc library.
+
+:[[tDiary|http://www.tdiary.org/]]:a Weblog/Web-diary software
+:[[Hiki|http://hikiwiki.org/]]:a powerful and fast wiki clone
+:[[lily|http://lily.sourceforge.jp/]]:a simple CMS
+:[[HikiDoc.pm|http://haro.jp/wiki/index.cgi?page=B%27s+Soft#p2]]:HikiDoc by Perl
+
+!! License
+
+HikiDoc's license is the 'Modified BSD License'.
+
+ Copyright (c) 2005, Kazuhiko <kazuhiko@fdiary.net>
+ All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are
+ met:
+ 
+     * Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+     * Redistributions in binary form must reproduce the above
+       copyright notice, this list of conditions and the following
+       disclaimer in the documentation and/or other materials provided
+       with the distribution.
+     * Neither the name of the HikiDoc nor the names of its
+       contributors may be used to endorse or promote products derived
+       from this software without specific prior written permission.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.ja

@@ -0,0 +1,82 @@
+! HikiDoc
+
+!! �Ϥ����
+
+'HikiDoc' �ϡ֥ƥ����Ȣ� HTML���Ѵ��ġ���Ǥ����񤭤䤹���ɤߤ䤹��ʸˡ��
+�ƥ����Ȥ�ޤȤ�� HTML (�� XHTML) ���Ѵ����ޤ���
+
+!! ɬ�פʤ��
+
+HikiDoc �μ¹Ԥˤ� Ruby 1.8.2 �ʹߤ�ɬ�פǤ���
+
+!! �����������
+
+Subversion ��ݥ��ȥ� http://hikidoc.rubyforge.org/svn/ �����������
+����������
+
+ (��)
+ svn co http://hikidoc.rubyforge.org/svn/trunk/ hikidoc
+
+!! ���󥹥ȡ���
+
+�ʲ��Τ褦�� 'setup.rb' ������ץȤ��Ѥ��ƥ��󥹥ȡ��뤷�ޤ���
+
+ $ ruby setup.rb config
+ $ ruby setup.rb setup
+ # ruby setup.rb install
+
+!! ʸˡ
+
+[[TextFormattingRules.ja]] ��������������
+
+!! �᡼��󥰥ꥹ��
+
+���ä��˾��������ϡ��ʲ��Τ褦�ʥ᡼����������Ƥ���������
+ To: hikidoc@ml.fdiary.net
+ Cc: kazuhiko@fdiary.net
+ 
+ ��ʸ�˼��ʾҲ�ʤ�
+
+���Υ᡼��� http://www.fdiary.net/ml/hikidoc/ �Ǹ������Ƥ��ޤ���
+
+!! ��Ϣ���륽�եȥ�����
+
+�ʲ��Υ��եȥ������� HikiDoc �饤�֥�꤬�Ѥ����Ƥ��ޤ���
+
+:[[tDiary|http://www.tdiary.org/]]:�������������եȥ�����
+:[[Hiki|http://hikiwiki.org/]]:¿��ǽ���Ĺ�®�� Wiki ��������
+:[[lily|http://lily.sourceforge.jp/]]:����ץ�� CMS (Web �����ȹ��ۥ����ƥ�)
+:[[HikiDoc.pm|http://haro.jp/wiki/index.cgi?page=B%27s+Soft#p2]]:Perl �ˤ�� HikiDoc �μ���
+
+!! �饤����
+
+Modified BSD �饤���󥹤Ǥ���
+
+ Copyright (c) 2005, Kazuhiko <kazuhiko@fdiary.net>
+ All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are
+ met:
+ 
+     * Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+     * Redistributions in binary form must reproduce the above
+       copyright notice, this list of conditions and the following
+       disclaimer in the documentation and/or other materials provided
+       with the distribution.
+     * Neither the name of the HikiDoc nor the names of its
+       contributors may be used to endorse or promote products derived
+       from this software without specific prior written permission.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,48 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+require 'find'
+
+base_dir = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(base_dir, 'lib'))
+require 'hikidoc'
+
+truncate_base_dir = Proc.new do |x|
+  x.gsub(/\A#{Regexp.escape(base_dir + File::SEPARATOR)}/, '')
+end
+
+manifest = File.join(base_dir, "Manifest.txt")
+manifest_contents = []
+base_dir_included_components = %w(COPYING README README.ja Rakefile
+                                  TextFormattingRules TextFormattingRules.ja
+                                  setup.rb)
+excluded_components = %w(.svn doc log pkg)
+Find.find(base_dir) do |target|
+  target = truncate_base_dir[target]
+  components = target.split(File::SEPARATOR)
+  if components.size == 1 and !File.directory?(target)
+    next unless base_dir_included_components.include?(components[0])
+  end
+  Find.prune if (excluded_components - components) != excluded_components
+  manifest_contents << target if File.file?(target)
+end
+
+File.open(manifest, "w") do |f|
+  f.puts manifest_contents.sort.join("\n")
+end
+at_exit do
+  FileUtils.rm_f(manifest)
+end
+
+ENV["VERSION"] ||= HikiDoc::VERSION
+project = Hoe.new('hikidoc', HikiDoc::VERSION) do |project|
+  project.author = ['Kazuhiko']
+  project.email = ['kazuhiko@fdiary.net']
+  project.description = project.paragraphs_of('README', 2).join
+  project.summary = project.description.split(/(\.)/, 3)[0, 2].join
+  project.url = 'http://rubyforge.org/projects/hikidoc/'
+  project.test_globs = ['test/test_*.rb']
+  project.rdoc_pattern = /(?:^(?:lib|bin)|\AREADME\z)/
+end

data/TextFormattingRules

@@ -0,0 +1,316 @@
+!Paragraphs
+
+Consecutive lines are concatenated into a single paragraph.
+
+Blank lines (ones with only a carriage return or with only spaces and tabs) mark the end of a paragraph.
+
+*Example statement
+
+ For example,
+ if I write like this, these lines
+ will be formatted as one paragraph.
+
+*Example output
+
+For example,
+if I write like this, these lines
+will be formatted as one paragraph.
+
+!Links
+
+!!WikiNames
+
+WikiNames are comprised of two or more words put together; each word begins with an uppercase letter, and is followed by at least one lowercase letter or number.
+
+Words in which this condition is met become a WikiName, and a link is automatically attached.
+
+*Example statement
+
+ WikiName     - WikiName
+ HogeRule1    - WikiName
+ NOTWIKINAME  - All of the letters are uppercase, so this is not a WikiName
+ WikiNAME     - All of the letters in NAME are uppercase, so this is not a WikiName
+ fooWikiName  - This begins with "foo", which is in all lowercase, so this is not a WikiName
+
+*Example output
+
+**WikiName     - WikiName
+**HogeRule1    - WikiName
+**NOTWIKINAME  - All of the letters are uppercase, so this is not a WikiName
+**WikiNAME     - All of the letters in NAME are uppercase, so this is not a WikiName
+**fooWikiName  - This begins with "foo", which is in all lowercase, so this is not a WikiName
+
+You can disable an auto WikiName link by prepending ''^'' to the WikiName.
+
+*Example statement
+
+ WikiName     - WikiName
+ ^WikiName    - Disable WikiName link
+
+*Example output
+
+**WikiName     - WikiName
+**^WikiName    - Disable WikiName link
+
+!!Linking to other Wiki pages
+
+If a page name is surrounded with two pairs of brackets, it becomes a link to that page.
+
+*Example statement
+
+ For example, if you write [[TextFormattingRules]], it becomes a link to that page.
+
+*Example output
+
+For example, if you write [[TextFormattingRules]], it becomes a link to that page.
+
+!!Linking to an arbitrary URL
+
+If a phrase and URL, separated by a vertical line, are surrounded with two pairs of brackets, it becomes a link to an arbitrary URL.
+
+*Example statement
+
+ Links like [[Yahoo!|http://www.yahoo.com/]] are also possible.
+
+*Example output
+
+Links like [[Yahoo!|http://www.yahoo.com/]] are also possible.
+
+Text in a paragraph that looks like a URL will automatically become a link.
+
+*Example statement
+
+ Hiki's home page is http://hikiwiki.org/en/ (English).
+
+*Example output
+
+Hiki's home page is http://hikiwiki.org/en/ (English).
+
+In this case, if the URL ends with jpg., .jpeg, .png, or .gif, the image is displayed on the page.
+
+*Example statement
+
+ http://jp.rubyist.net/theme/clover/clover_h1.png
+
+*Example output
+
+http://jp.rubyist.net/theme/clover/clover_h1.png
+
+!Preformatted text
+
+Lines beginning with spaces or tabs will be treated as preformatted text.
+
+*Example output
+
+ require 'cgi'
+ 
+ cgi = CGI::new
+ cgi.header
+ 
+ puts <<EOS
+ <html>
+   <head>
+     <title>Hello!</title>
+   </head>
+   <body>
+   <p>Hello!</p>
+   </body>
+ </html>
+ EOS
+
+!Text decoration
+
+Text surrounded by sets of two single quotes ('') is emphasized.
+
+Text surrounded by sets of three single quotes (''') is strongly emphasized.
+
+Text surrounded by sets of double equal signs (===) is struck out.
+
+*Example statement
+
+ If you write like this, it becomes ''emphasized''.
+ And if you write like this, it becomes '''strongly emphasized'''.
+ ==This is dull, but== And struck-out text is supported, too!
+
+*Example output
+
+If you write like this, it becomes ''emphasized''.
+And if you write like this, it becomes '''strongly emphasized'''.
+==This is dull, but== And struck-out text is supported, too!
+
+!Headings
+
+Lines with exclamation marks at the beginning become headings.
+
+One can use up to six exclamation marks; they will be converted to <h1> to <h6> tags.
+
+*Example statement
+
+ !Heading1
+ !!Heading2
+ !!!Heading3
+ !!!!Heading4
+ !!!!!Heading5
+
+*Example output
+
+!Heading1
+!!Heading2
+!!!Heading3
+!!!!Heading4
+!!!!!Heading5
+
+!Horizontal lines
+
+Four hyphens at the beginning of the line (----) become a horizontal rule.
+
+*Example statement
+
+ A B C D E
+ ----
+ F G H I J
+
+*Example output
+
+A B C D E
+----
+F G H I J
+
+!Lists
+
+Lines beginning with asterisks become list items.
+
+It is possible to use up to three asterisks; it is also possible to create nested lists.
+
+Lines beginning with a # become numbered lists.
+
+*Example statement
+
+ *Item 1
+ **Item 1.1
+ **Item 1.2
+ ***Item 1.2.1
+ ***Item 1.2.2
+ ***Item 1.2.3
+ **Item 1.3
+ **Item 1.4
+ *Item 2
+
+ #Item 1
+ #Item 2
+ ##Item 2.1
+ ##Item 2.2
+ ##Item 2.3
+ #Item 3
+ ##Item 3.1
+ ###Item 3.1.1
+ ###Item 3.1.2
+
+*Example output
+
+*Item 1
+**Item 1.1
+**Item 1.2
+***Item 1.2.1
+***Item 1.2.2
+***Item 1.2.3
+**Item 1.3
+**Item 1.4
+*Item 2
+
+#Item 1
+#Item 2
+##Item 2.1
+##Item 2.2
+##Item 2.3
+#Item 3
+##Item 3.1
+###Item 3.1.1
+###Item 3.1.2
+
+!Quotations
+
+Lines beginning with two double quotes become quotations.
+
+*Example statement
+
+ ""This is a quotation.
+ ""This is another quote.
+ ""This is a continued quote.  When there are consecutive quotations,
+ ""they are displayed as one quote,
+ ""like this.
+
+*Example output
+
+""This is a quotation.
+""This is another quote.
+""This is a continued quote.  When there are consecutive quotations,
+""they are displayed as one quote,
+""like this.
+
+!Definitions
+
+Lines beginning with a colon and have a phrase and explanation separated by another colon will become a definition.
+
+*Example statement
+
+ :ringo:apple
+ :gorira:gorilla
+ :rakuda:camel
+
+*Example output
+
+:ringo:apple
+:gorira:gorilla
+:rakuda:camel
+
+! Tables
+
+Tables begin with two vertical bars.
+
+Leading `!' in a cell means that it is a heading cell.
+
+To concatenate columns or rows, put `>'(columns) or `^'(rows) at head of
+the cell.
+
+* Example statement
+
+ ||!row heading \ column heading||!column A||!column B||!column C||!>column D-E (horizontal concatenation)
+ ||!row 1||A1||B1||^C1-C2 (vertical concatenation)||D1||E1
+ ||!row 2||A2||B2||^>D2-E2-D3-E3 (vertical and horizontal concatenation)
+ ||!row 3||>>A3-C3 (horizontal concatenation)
+
+* Example output
+
+||!row heading \ column heading||!column A||!column B||!column C||!>column D-E (horizontal concatenation)
+||!row 1||A1||B1||^C1-C2 (vertical concatenation)||D1||E1
+||!row 2||A2||B2||^>D2-E2-D3-E3 (vertical and horizontal concatenation)
+||!row 3||>>A3-C3 (horizontal concatenation)
+
+! Comments
+
+Lines starting with `//' becomes a comment line.
+Comment lines is not outputted.
+
+* Example statement
+  // This is a comment line.
+
+* Example output (not displayed)
+// This is a comment line.
+
+!Plugins
+
+One can use a plugin by surrounding text with two pairs of brackets.
+Multiple lines parameter is supported.
+When a line contains plugin only, it is becomes a block plugin,
+which is not surrounded by <p> ... </p>.
+
+*Example statement
+
+ {{recent(3)}}
+
+* Example statement of multiple lines
+
+ {{pre('
+ ...
+ ')}}