Skip to content

Commit f938eac

Browse files
authored
Merge pull request #2 from OpenDucks/fix-docs-parser
v1.3.0
2 parents 8de5170 + 1483820 commit f938eac

23 files changed

Lines changed: 2350 additions & 599 deletions

CHANGELOG.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,47 @@
11
# CHANGELOG.md
22

3+
## v1.3.0
4+
5+
- Added support for `@title "..."` in shared `@tags_import` files so tag statistics outputs (`statistics`, `json`, `html`, `pdf`) can use a custom report title instead of the file path.
6+
- Added full tag statistics support for `@tag_sources` with structured outputs via:
7+
- `protoparser tags <tags_file> statistics`
8+
- `protoparser tags <tags_file> json`
9+
- `protoparser tags <tags_file> html`
10+
- `protoparser tags <tags_file> pdf`
11+
- Added support for cross-file tag statistics using multiple shared tag files with nested `@tags_import` references.
12+
- Updated tag statistics so local tag overrides inside referenced source `.pml` files are preserved and shown in the task entries.
13+
- Added general `.pml` cross-reference analysis via `protoparser analyze <pml_file> <format>` with local stats, resolved stats, content imports, tag imports and recursive reference trees.
14+
- Added output directory support via `protoparser <file> <format> <output_dir>` e.g. `protoparser test.pml html ./html`
15+
- Added automatic output subdirectories for documents that use `@import ... html` or `@import ... pml` so rendered files are written to folders like `html/test.html` instead of cluttering the source directory.
16+
- Added a complete example and feature test set under `examples/feature-suite/` including:
17+
- 2 shared tag files
18+
- 2 `.pml` files
19+
- 1 imported `.html` file
20+
- macro usage, imports, tags, nested tag analysis and local tag overrides
21+
- Updated `README.md` to document the new tag analysis, output handling and example usage.
22+
23+
## v1.2.0
24+
25+
- Added full parser support for `@tags` and `@tags_import`, including external tag merging and task tag resolution
26+
- Added `@protocol "..."` to customize the HTML document title and top page heading, with placeholder support such as `{{date}}`
27+
- Added `@meeting "..."` as a shorthand to set a custom rendered meeting section title while still opening the `@meeting` block
28+
- Added support for `@import` command to include external `.pml` or `.html` files into the current file. Example usage:
29+
- Import file: `@import reference "fileName" type` e.g. `@import header "header.pml" pml`
30+
- Output contents: `@@import=header` or `@@output=header`
31+
- When using the `@import` command, the imported `.pml` content will be merged into the current file and processed as if it were part of the original file. This allows for modularization and reuse of common components across multiple files.
32+
- Added support for `@protocol` and `@meeting` commands to allow customization.
33+
- Example usage:
34+
- `@protocol "Custom Protocol Title {{date}}"` to set a custom title for the protocol document, with support for placeholders like `{{date}}` which will be replaced with the current date.
35+
- `@meeting "Custom Meeting Title"` to set a custom title for the meeting section while still opening the `@meeting` block for content.
36+
- Fixed an issue with the `@macro` loading command and the `--listMacros` command that could not properly process the `{{macro_dir}}` placeholder for loading macros from the default macro directory.
37+
38+
## v1.1.2
39+
40+
- Added `image` macro for embedding images. Supports local and remote images. Example usage:
41+
- `@@macro=image:src=assets/logo.png`
42+
- `@@macro=image:src=https://example.com/image.jpg`
43+
- Fixed an issue with comments being incorrectly or unintentionally parsed as content. Comments are now properly ignored or filtered during parsing.
44+
345
## v1.1.1
446

547
- Fixed an issue with the `--docs` command where it would not display documentation correctly.
@@ -14,4 +56,4 @@
1456

1557
## prior v1.0.6
1658

17-
There was no CHANGELOG.md file before v1.0.6.
59+
There was no CHANGELOG.md file before v1.0.6.

0 commit comments

Comments
 (0)