Skip to main content

Preprocessor which generates schemes from metadata

Project description

MetaGraph preprocessor for Foliant

Preprocessor generates Graphviz diagrams of meta sections in the project.

Installation

$ pip install foliantcontrib.metagraph

Config

preprocessors:
    - metagraph:
        natural: false
        directed: false
        draw_all: false

natural : if true — the graph is generated based on "natural" section structure: main sections are connected to the inner sections, which are connected to their child sections and so on. If false — the connections are deretmined by the relates meta section of each chapter. Default: false

directed : If true — draws a directed graph (with arrows). Default: false

draw_all : If true — draws all sections, except those which have meta field draw: false. If false — draws only sections which have meta field draw: true. Default: false

Usage

First set up a few meta sections:

<meta title="Main document" id="main" relates="['first', 'sub']" draw="true"></meta>

# First title
<meta id="first" draw="true"></meta>

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Nesciunt, atque.

## Subtitle

<meta id="sub"  draw="true"></meta>

Then add a metagraph tag somewhere in the project:

<metagraph></metagraph>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for foliantcontrib.metagraph, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size foliantcontrib.metagraph-0.1.1-py3-none-any.whl (4.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size foliantcontrib.metagraph-0.1.1.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page