1 files changed, 0 insertions, 176 deletions
diff --git a/README.txt b/README.txt
deleted file mode 100644
index c409335..0000000
--- a/README.txt
+++ /dev/null

@@ -1,176 +0,0 @@
-# HAT TRICK
-HAT TRICK is both a lightweight markup language inspired by gemtext and html,
-and this awk program to convert the markup language to gemtext, html, and
-gophermap markup.  It uses a mixture of "block"-level and line-level sigils to
-extend the pure line-based markup of gemtext, while removing some of the more
-annoying points (to my mind) of writing pure html---i.e., repetitive tags and
-other boilerplate.
-## Syntax
-### Blocks
-In HAT TRICK, block of text separated by a blank line is a type of "block."  The
-default block is a paragraph, or <p> tag in html.  (In gemini and gophermaps, no
-extra tags are added.)  Other blocks defined by the syntax are as follows:
->>>
-#       HEADING 1
-##      HEADING 2
-###     HEADING 3
-<<<
-Correspond to <hx> in html; passed through unmodified to gemtext and gophermaps.
->>>
->       BLOCK QUOTE
-<<<
-Corresponds to <blockquote>; passed through unmodified to gemtext and
-gophermaps.
->>>
-       UNORDERED LIST ITEM
-1.      ORDERED LIST ITEM
-<<<
-The first list item in a block automatically opens the necessary list tag in
-html.  In gemtext, the "-" is converted to "*" (which signifies a list item);
-the hyphen is passed through in gophermaps, because I think it's better syntax
-personally.
->>>
---     SECTION BREAK
-<<<
-A visual indication to break sections.  Corresponds to <hr> in html
-(TODO: consider html5 <section> tags --- this would take more logic.) 
-HAT TRICK reflows blocks, which means that only the first line of a block
-needs to start with the sigils outlined above.  However, each line of the block
-can begin with the sigil character for easier reading.
-### Lines
-Within blocks, there are certain other sigils that apply only to the line they
-prepend.  They include the following:
->>>
-=>      LINK
-<<<
-Links are probably the most important element in any hypertext language---since
-without them, it's hardly hypertext.  HAT TRICK borrows its link syntax from
-gemtext: the line starts with a "=>", the next field is the link's URL, and the
-rest of the line is the link's display text.
->>>
-<TAG>   HTML TAG
-<<<
-Lines beginning with an html tag are passed on to html verbatim.  The closing
-tag is automatically appended to the end of the line, before any ending
-punctuation.  I've found that 99 times out of 100, I don't want formatting to
-include the ending punctuation.
-A backslash (\) at the end of the tag line will prevent the tag from being
-ended, which is useful for tag-included punctuation as well as nesting tags.
-However, the tag is never closed, so you'll have to close it yourself on the
-next line.  In addition, text that isn't in a tag is html-escaped, so for the
-markup to properly apply, you'll need to write something like this:
->>>
-<b>She sells \
-<i>sea shells \
-</i>
-on the sea shore.\
-</b>
-<<<
-So while this markup is possible, it's discouraged through the awkwardness of
-the syntax.
-To translate these tags to meaningful markup in gemtext and gophermaps, a lookup
-table is used to correspond the tags to opening and closing characters around
-the line's text.  This correspondance can be defined with the environment
-variable HT_TAGCHARS or HAT TRICK's second positional argument (See INVOCATION,
-below).
->>>
-;       COMMENT
-<<<
-Comments in HAT TRICK aren't passed on to the output text---even in html, which
-has a comment syntax.  Instead, comments are passed, including the prepending
-semicolon, to standard error for further processing.
-### Verbatim blocks
-Finally, there is a special type of block for passing raw text through to the
-next phase of processing: the verbatim block.
->>>
- >>> [OUTPUTS]
- VERBATIM TEXT
- <<<
-<<<
-In html, the verbatim text is wrapped in <pre><code> tags; in gemtext, it's
-wrapped in gemtext's own verbatim text markers ```; and the text is unwrapped in
-gophermaps for a cleaner look.
-The OUTPUTS can be any output specifier HAT TRICK accepts; see INVOCATION below
-for details.  If OUTPUTS is present, the verbatim text will only be passed
-through in the output formats listed; with no OUTPUTS listed it will output to
-all formats.
-## "Escaping" line- and block-types
-Each of the types listed above are anchored at the beginning of the line.
-Therefore, a simple "escaping" mechanism is available for free: simply prepend a
-space to any line you don't want processed as a line or block and you'll be
-gravy.  Astute readers will notice I did just that above, to describe the syntax
-for verbatim fencing.
-## Invocation
-An invocation of HAT TRICK will look something like this:
->>>
-./ht.awk [HT_FORMATS] [HT_TAGCHARS] < INPUT
-<<<
-It processes text from standard input and uses two positional parameters to
-customize its usage, in addition to environment variables.  In each instance,
-the parameter will override the variable, and if neither are provided, HAT TRICK
-will choose a default.
-### HT_FORMATS (default: "html")
-The format(s) to export to.  Can be one or more of "html", "gemini", and
-"gopher".  As a convenience, a format can be prepended with a "-" (i.e.,
-"-html"), in which case every other format will be exported to.  Multiple
-formats can also be specified by separating them with a comma.  The special
-keyword "all" will export to all formats (this is the default).
-If HAT TRICK exports to one format, it will simply print out each line
-translated into that format.  However, if more than one format is given, 
-HAT TRICK prints each line multiple times, prepending the name of the format to
-the output.  This allows for further processing to filter outputs according to
-output type with just one pass through the input.
-### HT_TAGCHARS (default: 'b:**,i://,code:``')
-The correspondance between html tag lines and other output formats.  If
-HT_FORMAT is only html, this option has no real meaning.
-Each correspondance is of the (exploded) form
->>>
-TAG : LEFT_CHAR RIGHT_CHAR
-<<<
-where TAG is the html tag, LEFT_CHAR is the character on the left of the
-enclosed text, and RIGHT_CHAR is the character on the right.  Rules can be
-separated by commas to pass multiple ones to HAT TRICK.

