Package: tagtomarkdown
Copyright (c) 2019 Christian Hauris SorensenPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.Description: ## tagtomarkdownA [Python3 Markdown](https://github.com/Python-Markdown/markdown) preprocessorto transform a home made tag language for defining tables into the *Markdown*table format.The preprocessor can be used as an extension to[Python Markdown](https://python-markdown.github.io/) like this:from tagtomarkdown import TableTagExtension...ext_tables = TableTagExtension()html = markdown.markdown('Line 1\n>br text\nLine 3 and last', extensions=[ext_tables], output_format='html5')or:from tagtomarkdown import TableTagExtension...html = md.convert('Line 1\n>br text\nLine 3 and last', extensions=[TableTagExtension()], output_format='html5')or:html = md.convert('Line 1\n>br text\nLine 3 and last', extensions=['tables', 'tagtomarkdown'], output_format='html5')It can also be used as an [MkDocs](https://www.mkdocs.org/) extension by referringit in a document's *mkdocs.yml* file like this:markdown_extensions:- tagtomarkdown- tables...Your *MkDocs* instance must be installed under Python version 3, or you willget something like "tagtomarkdown not found".### Tags supported by the preprocessorPlease note that the source distribution contains a directory, `sample`,showing test and example use of the tool. There is a `README.txt` file thereexplaining the files. It might be quicker to get the idea by looking at the examplethan by reading the below, you might consider the below as a reference manual.The syntax of the tags supported is: Tags are identified by a `>` character, followedby a name. The `>` character must be at the beginning of a new line.The supported tags are:#### TablesTables are started the usual *Markdown* way, i.e. like this:```|:-:|---||No.|Subject|```The rows following the header row are then defined using the language, defined below.A table is ended by either a blank line or by the ```&gt;/row``` tag.**&gt;row**:   Produces a new table row**&gt;row noOfColumns**:   Produces a new table row and saves the number of columns. This number is beingused later when a new row is defined by another >row statement. The tablelogic will then fill in possible missing cells to finish the previous row.This parameter must be given only in the first >row statement in a given table.**&gt;cell [optional cell text in same line]**:   Produces a table cell. Contents can be of more lines.**&gt;cell &ast;start [symbol]**:   Sets a counter to the value 1 and inserts the 1 in a new cell,*symbol* is stored as a substitutable symbol of name symbol and the value 1**&gt;cell &ast;incr [symbol]**:   Increments the counter and writes its value in a new cell.*symbol* is stored as a substitutable symbol of name symbol and the value ofthe number substituting *incr.**&gt;/row [&ast;tableno] [optional table caption text in same line]**:   End a table definition. If the table definitions ends with a blank line,this tag is not necessary.*tableno indicates that the caption should be preceded by the text "Table n: "optional table caption: If given, a line with its text is written beneath the table.#### Ordered lists**&gt;li &ast;start [symbol]**:   Sets a counter to the value 1 and inserts the 1 in a new line.symbol is stored as a substitutable symbol of name symbol and the value 1**&gt;li &ast;incr [symbol]**:   Initiates a new List Item with a number.symbol is stored as a substitutable symbol of name symbol and the value ofthe number substituting *incr.**&gt;li [optional item text in same line]**:   Initiates a new List Item with a number.The item text is written to the same output line.**&gt;/li**:   Stops an Ordered List. Normally unnecessary.#### Substitutions**&gt;set symbol word [word] ...**:   Defines a one-line symbol with value word [word] ...**&gt;setblock symbol** and **&gt;/setblock**:  Defines the line(s) between the two tags as the value of symbol.The lines can contain &gt; tags**&gt;sub symbol**:   The value of symbol should be substituted here.**&gt;ignore** and **&gt;/ignore**:   Sections of text within these tags are not written to output.&gt;ignore tags can be nested**&gt;# [text]**:   Comment line#### Simple functions**&gt;date [word]**:   Insert a date stamp in the shape: YYYY-MM-DD.If a second word is given (period, e.g.), it is inserted right after the date stamp (no space).**&gt;time [word]**:   Insert a time stamp in the shape: HH:MM:SS.If a second word is given (period, e.g.), it is inserted right after the time stamp (no space).**&gt;br**:   Insert a line break**&gt;brn**, n being an integer:  Insert n line breaks### InstallationThe extension was made using Python v.3. As far as `mkdocs` goes, it has beentested with v.1.0.4. It has been test installed and tested un Linux Mint 19and Windows 10.You are supposed to install *Python-Markdown* and, maybe, *MkDocs* yourselfindependently of this product, which is defined as being dependent on *Markdown*,i.e. *Python-Markdown*.You can install the *Markdown* extension by issuing this command in a console:pip3 install tagtomarkdownYou can also download the `tar.gz` file and issue this command in the directory wherethe setup.py file is located:python3 setup.py installThe extension is going to write possible error messages on the console from whereit was started.If you are using the tags for defining table cells, you should of course make thedocument's *mkdocs.yml* file refer the `tables` extension too, like shown in thefigure above.If you are in doubt which version is installed on your machine, you can issuethese commands in a console:1 python32 >>> import tagtomarkdown3 >>> print(tagtomarkdown.version())4 tagtomarkdown v.0.4.0, 2019-04-115 >>>Line 4 is the product's indication of its version. You can update the productby adding the `--update` flag to the `pip3 install ...` command.Keywords: Markdown MkDocs tablesPlatform: UNKNOWNClassifier: Development Status :: 4 - BetaClassifier: Intended Audience :: DocumentationClassifier: Operating System :: OS IndependentClassifier: Programming Language :: Python :: 3.3Classifier: Programming Language :: Python :: 3.4Classifier: Programming Language :: Python :: 3.5Classifier: Programming Language :: Python :: 3.6Classifier: Programming Language :: Python :: 3.7Classifier: Topic :: Text ProcessingDescription-Content-Type: text/markdown