xmltangle quick reference

Note that all section ID's are normalized into the lowercase, characters-only form automatically.

lp-section-id, lp-section-id-end

This switches the "current" section being processed, and sets up internal storage for the data if it is the first time it is used.

lp-code, lp-code-end

This creates a segment of code within a section. It is an error to use this before having issued an lp-section-id/lp-section-id-end pair.

lp-ref, lp-ref-end

Inserts another section into the current one. The other section does not have to be defined yet. Simply put the section ID between these two processing instructions.

lp-file

This sets what section ID is the top-level section for a given file. Has two parameters - id and file.

lp-options

This allows you to set processing options. The following are available.

preserve-newlines

When set to no, a newline immediately following <?lp-code?> will be ignored. When set to yes it includes that newline in the code. Defaults to yes.

strict-options

If set to yes, it will give warnings for options that don't exist. Otherwise, if you specify an option that doesn't exist, it will just ignore it.

lp-block, lp-block-end

This is a convenience instruction, which allows xmltangle to automatically increase indentation upon tangling. After an lp-block instruction, all lines are indented by 1 tab. After two such instructions, they are indented by 2 tabs. This is especially useful in languages like Python, where indentation has meaning. This way, you don't have to memorize where you are on indentation in subordinate code pieces. You can just back everything to the left margin, and let your previous lp-block statements set the correct tabbing.