SectMan (Sections Manager)

SectMan allows you to extract "section streams" from text.

Sections are designated using prefix markup, which is "transparent" to the language of the document. SectMan prefixes are placed at the beginning of the line, and they can be "///" or "###" or other denoting string comments.

Section Definition

The main working SectMan markup tag is "send to section", it looks something like this:

test
///^ en ru

This line is written in the bottom section and means ***"send the data of the section that is higher in the en and ru" Streams.

Obviously, this also means "beginning of a new section".

This tag is distinguished by a ^, which is immediately after the prefix, and as if it were unpleasant at the top, reminding that we are talking about the text above it.

If the prefix ### were used, then the "send to section" tag would look like ###^.

The character that is detected immediately after the prefix of visible SectMan tags. In this case, the "^" character defines the "send to section" tag, followed by spaces a list of "section streams" to which the section above will be sent.

So you can, for example, write a file with text in two languages, and automatically split it into separate files for each language.

By the way, to create this text, SectMan is used, which automatically creates two files from one source text.

Setting parameters

Parameters are specified using "whitespace tags" followed by a description data in HELML format (see description) Data after all whitespace tags to be found in the document are combined into a single Header, which is parsed as HELML format. The whitespace tags for header data can be anywhere in the text.

Header and parameter "SectMan:"

Before starting any action, SectMan "reads the header" from the text, and first of all searches for the substring SectMan: in the text, so that at the beginning of the found string determine the SectMan-prefix to use.

If the "SectMan:" is not found, then the prefix will be determined by scanning the strings whichever occurs first, "###" or "///". If none of them does not meet, then SectMan will not work, since it needs a prefix.

It is recommended that you always specify the "SectMan:" parameter, as this will allow you to quickly and uniquely identify the prefix used for SectMan-markup.

Note: all header parameters are optional, and even if no parameters are not set, but the prefixes "###" or "///" are used, then SectMan will work.

Important header options

Consider an example header:

///  SectMan:
///   :outdir: .
///   :sections:
///     ::en: README.md
///     ::ru: README_ru.md
///   :targetlang: markdown
///   :dontwrite:  F
///   :overwrite:  T
///  Extract: ru en