diff --git a/README.txt b/README.txt deleted file mode 100644 index c409335..0000000 --- a/README.txt +++ /dev/null
@@ -1,176 +0,0 @@
1	# HAT TRICK
2
3	HAT TRICK is both a lightweight markup language inspired by gemtext and html,
4	and this awk program to convert the markup language to gemtext, html, and
5	gophermap markup. It uses a mixture of "block"-level and line-level sigils to
6	extend the pure line-based markup of gemtext, while removing some of the more
7	annoying points (to my mind) of writing pure html---i.e., repetitive tags and
8	other boilerplate.
9
10	## Syntax
11
12	### Blocks
13
14	In HAT TRICK, block of text separated by a blank line is a type of "block." The
15	default block is a paragraph, or <p> tag in html. (In gemini and gophermaps, no
16	extra tags are added.) Other blocks defined by the syntax are as follows:
17
18	>>>
19	# HEADING 1
20	## HEADING 2
21	### HEADING 3
22	<<<
23
24	Correspond to <hx> in html; passed through unmodified to gemtext and gophermaps.
25
26	>>>
27	> BLOCK QUOTE
28	<<<
29
30	Corresponds to <blockquote>; passed through unmodified to gemtext and
31	gophermaps.
32
33	>>>
34	- UNORDERED LIST ITEM
35	1. ORDERED LIST ITEM
36	<<<
37
38	The first list item in a block automatically opens the necessary list tag in
39	html. In gemtext, the "-" is converted to "*" (which signifies a list item);
40	the hyphen is passed through in gophermaps, because I think it's better syntax
41	personally.
42
43	>>>
44	--- SECTION BREAK
45	<<<
46
47	A visual indication to break sections. Corresponds to <hr> in html
48	(TODO: consider html5 <section> tags --- this would take more logic.)
49
50	HAT TRICK reflows blocks, which means that only the first line of a block
51	needs to start with the sigils outlined above. However, each line of the block
52	can begin with the sigil character for easier reading.
53
54	### Lines
55
56	Within blocks, there are certain other sigils that apply only to the line they
57	prepend. They include the following:
58
59	>>>
60	=> LINK
61	<<<
62
63	Links are probably the most important element in any hypertext language---since
64	without them, it's hardly hypertext. HAT TRICK borrows its link syntax from
65	gemtext: the line starts with a "=>", the next field is the link's URL, and the
66	rest of the line is the link's display text.
67
68	>>>
69	<TAG> HTML TAG
70	<<<
71
72	Lines beginning with an html tag are passed on to html verbatim. The closing
73	tag is automatically appended to the end of the line, before any ending
74	punctuation. I've found that 99 times out of 100, I don't want formatting to
75	include the ending punctuation.
76
77	A backslash (\) at the end of the tag line will prevent the tag from being
78	ended, which is useful for tag-included punctuation as well as nesting tags.
79	However, the tag is never closed, so you'll have to close it yourself on the
80	next line. In addition, text that isn't in a tag is html-escaped, so for the
81	markup to properly apply, you'll need to write something like this:
82
83	>>>
84	<b>She sells \
85	<i>sea shells \
86	</i>
87	on the sea shore.\
88	</b>
89	<<<
90
91	So while this markup is possible, it's discouraged through the awkwardness of
92	the syntax.
93
94	To translate these tags to meaningful markup in gemtext and gophermaps, a lookup
95	table is used to correspond the tags to opening and closing characters around
96	the line's text. This correspondance can be defined with the environment
97	variable HT_TAGCHARS or HAT TRICK's second positional argument (See INVOCATION,
98	below).
99
100	>>>
101	; COMMENT
102	<<<
103
104	Comments in HAT TRICK aren't passed on to the output text---even in html, which
105	has a comment syntax. Instead, comments are passed, including the prepending
106	semicolon, to standard error for further processing.
107
108	### Verbatim blocks
109
110	Finally, there is a special type of block for passing raw text through to the
111	next phase of processing: the verbatim block.
112
113	>>>
114	>>> [OUTPUTS]
115	VERBATIM TEXT
116	<<<
117	<<<
118
119	In html, the verbatim text is wrapped in <pre><code> tags; in gemtext, it's
120	wrapped in gemtext's own verbatim text markers ```; and the text is unwrapped in
121	gophermaps for a cleaner look.
122
123	The OUTPUTS can be any output specifier HAT TRICK accepts; see INVOCATION below
124	for details. If OUTPUTS is present, the verbatim text will only be passed
125	through in the output formats listed; with no OUTPUTS listed it will output to
126	all formats.
127
128	## "Escaping" line- and block-types
129
130	Each of the types listed above are anchored at the beginning of the line.
131	Therefore, a simple "escaping" mechanism is available for free: simply prepend a
132	space to any line you don't want processed as a line or block and you'll be
133	gravy. Astute readers will notice I did just that above, to describe the syntax
134	for verbatim fencing.
135
136	## Invocation
137
138	An invocation of HAT TRICK will look something like this:
139
140	>>>
141	./ht.awk [HT_FORMATS] [HT_TAGCHARS] < INPUT
142	<<<
143
144	It processes text from standard input and uses two positional parameters to
145	customize its usage, in addition to environment variables. In each instance,
146	the parameter will override the variable, and if neither are provided, HAT TRICK
147	will choose a default.
148
149	### HT_FORMATS (default: "html")
150
151	The format(s) to export to. Can be one or more of "html", "gemini", and
152	"gopher". As a convenience, a format can be prepended with a "-" (i.e.,
153	"-html"), in which case every other format will be exported to. Multiple
154	formats can also be specified by separating them with a comma. The special
155	keyword "all" will export to all formats (this is the default).
156
157	If HAT TRICK exports to one format, it will simply print out each line
158	translated into that format. However, if more than one format is given,
159	HAT TRICK prints each line multiple times, prepending the name of the format to
160	the output. This allows for further processing to filter outputs according to
161	output type with just one pass through the input.
162
163	### HT_TAGCHARS (default: 'b:**,i://,code:``')
164
165	The correspondance between html tag lines and other output formats. If
166	HT_FORMAT is only html, this option has no real meaning.
167
168	Each correspondance is of the (exploded) form
169
170	>>>
171	TAG : LEFT_CHAR RIGHT_CHAR
172	<<<
173
174	where TAG is the html tag, LEFT_CHAR is the character on the left of the
175	enclosed text, and RIGHT_CHAR is the character on the right. Rules can be
176	separated by commas to pass multiple ones to HAT TRICK.