Skip to content

Foliant

History of Releases

foliant-docs/foliant

History of Releases¶

Here is the single linear history of releases of Foliant and its extensions. It’s also available as an RSS feed.

[2024-02-08] foliantcontrib.swaggerdoc 1.2.5¶

Fix: a specific version of ruamel.yaml was used

[2023-12-13] foliantcontrib.escapecode 1.0.7¶

fix: the bug of incorrect selection of the frontmatter has been fixed

[2023-10-23] foliantcontrib.blockdiag 1.0.6¶

Pin down Pillow version.

[2023-10-09] foliantcontrib.escapecode 1.0.6¶

feat: frontmatter processing and option for frontmatter escaping

[2023-10-09] foliantcontrib.showcommits 1.0.5¶

add: option escape_shortcodes.

[2023-10-09] foliantcontrib.customids 1.0.8¶

If the site is generated by the hugo backend, the styles are inserted into the template for the foliant preprocessors.

[2023-06-15] foliantcontrib.dbmldoc 0.3.4¶

Fix default templates

[2023-05-02] foliantcontrib.includes 1.1.16¶

Feat: added 'allow_failure' and 'stub_text` options

[2023-04-19] foliantcontrib.escapecode 1.0.5¶

feat: using Marko parser to identify pre blocks, fence blocks and inline code as well as comments
feat: override pattern option in config

[2023-04-13] foliantcontrib.showcommits 1.0.4¶

fix: disabled escape html for diff
add: special syntax highlight in case of hugo backend

[2023-01-25] foliantcontrib.badges 1.0.4¶

feat: add support for different jira issue badges

[2023-01-23] foliantcontrib.includes 1.1.15¶

Feat: recursive link processing for url and repo_url

[2022-12-27] foliantcontrib.includes 1.1.14¶

Fix image_pattern for adjust_image_paths method

[2022-12-12] foliantcontrib.mkdocs 1.0.15¶

Raise error if mkdocs build failed but exited with status code 0

[2022-12-11] foliantcontrib.dbmldoc 0.3.3¶

Update PyDBML version
Update default template

[2022-12-09] foliantcontrib.macros 1.0.5¶

Do not fail preprocessors run if no replacement for a macro is found.

This case can occur if some undefined environment variable is passed to the macro.

[2022-12-04] foliantcontrib.dbmldoc 0.3.2¶

Update PyDBML version
Update default template

[2022-11-10] foliantcontrib.init 1.0.10¶

Add Makefile to the base template

[2022-10-31] foliantcontrib.imgcaptions 1.0.4¶

Fix: wrong captions were placed for figma-like images

[2022-10-28] foliantcontrib.mkdocs 1.0.14¶

Fix _image_pattern not to match image refs with brackets in captions

[2022-10-11] foliantcontrib.apireferences 1.0.7¶

Fix: small fix for proper work when input reference is a list item and have initial and last spaces inside

[2022-09-21] foliantcontrib.apireferences 1.0.6¶

Fix: now the preprocessor works correctly with initial and last spaces in input references like Client-API: GET user/info

[2022-09-01] foliantcontrib.history 1.0.9¶

The revision argument has been changed so that the default repository branch is used when generating the history.

[2022-08-30] foliantcontrib.checksources 1.0.0¶

Initial release

[2022-08-15] foliantcontrib.init 1.0.9¶

Add template download from got repository

[2022-06-27] foliantcontrib.showcommits 1.0.3¶

Add multithread file processing

[2022-06-22] foliantcontrib.apireferences 1.0.5¶

New: use_multiproject_mode option (default: True) to use cached API registries in multiproject

[2022-06-21] foliant 1.0.13¶

Add the clean_registry function to make. This function checks if multiproject and removes .apirefregistry files in .multiprojectache.

[2022-06-15] foliantcontrib.apireferences 1.0.4¶

New: endpoint_prefix_list option (default: []) for every API class

[2022-06-09] foliantcontrib.apireferences 1.0.3¶

New: trim_query option (default: True) for every API class

[2022-05-29] foliantcontrib.imgcaptions 1.0.3¶

Fix: style was inserted before front matter

[2022-05-29] foliantcontrib.mkdocs 1.0.13¶

Update to mkdocs 1.3.0
Replaced pages to nav in config generation due to github.com/mkdocs/mkdocs/pull/2652

[2021-12-12] foliantcontrib.confluence 0.6.20¶

Support for Confluence Cloud option to remove HTML formatting.
Page URL is now taken from the properties.
Article change is now detected by article body and title hash, stored in page properties.

[2021-12-12] foliantcontrib.replace 2.0.0¶

Preprocessor rewritten.

[2021-12-12] foliantcontrib.superlinks 1.0.12¶

Anchors added to beginning of files are not random anymore.

[2021-10-07] foliantcontrib.pandoc 1.1.2¶

Add odt and epub targets basic support.

[2021-08-17] foliantcontrib.dbdoc 0.1.8¶

DBMS python connectors are only imported on use.

[2021-08-04] foliantcontrib.argdown 0.1.1¶

Embed dot and graphml formats with as_image=False.

[2021-08-03] foliantcontrib.argdown 0.1.0¶

Initial release

[2021-08-03] foliantcontrib.superlinks 1.0.11¶

Fix imports.

[2021-08-02] foliantcontrib.bpmn 1.0.1¶

Initial release

[2021-08-02] foliantcontrib.pgsqldoc 1.1.7¶

New utils module

[2021-08-02] foliantcontrib.apilinks 1.2.6¶

New utils module

[2021-08-02] foliantcontrib.utils 1.0.3¶

PreprocessorExt: add debug_msg param to _warning method.

[2021-07-21] foliantcontrib.pandoc 1.1.1¶

Passing metadata parameters via config.
Fix: images didn't render during separate sections build.

[2021-07-21] foliantcontrib.meta 1.3.3¶

New utils module.

[2021-07-21] foliantcontrib.csvtables 1.0.2¶

New utils module.

[2021-07-21] foliantcontrib.mermaid 1.0.2¶

New utils module.

[2021-07-21] foliantcontrib.ramldoc 1.0.2¶

New utils module.

[2021-07-21] foliantcontrib.admonitions 1.0.1¶

New utils module.

[2021-07-21] foliantcontrib.metagraph 0.1.3¶

New utils module.

[2021-07-21] foliantcontrib.swaggerdoc 1.2.4¶

New utils module.

[2021-07-20] foliantcontrib.apireferences 1.0.2¶

New utils module.

[2021-07-20] foliantcontrib.dbdoc 0.1.7¶

New utils module.

[2021-07-20] foliantcontrib.dbmldoc 0.3.1¶

New utils module.
Update PyDBML parser to 0.4.1.

[2021-07-20] foliantcontrib.plantuml 1.0.10¶

New utils module.

[2021-07-20] foliantcontrib.graphviz 1.1.5¶

New utils module.
Output syntax errors in stdout.

[2021-07-20] foliantcontrib.templateparser 1.0.6¶

New utils module.

[2021-07-20] foliantcontrib.alt_structure 0.2.1¶

New utils module.

[2021-07-20] foliantcontrib.anchors 1.0.7¶

New utils module.

[2021-07-20] foliantcontrib.confluence 0.6.19¶

New utils module.

[2021-07-19] foliantcontrib.superlinks 1.0.10¶

New utils module.

[2021-07-15] foliantcontrib.utils 1.0.2¶

Fix error in initial values for combined options classes.
Combined options classes now clone input dicts and lists.
Combined options: fix validate_in.
Header Anchors: fix slate id generator.
PreprocessorExt: allow_fail now supports methods without args.

[2021-07-14] foliantcontrib.utils 1.0.1¶

All utils from separate repositories now reside here.

[2021-06-18] foliantcontrib.plantuml 1.0.9¶

