summaryrefslogtreecommitdiff
path: root/subplot.md
AgeCommit message (Collapse)AuthorFilesLines
2023-11-11Merge branch 'fix-320' into 'main'Lars Wirzenius1-0/+68
Make bindings parsing more strict, and validate that strictness Closes #320 See merge request subplot/subplot!364
2023-11-11subplot: Validate some of the bindings semi-strictnessDaniel Silverstone1-0/+68
2023-10-30feat: allow adding CSS URLs to HTML outputLars Wirzenius1-0/+34
This is in the meta data field "css_urls". Signed-off-by: Lars Wirzenius <liw@liw.fi> Sponsored-by: author
2023-10-30feat: allow .subplot to list CSS files to embed in HTML outputLars Wirzenius1-0/+45
This is in the meta data field "css_embed". Signed-off-by: Lars Wirzenius <liw@liw.fi> Sponsored-by: author
2023-07-10Merge branch 'liw/unbib' into 'main'Daniel Silverstone1-31/+0
feat! drop support for bibliographies in document metadata Closes #326 See merge request subplot/subplot!346
2023-07-10Merge branch 'liw/atomic-function' into 'main'Daniel Silverstone1-0/+18
docs: make it clear that cleanups are call only on successful steps Closes #261 See merge request subplot/subplot!344
2023-07-02feat! drop support for bibliographies in document metadataLars Wirzenius1-31/+0
We don't use the bibliographies for anything so there's not point in allowing users to specify it. If and when we add support for bibliographies again, we may well want to do it in a different way. Alas, we also have to disable reference.md because the release it refers to uses bibliographies. We'll have to re-enable it again after the next release. Sponsored-by: author
2023-07-02docs: reserve all attributes on scenarios for SubplotLars Wirzenius1-0/+5
Sponsored-by: author
2023-07-02docs: make it clear that cleanups are call only on successful stepsLars Wirzenius1-0/+18
Sponsored-by: author
2023-06-10feat: Warn when named codeblocks lack classesDaniel Silverstone1-0/+50
To both improve debugability when writing scenarios, and also to protect against future incompatibilities which might occur if we add more classes which are appropriate for named code blocks, we require that named blocks have one of `file` or `example` as classes or else we warn. Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2023-06-07feat! don't allow indented scenario stepsLars Wirzenius1-0/+36
Some day we will have syntax for continuing a step to the next line. This change makes it easier to introduce that syntax, without a breaking change. Sponsored-by: author
2023-06-03fix: allow docgen to handle a subplot not in current directoryLars Wirzenius1-0/+24
Sponsored-by: author
2023-05-31feat! docgen always outputs a documentLars Wirzenius1-92/+0
We have long had a feature for docgen that checks the time stamps of all input files and the output file and avoids running Pandoc to produce the output file, if the output file won't change. This has always been a little imperfect: sometimes the output file would change due to other changes than what's in the input files. For example, when Pandoc changes, or when Subplot code changes. This has led to surprised users. We no longer user Pandoc at all. Drop the time stamp checking functionality and have docgen always write the output file. Sponsored-by: author
2023-05-19tests: verify that Subplot reports specific errors with locationLars Wirzenius1-0/+86
Sponsored-by: author
2023-05-14feat: check for duplicate scenario titlesLars Wirzenius1-0/+42
Sponsored-by: author
2023-05-10feat! allow multiple markdown files for a subplotLars Wirzenius1-0/+38
Sponsored-by: author
2023-04-30fix: extraction of plain text in scenario titlesLars Wirzenius1-0/+34
When I changed Subplot to use pulldown_cmark for parsing markdown, I introduced a bug: if a scenario title uses markup (e.g., bold face), that part of the title was dropped when it was converted into scenario title. Fix that. Sponsored-by: author
2023-04-08tests(subplot.md): update subplot for Pandoc-less futureLars Wirzenius1-104/+51
Sponsored-by: author
2023-02-14feat! drop support for producing PDF outputLars Wirzenius1-51/+33
We may add this back later, but for now, it's not wanted. Sponsored-by: author
2023-01-22fix: markdown in test dataLars Wirzenius1-0/+1
A fenced code block can't start in middle of text, so add an empty line to avoid doing that. Sponsored-by: author
2022-10-25feat! subplot metadata field for authorsLars Wirzenius1-3/+8
Rename the field "author", which takes a single string value, to "authors", which takes a list of strings. This way we're consistent for single- and multi-author documents. Sponsored-by: author
2022-10-22(subplot.md): Add scenario about not needing a template for docgenDaniel Silverstone1-0/+34
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2022-10-22feat: allow arbitrary Pandoc metadata in a .subplotLars Wirzenius1-0/+26
The "pandoc" key gets added to the metadata given to Pandoc as-is. Sponsored-by: author
2022-09-28fix: include the subplot in the sources of the documentLars Wirzenius1-0/+18
This means that if only the subplot is modified, docgen will rebuild the output. Sponsored-by: author
2022-09-06feat! read document metadata from a YAML fileLars Wirzenius1-248/+375
This is a huge change all in one commit, sorry. However, as it changes a fundamental part of the command line interface (namely, what constitutes as the input file), there doesn't seem a way to break this into a tidy series of small commits. Most of the diff is in subplot.md, where every scenario that invokes Subplot needs multiple changes, thus touching much of the file. The overall change is that where we previously had document metadata in embedded YAML in the Markdown file, we now have it in a separate YAML file. The Markdown file is named in the YAML file. We still parse the Markdown with Pandoc for everything, except codegen. Switching from Pandoc to pulldown_cmark for parsing will be another big change that I didn't want to include in this huge change set. Sponsored-by: author
2022-08-14feat! drop support to act as a Pandoc filterLars Wirzenius1-43/+21
When we change Subplot to take a YAML file instead of a Markdown file as input, it doesn't make sense to act as a Pandoc filter anymore: Pandoc doesn't understand our YAML file. In any case, I seem to have been the only user ever of that feature, so it won't really bother anyone else. Even so, we should treat this as a breaking change. "subplot docgen" still works as before. Sponsored-by: author
2022-08-13feat: make errors have a source errorLars Wirzenius1-2/+4
When errors have a source, i.e., an underlying error, it results in better error messages to the user. Also, refactor the way the source chain is printed, to code that is clearer to me. I will need this to for loading document metadata from an external YAML file. Sponsored-by: author
2022-07-16(subplot.md): Fix for newer pandocDaniel Silverstone1-4/+4
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2022-05-04(subplot.md): Add example scenarios covering example blocksDaniel Silverstone1-0/+57
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2022-04-26refactor: use "diagram" instead of "graph"Lars Wirzenius1-12/+12
Change everywhere to use the word "diagram" instead of "graph. Diagram seems like the better word. It's mostly used in comments and documentation, but there was one filename and one trait name that needed changing. I used "rg -iw graph" and "find -iname '*graph*'" to find everywhere that needed changing. Sponsored-by: author
2022-04-10feat! treat warnings as errors by defaultLars Wirzenius1-7/+17
Add a --merciful option to subcommands for which this matters. Adjust tests to invoke subplot with that option as necessary. Sponsored-by: author
2022-04-09'should be' feels wrong here, 'are' seems a better fitXipmix1-1/+1
2022-04-09Comma to break sentence into contrasting optionsXipmix1-1/+1
2022-04-09Reword sentence after standing back and staring a bitXipmix1-2/+2
2022-04-09Break long sentenceXipmix1-1/+1
2022-04-09Reword opening sentence and tidy up related textXipmix1-4/+3
On a first reading, this sentence seemed circular to me. After many, many rereadings, the only way I could interpret it was as shown here. Since the second paragraph is now repeating the first, prune it and rearrange the line break in the second sentence.
2022-04-09Remove full stopXipmix1-1/+1
Unusual in headings and not done elsewhere in the document
2022-03-23Clarify these two sections are closely relatedXipmix1-4/+6
2022-03-23typoXipmix1-1/+1
2022-03-16pluralXipmix1-1/+1
2022-03-16typosXipmix1-3/+3
2022-03-16tenseXipmix1-1/+1
2022-03-16trailing space in other placesXipmix1-12/+12
2022-03-16trailing space in python implsXipmix1-29/+29
2022-03-16mdashXipmix1-1/+1
2022-02-19(doc): Add scenario runner comparison 'table'Daniel Silverstone1-0/+26
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2022-01-26feat: automatically use "and" on outputLars Wirzenius1-11/+15
This changes typesetting of scenarios so that when two adjacent scenario steps have the same keyword, "and" is used on the second one. This means that when input has when I do foo when I do bar the output will have when I do foo and I do bar I didn't bother to make this configurable. I don't feel that level of configuration is good. The "keyword aliases" scenario is repurposed to verify this. Sponsored-by: author
2022-01-01subplotlib: Run subplot.md in Rust tooDaniel Silverstone1-0/+2
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-11-27feat: warn about unused embedded filesLars Wirzenius1-0/+26
This is merely a warning, for now, to stderr. subplot.md has two embedded files used as examples, and I'm too tired to add a way to indicate that it's OK for a specific file to not be used. That should probably be added later, though. Sponsored-by: author
2021-11-27fix: markup of embedded markdown in subplot.mdLars Wirzenius1-2/+2
The embedded file with markdown was insufficiently escaped. Sponsored-by: author