iAdd a descriptive README - tttml - converters for a simpler syntax than markdown Err bitreich.org 70
hgit clone git://bitreich.org/tttml git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/tttml URL:git://bitreich.org/tttml git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/tttml bitreich.org 70
1Log /scm/tttml/log.gph bitreich.org 70
1Files /scm/tttml/files.gph bitreich.org 70
1Refs /scm/tttml/refs.gph bitreich.org 70
1Tags /scm/tttml/tag bitreich.org 70
1README /scm/tttml/file/README.gph bitreich.org 70
i--- Err bitreich.org 70
1commit 988fa554a3a032a34b33f645453e1866fed54b39 /scm/tttml/commit/988fa554a3a032a34b33f645453e1866fed54b39.gph bitreich.org 70
1parent dfd29d4237158b9699334bbab6d22e4285e4a8a4 /scm/tttml/commit/dfd29d4237158b9699334bbab6d22e4285e4a8a4.gph bitreich.org 70
hAuthor: Josuah Demangeon <mail@josuah.net> URL:mailto:mail@josuah.net bitreich.org 70
iDate: Tue, 12 Jun 2018 23:07:21 +0200 Err bitreich.org 70
i Err bitreich.org 70
iAdd a descriptive README Err bitreich.org 70
i Err bitreich.org 70
iDiffstat: Err bitreich.org 70
i M Makefile | 3 --- Err bitreich.org 70
i M README | 169 +++++-------------------------- Err bitreich.org 70
i D a.out | 0 Err bitreich.org 70
i D a.out.core | 0 Err bitreich.org 70
i D t | 70 ------------------------------- Err bitreich.org 70
i Err bitreich.org 70
i5 files changed, 24 insertions(+), 218 deletions(-) Err bitreich.org 70
i--- Err bitreich.org 70
1diff --git a/Makefile b/Makefile /scm/tttml/file/Makefile.gph bitreich.org 70
i@@ -4,9 +4,6 @@ MAN5 = tttml.5 Err bitreich.org 70
i Err bitreich.org 70
i all: Err bitreich.org 70
i Err bitreich.org 70
i-README: Makefile $(MAN1) $(MAN5) Err bitreich.org 70
i- mandoc -T ascii $(MAN5) $(MAN1) | col -bx >$@ Err bitreich.org 70
i- Err bitreich.org 70
i install: Err bitreich.org 70
i mkdir -p $(PREFIX)/bin Err bitreich.org 70
i cp $(BIN) $(PREFIX)/bin Err bitreich.org 70
1diff --git a/README b/README /scm/tttml/file/README.gph bitreich.org 70
i@@ -1,158 +1,37 @@ Err bitreich.org 70
i-TTTML(5) File Formats Manual TTTML(5) Err bitreich.org 70
i+Text To Text Markup Language (tttml) Err bitreich.org 70
i+================================================================================ Err bitreich.org 70
i Err bitreich.org 70
i-NAME Err bitreich.org 70
i- tttml - simpler markup syntax than markdown Err bitreich.org 70
i+[git clone]: git://bitreich.org/tttml/ Err bitreich.org 70
i+git:/bitreich.org/tttml/ Err bitreich.org 70
i Err bitreich.org 70
i-SYNOPSIS Err bitreich.org 70
i- file.md Err bitreich.org 70
i+*tttml* is a simpler alternative to the markdown format. It is focused on Err bitreich.org 70
i+maintaining well-formatted plain text documents that look good enough to be Err bitreich.org 70
i+published without conversion. Err bitreich.org 70
i Err bitreich.org 70
i-DESCRIPTION Err bitreich.org 70
i- The tttml format is a very simple format for writiing text that look good Err bitreich.org 70
i- enough to be published without conversion. It lacks the markdown Err bitreich.org 70
i- recursive syntax (such as recursive lists anb quotes) which also remove Err bitreich.org 70
i- markdown ambiguities. Each block of text is separated from anotherone by Err bitreich.org 70
i- an empty line. Err bitreich.org 70
i+This is an awk implementation and converts documents in two steps: Err bitreich.org 70
i Err bitreich.org 70
i- paragraph Err bitreich.org 70
i- Any non-special block of text: Err bitreich.org 70
i+- the formatter fix the input if needed Err bitreich.org 70
i Err bitreich.org 70
i- First paragraph of text. Err bitreich.org 70
i+- the converters read this well-formatted input Err bitreich.org 70
i Err bitreich.org 70
i- Second paragraph of text. Err bitreich.org 70
i Err bitreich.org 70
i- title Block that ends by a line with only `=': Err bitreich.org 70
i+tttml-fmt Err bitreich.org 70
i+-------------------------------------------------------------------------------- Err bitreich.org 70
i Err bitreich.org 70
i- Title can therefore have multiple lines if required Err bitreich.org 70
i- although it is not advised. Err bitreich.org 70
i- ====================================================== Err bitreich.org 70
i+This is the formatter part. It takes a less rigid format (like markdown "lazy" Err bitreich.org 70
i+forms) as input that may contain errors and fix them up as much as it is Err bitreich.org 70
i+possible. It only print well formated output. Err bitreich.org 70
i Err bitreich.org 70
i- heading Err bitreich.org 70
i- Block that ends with a line with only `-': Err bitreich.org 70
i Err bitreich.org 70
i- Heading can also have multiple lines Err bitreich.org 70
i- ------------------------------------------------------ Err bitreich.org 70
i+tttml-gopher Err bitreich.org 70
i+-------------------------------------------------------------------------------- Err bitreich.org 70
i Err bitreich.org 70
i- subheading Err bitreich.org 70
i- Block with a single line with at least 3 leading `#' characters Err bitreich.org 70
i- starting at subheading and going down the outline (subheading, Err bitreich.org 70
i- subsubheading ...) every time an additionnal `#' is added: Err bitreich.org 70
i+This is a converter. It takes a well-formatted document and convert it to the Err bitreich.org 70
i+target format, in this case a gophermap: It converts the links and replace some Err bitreich.org 70
i+ASCII by equivalent prettier UTF-8 symbols. Err bitreich.org 70
i Err bitreich.org 70
i- ### Subheading Err bitreich.org 70
i+It is easy to convert a gophermap into an HTML document. gophermap-html [1] Err bitreich.org 70
i+does this. Err bitreich.org 70
i Err bitreich.org 70
i- #### Subsubheading Err bitreich.org 70
i- Err bitreich.org 70
i- ##### Subsubsubheading Err bitreich.org 70
i- Err bitreich.org 70
i- tag Block that start with a tag line: Err bitreich.org 70
i- Err bitreich.org 70
i- *tagline with asterisks and a column*: Err bitreich.org 70
i- Body of the tag block that can span over multiple Err bitreich.org 70
i- lines like regular paragraphs. Err bitreich.org 70
i- Err bitreich.org 70
i- list Block that start with a dash: Err bitreich.org 70
i- Err bitreich.org 70
i- - List item. The following lines might not have Err bitreich.org 70
i- leading space. Err bitreich.org 70
i- Err bitreich.org 70
i- - Note that multi-paragraph lists are not handled Err bitreich.org 70
i- Err bitreich.org 70
i- quote Block that has a leading `>' on every line: Err bitreich.org 70
i- Err bitreich.org 70
i- > Mail-style quoting. Note that nested quotes Err bitreich.org 70
i- > are not handled. Err bitreich.org 70
i- Err bitreich.org 70
i- literal Err bitreich.org 70
i- Block that has a leading tab on every line: Err bitreich.org 70
i- Err bitreich.org 70
i- Nothing gets interpreted in these blocks. Err bitreich.org 70
i- They get printed as-is. Err bitreich.org 70
i- They may contain extra tabs. Err bitreich.org 70
i- Err bitreich.org 70
i- link Block that start with a label line and eventual subsequent Err bitreich.org 70
i- description lines: Err bitreich.org 70
i- Err bitreich.org 70
i- [label]: git://josuah.net/git/tttml Err bitreich.org 70
i- git repository for the tttml set of tools Err bitreich.org 70
i- Err bitreich.org 70
i- [label2]: /url/without/description.txt Err bitreich.org 70
i- Err bitreich.org 70
i-SEE ALSO Err bitreich.org 70
i- smu(1), simple markup - markdown like syntax: Err bitreich.org 70
i- https://github.com/Gottox/smu Err bitreich.org 70
i- Err bitreich.org 70
i-AUTHORS Err bitreich.org 70
i- Josuah Demangeon <mail@josuah.net> Err bitreich.org 70
i- Err bitreich.org 70
i-OpenBSD 6.3 April 19, 2018 OpenBSD 6.3 Err bitreich.org 70
i- Err bitreich.org 70
i------------------------------------------------------------------------------- Err bitreich.org 70
i- Err bitreich.org 70
i-TTTML-FMT(1) General Commands Manual TTTML-FMT(1) Err bitreich.org 70
i- Err bitreich.org 70
i-NAME Err bitreich.org 70
i- tttml-fmt - format/pretty-print a tttml file Err bitreich.org 70
i- Err bitreich.org 70
i-SYNOPSIS Err bitreich.org 70
i- tttml-fmt [file...] Err bitreich.org 70
i- Err bitreich.org 70
i-DESCRIPTION Err bitreich.org 70
i- The tttml-fmt utility reformat a tttml(5) and print valid format to Err bitreich.org 70
i- stdout. Err bitreich.org 70
i- Err bitreich.org 70
i- Most markdown documents can be converted to tttml(5) with if they do not Err bitreich.org 70
i- have recursive elents such as nested lists or nested quotes. Err bitreich.org 70
i- Err bitreich.org 70
i- o The paragraphs are being filled to 80 columns, Err bitreich.org 70
i- Err bitreich.org 70
i- o The empty lines are set as apropriate Err bitreich.org 70
i- Err bitreich.org 70
i- o The blocks merged together are separated, such as lists without Err bitreich.org 70
i- separating blank spaces. Err bitreich.org 70
i- Err bitreich.org 70
i- o The title and heading horizontal lines are expanded to 80 Err bitreich.org 70
i- columns. Err bitreich.org 70
i- Err bitreich.org 70
i- o The tags with the tagline merged with the paragraph are separated Err bitreich.org 70
i- on their own line. Err bitreich.org 70
i- Err bitreich.org 70
i-SEE ALSO Err bitreich.org 70
i- tttml-gopher(1), smu(1), tttml(5), simple tttml - markdown like syntax: Err bitreich.org 70
i- https://github.com/Gottox/smu Err bitreich.org 70
i- Err bitreich.org 70
i-AUTHORS Err bitreich.org 70
i- Josuah Demangeon <mail@josuah.net> Err bitreich.org 70
i- Err bitreich.org 70
i-OpenBSD 6.3 April 19, 2018 OpenBSD 6.3 Err bitreich.org 70
i- Err bitreich.org 70
i------------------------------------------------------------------------------- Err bitreich.org 70
i- Err bitreich.org 70
i-TTTML-GOPHER(1) General Commands Manual TTTML-GOPHER(1) Err bitreich.org 70
i- Err bitreich.org 70
i-NAME Err bitreich.org 70
i- tttml-gopher - generate a gophermap from a tttml file Err bitreich.org 70
i- Err bitreich.org 70
i-SYNOPSIS Err bitreich.org 70
i- tttml-gopher host port [file...] Err bitreich.org 70
i- Err bitreich.org 70
i-DESCRIPTION Err bitreich.org 70
i- The tttml-gopher utility convert file to a gophermap format, simply by Err bitreich.org 70
i- converting all link entries, converting tabs into spaces and printing the Err bitreich.org 70
i- rest. host and port is used to set the host in links that do not have a Err bitreich.org 70
i- host, such as /path/to/file.txt Err bitreich.org 70
i- Err bitreich.org 70
i- o All URI starting with a `/' and ending with a `/' are printed Err bitreich.org 70
i- using the `1' entry type Err bitreich.org 70
i- Err bitreich.org 70
i- o All URI starting with a `/' and not ending with a `/' are printed Err bitreich.org 70
i- using the `0' Err bitreich.org 70
i- Err bitreich.org 70
i- o All URI starting with `0', `1', `7', `8', `9', `a', `g', `h' or Err bitreich.org 70
i- `I' followed by a `/' and all "gopher://&; URI are printed using Err bitreich.org 70
i- the corresponding entry type. Err bitreich.org 70
i- Err bitreich.org 70
i- o All other URI are printed using the `h' entry type Err bitreich.org 70
i- Err bitreich.org 70
i-AUTHORS Err bitreich.org 70
i- Josuah Demangeon <mail@josuah.net> Err bitreich.org 70
i- Err bitreich.org 70
i-OpenBSD 6.3 April 19, 2018 OpenBSD 6.3 Err bitreich.org 70
i+[1]: /code/gophermap/ Err bitreich.org 70
i+gophermap Err bitreich.org 70
1diff --git a/a.out b/a.out /scm/tttml/file/a.out.gph bitreich.org 70
iBinary files differ. Err bitreich.org 70
1diff --git a/a.out.core b/a.out.core /scm/tttml/file/a.out.core.gph bitreich.org 70
iBinary files differ. Err bitreich.org 70
1diff --git a/t b/t /scm/tttml/file/t.gph bitreich.org 70
i@@ -1,69 +0,0 @@ Err bitreich.org 70
i- TTTML(5) File Formats Manual TTTML(5) Err bitreich.org 70
i- NAME tttml - simpler markup syntax than markdown SYNOPSIS file.md Err bitreich.org 70
i- DESCRIPTION The tttml format is a very simple format for writiing text Err bitreich.org 70
i- that look good enough to be published without conversion. It lacks the Err bitreich.org 70
i- markdown recursive syntax (such as recursive lists anb quotes) which Err bitreich.org 70
i- also remove markdown ambiguities. Each block of text is separated from Err bitreich.org 70
i- anotherone by an empty line. paragraph Any Err bitreich.org 70
i- non-special block of text: First paragraph of text. Err bitreich.org 70
i- Second paragraph of text. title Block that ends by a line with only Err bitreich.org 70
i- `=': Title can therefore have multiple lines if required Err bitreich.org 70
i- although it is not advised. Err bitreich.org 70
i- ====================================================== heading Err bitreich.org 70
i- Block that ends with a line with only `-': Heading can also Err bitreich.org 70
i- have multiple lines Err bitreich.org 70
i- ------------------------------------------------------ subheading Err bitreich.org 70
i- Block with a single line with at least 3 leading `#' characters Err bitreich.org 70
i- starting at subheading and going down the outline (subheading, Err bitreich.org 70
i- subsubheading ...) every time an additionnal `#' is added: Err bitreich.org 70
i- ### Subheading #### Subsubheading ##### Err bitreich.org 70
i- Subsubsubheading tag Block that start with a tag line: Err bitreich.org 70
i- *tagline with asterisks and a column*: Body of the tag block Err bitreich.org 70
i- that can span over multiple lines like regular paragraphs. Err bitreich.org 70
i- list Block that start with a dash: - List item. The Err bitreich.org 70
i- following lines might not have leading space. Err bitreich.org 70
i- - Note that multi-paragraph lists are not handled quote Block that Err bitreich.org 70
i- has a leading `>' on every line: > Mail-style quoting. Note Err bitreich.org 70
i- that nested quotes > are not handled. literal Err bitreich.org 70
i- Block that has a leading tab on every line: Nothing Err bitreich.org 70
i- gets interpreted in these blocks. They get printed Err bitreich.org 70
i- as-is. They may contain extra tabs. Err bitreich.org 70
i- link Block that start with a label line and eventual subsequent Err bitreich.org 70
i- description lines: [label]: git://josuah.net/git/tttml Err bitreich.org 70
i- git repository for the tttml set of tools [label2]: Err bitreich.org 70
i- /url/without/description.txt SEE ALSO smu(1), simple markup - markdown Err bitreich.org 70
i- like syntax: https://github.com/Gottox/smu AUTHORS Josuah Err bitreich.org 70
i- Demangeon <mail@josuah.net> OpenBSD 6.3 April 19, 2018 Err bitreich.org 70
i- OpenBSD 6.3 Err bitreich.org 70
i- ------------------------------------------------------------------------------ Err bitreich.org 70
i- TTTML-FMT(1) General Commands Manual Err bitreich.org 70
i- TTTML-FMT(1) NAME tttml-fmt - format/pretty-print a tttml file Err bitreich.org 70
i- SYNOPSIS tttml-fmt [file...] DESCRIPTION The tttml-fmt utility Err bitreich.org 70
i- reformat a tttml(5) and print valid format to stdout. Most Err bitreich.org 70
i- markdown documents can be converted to tttml(5) with if they do not have Err bitreich.org 70
i- recursive elents such as nested lists or nested quotes. o The Err bitreich.org 70
i- paragraphs are being filled to 80 columns, o The empty lines are Err bitreich.org 70
i- set as apropriate o The blocks merged together are separated, Err bitreich.org 70
i- such as lists without separating blank spaces. o The Err bitreich.org 70
i- title and heading horizontal lines are expanded to 80 columns. Err bitreich.org 70
i- o The tags with the tagline merged with the paragraph are separated Err bitreich.org 70
i- on their own line. SEE ALSO tttml-gopher(1), smu(1), tttml(5), simple Err bitreich.org 70
i- tttml - markdown like syntax: https://github.com/Gottox/smu AUTHORS Err bitreich.org 70
i- Josuah Demangeon <mail@josuah.net> OpenBSD 6.3 April 19, Err bitreich.org 70
i- 2018 OpenBSD 6.3 Err bitreich.org 70
i- ------------------------------------------------------------------------------ Err bitreich.org 70
i- TTTML-GOPHER(1) General Commands Manual Err bitreich.org 70
i- TTTML-GOPHER(1) NAME tttml-gopher - generate a gophermap from a tttml Err bitreich.org 70
i- file SYNOPSIS tttml-gopher host port [file...] DESCRIPTION The Err bitreich.org 70
i- tttml-gopher utility convert file to a gophermap format, simply by Err bitreich.org 70
i- converting all link entries, converting tabs into spaces and printing the Err bitreich.org 70
i- rest. host and port is used to set the host in links that do not have a Err bitreich.org 70
i- host, such as /path/to/file.txt o All URI starting with a `/' and Err bitreich.org 70
i- ending with a `/' are printed using the `1' entry type o Err bitreich.org 70
i- All URI starting with a `/' and not ending with a `/' are printed Err bitreich.org 70
i- using the `0' o All URI starting with `0', `1', `7', `8', `9', Err bitreich.org 70
i- `a', `g', `h' or `I' followed by a `/' and all "gopher://&; URI Err bitreich.org 70
i- are printed using the corresponding entry type. o Err bitreich.org 70
i- All other URI are printed using the `h' entry type AUTHORS Josuah Err bitreich.org 70
i- Demangeon <mail@josuah.net> OpenBSD 6.3 April 19, 2018 Err bitreich.org 70
i- OpenBSD 6.3 Err bitreich.org 70
i-\ No newline at end of file Err bitreich.org 70
.
Response:
text/plain