Diagrams with same options now generate in single PlantUML instance.
Error tracebacks now are shown in console, error images are not generated.
Markdown image tags for broken diagrams are not inserted so they won't crash the build of the project.

[2021-05-20] foliantcontrib.dbmldoc 0.3.0¶

Update PyDBML parser to 0.4.0. This breaks backward compatibility with previous versions (reference cols are now lists).

[2021-05-07] foliantcontrib.multiproject 1.0.15¶

Fix crash caused by YAML-tags in subproject config.

[2021-05-07] foliantcontrib.yaml_include 1.0.1¶

Better logging.
Improved paths handling.

[2021-05-06] foliantcontrib.downloadfile 1.0.1¶

Better work with multiproject.
fail_fast parameter.

[2021-05-04] foliantcontrib.downloadfile 1.0.0¶

Initial release.

[2021-04-20] foliantcontrib.anchors 1.0.6¶

Fix: missing dependency in setup.py

[2021-04-01] foliantcontrib.confluence 0.6.18¶

Fix: external images didn't work.

[2021-03-11] foliantcontrib.apilinks 1.2.5¶

APILinks is now deprecated. Use APIReferences instead.

[2021-03-11] foliantcontrib.apireferences 1.0.1¶

Better logging and output.
New: warning_level param.

[2021-03-10] foliantcontrib.confluence 0.6.17¶

Fix: parent_id param didn't work.

[2021-03-10] foliantcontrib.yaml_include 1.0.0¶

Initial release.

[2021-03-09] foliantcontrib.apireferences 1.0.0¶

Initial release.

[2021-02-18] foliantcontrib.confluence 0.6.16¶

New: attaching arbitrary files with help of attachments parameter.
New: supply attachments implicitly using ac:image tag, without mentioning them in attachments parameter.
Attachments and images which were referenced several times on a page will now only be uploaded once.
Allow !path, !project_path modifiers inside ac:attachment param for ac:link, ac:image.

[2021-02-03] foliantcontrib.apilinks 1.2.4¶

Better warning when there's error in API configuration
Trailing slash is not enforced in generated urls. Previously didn't work with *.html sites

[2021-02-01] foliantcontrib.plantuml 1.0.8¶

Config options now can be overriden in tag options.
Add as_image option, which allows (when false) to insert svg-code instead of image into the document.

[2021-01-25] foliantcontrib.dbdoc 0.1.6¶

Templates now support imports and includes from the same folder.
Fix: Remove TEXT_VC field from Oracle views query, which is absent on some versions.

[2021-01-22] foliantcontrib.apilinks 1.2.3¶

Added options login and password for basic authentication on API sites.

[2020-12-18] foliantcontrib.confluence 0.6.15¶

New: [experimental] raw_confluence tags are now not necessary for ac:... tags, they are escaped automatically.
New: supply images with additional parameters using ac:image tag.
New: verify_ssl parameter.

[2020-12-04] foliantcontrib.templateparser 1.0.5¶

Config, backend name and target are now available under config, backend and target variables.
All the above variables along with meta and meta_object are now moved from _foliant_context into _foliant_vars variable.
Fix: external context was overriding meta variables.

[2020-12-03] foliantcontrib.replace 1.0.5¶

Bug fixed with several replaceable items in one string.

[2020-11-27] foliantcontrib.superlinks 1.0.9¶

Fix: BOF anchors bug
Fix: common paths processing

[2020-11-17] foliantcontrib.customids 1.0.7¶

Styles are now inserted after YAML Front Matter if that is present.

[2020-11-16] foliantcontrib.utils 1.0.0¶

Initial release.

[2020-11-10] foliantcontrib.dbdoc 0.1.5¶

New: trusted_connection option for Microsoft SQL Server

[2020-11-02] foliantcontrib.apilinks 1.2.2¶

Fix: Endnpoint prefix was ignored in swagger and redoc site backends.
Better logging.

[2020-10-28] foliantcontrib.superlinks 1.0.8¶

Fix: proper relative path generation for links.
Fix: multiple issues when !path modifier is used in the link tag.
BOF anchors now won't be added for mkdocs backend.

[2020-10-20] foliantcontrib.pandoc 1.1.0¶

Option to build separate chapters (sections) into separate files.

[2020-10-16] foliantcontrib.confluence 0.6.14¶

Add code blocks processing for Confluence preprocessor.

[2020-10-14] foliantcontrib.graphviz 1.1.4¶

Fix: issue with MkDocs: raw svgs are now wrapped in div tag.

[2020-10-08] foliantcontrib.superlinks 1.0.7¶

If tag body it empty, superlinks will try to guess the right caption of the link:
referenced title for links by title,
meta section title for links by meta section,
heading title for links by CustomIDs,
title from config or first heading title in the file for links to file,
anchor name for links by anchors.

[2020-10-07] foliantcontrib.apilinks 1.2.1¶

Renamed spec_url to spec because it may also be a path to local file,
Improved swagger.json parsing
Added Redoc support (redoc site backend)

[2020-10-06] foliantcontrib.apilinks 1.2.0¶

Added Swagger UI support,
Anchors are now generated properly, with header_anchors tool. Added site_backend optional param to determine for which backend the anchors should be generated.

[2020-09-16] foliantcontrib.archeme 1.0.3¶

Add config_concat option.

[2020-09-07] foliantcontrib.reindexer 1.0.1¶

Add the fulltext_config option.
Fix web application example: mention the content field, not only title, in the query filter settings.

[2020-08-26] foliantcontrib.superlinks 1.0.6¶

Improved Confluence links: if section is not uploaded to Confluence, reference to overall project (if it is uploaded to Confluence).

[2020-08-25] foliantcontrib.superlinks 1.0.5¶

New: added Confluence backend support.
Fix: links were corrupted when customids were used.
Fix: several other bug fixes and optimizations.

[2020-08-24] foliantcontrib.swaggerdoc 1.2.3¶

Fix: build failed when spec referenced to other files with $ref.

[2020-08-21] foliantcontrib.confluence 0.6.13¶

Fix: cache dir for preprocessor was not created

[2020-08-21] foliantcontrib.dbdoc 0.1.4¶

New: Added support for MySQL

[2020-08-20] foliantcontrib.dbdoc 0.1.3¶

New: Added support for Microsoft SQL Server

[2020-07-31] foliantcontrib.escapecode 1.0.4¶

Addition to normalization: remove BOM.

[2020-07-29] foliantcontrib.includes 1.1.13¶

When getting the included content by URL, take into account the charset parameter of the Content-Type response header field.

[2020-07-29] foliantcontrib.includes 1.1.12¶

Add the wrap_code and code_language attributes to mark up the included content as fence code block or inline code.
Prevent to create cache directory when it’s not needed. Improve code style. Refactor a little.

[2020-07-22] foliant 1.0.12¶

Add the disable_implicit_unescape option. Remove warning when escape_code is not set.
Support the !env YAML tag to use environment variables in the project config.
Allow to specify custom directory to store logs with the --logs|-l command line option.
Flush output to STDOUT in progress status messages and in the foliant.utils.output() method.
Get and log the names and versions of all installed Foliant-related packages.
Do not raise exception of the same type that is raised by a preprocessor, raise RuntimeError instead because some exceptions take more arguments than one.

[2020-07-22] foliantcontrib.pandoc 1.0.11¶

Do not re-raise an exception of the same type as raised, raise RuntimeError instead, it’s needed to avoid non-informative error messages.

[2020-07-22] foliantcontrib.mkdocs 1.0.12¶

Do not re-raise an exception of the same type as raised, raise RuntimeError instead, it’s needed to avoid non-informative error messages.

[2020-07-20] foliantcontrib.multiproject 1.0.14¶

Support Foliant Core 1.0.12, write logs to the directory that is specified for the multiproject.

[2020-07-19] foliantcontrib.escapecode 1.0.3¶

Do not fail the preprocessor if saved code is not found, show warning message instead.

