kazutomi / lpmp Goto Github PK

Leanpub Markdown Preprocessor

License: MIT License

Ruby 100.00%

lpmp's Introduction

lpmp - Leanpub Markdown Preprocessor

Usage

$ lpmp [-v|--verb] [-d|--dump] [-s sep] [-j] [-h]

The command reads Book.txt and *.lmp files and generates corresponding .txt or .md files. If Book.txt has a '01.txt' (or '01.md') entry, provide 01.lmp and run lpmp to produce 01.txt (or 01.md).

-s or --verb : display verbatim lines for debug
-d or --dump : display all lines under processing
-s sep : separator for section names in index (default .)
-j : enable joining lines by backslash at line end; this feature requires the 3rd pass
-h : show help

Commands available in .lmp files

In addition to the Leanpub Markdown syntax, the following commands are available in .lmp files.

@<kw>{word,yomi} : keyword to be indexed (in boldface); yomi can be omitted
@<idx>{word,yomi} : same as @<kw> but not boldface
@<hidx>{word,yomi} : hidden index, not appear as text

Giving any third argument to @<idx> or @<hidx> makes the index entry boldface. (e.g., @<idx>{foo,foo,1})

@<index>{} : generates index
@<ruby>{word,furigana} : give furigana
@<fig>{tag}[caption](file) : insert image
@<fig>(tag) : figure reference
@<tbl>{tag}[caption] ... @<tbl> : table block
@<tbl>(tag) : table reference
@<list>{tag}[caption](file) : insert code
@<list>{tag}[caption] ... @<list> : literal code block
@<list>(tag) : list reference
@<lists>{} : generates the list of lists
@<cmd>{option} ... @<cmd> : command-line session
@<slabel>{tag} : label the section
@<sref>(tag) : reference to section
@<bib>{tag} ... @<bib> : bibliography item
@<bib>(tag) : reference to bib item

Captions can include [...] to one level (nested ones not allowed).

@<fig>{, @<tbl>{ and @<list>{ can take options at end in {...} form: e.g., @<list>{...}[...]{linenos=off}

Do not add # in front of tags specified in @<...> commands; they automatically add one if necessary.

Other features

Joining lines : A single backslash (\) at end of line joins it with the next line (works in asides and footnotes as well). This feature is enabled by -j option. Note that this function is performed in the extra 3rd pass, which is after any lpmp commands are processed (i.e., it just joins Markdown lines).

Experimental

The following functions are experimental and may be changed or removed later:

@#, @##, and like make the heading unnumbered (with the small font, boldface)

lpmp's People

Contributors

Watchers

lpmp's Issues

Generate bibliography

like BibTeX?

Generate table of contents for unnumbered sections

Like sections in A>

Indexing

define syntax to specify words to be indexed, and create index
should process all files at once?
two pass?

define syntax
should process all files at once to give sequential numbers?
two pass?

@<list>{foo}[Example 1: Hello, World]

generates:

{id="foo", title="List 1.1: Example 1: Hello, World"}
~~~~~~~~

but this text does not give HTML ID foo to the block; It generates:

<div class="code-block">
  <p class="codeblock-title">List 1.1: Example 1: Hello, World</p>

@<fig>{...}[...]{options}
@<tbl>{...}[...]{options}

Check for duplicates of HTML ids

Should check duplicates among different reference types (figures, tables, bib items, etc.)

verbatim handling

should reorder logic for handling verbatim lines