forked from lessonomicon/mccole
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
379 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| """Initialization required by template.""" | ||
|
|
||
| import ark | ||
| from datetime import datetime | ||
| from pathlib import Path | ||
| import shortcodes | ||
| from shutil import copyfile | ||
|
|
||
| import util | ||
|
|
||
|
|
||
| @ark.events.register(ark.events.Event.INIT_BUILD) | ||
| def init_build(): | ||
| """Launch startup tasks in order.""" | ||
| _init_date() | ||
| _number_contents() | ||
| _collect_titles() | ||
| _collect_targets() | ||
|
|
||
|
|
||
|
|
||
| @ark.events.register(ark.events.Event.EXIT_BUILD) | ||
| def exit_build(): | ||
| """Run finalization tasks in order.""" | ||
| _copy_files() | ||
|
|
||
|
|
||
| @ark.filters.register(ark.filters.Filter.LOAD_NODE_FILE) | ||
| def filter_files(value, filepath): | ||
| """Only process HTML and Markdown files.""" | ||
| result = filepath.suffix in {".html", ".md"} | ||
| return result | ||
|
|
||
|
|
||
| def _collect_targets(): | ||
| """Collect targets of numbered cross-references.""" | ||
|
|
||
| def _collect_figures(pargs, kwargs, extra): | ||
| util.require( | ||
| "slug" in kwargs, | ||
| f"Bad 'figure' in {extra['filename']}: '{pargs}' and '{kwargs}'", | ||
| ) | ||
| extra["figures"].append(kwargs["slug"]) | ||
|
|
||
| def _collect_tables(pargs, kwargs, extra): | ||
| util.require( | ||
| "slug" in kwargs, | ||
| f"Bad 'table' in {extra['filename']}: '{pargs}' and '{kwargs}'", | ||
| ) | ||
| extra["tables"].append(kwargs["slug"]) | ||
|
|
||
| def _collect_this(node): | ||
| return node.slug and (node.ext == "md") | ||
|
|
||
| def _visitor(node): | ||
| if not _collect_this(node): | ||
| return | ||
|
|
||
| collected = {"filename": node.filepath, "figures": [], "tables": []} | ||
| parser.parse(node.text, collected) | ||
| if node.slug not in collector: | ||
| collector[node.slug] = {"figures": {}, "tables": {}} | ||
| number = ark.site.config["_number_"][node.slug]["number"] | ||
| collector[node.slug]["figures"].update( | ||
| { | ||
| fig_slug: {"slug": f"{number}.{i + 1}", "node": node.slug} | ||
| for i, fig_slug in enumerate(collected["figures"]) | ||
| } | ||
| ) | ||
| collector[node.slug]["tables"].update( | ||
| { | ||
| tbl_slug: {"slug": f"{number}.{i + 1}", "node": node.slug} | ||
| for i, tbl_slug in enumerate(collected["tables"]) | ||
| } | ||
| ) | ||
|
|
||
| parser = shortcodes.Parser(inherit_globals=False, ignore_unknown=True) | ||
| parser.register(_collect_figures, "figure") | ||
| parser.register(_collect_tables, "table") | ||
| collector = {} | ||
| ark.nodes.root().walk(_visitor) | ||
| ark.site.config["_figures_"] = {} | ||
| ark.site.config["_tables_"] = {} | ||
| for slug, seen in collector.items(): | ||
| for key, number in seen["figures"].items(): | ||
| ark.site.config["_figures_"][key] = number | ||
| for key, number in seen["tables"].items(): | ||
| ark.site.config["_tables_"][key] = number | ||
|
|
||
|
|
||
| def _collect_titles(): | ||
| """Gather titles of pages.""" | ||
| assert "_number_" in ark.site.config | ||
|
|
||
| def _visitor(node): | ||
| if node.ext != "md": | ||
| return | ||
| if not node.slug: | ||
| return | ||
| assert node.slug in ark.site.config["_number_"] | ||
| ark.site.config["_number_"][node.slug]["title"] = node.meta["title"] | ||
|
|
||
| ark.nodes.root().walk(_visitor) | ||
|
|
||
|
|
||
| def _copy_files(): | ||
| """Copy files from source directories (not recursive).""" | ||
| for pat in ark.site.config["copy"]: | ||
| src_dir = ark.site.src() | ||
| out_dir = ark.site.out() | ||
| for src_file in Path(src_dir).rglob(f"**/{pat}"): | ||
| out_file = str(src_file).replace(src_dir, out_dir) | ||
| Path(out_file).parent.mkdir(exist_ok=True, parents=True) | ||
| copyfile(src_file, out_file) | ||
|
|
||
|
|
||
| def _init_date(): | ||
| """Add the date to the site configuration object.""" | ||
| ark.site.config["_timestamp_"] = datetime.utcnow() | ||
|
|
||
|
|
||
| def _number_contents(): | ||
| """Number chapters and appendices.""" | ||
| chapters = { | ||
| slug: {"kind": util.kind("chapter"), "number": str(i + 1)} | ||
| for i, slug in enumerate(ark.site.config["chapters"]) | ||
| } | ||
| appendices = { | ||
| slug: {"kind": util.kind("appendix"), "number": chr(ord("A") + i)} | ||
| for i, slug in enumerate(ark.site.config["appendices"]) | ||
| } | ||
| ark.site.config["_number_"] = chapters | appendices |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| """Handle figures references and figures.""" | ||
|
|
||
| import ark | ||
| import shortcodes | ||
|
|
||
| import util | ||
|
|
||
|
|
||
| @shortcodes.register("f") | ||
| def figure_ref(pargs, kwargs, node): | ||
| """Handle [%f slug %] figure reference shortcode.""" | ||
| util.require( | ||
| (len(pargs) == 1) and (not kwargs), | ||
| f"Bad 'f' in {node.path}: '{pargs}' and '{kwargs}'", | ||
| ) | ||
| slug = pargs[0] | ||
| known = ark.site.config["_figures_"] | ||
| util.require(slug in known, f"Unknown figure slug {slug} in {node.path}") | ||
| number = known[slug]["slug"] | ||
| file_slug = known[slug]["node"] | ||
| caption = f"{util.kind('figure')} {number}" | ||
| return f'<a class="fig-ref" href="@root/{file_slug}/#{slug}">{caption}</a>' | ||
|
|
||
|
|
||
| @shortcodes.register("figure") | ||
| def figure_def(pargs, kwargs, node): | ||
| """Handle figure definition.""" | ||
| allowed = {"cls", "scale", "slug", "img", "alt", "caption"} | ||
| util.require( | ||
| (not pargs) and util.allowed(kwargs, allowed), | ||
| f"Bad 'figure' in {node.path}: '{pargs}' and '{kwargs}'", | ||
| ) | ||
|
|
||
| cls = kwargs.get("cls", None) | ||
| cls = f' class="{cls}"' if cls is not None else "" | ||
|
|
||
| scale = kwargs.get("scale", None) | ||
| scale = f' width="{scale}"' if scale is not None else "" | ||
|
|
||
| slug = kwargs["slug"] | ||
| img = kwargs["img"] | ||
| alt = util.markdownify(kwargs["alt"]) | ||
| caption = util.markdownify(kwargs["caption"]) | ||
|
|
||
| util.require_file(node, img, "figure") | ||
| known = ark.site.config["_figures_"] | ||
|
|
||
| label = f"{util.kind('figure')} {known[slug]['slug']}" | ||
| body = f'<img src="./{img}" alt="{alt}"{scale}/>' | ||
| caption = f'<figcaption>{label}: {caption}</figcaption>' | ||
| return f'<figure id="{slug}"{cls}>\n{body}\n{caption}\n</figure>' |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.