[2020-07-14] foliantcontrib.confluence 0.6.12¶

New: option to store passwords in passfile.
New: nohead option to crop first title from the page.
Fix: better error reporting after updated atlassian-python-api package.
New: if you specified only space_key param in metadata and no title, section heading will be used as title.
Fix: if hierarchy is created on the test run, missing parents by title are now ignored

[2020-07-09] foliantcontrib.multilinetables 1.2.3¶

Problem with strings containing only hyphens fixed (critical for narrow columns with lists in grid tables).

[2020-07-09] foliantcontrib.includes 1.1.11¶

Add the extensions config parameter to process file types different from .md.
Add the url attribute to include content that is available by HTTP(S) URL.

[2020-06-16] foliantcontrib.confluence 0.6.11¶

Fix: XML error in code block conversion.

[2020-06-10] foliantcontrib.testrail 1.3.1¶

Now it's possible to use one image in several test-cases and process it correctly with move_imgs_from_text parameter.

[2020-06-09] foliantcontrib.testrail 1.3.0¶

New parameter:
move_imgs_from_text — converts image links in test cases to ordinary markdown-links, and adds all links to params variable to use in jinja template.
Some readme.md bugs fixed.

[2020-06-09] foliantcontrib.flatten 1.0.7¶

Fix: bug in rewrite local links regex.

[2020-06-08] foliantcontrib.testrail 1.2.2¶

Processing of several images in one case-step fixed.

[2020-06-05] foliantcontrib.dbdoc 0.1.2¶

Fix: schema filter in Oracle functions query

[2020-06-05] foliantcontrib.swaggerdoc 1.2.2¶

Fix spec path issue.
Fix: jinja mode default template wansn't copied.

[2020-06-05] foliantcontrib.dbdoc 0.1.1¶

New: Add views query to components
Fix: Oracle triggers query
Fix: Fix both PostgreSQL and Oracle templates

[2020-06-03] foliantcontrib.dbmldoc 0.2.4¶

Pydbml parser version updated to 0.3.2
Updated templates

[2020-06-02] foliantcontrib.pgsqldoc 1.1.6¶

Preprocessor is now deprecated. Please, use DBDoc instead: https://github.com/foliant-docs/foliantcontrib.dbdoc

[2020-06-02] foliantcontrib.dbdoc 0.1.0¶

Initial release

[2020-05-28] foliantcontrib.testrail 1.2.1¶

Bug with copying nonexistent folder to source fixed.

[2020-05-27] foliantcontrib.bindfigma 1.0.3¶

Fix bug in caching.

[2020-05-27] foliantcontrib.bindfigma 1.0.2¶

Add api_caching option. Add source Markdown file path to the messages written to STDOUT.

[2020-05-26] foliantcontrib.testrail 1.2.0¶

Downloading of images from test cases implemented.
New parameter:
img_folder – folder name to store downloaded images.
Renamed parameters:
rewrite_src_file -> rewrite_src_files,
screenshots_ext -> img_ext.
Paths processing fixed.

[2020-05-22] foliantcontrib.templateparser 1.0.4¶

All variables, supplied in context, are also available inside the _foliant_context variable
You can now supply a link to file on remote server in the ext_context parameter.
External context yaml-file now may be not a dictionary. In this case it will be available under the context template variable.

[2020-05-20] foliantcontrib.superlinks 1.0.4¶

Fix: bug with chapters.

[2020-04-23] foliantcontrib.archeme 1.0.2¶

Fix the same bug in stronger way.

[2020-04-23] foliantcontrib.archeme 1.0.1¶

Fix very strange bug with modules cache.

[2020-04-22] foliantcontrib.dbmldoc 0.1¶

Initial release

[2020-04-17] foliantcontrib.multiproject 1.0.13¶

Keep temporary directories of built subprojects. It is needed when local includes that rewrite image paths are used.

[2020-04-14] foliantcontrib.elasticsearch 1.0.4¶

Add copy action.

[2020-04-10] foliantcontrib.replace 1.0.4¶

Replace in links and images fixed.

[2020-04-10] foliantcontrib.alt_structure 0.2.0¶

Preprocessor now doesn't read config file, which previously caused MultiProject to run second time.
Registry is now flat dictionary.
Structure is now supplied via dictionary.

[2020-04-10] foliantcontrib.showcommits 1.0.2¶

Add try_default_path and escape_html options.

[2020-04-09] foliantcontrib.elasticsearch 1.0.3¶

Add require_env option.

[2020-04-06] foliantcontrib.meta 1.3.2¶

Cutomids are now cut out from titles.
Added logging.
Meta commands now support --debug -d and --quiet -q arguments.
meta generate command now gives some verbose output after work.
Fix: get_section_by_offset didn't count YFM.

[2020-04-02] foliantcontrib.confluence 0.6.10¶

Disabled tabbed code blocks conversion because of conflicts.

[2020-04-01] foliantcontrib.testcoverage 0.1.1¶

Support meta 1.3.0

[2020-04-01] foliantcontrib.testcoverage 0.1.0¶

Initial release.

[2020-04-01] foliantcontrib.metagraph 0.1.2¶

Metadata is now taken from src_dir to minimize possible conflicts with other preprocessors.

[2020-03-27] foliantcontrib.metagraph 0.1.1¶

New parameter: draw_all, which controls which sections are included.

[2020-03-26] foliantcontrib.metagraph 0.1.0¶

Initial release

[2020-03-26] foliantcontrib.templateparser 1.0.3¶

Now meta dictionary is available inside templates under meta variable.
Project's meta object is available inside templates under meta_object variable.

[2020-03-26] foliantcontrib.meta 1.3.1¶

remove_meta now also trims whitespaces in the beginning of the file after removing YFM
Main section's title is now set to first heading, if:
the first heading is a 1-level heading (#),
the first heading doesn't have meta.
Fix: YFM was not included in meta in some cases

[2020-03-25] foliantcontrib.confluence 0.6.8¶

Now foliant-anchors are always added even for new pages

[2020-03-25] foliantcontrib.confluence 0.6.9¶

Introducing import from confluence into Foliant with confluence tag
Fix: solved conflicts between inline comments and macros (including anchors)
Fix: backend crashed if new page content was empty
Markdown code blocks are now converted into code-block macros
Markdown task lists are now converted into task-list macros
New test_run option

[2020-03-12] foliantcontrib.testrail 1.1.11¶

Misprint fixed.

[2020-03-12] foliantcontrib.testrail 1.1.10¶

Bug with template handling fixed.

[2020-03-11] foliantcontrib.confluence 0.6.7¶

Fix another conflict with escapecode

[2020-03-05] foliantcontrib.graphviz 1.1.3¶

Fix: as_image takes effect only with svg format.

[2020-02-28] foliantcontrib.bindfigma 1.0.1¶

Add hyperlinks and multi_delimeter options.
Output error messages to STDOUT.
Minor improvements.

[2020-02-12] foliantcontrib.alt_structure 0.1.2¶

Fix: Remove config check from init

[2020-02-10] foliantcontrib.alt_structure 0.1.1¶

Initial release

[2020-02-06] foliantcontrib.mkdocs 1.0.11¶

Get captions for pages from workingdir instead of src_dir

[2020-02-04] foliantcontrib.slate 1.0.8¶

Support meta 1.3

[2020-02-04] foliantcontrib.superlinks 1.0.3¶

Support meta 1.3.

[2020-02-04] foliantcontrib.includes 1.1.9¶

Support meta 1.3.

[2020-02-04] foliantcontrib.meta 1.3.0¶

Restructure modules to aid import errors. Meta-related functions and classes are now available independantly from foliant.meta package.

[2020-02-04] foliantcontrib.confluence 0.6.6¶

Support meta 1.3
Now foliant-anchors are always added around uploaded content
Anchors are now case insensitive

[2020-02-03] foliantcontrib.meta 1.2.3¶

Add get_chapter method to Meta class.
Add Developer's guide to readme.

[2020-01-31] foliantcontrib.elasticsearch 1.0.2¶

Add format option. Use escape_html only for format: plaintext.

[2020-01-31] foliantcontrib.elasticsearch 1.0.1¶

Add escape_html option. Perform actions delete, create by default. Fix HTML markup in Web application example.

[2020-01-22] foliantcontrib.confluence 0.6.5¶

Fix: build crashed when several resolved inline comments referred to same string

[2019-12-24] foliantcontrib.superlinks 1.0.2¶

add dependencies order check.
rename anchor parameter to id.
add anchor parameter for possibly global anchor search.
link to anchors in Confluence are now partly supported.

[2019-12-24] foliantcontrib.anchors 1.0.4¶

Applied anchors are now checked from all chapters for flat backends.

[2019-12-24] foliantcontrib.testrail 1.1.9¶

Function to get case data by id added.

[2019-12-23] foliantcontrib.superlinks 1.0.1¶

Initial release.

[2019-12-20] foliantcontrib.anchors 1.0.3¶

Better regex patterns.
Conflicts are now determined for each backend separately.
Add confluence anchors.

[2019-12-20] foliantcontrib.meta 1.2.2¶

Don't require empty line between heading and meta tag.
Allow comments in YFM.
Better patterns for sections detection.

[2019-12-12] foliantcontrib.showcommits 1.0.1¶

Fix template processing. Log repo path.

[2019-12-12] foliantcontrib.flatten 1.0.6¶

Rewrite local links (e.g. some_file.md#some_id → #some_id).

[2019-12-04] foliantcontrib.slate 1.0.7¶

Fix: images are preserved in the output, even from subfolders.
YAML Front Matter from the sources is now ignored.

[2019-12-02] foliantcontrib.init 1.0.8¶

Add comment to Dockerfile with option to use Foliant full image.
Remove slugs from docker-compose. Now the service is always named foliant.

[2019-11-22] foliantcontrib.meta 1.2.1¶

Fix bug with imports.

[2019-11-21] foliantcontrib.meta 1.2.0¶

Support sections
meta.yml format restructure

[2019-11-21] foliantcontrib.confluence 0.6.4¶

Support meta 1.2. Now you can publish sections to confluence.

[2019-11-21] foliantcontrib.includes 1.1.8¶

Support meta 1.2.

[2019-11-20] foliantcontrib.imgcaptions 1.0.2¶

Fix: stylesheet_path only worked with the !project_path modifier.
Add the template parameter to customize the caption HTML tag.

[2019-11-09] foliantcontrib.mdtopdf 1.0.0¶

Initial release.

[2019-11-06] foliantcontrib.ramldoc 1.0.1¶

Initial release

[2019-10-28] foliantcontrib.aglio 1.0.0¶

Initial release

[2019-10-25] foliantcontrib.slate 1.0.6¶

Fix bug with error catching introduced in 1.0.5

[2019-10-25] foliantcontrib.slate 1.0.5¶

Better error reporting.
Fixes for working with includes.

[2019-10-16] foliantcontrib.escapecode 1.0.2¶

Improve flexibility: add new actions, allow to override defaults.

[2019-10-16] foliantcontrib.multiproject 1.0.12¶

Take into account the quiet flag. Require Foliant 1.0.11 for this reason.

[2019-10-16] foliantcontrib.includes 1.1.7¶

Allow to specify custom options for EscapeCode preprocessor as the escape_code.options config parameter value.

[2019-10-16] foliant 1.0.11¶

Allow to specify custom options for EscapeCode preprocessor as the escape_code.options config parameter value.
Pass the quiet flag to BaseParser() as an optional argument for using in config extensions.

[2019-10-15] foliantcontrib.subset 1.0.9¶

Fix incompatibilities with newer versions of modules: Cliar, PyYAML.

[2019-10-10] foliantcontrib.multiproject 1.0.11¶

Allow recursive processing of nested subprojects.
Allow to specify type (HTML/Markdown) and location for repo links.
Fix incompatibility with new Cliar: key names should not contain hyphens.

[2019-10-07] foliantcontrib.confluence 0.6.3¶

Remove resolved inline comments as they mix up with unresolved.

[2019-10-04] foliantcontrib.mermaid 1.0.1¶

Better error reporting

[2019-10-01] foliantcontrib.confluence 0.6.2¶

Added parent_title parameter.
Fix: images were not uploaded for new pages.

[2019-10-01] foliantcontrib.multiproject 1.0.10¶

Allow the first heading to be located not in the beginning of a document.

[2019-09-26] foliantcontrib.flatten 1.0.5¶

Add the keep_sources option to keep original files in the temporary working directory after flattening.

[2019-09-25] foliantcontrib.confluence 0.6.0¶

Now content is put in place of foliant anchor or instead of foliant_start...foliant_end anchors on the target page. If no anchors on page — content replaces the whole body.
New modes (backwards compatibility is broken!).
Now following files are available for debug in cache dir: 1. markdown before conversion to html. 2. Converted to HTML. 3. Final XHTML source which is uploaded to confluence.
Working (but far from perfect) detection if file was changed.
Only upload changed attachments.
Updating attachments instead of deleting and uploading again.

[2019-09-19] foliantcontrib.confluence 0.5.2¶

Completely rewrite restoring inline comments feature.
Add restore_comments and resolve_if_changed emergency options.
Allow insert raw confluence code (macros, etc) inside <raw_confluence> tag.

[2019-09-19] foliantcontrib.history 1.0.8¶

Allow to ignore merge commits in from: commits mode.

[2019-09-18] foliantcontrib.history 1.0.7¶

Allow to get repo names from README files.

[2019-09-16] foliantcontrib.history 1.0.6¶

Fix some regex patterns.

[2019-09-16] foliantcontrib.history 1.0.5¶

Allow to generate history based on tags and commits.

[2019-09-13] foliantcontrib.history 1.0.4¶

Add templates for target Markdown headings and RSS items titles.

[2019-09-13] foliantcontrib.history 1.0.3¶

Escape regex metacharacters in headings.

[2019-09-10] foliantcontrib.epsconvert 1.0.7¶

Fix image reference detection pattern, other minor fixes.

[2019-09-09] foliantcontrib.history 1.0.2¶

Do not generate common top-level heading of target Markdown content.

[2019-09-06] foliantcontrib.history 1.0.1¶

Add RSS feed generation.

[2019-08-28] foliantcontrib.includes 1.1.6¶

Escape regular expression metacharacters in starting and ending headings, IDs, modifiers.

[2019-08-27] foliantcontrib.includes 1.1.5¶

Remove meta blocks from the included content.

[2019-08-26] foliantcontrib.mkdocs 1.0.10¶

Fix pattern for heading detection.

[2019-08-26] foliantcontrib.swaggerdoc 1.2.0¶

Add spec_path and spec_url parameters.
All path tag parameters are now loaded relative to current file.
Better logging and error reporting

[2019-08-26] foliantcontrib.customids 1.0.6¶

Allow to define custom styles for headings of each level.

[2019-08-26] foliantcontrib.confluence 0.4.1¶

Fix: conflict with escape_code

[2019-08-23] foliantcontrib.includes 1.1.4¶

Allow for the starting and ending headings to be 1-character long.

[2019-08-23] foliantcontrib.confluence 0.4.0¶

Fix: attachments were not uploaded for nonexistent pages
Change confluence api wrapper to atlassian-python-api
Rename backend to confluence
Better error reporting

[2019-08-23] foliantcontrib.mkdocs 1.0.9¶

Allow the first heading to be located not in the beginning of a document.

[2019-08-23] foliantcontrib.epsconvert 1.0.6¶

Bug fix: update current directory path before processing of Markdown file content, not after.

[2019-08-22] foliantcontrib.imagemagick 1.0.2¶

Bug fix: update current directory path before processing of Markdown file content, not after.

[2019-08-22] foliantcontrib.meta 1.1.0¶

Remove the sections entity.
Restructure code.

[2019-08-22] foliantcontrib.confluence 0.3.0¶

Fix bug with images.
Add multiple modes and mode parameter.
Add toc parameter to automatically insert toc.
Fix: upload attachments before text update (this caused images to disappear after manually editing).

[2019-08-20] foliantcontrib.meta 1.0.3¶

Add span to meta

[2019-08-16] foliantcontrib.confluence 0.2.0¶

Allow to input login and/or password during build
Added pandoc_path option
Better logging and error catching

[2019-08-15] foliantcontrib.confluence 0.1.0¶

Initial release.

[2019-08-14] foliantcontrib.includes 1.1.3¶

Allow to specify IDs of anchors in the from_id and to_id attributes. Support the to_end attribute.

[2019-08-02] foliantcontrib.escapecode 1.0.1¶

Do not ignore diagram definitions. It should be possible to escape the tags used by diagram drawing preprocessors. If some preprocessors need to work with the content that is recognized as code, call UnescapeCode explicitly before them.

[2019-08-01] foliantcontrib.replace 1.0.3¶

Fixed issue with PyYAML deprecated loader.

[2019-08-01] foliantcontrib.mermaid 1.0.0¶

Initial release

[2019-07-30] foliantcontrib.includes 1.1.2¶

Fix include statement regex pattern. Tags joined with | must be in non-capturing parentheses.

[2019-07-30] foliant 1.0.10¶

Add escape_code config option. To use it, escapecode and unescapecode preprocessors must be installed.

[2019-07-30] foliantcontrib.includes 1.1.1¶

Support escape_code config option. Require Foliant 1.0.10 and escapecode preprocessor 1.0.0.
Process sethead recursively.

[2019-07-16] foliantcontrib.bindsympli 1.0.14¶

Add width attribute to <sympli> tag.
Refactor a little.

[2019-07-15] foliantcontrib.slugs 1.0.1¶

Add !version and !commit_count YAML tags.

[2019-07-09] foliantcontrib.docus 0.2.0¶

More flexible chapters parsing. Lists are now not mandatory.

[2019-07-09] foliantcontrib.docus 0.1.0¶

Initial release.

[2019-07-05] foliantcontrib.runcommands 1.0.1¶

Capture the output of an external command and write it to STDOUT.

[2019-07-01] foliantcontrib.meta 1.0.2¶

Fix: subsections title may be specified in YFM;
Fix: in subsections title was being cropped out

[2019-07-01] foliantcontrib.project_graph 1.0.1¶

Rename rel attributes: rel_path to path, rel_id to id
Relation types now don't implicitly go to edge labels. Add label explicitly from now on.
Fixed: relations to !project_path and !rel_path didn't work.

[2019-07-01] foliantcontrib.meta 1.0.1¶

Fix: seeds for main sections were not processed.
Add debug messages for seeds processing.

[2019-06-28] foliantcontrib.project_graph 1.0.0¶

Initial release.

[2019-06-28] foliantcontrib.meta 1.0.0¶

Initial release.

[2019-06-28] foliantcontrib.includes 1.1.0¶

Support Foliant 1.0.9. Add processing of !path, !project_path, and !rel_path modifiers (i.e. YAML tags) in attribute values of pseudo-XML tags inside the included content. Replace the values that preceded by these modifiers with absolute paths resolved depending on current context.
Allow to specify the top-level (“root”) directory of Foliant project that the included file belongs to, with optional project_root attribute of the <include> tag. This can be necessary to resolve the !path and the !project_path modifiers in the included content correctly.
Allow to specify all necessary parameters of each include statement as attribute values of pseudo-XML tags. Keep legacy syntax for backward compatibility.
Update README.

[2019-06-17] foliant 1.0.9¶

Process attribute values of pseudo-XML tags as YAML.
Allow single quotes for enclosing attribute values of pseudo-XML tags.
Add !project_path and !rel_path YAML tags.

[2019-06-14] foliantcontrib.templateparser 1.0.2¶

support PyYAML 5.1

[2019-06-14] foliantcontrib.bindsympli 1.0.13¶

Set 2-minutes timeout instead of default 30-seconds when launching Chromium.
Use page.waitForSelector() instead of page.waitForNavigation().
Use custom sleep() function for intentional delays.

[2019-06-13] foliantcontrib.badges 1.0.2¶

support params which alter badge look to be supplied in tag params

[2019-06-11] foliantcontrib.badges 1.0.1¶

force img mode on pdf and docx
add target parameter

[2019-06-11] foliantcontrib.badges 1.0.0¶

Initial release

[2019-06-10] foliantcontrib.admonitions 1.0.0¶

Initial release.

[2019-05-20] foliantcontrib.graphviz 1.1.1¶

Remove src param. (Use includes instead)
Allow separate tags fail. Preprocessor would issue warning and continue work.

[2019-05-20] foliantcontrib.templateparser 1.0.1¶

add ext_context param for external file with context
allow separate templates to fail, the preprocessor would issue warning and skip them

[2019-05-17] foliantcontrib.blockdiag 1.0.5¶

Attributes of pseudo-XML tags have higher priority than config file options.

[2019-05-17] foliantcontrib.plantuml 1.0.6¶

Attributes of <plantuml> tag have higher priority than config file options.

[2019-05-14] foliantcontrib.templateparser 1.0.0¶

Initial release

[2019-04-30] foliantcontrib.bindsympli 1.0.12¶

Capture the output of the Puppeter-based script and write it to STDOUT.

[2019-04-15] foliantcontrib.swaggerdoc 1.1.3¶

Fix issues with json and yaml. All spec files are now loaded with yaml loader.
Change PyYAML to ruamel.yaml
jinja mode is deprecated, widdershins is the default mode

[2019-04-10] foliantcontrib.mkdocs 1.0.8¶

Escape control characters (double quotation marks, dollar signs, backticks) that may be used in system shell commands.

[2019-04-10] foliantcontrib.pandoc 1.0.10¶

Add backticks to the set of characters that should be escaped.

[2019-04-10] foliantcontrib.pandoc 1.0.9¶

Escape double quotation marks (") and dollar signs ($) which may be used in PDF, docx, and TeX generation commands as parts of filenames, variable values, etc. Enclose filenames that may be used in commands into double quotes.

[2019-04-05] foliantcontrib.includes 1.0.11¶

Take into account the results of work of preprocessors that may be applied before includes within a single Foliant project. Rewrite the currently processed Markdown file path with the path of corresponding file that is located inside the project source directory only if the currently processed Markdown file is located inside the temporary working directory and the included file is located outside the temporary working directory. Keep all paths unchanged in all other cases.

[2019-03-27] foliantcontrib.graphviz 1.0.6¶

Added as_image option.

[2019-03-21] foliantcontrib.anchors 1.0.5¶

Anchor headings conflicts are now more accurate, because for flat backends are checked for all chapters.
Anchors with illegal characters (list in readme) now will be removed.
Preprocessor now can also work with custom ids.

[2019-03-21] foliantcontrib.anchors 1.0.2¶

Added preprocessor_ext for better warnings (and better code)

[2019-03-21] foliantcontrib.anchors 1.0.1¶

Added 'element' option to customize anchor span element.

[2019-03-21] foliantcontrib.anchors 1.0.0¶

Initial release

[2019-03-14] foliantcontrib.notifier 1.0.0¶

Initial release.

[2019-02-21] foliantcontrib.testrail 1.1.8¶

Hardcoded section headers processing removed.

[2019-02-18] foliantcontrib.replace 1.0.2¶

Now it's possible to pass the lambda function from dictionary file.
with_confirmation parameter added.

[2019-02-15] foliantcontrib.csvtables 1.0.1¶

setup.py fixed.

[2019-02-14] foliantcontrib.graphviz 1.0.4¶

Moved combined_options out

[2019-02-14] foliantcontrib.apilinks 1.1.3¶

Moved combined_options into a submodule

[2019-02-14] foliantcontrib.pgsqldoc 1.1.5¶

Move combined_options into another module

[2019-02-12] foliantcontrib.testrail 1.1.7¶

Sections exclusion fixed.

[2019-02-08] foliantcontrib.testrail 1.1.6¶

Case structure output fixed if any problem occurs.

[2019-02-01] foliantcontrib.testrail 1.1.5¶

Bug with test case table numbering when deleting empty objects fixed.
Readme updated.

[2019-01-21] foliantcontrib.apilinks 1.1.1¶

Added filename to warnings.

[2019-01-10] foliantcontrib.bindsympli 1.0.11¶

Disable images downloading from design pages only, but not from login page.

[2018-12-24] foliantcontrib.graphviz 1.0.2¶

Fixed external diagrams not reloading on change.
Fixed external diagrams are not crashing preprocessor if the file is missing.

[2018-12-20] foliantcontrib.bindsympli 1.0.10¶

Check if the design page exists and the image URL is valid.

[2018-12-17] foliantcontrib.graphviz 1.0.1¶

Added 'src' tag option to load diagram source from external file.

[2018-12-17] foliantcontrib.graphviz 1.0.0¶

Initial release

[2018-12-13] foliantcontrib.apilinks 1.1.0¶

Prefixes are now case insensitive.
Only prefixes which are defined are trimmed.
New option only-defined-prefixes to ignore all prefixes which are not listed in config.
Options renamed and regrouped. Breaks backward compatibility.
Support of several reference pattern and properties (to catch models).
Now search on API page for headers h1, h2, h3 and h4.

[2018-12-06] foliantcontrib.subset 1.0.8¶

Remove forgotten unnecessary import.

[2018-12-06] foliantcontrib.subset 1.0.7¶

Move the imports of the oyaml module directly into the methods that use it.

[2018-12-06] foliantcontrib.bindsympli 1.0.9¶

Move the while loop from JavaScript code to Python code.
Add the max_attempts config option.
Require Foliant 1.0.8 because of using the utils.output() method.

[2018-12-04] foliantcontrib.subset 1.0.6¶

Fix a bug: check if subset partial config contains chapters section correctly.
Inherit the class Cli from BaseCli, not from Cliar.

[2018-12-04] foliantcontrib.multiproject 1.0.9¶

Inherit the class Cli from BaseCli, not from Cliar.

[2018-12-04] foliantcontrib.apilinks 1.0.5¶

Now both command and endpoint prefix are ensured to start from root (/).

[2018-12-03] foliantcontrib.apilinks 1.0.4¶

Fix not catching errors from urllib.
Added 'ignoring-prefix' option.
Added 'endpoint-prefix' option into API->Name section.

[2018-11-29] foliantcontrib.apilinks 1.0.3¶

Add require-prefix option.

[2018-11-29] foliantcontrib.apilinks 1.0.2¶

Trim prefixes function.

[2018-11-29] foliantcontrib.apilinks 1.0.1¶

Update docs, fix anchor error.
Add all HTTP verbs to regular expression.

[2018-11-27] foliantcontrib.apilinks 1.0.0¶

Initial release.

[2018-11-23] foliantcontrib.templates.preprocessor 1.0.3¶

Fix packages value in setup.py of the template: use foliant.preprocessors instead of foliantcontrib.preprocessors.
Require Foliant 1.0.8 in setup.py of the template.

[2018-11-20] foliantcontrib.testrail 1.1.4¶

Another bug with multi-select parameter processing fixed.

[2018-11-20] foliantcontrib.testrail 1.1.3¶

Jinja templates updated.
Bug with multi-select parameter processing fixed.

[2018-11-19] foliantcontrib.testrail 1.1.2¶

Now it's possible to use dropdown type parameters for test cases samplings.

[2018-11-19] foliantcontrib.testrail 1.1.1¶

Readme updated.

[2018-11-19] foliantcontrib.testrail 1.1.0¶

Removed parameters:
platforms,
platform_id,
add_cases_without_platform,
add_unpublished_cases.
Added parameters:
exclude_suite_ids — to exclude suites from final document by ID,
exclude_section_ids — to exclude sections from final document by ID,
exclude_case_ids — to exclude cases from final document by ID,
add_case_id_to_std_table - to add column with case ID to the testing table,
multi_param_name - name of custom TestRail multi-select parameter for cases sampling,
multi_param_select - values of multi-select parameter for cases sampling,
multi_param_select_type — sampling method,
add_cases_without_multi_param - to add cases without any value of multi-select parameter,
add_multi_param_to_case_header — to add values of multi-select parameter to the case headers,
add_multi_param_to_std_table — to add column with values of multi-select parameter to the testing table,
checkbox_param_name - name of custom TestRail checkbox parameter for cases sampling,
checkbox_param_select_type — state of custom TestRail checkbox parameter for cases sampling,
choose_priorities — selection of case priorities for cases sampling,
add_priority_to_case_header - to add priority to the case header,
add_priority_to_std_table — to add column with priority to the testing table.
Renamed parameters:
add_case_id_to_case_name -> add_case_id_to_case_header.
Fixed config parsing.

[2018-11-19] foliantcontrib.pgsqldoc 1.1.3¶

Add tests; refactor code
Fix triggers and functions; add description to functions
Fix template

[2018-11-16] foliantcontrib.templates.preprocessor 1.0.2¶

Require foliantcontrib.init 1.0.7, import the output() method.
Do not rewrite source Markdown file if an error occurs.

[2018-11-16] foliantcontrib.multiproject 1.0.8¶

Do not rewrite source Markdown file if an error occurs in RepoLink preprocessor.

[2018-11-16] foliantcontrib.macros 1.0.4¶

Do not rewrite source Markdown file if an error occurs.

[2018-11-16] foliantcontrib.includes 1.0.10¶

Do not rewrite source Markdown file if an error occurs.

[2018-11-16] foliantcontrib.imgcaptions 1.0.1¶

Do not rewrite source Markdown file if an error occurs.

[2018-11-16] foliantcontrib.imagemagick 1.0.1¶

Do not rewrite source Markdown file if an error occurs.

[2018-11-16] foliantcontrib.flags 1.0.2¶

Do not rewrite source Markdown file if an error occurs.

[2018-11-16] foliantcontrib.epsconvert 1.0.5¶

Do not rewrite source Markdown file if an error occurs.

[2018-11-16] foliantcontrib.customids 1.0.5¶

Do not rewrite source Markdown file if an error occurs.

[2018-11-16] foliantcontrib.bindsympli 1.0.8¶

Do not rewrite source Markdown file if an error occurs.

[2018-11-16] foliantcontrib.gupload 1.1.5¶

Provide compatibility with Foliant 1.0.8.

[2018-11-16] foliantcontrib.slate 1.0.4¶

Provide compatibility with Foliant 1.0.8.
Fix preprocessor: if error source won't be cleared.

[2018-11-14] foliantcontrib.plantuml 1.0.5¶

Do not rewrite source Markdown file if an error occurs.
Use output() method and Foliant 1.0.8.

[2018-11-14] foliantcontrib.blockdiag 1.0.4¶

Do not rewrite source Markdown file if an error occurs.
Use output() method and Foliant 1.0.8.

[2018-11-14] foliantcontrib.mkdocs 1.0.7¶

Provide compatibility with Foliant 1.0.8.

[2018-11-14] foliantcontrib.pandoc 1.0.8¶

Provide compatibility with Foliant 1.0.8.

[2018-11-14] foliantcontrib.init 1.0.7¶

Provide compatibility with Foliant 1.0.8.

[2018-11-14] foliant 1.0.8¶

Restore quiet mode.
Add the output() method for using in preprocessors.

[2018-11-14] foliantcontrib.pandoc 1.0.7¶

Provide compatibility with Foliant 1.0.7.

[2018-11-14] foliantcontrib.mkdocs 1.0.6¶

Provide compatibility with Foliant 1.0.7.

[2018-11-14] foliant 1.0.7¶

Remove spinner made with Halo.
Abolish quiet mode because it is useless if extensions are allowed to write anything to STDOUT.
Show full tracebacks in debug mode; write full tracebacks into logs.

[2018-11-13] foliantcontrib.init 1.0.6¶

Provide compatibility with Foliant 1.0.7.

[2018-11-12] foliantcontrib.multilinetables 1.2.2¶

Problem with deletion of table strings containing only spaces fixed (critical for lists in grid tables).

[2018-11-09] foliantcontrib.subset 1.0.5¶

Do not use yaml alias for oyaml module to prevent possible influence of this overriding on other parts of code.

[2018-11-09] foliantcontrib.plantuml 1.0.4¶

Additionally сheck if diagram image is not saved.

[2018-11-09] foliantcontrib.blockdiag 1.0.3¶

Do not fail the preprocessor if some diagrams contain errors. Write error messages into the log.

[2018-11-08] foliantcontrib.slate 1.0.3¶

Add slate preprocessor which copies the images outside src into the slate project.

[2018-11-08] foliantcontrib.testrail 1.0.7¶

Minor fixes.

[2018-11-08] foliantcontrib.plantuml 1.0.3¶

Add parse_raw option.
Do not fail the preprocessor if some diagrams contain errors. Write error messages into the log.

[2018-11-08] foliantcontrib.testrail 1.0.6¶

Added: parameters to exclude suite and section headers from the final document.

[2018-11-07] foliantcontrib.testrail 1.0.5¶

Minor fixes.

[2018-11-07] foliantcontrib.testrail 1.0.4¶

Fixed: if there is only one suite in project, it's header not added to the contents.

[2018-11-02] foliantcontrib.gupload 1.1.4¶

Code refactored.

[2018-11-01] foliantcontrib.templates.preprocessor 1.0.1¶

Add package_data to setup.py.

[2018-11-01] foliantcontrib.gupload 1.1.3¶

Logger bug fixed.

[2018-10-31] foliantcontrib.swaggerdoc 1.1.2¶

Bug fixes
All path parameters in config now accept either strings or !path strings

[2018-10-31] foliantcontrib.swaggerdoc 1.1.1¶

Add 'additional_json_path' param for jinja mode
Add support for several json_urls

[2018-10-30] foliantcontrib.multilinetables 1.2.1¶

Possibility to rewrite source files added.

[2018-10-30] foliantcontrib.testrail 1.0.3¶

Possibility to rewrite source file added.

[2018-10-29] foliantcontrib.bindsympli 1.0.7¶

Use 60-seconds timeout instead of 30-seconds. Provide multiple attempts to open pages.

[2018-10-29] foliantcontrib.testrail 1.0.2¶

Suites collecting fixed.

[2018-10-29] foliantcontrib.multilinetables 1.2.0¶

Convertation th the grid format added for arbitrary cell' content (multiple paragraphs, code blocks, lists, etc.).

[2018-10-24] foliantcontrib.multiproject 1.0.7¶

Allow to override the edit_uri config option of RepoLink preprocessor with the FOLIANT_REPOLINK_EDIT_URI system environment variable.

[2018-10-23] foliantcontrib.multiproject 1.0.6¶

Tidy up CLI arguments.

[2018-10-23] foliantcontrib.subset 1.0.4¶

Tidy up command line arguments one more time.

[2018-10-23] foliantcontrib.subset 1.0.3¶

Tidy up command line arguments.

[2018-10-23] foliantcontrib.subset 1.0.2¶

Fix a bug with object names.

[2018-10-22] foliantcontrib.subset 1.0.1¶

Parse YAML fairly. Merge config files recursively.

[2018-10-19] foliantcontrib.swaggerdoc 1.1.0¶

Change parameter names and behavior uncompatible with 1.0.0
Add conversion to md with widdershins

[2018-10-11] foliantcontrib.includes 1.0.9¶

Don’t crash on failed repo sync (i.e. when you’re offline).

[2018-10-11] foliantcontrib.mkdocs 1.0.5¶

Require MkDocs 1.0.4.

[2018-10-02] foliantcontrib.replace 1.0.1¶

Strings with image links are ignored.

[2018-10-01] foliantcontrib.gupload 1.1.2¶

Convert to google docs format setting added.

[2018-09-25] foliantcontrib.gupload 1.1.1¶

Unification of repository name, settings section name, and command.

[2018-09-25] foliantcontrib.gupload 1.1.0¶

Backend was converted to CLI extension.

[2018-09-25] foliantcontrib.multilinetables 1.1.3¶

'targets' option added to the preprocessor settings.

[2018-09-21] foliantcontrib.slate 1.0.2¶

Rename shards_path param to shards. It now accepts string or list.
Fix no header param.

[2018-09-20] foliantcontrib.slate 1.0.1¶

Remove flatten. First chapter goes to index.html.md; all the rest go into the includes.

[2018-09-18] foliantcontrib.gupload 1.0.1¶

Command line authentication was added, for example for Docker use.

[2018-09-14] foliantcontrib.testrail 1.0.1¶

Preprocessor folder structure fixed.

[2018-09-12] foliantcontrib.bindsympli 1.0.6¶

Do not disable images downloading. Use delays when filling email and password fields. Wait for idle network connections when loading pages.

[2018-08-31] foliant 1.0.6¶

CLI: If no args are provided, print help.
Fix tags searching pattern in _unescape preprocessor.

[2018-08-29] foliantcontrib.pgsqldoc 1.1.2¶

Queries are now ordered (not adjustable right now)
Flexable filters instead of strict filtering by schema

[2018-08-27] foliantcontrib.pgsqldoc 1.1.1¶

Fix scheme template (blank lines issue)
Refactor queries code

[2018-08-24] foliantcontrib.multilinetables 1.1.2¶

Now it's possible to break the text anywhere in multiline tables with custom tag.
Fixed determination of columns number in tables with and without side lines.

[2018-08-24] foliantcontrib.pgsqldoc 1.1.0¶

Docs and scheme structure is now defined by Jinja2 templates.

[2018-08-22] foliantcontrib.multilinetables 1.1.1¶

Bug with regular expression fixed. 3+ code strings with || operator in a row are not perceived as a tables now.

[2018-08-22] foliantcontrib.multilinetables 1.1.0¶

Code strings with || operator are not perceived as a tables now.

[2018-07-31] foliantcontrib.bump 1.0.2¶

Declare semver as dependency.

[2018-07-29] foliantcontrib.bump 1.0.1¶

Fix packaging with setup.py. Poetry doesn't quite do the trick 😔

[2018-07-28] foliantcontrib.bump 1.0.0¶

Initial release.

[2018-07-24] foliantcontrib.mkdocs 1.0.4¶

Provide customizable default names for untitled nested groups of chapters.

[2018-07-24] foliantcontrib.flatten 1.0.4¶

Skip empty headings of nested subsections.

[2018-07-23] foliantcontrib.includes 1.0.8¶

Require at least one space after hashes in the beginning of each heading.
Add inline option to the <include> tag.
Fix the bug: do not ignore empty lines after headings when using sethead.
Fix the bug: allow to use less than 3 characters in the heading content.
Do not mark as headings the strings that contain more than 6 leading hashes. If shifted heading level is more than 6, mark the heading content as bold paragraph text, not as heading.

[2018-06-08] foliantcontrib.multiproject 1.0.5¶

Provide Git submodules support.

[2018-06-07] foliantcontrib.flatten 1.0.3¶

Use flattened file path in includes preprocessor call.
Require includes preprocessor 1.0.7.

[2018-06-06] foliantcontrib.includes 1.0.7¶

Fix paths resolving in case of recursive processing of include statements.
Allow revision markers in repo aliases.

[2018-06-04] foliantcontrib.includes 1.0.6¶

Fix logging in file search method.
Fix top heading level calculation.

[2018-06-04] foliantcontrib.multiproject 1.0.4¶

Provide compatibility with Foliant 1.0.5. Allow to use multiple config files.

[2018-06-04] foliantcontrib.pandoc 1.0.6¶

Apply flatten after all preprocessors, not before them. This fixes incompatibility with foliantcontrib.includes 1.0.5.

[2018-06-04] foliantcontrib.flatten 1.0.2¶

Fix incorrect includes preprocessor call.
Require Foliant 1.0.5.

[2018-06-04] foliantcontrib.init 1.0.5¶

Require Foliant 1.0.5 with prompt_toolkit^2.0.0.

[2018-05-30] foliantcontrib.customids 1.0.4¶

Provide separate block-level HTML elements for the anchors. Allow to define custom stylesheets for these elements.

[2018-05-25] foliantcontrib.includes 1.0.5¶

Use paths that are relative to the current processed Markdown file.
Fix sethead behavior for headings that contains hashes (#).

[2018-05-14] foliant 1.0.5¶

Allow to override default config file name in CLI.
Allow multiline tags. Process true and false attribute values as boolean, not as integer.
Add tests.
Improve code style.

[2018-05-10] foliantcontrib.pandoc 1.0.5¶

Add slug config option.

[2018-05-08] foliantcontrib.multiproject 1.0.3¶

Fix config loading. Other small fixes.

[2018-04-25] foliantcontrib.multiproject 1.0.2¶

Fix bugs with the project directory path and Git repos syncronizing.

[2018-04-23] foliantcontrib.multiproject 1.0.1¶

Fix logging.

[2018-04-20] foliantcontrib.bindsympli 1.0.5¶

Add logging.

[2018-04-20] foliantcontrib.plantuml 1.0.2¶

Fix logging in __init__.

[2018-04-20] foliantcontrib.plantuml 1.0.1¶

Add logging.

[2018-04-20] foliantcontrib.flatten 1.0.1¶

Fix incorrect includes preprocessor call.
Add logging.
Require Foliant 1.0.4.

[2018-04-19] foliantcontrib.epsconvert 1.0.4¶

Do not use image path when computing MD5 hash.
Add targets config option.
Add logging.

[2018-04-19] foliantcontrib.templates.preprocessor 1.0.0¶

Initial release.

[2018-04-18] foliantcontrib.customids 1.0.3¶

Add targets config option.
Add logging.

[2018-04-14] foliantcontrib.blockdiag 1.0.2¶

Add logging.
Require Foliant 1.0.4.

[2018-04-14] foliantcontrib.pandoc 1.0.4¶

Add logs.
Update for Foliant 1.0.4: Pass logger to spinner.
Require Foliant 1.0.4.

[2018-04-14] foliantcontrib.mkdocs 1.0.3¶

Add logs.
Update for Foliant 1.0.4: Pass logger to spinner.
Require Foliant 1.0.4.

[2018-04-14] foliantcontrib.init 1.0.4¶

Replace placeholders in file and directory names.
Process *.py files.
User Template strings instead of format strings for safer substitutions.
Update for Foliant 1.0.4: Pass logger to spinner.
Require Foliant 1.0.4.

[2018-04-11] foliant 1.0.4¶

Breaking change. Add logging to all stages of building a project. Config parser extensions, CLI extensions, backends, and preprocessors can now access self.logger and create child loggers with self.logger = self.logger.getChild('newbackend').
Add pre backend with pre target that applies the preprocessors from the config and returns a Foliant project that doesn't require any preprocessing.
make now returns its result, which makes is easier to call it from extensions.

[2018-04-10] foliantcontrib.bindsympli 1.0.4¶

Describe the preprocessor usage in README.md.

[2018-04-10] foliantcontrib.bindsympli 1.0.3¶

Eliminate external Perl scripts, rewrite the preprocessor code in Python.

[2018-04-02] foliant 1.0.3¶

Fix critical issue when config parsing would fail if any config value contained non-latin characters.

[2018-04-01] foliantcontrib.includes 1.0.4¶

Fix the pattern for headings detection.

[2018-03-31] foliantcontrib.includes 1.0.3¶

Allow hashes (# characters) in the content of headings.

[2018-03-29] foliantcontrib.epsconvert 1.0.3¶

Take into account the content of image file when computing MD5 hash.

[2018-03-29] foliantcontrib.epsconvert 1.0.2¶

Add support of any local paths. Add image cache.
Remove mogrify_path and diagrams_cache_dir options, add convert_path and cache_dir instead.

[2018-03-28] foliantcontrib.customids 1.0.2¶

Process first heading and all other headings separately.

[2018-03-27] foliantcontrib.customids 1.0.1¶

Update README.md and docstrings.
Update long description content type in setup.py

[2018-03-27] foliantcontrib.bindsympli 1.0.2¶

Change the path for non-Python scripts once more.

[2018-03-27] foliantcontrib.bindsympli 1.0.1¶

Change the path for non-Python scripts.

[2018-03-21] foliantcontrib.includes 1.0.2¶

Fix inappropriate translation of image URLs into local paths.

[2018-03-21] foliantcontrib.mkdocs 1.0.2¶

Add use_headings and slug options for MkDocs backend.
Fix inappropriate translation of image URLs into local paths in MkDocs preprocessor.

[2018-03-17] foliant 1.0.2¶

Use README.md as package description.

[2018-03-13] foliantcontrib.epsconvert 1.0.1¶

Add diagrams_cache_dir option support.

[2018-02-28] foliantcontrib.pandoc 1.0.3¶

Change Pandoc command line parameter --reference-docx to --reference-doc.

[2018-02-25] foliant 1.0.1¶

Fix critical bug with CLI module caused by missing version definition in the root __init__.py file.

[2018-02-23] foliant 1.0.0¶

Complete rewrite.

[2018-02-16] foliantcontrib.blockdiag 1.0.1¶

Add pdf output format support.

[2018-02-07] foliantcontrib.init 1.0.3¶

Upon creation, relative path to the created project directory is returned instead of an absolute one.
Templates: basic: Foliant docs related content removed from README.md.
Templates: basic: foliantcontrib.mkdocs added to requirements.txt.

[2018-02-07] foliantcontrib.init 1.0.2¶

Add slug placeholder.
Process placeholders in .yml, .txt, and .md files, not just foliant.yml.
Templates: basic: Add Dockerfile, docker-compose.yml, requirements.txt, and README.md.

[2018-02-07] foliantcontrib.init 1.0.1¶

Fix issue with init command missing after installation.
Fix issue with missing templates after installation.

[2018-02-01] foliantcontrib.macros 1.0.3¶

Add tag <m>...</m>.

[2018-01-17] foliantcontrib.macros 1.0.2¶

Switch from unnamed to named parameters.
Macro name is now defined in the tag body instead of "name" option.

[2018-01-15] foliantcontrib.macros 1.0.1¶

Preserve param case.

[2018-01-06] foliantcontrib.flags 1.0.1¶

Add targets and backends options to <if> tag.

[2018-01-05] foliantcontrib.pandoc 1.0.2¶

Change default Markdown flavor from markdown_strict to markdown.

[2017-12-17] foliantcontrib.pandoc 1.0.1¶

Add tex target.

[2017-12-16] foliantcontrib.mkdocs 1.0.1¶

Add ghp target for GitHub Pages deploy with mkdocs gh-deploy.

[2017-12-15] foliantcontrib.includes 1.0.1¶

Fix git repo name detection when the repo part contains full stops.