Compare commits

...

23 commits

Author SHA1 Message Date
8b26f63494 Forgotten readme edit 2024-09-25 20:02:31 +02:00
fa6b772674 Fixed typo in context.unset_data
Picked from 71e5c5b and 38029e3
2024-03-18 20:55:34 +01:00
2a0e90bb96 Quick fix srcsetů, hodně malé obrázky nenafoukneme víc, než je potřeba. 2024-03-07 19:47:31 +01:00
0e5735cba2 Added FileLink element for publishing and linking local files. 2024-03-07 17:58:18 +01:00
42d04b77de Added title attribute for images, fixed formatting of raw blocks. 2024-02-27 16:24:27 +01:00
583b3ba010 Stop adding NBSPs around TeX math. Patches welcome to make this smarter. 2024-02-27 10:14:19 +01:00
9ccd2886b9 Bump katex-server: Nobody needs a better nullish coalescing operator than OR 2024-02-27 10:11:39 +01:00
c90e00a1ae Fix broken transformation of divs and spans. 2024-02-27 10:02:19 +01:00
7f52abde14 katex-server bump: Removed null coalescing operator, because I don't want to update node on every computer in existence. 2024-02-24 02:11:57 +01:00
f0d939a65b Separate context init for transform processor into separate function, add option to not make images clickable. 2024-02-23 23:37:22 +01:00
f14f28d3a4 Added dependency printing 2024-02-22 14:02:32 +01:00
cd07b3abf8 Creating of dirs in namespaces only when they're accessed (this is needed because until then, we don't know what $dir is. Also telling pandoc to strip comments. 2024-02-22 11:50:50 +01:00
a1c439c32e Minor fixes, typos, generating of MetaValues, fixed error where KeyErrors from the inside of the tree would get eaten. 2024-02-21 23:34:23 +01:00
72b9bc7bf1 Add special StandaloneHTMLGenerator. Also handle prepending the document in a more pandocy way. 2024-02-21 21:43:49 +01:00
7f3490536e Attach Groups correctly in the tree, Images now support height in HTML. 2024-02-21 16:27:04 +01:00
3ce0b5037b Some changes to allow commands to touch the rest of the tree they're currently in. This shall only be done on parts of the tree not yet transformed, otherwise, very weird things can happen. 2024-02-21 15:04:25 +01:00
e2f2c4f5f0 Ještě více magie, která se snaží zachraňovat blokové výstupy z příkazů, které byly zavolány jako Span. 2024-02-20 20:09:58 +01:00
7b81919914 OK the submodule was broken. 2024-02-20 18:27:34 +01:00
6180b581b8 KaTeX server is now in separate repo. 2024-02-20 18:23:51 +01:00
93f5949361 Přidána data na kontextu nezávislá na docu. 2024-02-20 12:13:06 +01:00
5c066d46af Fix handlování cest obrázků, když jsou namespacové. 2024-02-20 01:00:36 +01:00
caef60d472 TP is now passed to commands. Output from the TP is not transformed automatically and has to be done manually from the commands. 2024-02-18 00:27:13 +01:00
84a4f6acb7 Merge pull request 'Přidány namespaces pro obrázky, jak jsme se o nich bavili s @mj' (#55) from image-namespaces into master
Reviewed-on: #55
2024-02-17 23:57:47 +01:00
26 changed files with 346 additions and 297 deletions

3
.gitmodules vendored
View file

@ -1,3 +1,6 @@
[submodule "ucwmac"] [submodule "ucwmac"]
path = ucwmac path = ucwmac
url = git://git.ucw.cz/ucwmac.git url = git://git.ucw.cz/ucwmac.git
[submodule "src/formatitko/katex-server"]
path = src/formatitko/katex-server
url = https://gitea.ks.matfyz.cz:/KSP/formatitko-katex-server

View file

@ -59,7 +59,7 @@ definition lists and citations. It also adds its own custom features.
Flags can be set in the Front Matter or with python code. Then, elements with Flags can be set in the Front Matter or with python code. Then, elements with
the `if` attribute will only be shown if the flag is set to True and elements the `if` attribute will only be shown if the flag is set to True and elements
with the `ifn` attribute will only be show if the flag is not set to True. with the `ifnot` attribute will only be show if the flag is not set to True.
**Example:** **Example:**
@ -72,7 +72,7 @@ flags:
[This will not be shown]{if=bar} [This will not be shown]{if=bar}
[This will be shown]{ifn=bar} [This will be shown]{ifnot=bar}
``` ```
### Including other files ### Including other files

View file

@ -16,7 +16,7 @@ class InlineCommand(Span, Command):
if len(content) == 1 and (isinstance(content[0], Para) or isinstance(content[0], Plain)): if len(content) == 1 and (isinstance(content[0], Para) or isinstance(content[0], Plain)):
return Span(*content[0].content) return Span(*content[0].content)
else: else:
raise InlineError(f"The command {self.attributes['c']} returned multiple Paragraphs and must be executed using `::: {{c={self.attributes['c']}}}\\n:::`.\n\n{content}") return Div(*content)
pass pass
class BlockCommand(Div, Command): class BlockCommand(Div, Command):

View file

@ -5,4 +5,5 @@ from formatitko.util import parse_string
from formatitko.context import Context from formatitko.context import Context
from formatitko.command import Command from formatitko.command import Command
from .nop_processor import NOPProcessor
from panflute import Element from panflute import Element

View file

@ -15,7 +15,7 @@ def parse_command(code: str) -> CommandCallable:
indented_code_lines = [] indented_code_lines = []
for line in code_lines: for line in code_lines:
indented_code_lines.append(("\t" if tabs else " ")+line) indented_code_lines.append(("\t" if tabs else " ")+line)
code = "def command(element: Command, context: Context) -> list[Element]:\n"+"\n".join(indented_code_lines) code = "def command(element: Command, context: Context, processor: NOPProcessor) -> list[Element]:\n"+"\n".join(indented_code_lines)
env = {**command_env.__dict__} env = {**command_env.__dict__}
exec(code, env) exec(code, env)
return env["command"] return env["command"]

View file

@ -3,11 +3,10 @@ from panflute import Doc, Element, Div, Span
from typing import Union, Callable from typing import Union, Callable
from types import ModuleType from types import ModuleType
import os import os
import warnings
from .command import Command from .command import Command
CommandCallable = Callable[[Command, 'Context'], list[Element]] # This is here because of a wild circular import dependency between many functions and classes CommandCallable = Callable[[Command, 'Context', 'NOPProcessor'], list[Element]] # This is here because of a wild circular import dependency between many functions and classes
# This class is used to keep state while transforming the document using # This class is used to keep state while transforming the document using
# transform.py. For the context to be available to the html and TeX generators, # transform.py. For the context to be available to the html and TeX generators,
@ -23,6 +22,7 @@ CommandCallable = Callable[[Command, 'Context'], list[Element]] # This is here b
class Context: class Context:
parent: Union["Context", None] parent: Union["Context", None]
_commands: dict[str, Union[CommandCallable, None]] _commands: dict[str, Union[CommandCallable, None]]
_data: dict[str, object]
doc: Doc doc: Doc
trusted: bool trusted: bool
path: str path: str
@ -30,10 +30,12 @@ class Context:
filename: str filename: str
root_dir: str # Absolute path to the dir of the file formátítko was called on root_dir: str # Absolute path to the dir of the file formátítko was called on
rel_dir: str # Relative path to the current dir from the root dir rel_dir: str # Relative path to the current dir from the root dir
deps: set[str]
def __init__(self, doc: Doc, path: str, parent: Union['Context', None]=None, trusted: bool=True): def __init__(self, doc: Doc, path: str, parent: Union['Context', None]=None, trusted: bool=True):
self.parent = parent self.parent = parent
self._commands = {} self._commands = {}
self._data = {}
self.doc = doc self.doc = doc
self.trusted = trusted self.trusted = trusted
self.path = path self.path = path
@ -41,6 +43,8 @@ class Context:
self.filename = os.path.basename(path) self.filename = os.path.basename(path)
self.root_dir = parent.root_dir if parent else os.path.abspath(self.dir) self.root_dir = parent.root_dir if parent else os.path.abspath(self.dir)
self.rel_dir = os.path.relpath(self.dir, self.root_dir) self.rel_dir = os.path.relpath(self.dir, self.root_dir)
self.deps = set()
self.add_dep(path)
if self.get_metadata("flags", immediate=True) is None: if self.get_metadata("flags", immediate=True) is None:
self.set_metadata("flags", {}) self.set_metadata("flags", {})
@ -113,7 +117,57 @@ class Context:
else: else:
self.set_metadata(key, data) self.set_metadata(key, data)
def get_data(self, key: str, immediate: bool=False):
data = self._data
keys = key.split(".")
try:
for k in keys:
data = data[k]
return data
except KeyError:
if self.parent and not immediate:
return self.parent.get_data(key)
else:
return None
def set_data(self, key: str, value: object):
data = self._data
keys = key.split(".")
for k in keys[:-1]:
try:
data = data[k]
except KeyError:
data[k] = {}
data = data[k]
data[keys[-1]] = value
def unset_data(self, key: str):
if key == "":
self._data = {}
data = self._data
keys = key.split(".")
for k in keys[:-1]:
data = data[k]
del data[keys[-1]]
def get_deps(self) -> list[str]:
if self.parent is not None:
return self.parent.get_deps()
else:
return self.deps
def add_dep(self, dep: str):
self.get_deps().add(os.path.abspath(dep))
def add_deps(self, deps: list[str]):
self.get_deps().update([os.path.abspath(path) for path in deps])
def get_context_from_doc(doc: Doc) -> Context:
if len(doc.content) == 1 and isinstance(doc.content[0], Group):
return doc.content[0].context
else:
return None
# This is a custom element which creates \begingroup \endgroup groups in TeX # This is a custom element which creates \begingroup \endgroup groups in TeX
# and also causes KaTeX math blocks to be isolated in a similar way. # and also causes KaTeX math blocks to be isolated in a similar way.

View file

@ -1,4 +1,4 @@
from panflute import Quoted from panflute import Quoted, Link
from .command import Command, InlineCommand, BlockCommand, CodeCommand from .command import Command, InlineCommand, BlockCommand, CodeCommand
@ -14,3 +14,6 @@ class FQuoted(Quoted):
del kwargs["style"] del kwargs["style"]
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
class FileLink(Link):
pass

View file

@ -8,14 +8,14 @@ import shutil
# Import local files # Import local files
from .util import import_md from .util import import_md
from .context import Context, BlockGroup
from .katex import KatexClient from .katex import KatexClient
from .images import ImageProcessor, ImageProcessorNamespace from .images import ImageProcessor, ImageProcessorNamespace
from .output_generator import OutputGenerator, FormatitkoRecursiveError from .output_generator import OutputGenerator, FormatitkoRecursiveError
from .html_generator import HTMLGenerator from .html_generator import HTMLGenerator, StandaloneHTMLGenerator
from .transform_processor import TransformProcessor from .transform_processor import TransformProcessor
from .pandoc_processor import PandocProcessor from .pandoc_processor import PandocProcessor
from .tex_generator import UCWTexGenerator from .tex_generator import UCWTexGenerator
from .context import get_context_from_doc
from panflute import convert_text from panflute import convert_text
@ -27,6 +27,7 @@ def main():
parser.add_argument("-c", "--img-cache-dir", help="Directory to cache processed images and intermediate products. The program will overwrite files, whose dependencies are newer.", default="cache") parser.add_argument("-c", "--img-cache-dir", help="Directory to cache processed images and intermediate products. The program will overwrite files, whose dependencies are newer.", default="cache")
parser.add_argument("-i", "--img-web-path", help="Path where the processed images are available on the website.", default="/") parser.add_argument("-i", "--img-web-path", help="Path where the processed images are available on the website.", default="/")
parser.add_argument("-w", "--output-html", help="The HTML file (for Web) to write into.") parser.add_argument("-w", "--output-html", help="The HTML file (for Web) to write into.")
parser.add_argument("-s", "--output-standalone-html", help="The Standalone HTML file to write into. A full page is generated instead of just a fragment.")
parser.add_argument("-t", "--output-tex", help="The TEX file to write into.") parser.add_argument("-t", "--output-tex", help="The TEX file to write into.")
parser.add_argument("-m", "--output-md", help="The Markdown file to write into. (Uses pandoc to generate markdown)") parser.add_argument("-m", "--output-md", help="The Markdown file to write into. (Uses pandoc to generate markdown)")
parser.add_argument("-j", "--output-json", help="The JSON file to dump the pandoc-compatible AST into.") parser.add_argument("-j", "--output-json", help="The JSON file to dump the pandoc-compatible AST into.")
@ -35,6 +36,8 @@ def main():
parser.add_argument("-k", "--katex-socket", help="The KaTeX server socket filename obtained by running with `--katex-server`.") parser.add_argument("-k", "--katex-socket", help="The KaTeX server socket filename obtained by running with `--katex-server`.")
parser.add_argument("input_filename", help="The markdown file to process.", nargs="?" if "--katex-server" in sys.argv else None) parser.add_argument("input_filename", help="The markdown file to process.", nargs="?" if "--katex-server" in sys.argv else None)
parser.add_argument("--debug", action='store_true') parser.add_argument("--debug", action='store_true')
parser.add_argument("--traceback-limit", help="Traceback limit for when errors happen, defaults to 0, as it is only useful for internal debugging.", default=0)
parser.add_argument("--deps", help="File to write list of dependencies to. May depend on output formats used.")
args = parser.parse_args() args = parser.parse_args()
if args.katex_server: if args.katex_server:
@ -54,12 +57,12 @@ def main():
try: try:
OutputGenerator(sys.stdout).generate(doc) OutputGenerator(sys.stdout).generate(doc)
except FormatitkoRecursiveError as e: except FormatitkoRecursiveError as e:
e.pretty_print() e.pretty_print(tracebacklimit=args.traceback_limit)
try: try:
doc = TransformProcessor(args.input_filename).transform(doc) doc = TransformProcessor(args.input_filename).transform(doc)
except FormatitkoRecursiveError as e: except FormatitkoRecursiveError as e:
e.pretty_print() e.pretty_print(tracebacklimit=args.traceback_limit)
# Initialize the image processor (this just keeps some basic state) # Initialize the image processor (this just keeps some basic state)
imageProcessor = ImageProcessor({"": ImageProcessorNamespace(args.img_public_dir, args.img_web_path, args.img_cache_dir, args.img_lookup_dirs, True)}) imageProcessor = ImageProcessor({"": ImageProcessorNamespace(args.img_public_dir, args.img_web_path, args.img_cache_dir, args.img_lookup_dirs, True)})
@ -71,15 +74,23 @@ def main():
try: try:
HTMLGenerator(file, katexClient, imageProcessor).generate(doc) HTMLGenerator(file, katexClient, imageProcessor).generate(doc)
except FormatitkoRecursiveError as e: except FormatitkoRecursiveError as e:
e.pretty_print() e.pretty_print(tracebacklimit=args.traceback_limit)
if args.output_standalone_html is not None:
# Initialize KaTeX client (this runs the node app and connects to a unix socket)
with KatexClient(socket=args.katex_socket) as katexClient:
with open(args.output_standalone_html, "w") as file:
try:
StandaloneHTMLGenerator(file, katexClient, imageProcessor).generate(doc)
except FormatitkoRecursiveError as e:
e.pretty_print(tracebacklimit=args.traceback_limit)
if args.output_tex is not None: if args.output_tex is not None:
with open(args.output_tex, "w") as file: with open(args.output_tex, "w") as file:
try: try:
UCWTexGenerator(file, imageProcessor).generate(doc) UCWTexGenerator(file, imageProcessor).generate(doc)
except FormatitkoRecursiveError as e: except FormatitkoRecursiveError as e:
e.pretty_print() e.pretty_print(tracebacklimit=args.traceback_limit)
if args.output_md is not None: if args.output_md is not None:
with open(args.output_md, "w") as file: with open(args.output_md, "w") as file:
@ -96,7 +107,7 @@ def main():
try: try:
UCWTexGenerator(file, imageProcessor).generate(doc) UCWTexGenerator(file, imageProcessor).generate(doc)
except FormatitkoRecursiveError as e: except FormatitkoRecursiveError as e:
e.pretty_print() e.pretty_print(tracebacklimit=args.traceback_limit)
filename = fd.name filename = fd.name
else: else:
filename = args.output_tex filename = args.output_tex
@ -104,12 +115,17 @@ def main():
subprocess.run(["pdfcsplain", "-halt-on-error", "-output-directory="+outdir.name, "-jobname=formatitko", filename], check=True) subprocess.run(["pdfcsplain", "-halt-on-error", "-output-directory="+outdir.name, "-jobname=formatitko", filename], check=True)
shutil.move(outdir.name+"/formatitko.pdf", args.output_pdf) shutil.move(outdir.name+"/formatitko.pdf", args.output_pdf)
if args.deps is not None:
with open(args.deps, "w") as file:
for dep in get_context_from_doc(doc).get_deps():
file.write(dep + "\n")
if args.debug: if args.debug:
print("-----------------------------------") print("-----------------------------------")
try: try:
OutputGenerator(sys.stdout).generate(doc) OutputGenerator(sys.stdout).generate(doc)
except FormatitkoRecursiveError as e: except FormatitkoRecursiveError as e:
e.pretty_print() e.pretty_print(tracebacklimit=args.traceback_limit)
if __name__ == "__main__": if __name__ == "__main__":

View file

@ -19,6 +19,8 @@ from .output_generator import OutputGenerator
from .katex import KatexClient from .katex import KatexClient
from .images import ImageProcessor, ImageProcessorNamespaceSearcher from .images import ImageProcessor, ImageProcessorNamespaceSearcher
from .util import inlinify from .util import inlinify
from .elements import FileLink
class HTMLGenerator(OutputGenerator): class HTMLGenerator(OutputGenerator):
imageProcessor: ImageProcessor imageProcessor: ImageProcessor
@ -136,6 +138,7 @@ class HTMLGenerator(OutputGenerator):
url = e.url url = e.url
additional_args = self.get_image_processor_args(e.attributes) additional_args = self.get_image_processor_args(e.attributes)
additional_args["context"] = self.context
# The directory of the current file relative to the current working directory # The directory of the current file relative to the current working directory
source_dir = self.context.dir source_dir = self.context.dir
@ -143,6 +146,7 @@ class HTMLGenerator(OutputGenerator):
rel_dir = self.context.rel_dir rel_dir = self.context.rel_dir
searcher = self.imageProcessor.get_searcher_by_path(url, rel_dir, source_dir) searcher = self.imageProcessor.get_searcher_by_path(url, rel_dir, source_dir)
url = self.imageProcessor.get_path_without_namespace(url)
_, ext = os.path.splitext(url) _, ext = os.path.splitext(url)
ext = ext[1:] ext = ext[1:]
@ -189,6 +193,10 @@ class HTMLGenerator(OutputGenerator):
attributes = self.common_attributes(e) attributes = self.common_attributes(e)
if "width" in e.attributes: if "width" in e.attributes:
attributes["width"] = e.attributes["width"] attributes["width"] = e.attributes["width"]
if "height" in e.attributes:
attributes["height"] = e.attributes["height"]
if "title" in e.attributes:
attributes["title"] = e.attributes["title"]
if e.title: if e.title:
attributes["alt"] = e.title attributes["alt"] = e.title
@ -197,17 +205,38 @@ class HTMLGenerator(OutputGenerator):
HTMLGenerator(fake_out, self.katexClient, self.imageProcessor).generate(e.content) HTMLGenerator(fake_out, self.katexClient, self.imageProcessor).generate(e.content)
attributes["alt"] = fake_out.getvalue() attributes["alt"] = fake_out.getvalue()
if len(srcset) != 0: if len(srcset) > 1:
attributes["src"] = srcset[-1][0] attributes["src"] = srcset[-1][0]
attributes["srcset"] = ", ".join([" ".join(src) for src in srcset]) attributes["srcset"] = ", ".join([" ".join(src) for src in srcset])
else: else:
attributes["src"] = url attributes["src"] = url
if e.attributes["no-img-link"]:
self.write(self.single_tag("img", attributes))
return
img = RawInline(self.single_tag("img", attributes)) img = RawInline(self.single_tag("img", attributes))
link = Link(img, url=url) link = Link(img, url=url)
self.generate(link) self.generate(link)
def generate_FileLink(self, e: FileLink):
url = e.url
# The directory of the current file relative to the current working directory
source_dir = self.context.dir
# The directory of the current file relative to the md file we were called on
rel_dir = self.context.rel_dir
searcher = self.imageProcessor.get_searcher_by_path(url, rel_dir, source_dir)
url = self.imageProcessor.get_path_without_namespace(url)
url = self.imageProcessor.process_image(url, "", searcher, self.context)
searcher.publish_image(url)
url = searcher.get_web_path() + "/" + url
self.generate_Link(Link(*e.content, url=url))
def generate_InlineGroup(self, e: InlineGroup): def generate_InlineGroup(self, e: InlineGroup):
self.generate_Group(e) self.generate_Group(e)
@ -314,3 +343,34 @@ class HTMLGenerator(OutputGenerator):
def generate_DefinitionList(self, e: DefinitionList): def generate_DefinitionList(self, e: DefinitionList):
self.writeln("<!-- FIXME: DefinitionLists not implemented -->") self.writeln("<!-- FIXME: DefinitionLists not implemented -->")
class StandaloneHTMLGenerator(HTMLGenerator):
def generate_Doc(self, e: Doc):
self.writeraw("<!DOCTYPE html>")
self.writeln(self.start_tag("html", attributes={"lang": e.get_metadata("lang", None, True)}))
self.writeln(self.start_tag("head"))
self.indent_more()
self.writeln(self.single_tag("meta", attributes={"charset": "utf-8"}))
self.writeln(self.single_tag("meta", attributes={"viewport": "width=device-width, initial-scale=1.0"}))
self.writeln(self.single_tag("link", attributes={"rel": "stylesheet", "href": "https://cdn.jsdelivr.net/npm/katex@0.16.4/dist/katex.min.css", "integrity":"sha384-vKruj+a13U8yHIkAyGgK1J3ArTLzrFGBbBc0tDp4ad/EyewESeXE/Iv67Aj8gKZ0", "crossorigin":"anonymous"}))
if "title" in e.metadata:
self.write(self.start_tag("title"))
self.generate(e.metadata["title"])
self.write(self.end_tag("title"))
self.endln()
if "html-head-includes" in e.metadata:
self.generate(e.metadata["html-head-includes"])
self.indent_less()
self.writeln(self.end_tag("head"))
self.writeln(self.start_tag("body"))
self.indent_more()
super().generate_Doc(e)
self.indent_less()
self.writeln(self.end_tag("body"))
self.writeln(self.end_tag("html"))

View file

@ -4,6 +4,8 @@ import shutil
import subprocess import subprocess
from PIL import Image from PIL import Image
from .context import Context
class FileInWrongDirError(Exception): class FileInWrongDirError(Exception):
pass pass
@ -38,11 +40,6 @@ class ImageProcessorNamespace:
self.lookup_dirs = lookup_dirs self.lookup_dirs = lookup_dirs
self.web_path = web_path if web_path[-1] != "/" else web_path[:-1] self.web_path = web_path if web_path[-1] != "/" else web_path[:-1]
self.include_src = include_src self.include_src = include_src
if not os.path.exists(self.public_dir):
os.mkdir(self.public_dir)
if not os.path.exists(self.cache_dir):
os.mkdir(self.cache_dir)
class ImageProcessorSearcher: class ImageProcessorSearcher:
def get_lookup_dirs(self) -> list[str]: def get_lookup_dirs(self) -> list[str]:
@ -96,6 +93,8 @@ class ImageProcessorCacheSearcher(ImageProcessorSearcher):
def __init__(self, cache_dir: str): def __init__(self, cache_dir: str):
self.cache_dir = cache_dir self.cache_dir = cache_dir
if not os.path.exists(self.cache_dir):
os.makedirs(self.cache_dir, exist_ok=True)
def get_lookup_dirs(self) -> list[str]: def get_lookup_dirs(self) -> list[str]:
return [self.cache_dir] return [self.cache_dir]
@ -129,10 +128,16 @@ class ImageProcessorNamespaceSearcher(ImageProcessorSearcher):
return path.replace("$dir", self.rel_dir) return path.replace("$dir", self.rel_dir)
def get_cache_dir(self) -> str: def get_cache_dir(self) -> str:
return self.transform_path(self.namespace.cache_dir) cache_dir = self.transform_path(self.namespace.cache_dir)
if not os.path.exists(cache_dir):
os.makedirs(cache_dir, exist_ok=True)
return cache_dir
def get_public_dir(self) -> str: def get_public_dir(self) -> str:
return self.transform_path(self.namespace.public_dir) public_dir = self.transform_path(self.namespace.public_dir)
if not os.path.exists(public_dir):
os.makedirs(public_dir, exist_ok=True)
return public_dir
def get_web_path(self) -> str: def get_web_path(self) -> str:
return self.transform_path(self.namespace.web_path) return self.transform_path(self.namespace.web_path)
@ -149,10 +154,15 @@ class ImageProcessor:
def get_namespace_by_path(self, path: str) -> ImageProcessorNamespace: def get_namespace_by_path(self, path: str) -> ImageProcessorNamespace:
return self.namespaces[path.split(":")[0] if ":" in path else ""] return self.namespaces[path.split(":")[0] if ":" in path else ""]
def get_path_without_namespace(self, path: str) -> str:
if len(path.split(":")) <= 1:
return path
return ":".join(path.split(":")[1:])
def get_searcher_by_path(self, path: str, rel_dir: str, source_dir: str) -> ImageProcessorNamespaceSearcher: def get_searcher_by_path(self, path: str, rel_dir: str, source_dir: str) -> ImageProcessorNamespaceSearcher:
return ImageProcessorNamespaceSearcher(self.get_namespace_by_path(path), rel_dir, source_dir) return ImageProcessorNamespaceSearcher(self.get_namespace_by_path(path), rel_dir, source_dir)
def process_image(self, input_filename: str, format: str, searcher: ImageProcessorSearcher, width: int=None, height:int=None, quality: int=None, dpi: int=None, fit: bool=True, deps: list[str]=[]) -> str: def process_image(self, input_filename: str, format: str, searcher: ImageProcessorSearcher, context: Context=None, width: int=None, height:int=None, quality: int=None, dpi: int=None, fit: bool=True, deps: list[str]=[]) -> str:
name = os.path.basename(input_filename) name = os.path.basename(input_filename)
base, ext = os.path.splitext(name) base, ext = os.path.splitext(name)
ext = ext[1:] ext = ext[1:]
@ -163,6 +173,9 @@ class ImageProcessor:
if format == "jpg": if format == "jpg":
format = "jpeg" format = "jpeg"
if format == "":
format = ext
# Locate all dependencies # Locate all dependencies
deps_full = [full_path] deps_full = [full_path]
for dep in deps: for dep in deps:
@ -229,6 +242,8 @@ class ImageProcessor:
if subprocess.run(['convert', *density_arg, full_path, *resize_arg, *quality_arg, target_path]).returncode != 0: if subprocess.run(['convert', *density_arg, full_path, *resize_arg, *quality_arg, target_path]).returncode != 0:
raise ImageMagickError(f"Could not convert '{full_path}' to '{format}'") raise ImageMagickError(f"Could not convert '{full_path}' to '{format}'")
if context is not None:
context.add_deps(deps_full)
return target_name return target_name
def is_outdated(self, target: str, deps: list[str]): def is_outdated(self, target: str, deps: list[str]):

@ -0,0 +1 @@
Subproject commit 211cb2010e23265be599819c5f79f66f0abd62d1

View file

@ -1 +0,0 @@
node_modules

View file

@ -1 +0,0 @@
This was made by Standa Lukeš @exyi

View file

@ -1 +0,0 @@
console.log(require('katex').renderToString('\\frac{2a}{b}'))

View file

@ -1,131 +0,0 @@
// KaTeX rendering server
// Listens on unix socket, path is provided as first argument
// Expects JSON lines, each line is a query with the following schema:
// {
// formulas: [
// {
// tex: string,
// options?: object
// }
// ],
// options?: object
// }
// see https://katex.org/docs/options.html for list of available options
// If options formulas[].options field is used, the global options field is ignored.
// For each line, returns one JSON line with the following schema:
// {
// results: [
// { html?: string } | { error?: string }
// ]
// } | { error?: string }
// If one formula is invalid, the error in results is used
// If the entire query is invalid (couldn't parse JSON, for example), the outer error field is used
import katex from 'katex'
import net from 'net'
import * as readline from 'readline'
const myArgs = process.argv.slice(2)
const unixSocketPath = myArgs[0]
if (!unixSocketPath) {
console.error('you must specify socket path')
process.exit(1)
}
// This server listens on a Unix socket at /var/run/mysocket
var unixServer = net.createServer(handleClient);
unixServer.listen(unixSocketPath);
console.log("OK")
function handleExit(signal) {
// unixServer.emit('close')
unixServer.close(function () {
});
process.exit(0); // put this into the callback to avoid closing open connections
}
process.on('SIGINT', handleExit);
process.on('SIGQUIT', handleExit);
process.on('SIGTERM', handleExit);
process.on('exit', handleExit);
const defaultOptions = {}
/**
* @param {net.Socket} socket
* @returns {Promise<void>}
* */
function socketWrite(socket, data) {
return new Promise((resolve, reject) => {
socket.write(data, (err) => {
if (err) {
reject(err)
} else {
resolve()
}
})
})
}
/**
* @param {net.Socket} client
* */
async function handleClient(client) {
const rl = readline.createInterface({ input: client })
/* Added by GS: A stack of katex's `macros` objects, each group inherits
* the one from the parent group and can add its own stuff without
* affecting the parent.
*/
let macroStack = [{}]
for await (const line of rl) {
try {
// The custom commands for pushing and popping the macro stack.
if (line === "begingroup") {
// Copy the current state of macros and push it onto the stack.
macroStack.push({...macroStack.slice(-1)[0]})
continue
} else if (line === "endgroup") {
macroStack.pop()
continue
} else if (line === "init") {
macroStack = [{}]
continue
}
const query = JSON.parse(line)
const results = []
for (const input of query.formulas) {
const options = input.options ?? query.options ?? defaultOptions
// Add macros from the macros option
if (options.macros) {
for (const macro of Object.keys(options.macros)) {
macroStack.slice(-1)[macro] = options.macros[macro]
}
}
options.macros = macroStack.slice(-1)[0]
// Enforce globalGroup option, katex then saves created macros
// into the options.macros object.
options.globalGroup = true
try {
const html = katex.renderToString(input.tex, options)
results.push({ html })
} catch (e) {
results.push({ error: String(e) })
}
}
await socketWrite(client, JSON.stringify({ results }, null, query.debug ? ' ' : undefined))
await socketWrite(client, '\n')
} catch (e) {
console.error(e)
await socketWrite(client, JSON.stringify({ error: String(e) }))
await socketWrite(client, '\n')
}
}
}

View file

@ -1,39 +0,0 @@
{
"name": "ksp-katex-server",
"version": "1.0.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "ksp-katex-server",
"version": "1.0.0",
"license": "ISC",
"dependencies": {
"katex": "^0.16.3"
}
},
"node_modules/commander": {
"version": "8.3.0",
"resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz",
"integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==",
"engines": {
"node": ">= 12"
}
},
"node_modules/katex": {
"version": "0.16.3",
"resolved": "https://registry.npmjs.org/katex/-/katex-0.16.3.tgz",
"integrity": "sha512-3EykQddareoRmbtNiNEDgl3IGjryyrp2eg/25fHDEnlHymIDi33bptkMv6K4EOC2LZCybLW/ZkEo6Le+EM9pmA==",
"funding": [
"https://opencollective.com/katex",
"https://github.com/sponsors/katex"
],
"dependencies": {
"commander": "^8.0.0"
},
"bin": {
"katex": "cli.js"
}
}
}
}

View file

@ -1,14 +0,0 @@
{
"name": "ksp-katex-server",
"version": "1.0.0",
"description": "",
"main": "index.mjs",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
"dependencies": {
"katex": "^0.16.3"
}
}

View file

@ -3,6 +3,7 @@ import subprocess
import tempfile import tempfile
import json import json
import os import os
import shutil
class KatexError(Exception): class KatexError(Exception):
pass pass
@ -20,8 +21,10 @@ class KatexClient:
_socket_file: str _socket_file: str
_temp_dir: tempfile.TemporaryDirectory[str] _temp_dir: tempfile.TemporaryDirectory[str]
_connected: bool _connected: bool
_katex_server_path: str
def __init__(self, socket: str=None, connect: bool=True): def __init__(self, socket: str=None, connect: bool=True, katex_server_path: str=None):
self._katex_server_path = katex_server_path
if socket is not None: if socket is not None:
self._socket_file = socket self._socket_file = socket
else: else:
@ -38,20 +41,21 @@ class KatexClient:
self._temp_dir = tempfile.TemporaryDirectory(prefix='formatitko') self._temp_dir = tempfile.TemporaryDirectory(prefix='formatitko')
self._socket_file = self._temp_dir.name + "/katex-socket" self._socket_file = self._temp_dir.name + "/katex-socket"
if self._katex_server_path is None:
srcdir = os.path.dirname(os.path.realpath(__file__)) srcdir = os.path.dirname(os.path.realpath(__file__))
# Test if `node_modules` directory exists and if not, run `npm install` # Test if `node_modules` directory exists and if not, run `npm install`
if not os.path.isdir(srcdir + "/katex-server/node_modules"): if not os.path.isdir(srcdir + "/katex-server/node_modules"):
print("Installing node dependencies for the first time...") print("Installing node dependencies for the first time...")
try: npm = shutil.which("npm") or shutil.which("yarnpkg")
subprocess.run(["npm", "install"], cwd=srcdir+"/katex-server", check=True) if npm is None:
except subprocess.CalledProcessError as e:
if e.returncode == 127:
raise NPMNotFoundError("npm not found. Node.js is required to use KaTeX.") raise NPMNotFoundError("npm not found. Node.js is required to use KaTeX.")
else: subprocess.run([npm, "install"], cwd=srcdir+"/katex-server", check=True)
raise e
self._server_process = subprocess.Popen(["node", srcdir + "/katex-server/index.mjs", self._socket_file], stdout=subprocess.PIPE) self._katex_server_path = srcdir + "/katex-server/index.mjs"
self._server_process = subprocess.Popen(["node", self._katex_server_path, self._socket_file], stdout=subprocess.PIPE)
ok = self._server_process.stdout.readline() ok = self._server_process.stdout.readline()
if ok != b"OK\n": if ok != b"OK\n":

View file

@ -6,7 +6,7 @@ from panflute import MetaValue
from typing import Union, Callable from typing import Union, Callable
from .whitespace import NBSP from .whitespace import NBSP
from .elements import FQuoted from .elements import FQuoted, FileLink
from .context import Group, InlineGroup, BlockGroup, Context from .context import Group, InlineGroup, BlockGroup, Context
from .whitespace import Whitespace from .whitespace import Whitespace
from .command import BlockCommand, InlineCommand, CodeCommand, Command from .command import BlockCommand, InlineCommand, CodeCommand, Command
@ -88,6 +88,7 @@ class NOPProcessor:
Underline: self.transform_Underline, Underline: self.transform_Underline,
NBSP: self.transform_NBSP, NBSP: self.transform_NBSP,
FQuoted: self.transform_FQuoted, FQuoted: self.transform_FQuoted,
FileLink: self.transform_FileLink,
InlineCommand: self.transform_InlineCommand, InlineCommand: self.transform_InlineCommand,
BlockCommand: self.transform_BlockCommand, BlockCommand: self.transform_BlockCommand,
@ -111,10 +112,12 @@ class NOPProcessor:
e = transformer(e) e = transformer(e)
try: try:
e = self.TYPE_DICT[type(e)](e) method = self.TYPE_DICT[type(e)]
except KeyError: except KeyError:
raise self.UnknownElementError(type(e)) raise self.UnknownElementError(type(e))
e = method(e)
for transformer in self.get_posttransformers(): for transformer in self.get_posttransformers():
e = transformer(e) e = transformer(e)
@ -127,13 +130,17 @@ class NOPProcessor:
raise FormatitkoRecursiveError(e, self.context) from err raise FormatitkoRecursiveError(e, self.context) from err
def transform_list(self, e: list[Union[Element, ListContainer]]) -> list[Union[Element, ListContainer]]: def transform_list(self, e: list[Union[Element, ListContainer]]) -> list[Union[Element, ListContainer]]:
for i in range(len(e)): i = 0
while i < len(e): # The length of the list can change mid-transformation, so we need to check the length each time
e[i] = self.transform(e[i]) e[i] = self.transform(e[i])
i-=-1
return e return e
def transform_ListContainer(self, e: ListContainer) -> ListContainer: def transform_ListContainer(self, e: ListContainer) -> ListContainer:
for i in range(len(e)): i = 0
while i < len(e): # The length of the list can change mid-transformation, so we need to check the length each time
e[i] = self.transform(e[i]) e[i] = self.transform(e[i])
i-=-1
return e return e
@ -293,6 +300,10 @@ class NOPProcessor:
e.content = self.transform(e.content) e.content = self.transform(e.content)
return e return e
def transform_FileLink(self, e: FileLink) -> FileLink:
e.content = self.transform(e.content)
return e
def transform_Figure(self, e: Figure) -> Figure: def transform_Figure(self, e: Figure) -> Figure:
e.content = self.transform(e.content) e.content = self.transform(e.content)
e.caption = self.transform(e.caption) e.caption = self.transform(e.caption)

View file

@ -7,7 +7,7 @@ from panflute import stringify
from typing import Union, Callable from typing import Union, Callable
from .whitespace import NBSP from .whitespace import NBSP
from .elements import FQuoted from .elements import FQuoted, FileLink
from .context import Group, InlineGroup, BlockGroup, Context from .context import Group, InlineGroup, BlockGroup, Context
@ -31,7 +31,7 @@ class FormatitkoRecursiveError(Exception):
def add_element(self, e: Union[Element, ListContainer, list[Union[Element, ListContainer]]]): def add_element(self, e: Union[Element, ListContainer, list[Union[Element, ListContainer]]]):
self.elements.append(e) self.elements.append(e)
def pretty_print(self): def pretty_print(self, tracebacklimit: int=0):
def eprint(*args, **kwargs): def eprint(*args, **kwargs):
print(*args, file=sys.stderr, **kwargs) print(*args, file=sys.stderr, **kwargs)
@ -49,7 +49,7 @@ class FormatitkoRecursiveError(Exception):
eprint('on line: "' + stringify(line).strip() + '"', end="") eprint('on line: "' + stringify(line).strip() + '"', end="")
eprint() eprint()
eprint("in element: " + str(self.elements[0]).replace("\n", "\\n")) eprint("in element: " + str(self.elements[0]).replace("\n", "\\n"))
sys.tracebacklimit = 0 sys.tracebacklimit = tracebacklimit
raise self.__cause__ from None raise self.__cause__ from None
@ -127,6 +127,7 @@ class OutputGenerator:
Underline: self.generate_Underline, Underline: self.generate_Underline,
NBSP: self.generate_NBSP, NBSP: self.generate_NBSP,
FQuoted: self.generate_FQuoted, FQuoted: self.generate_FQuoted,
FileLink: self.generate_FileLink,
InlineGroup: self.generate_InlineGroup InlineGroup: self.generate_InlineGroup
} }
@ -157,9 +158,10 @@ class OutputGenerator:
self.generate_MetaList(e) self.generate_MetaList(e)
else: else:
try: try:
self.TYPE_DICT_MISC[type(e)](e) method = self.TYPE_DICT_MISC[type(e)]
except KeyError as err: except KeyError as err:
raise UnknownElementError(type(e)) from err raise UnknownElementError(type(e)) from err
method(e)
if isinstance(e, Group): if isinstance(e, Group):
self.context = old_context self.context = old_context
except FormatitkoRecursiveError as err: except FormatitkoRecursiveError as err:
@ -271,9 +273,9 @@ class OutputGenerator:
self.write(self.end_tag(tag)) self.write(self.end_tag(tag))
def generate_raw_block_tag(self, tag: str, text: str, attributes: dict[str,str]={}): def generate_raw_block_tag(self, tag: str, text: str, attributes: dict[str,str]={}):
self.writeln(self.start_tag(tag, attributes)) self.writeraw(self.start_tag(tag, attributes))
self.writeraw(text) self.writeraw(text)
self.writeln(self.end_tag(tag)) self.writeraw(self.end_tag(tag))
def generate_empty_block_tag(self, tag: str, attributes: dict[str,str]={}): def generate_empty_block_tag(self, tag: str, attributes: dict[str,str]={}):
self.writeln(self.single_tag(tag, attributes)) self.writeln(self.single_tag(tag, attributes))
@ -292,9 +294,10 @@ class OutputGenerator:
def generate_MetaValue(self, e: MetaValue): def generate_MetaValue(self, e: MetaValue):
try: try:
self.TYPE_DICT_META[type(e)](e) method = self.TYPE_DICT_META[type(e)]
except KeyError: except KeyError:
self.generate(e.content) self.generate(e.content)
method(e)
def generate_MetaBlocks(self, e: MetaBlocks): def generate_MetaBlocks(self, e: MetaBlocks):
self.generate(e.content) self.generate(e.content)
@ -303,16 +306,23 @@ class OutputGenerator:
self.generate(e.content) self.generate(e.content)
def generate_MetaBool(self, e: MetaBool): def generate_MetaBool(self, e: MetaBool):
self.generate_simple_tag(e) if e.boolean:
self.write("True")
else:
self.write("False")
def generate_MetaMap(self, e: MetaMap): def generate_MetaMap(self, e: MetaMap):
self.generate_simple_tag(e) self.generate_simple_tag(e)
def generate_MetaString(self, e: MetaString): def generate_MetaString(self, e: MetaString):
self.generate_simple_tag(e) self.write(e.text)
def generate_Inline(self, e: Inline): def generate_Inline(self, e: Inline):
self.TYPE_DICT_INLINE[type(e)](e) try:
method = self.TYPE_DICT_INLINE[type(e)]
except KeyError as err:
raise UnknownElementError(type(e)) from err
method(e)
def generate_Str(self, e: Str): def generate_Str(self, e: Str):
self.write(self.escape_special_chars(e.text)) self.write(self.escape_special_chars(e.text))
@ -359,6 +369,8 @@ class OutputGenerator:
self.generate(e.content) self.generate(e.content)
self.write("\"") self.write("\"")
def generate_FileLink(self, e: FileLink):
self.generate_simple_tag(e)
# Inline Elements # Inline Elements
def generate_Cite(self, e: Cite): def generate_Cite(self, e: Cite):
@ -413,7 +425,11 @@ class OutputGenerator:
def generate_Block(self, e: Block): def generate_Block(self, e: Block):
self.TYPE_DICT_BLOCK[type(e)](e) try:
method = self.TYPE_DICT_BLOCK[type(e)]
except KeyError as err:
raise UnknownElementError(type(e)) from err
method(e)
# Block elements # Block elements
@ -478,6 +494,8 @@ class OutputGenerator:
self.generate_simple_tag(e) self.generate_simple_tag(e)
def generate_Doc(self, e: Doc): def generate_Doc(self, e: Doc):
if "header-includes" in e.metadata: # This is the pandoc way of doing things
self.generate(e.metadata["header-includes"])
if "header_content" in e.metadata: if "header_content" in e.metadata:
self.generate(e.metadata["header_content"]) self.generate(e.metadata["header_content"])
self.generate_simple_tag(e) self.generate_simple_tag(e)

View file

@ -110,6 +110,7 @@ class UCWTexGenerator(OutputGenerator):
url = e.url url = e.url
additional_args = self.get_image_processor_args(e.attributes) additional_args = self.get_image_processor_args(e.attributes)
additional_args["context"] = self.context
# The directory of the current file relative to the current working directory # The directory of the current file relative to the current working directory
source_dir = self.context.dir source_dir = self.context.dir
@ -117,6 +118,7 @@ class UCWTexGenerator(OutputGenerator):
rel_dir = self.context.rel_dir rel_dir = self.context.rel_dir
searcher = self.imageProcessor.get_searcher_by_path(url, rel_dir, source_dir) searcher = self.imageProcessor.get_searcher_by_path(url, rel_dir, source_dir)
url = self.imageProcessor.get_path_without_namespace(url)
_, ext = os.path.splitext(url) _, ext = os.path.splitext(url)
ext = ext[1:] ext = ext[1:]

View file

@ -3,6 +3,7 @@ from panflute import Cite, Code, Emph, Image, LineBreak, Link, Math, Note, Quote
from panflute import BlockQuote, BulletList, Citation, CodeBlock, Definition, DefinitionItem, DefinitionList, Div, Figure, Header, HorizontalRule, LineBlock, LineItem, ListItem, MetaBlocks, MetaBool, MetaInlines, MetaList, MetaMap, MetaString, Null, OrderedList, Para, Plain, RawBlock, Table, TableBody, TableFoot, TableHead from panflute import BlockQuote, BulletList, Citation, CodeBlock, Definition, DefinitionItem, DefinitionList, Div, Figure, Header, HorizontalRule, LineBlock, LineItem, ListItem, MetaBlocks, MetaBool, MetaInlines, MetaList, MetaMap, MetaString, Null, OrderedList, Para, Plain, RawBlock, Table, TableBody, TableFoot, TableHead
from panflute import TableRow, TableCell, Caption, Doc from panflute import TableRow, TableCell, Caption, Doc
from panflute import MetaValue from panflute import MetaValue
from panflute.containers import attach
from typing import Union, Callable from typing import Union, Callable
from types import ModuleType from types import ModuleType
@ -18,7 +19,7 @@ from .context import Group, InlineGroup, BlockGroup
from .util import nullify, import_md from .util import nullify, import_md
from .context import Context, CommandCallable from .context import Context, CommandCallable
from .whitespace import Whitespace, bavlna from .whitespace import Whitespace, bavlna
from .command import BlockCommand, InlineCommand, CodeCommand, Command from .command import BlockCommand, InlineCommand, CodeCommand, Command, InlineError
from .command_util import handle_command_define, parse_command from .command_util import handle_command_define, parse_command
from .nop_processor import NOPProcessor, ELCl, DoubleDocError from .nop_processor import NOPProcessor, ELCl, DoubleDocError
@ -39,6 +40,15 @@ class TransformProcessor(NOPProcessor):
def add_command_module(self, module: Union[dict[str, CommandCallable], ModuleType], module_name: str=""): def add_command_module(self, module: Union[dict[str, CommandCallable], ModuleType], module_name: str=""):
self._command_modules.append((module, module_name)) self._command_modules.append((module, module_name))
def init_context(self, e: Doc) -> Context:
if self.context is not None:
raise DoubleDocError()
self.context = Context(e, self.root_file_path)
for module, module_name in self._command_modules:
self.context.add_commands_from_module(module, module_name)
e.content = [BlockGroup(*e.content, context=self.context)]
return self.context
def get_pretransformers(self) -> list[Callable[[ELCl],ELCl]]: def get_pretransformers(self) -> list[Callable[[ELCl],ELCl]]:
return super().get_pretransformers()+[self.handle_if_attribute, self.handle_ifnot_attribute] return super().get_pretransformers()+[self.handle_if_attribute, self.handle_ifnot_attribute]
@ -56,15 +66,22 @@ class TransformProcessor(NOPProcessor):
return nullify(e) return nullify(e)
return e return e
def transform_ListContainer(self, e: ListContainer) -> ListContainer:
try:
return super().transform_ListContainer(e)
except TypeError as err:
names = []
for el in e:
if hasattr(el, "attributes") and "c" in el.attributes:
names.append(el.attributes["c"])
if len(names) > 0:
raise InlineError(f"The command{'s' if len(names) > 1 else ''} {names[0] if len(names) == 1 else names} was called in an Inline way but returned Block content. Put it in a paragraph alone or execute it as a Div using: \n::: {{c={names[0] if len(names) == 1 else '<command_name>'}}}\n:::")
else:
raise err
def transform_Doc(self, e: Doc) -> Doc: def transform_Doc(self, e: Doc) -> Doc:
if self.context is not None: self.init_context(e)
raise DoubleDocError()
self.context = Context(e, self.root_file_path)
for module, module_name in self._command_modules:
self.context.add_commands_from_module(module, module_name)
e.content = self.transform(e.content) e.content = self.transform(e.content)
e.content = [BlockGroup(*e.content, context=self.context)]
return e return e
@ -82,22 +99,38 @@ class TransformProcessor(NOPProcessor):
e.content = self.transform(e.content) e.content = self.transform(e.content)
# OG now has Context so this is not needed per se, but I'm keeping this here for the handling of attribute > context > default value # OG now has Context so this is not needed per se, but I'm keeping this here for the handling of attribute > context > default value
# Pass down "no-srcset" metadatum as attribute down to images. # Pass down "no-srcset" metadatum as attribute down to images.
if not "no-srcset" in e.attributes: if "no-srcset" not in e.attributes:
e.attributes["no-srcset"] = self.context.get_metadata("no-srcset") if self.context.get_metadata("no-srcset") is not None else False e.attributes["no-srcset"] = self.context.get_metadata("no-srcset") if self.context.get_metadata("no-srcset") is not None else False
if "no-img-link" not in e.attributes:
e.attributes["no-img-link"] = self.context.get_metadata("no-img-link") if self.context.get_metadata("no-img-link") is not None else False
return e return e
def create_Group(self, *content, new_context: Context, inline: bool=False) -> Group: def create_Group(self, *content, new_context: Context, replaced:Element, inline: bool=False) -> Group:
old_context = self.context old_context = self.context
self.context = new_context self.context = new_context
content = self.transform([*content])
self.context = old_context
if inline: if inline:
return InlineGroup(*content, context=new_context) g = InlineGroup(*content, context=new_context)
else: else:
return BlockGroup(*content, context=new_context) g = BlockGroup(*content, context=new_context)
attach(g, replaced.parent, replaced.location, replaced.index)
g = self.transform(g)
self.context = old_context
return g
def transform_Para(self, e: Para) -> Union[Para, Div]:
if len(e.content) == 1 and isinstance(e.content[0], Span):
# If the span turns out to be a command, it might return a Div. We should then replace ourselves with the Div
span = e.content[0]
span = self.transform(span)
if isinstance(span, Div):
return span
else:
e.content[0] = span
return super().transform_Para(e)
else:
return super().transform_Para(e)
def transform_Div(self, e: Div) -> Union[Div, Group, Null, RawBlock]: def transform_Div(self, e: Div) -> Union[Div, Group, Null, RawBlock]:
e.content = self.transform(e.content)
if "group" in e.classes: if "group" in e.classes:
# `.group` class for Divs # `.group` class for Divs
@ -105,14 +138,15 @@ class TransformProcessor(NOPProcessor):
new_context = Context(Doc(), self.context.path, self.context, trusted=self.context.trusted) new_context = Context(Doc(), self.context.path, self.context, trusted=self.context.trusted)
for attribute, value in e.attributes.items(): for attribute, value in e.attributes.items():
new_context.set_metadata(attribute, value) new_context.set_metadata(attribute, value)
return self.create_Group(*e.content, new_context=new_context) return self.create_Group(*e.content, replaced=e, new_context=new_context)
if "c" in e.attributes: if "c" in e.attributes:
# Commands can be called multiple ways, this handles the following syntax: # Commands can be called multiple ways, this handles the following syntax:
# :::{c=commandname} # :::{c=commandname}
# ::: # :::
e = BlockCommand(*e.content, identifier=e.identifier, classes=e.classes, attributes=e.attributes) command = BlockCommand(*e.content, identifier=e.identifier, classes=e.classes, attributes=e.attributes)
return self.transform(e) attach(command, e.parent, e.location, e.index)
return self.transform(command)
if "partial" in e.attributes: if "partial" in e.attributes:
# `partial` attribute # `partial` attribute
@ -124,7 +158,9 @@ class TransformProcessor(NOPProcessor):
pwd = os.path.abspath(".") pwd = os.path.abspath(".")
if os.path.commonpath([full_path, pwd]) != os.path.commonpath([pwd]): if os.path.commonpath([full_path, pwd]) != os.path.commonpath([pwd]):
return nullify(e) return nullify(e)
text = open(self.context.dir + "/" + e.attributes["partial"], "r").read() filename = self.context.dir + "/" + e.attributes["partial"]
self.context.add_dep(filename)
text = open(filename, "r").read()
path = self.context.dir + "/" + e.attributes["partial"] path = self.context.dir + "/" + e.attributes["partial"]
if e.attributes["type"] == "md": if e.attributes["type"] == "md":
includedDoc = import_md(text) includedDoc = import_md(text)
@ -133,7 +169,7 @@ class TransformProcessor(NOPProcessor):
trusted = False trusted = False
if not self.context.trusted: if not self.context.trusted:
trusted = False trusted = False
return self.create_Group(*includedDoc.content, new_context=Context(includedDoc, path, self.context, trusted=trusted)) return self.create_Group(*includedDoc.content, replaced=e, new_context=Context(includedDoc, path, self.context, trusted=trusted))
elif e.attributes["type"] in ["tex", "html"]: elif e.attributes["type"] in ["tex", "html"]:
return RawBlock(text, e.attributes["type"]) return RawBlock(text, e.attributes["type"])
@ -154,10 +190,9 @@ class TransformProcessor(NOPProcessor):
if "lang" in e.attributes: if "lang" in e.attributes:
warnings.warn("To set language in a way formátítko will understand, this Div has to have the `.group` class and be a Group.", UserWarning) warnings.warn("To set language in a way formátítko will understand, this Div has to have the `.group` class and be a Group.", UserWarning)
return e return super().transform_Div(e)
def transform_Span(self, e: Span) -> Span: def transform_Span(self, e: Span) -> Span:
e.content = self.transform(e.content)
if "group" in e.classes: if "group" in e.classes:
# `.group` class for Spans # `.group` class for Spans
@ -165,19 +200,21 @@ class TransformProcessor(NOPProcessor):
new_context = Context(Doc(), self.context.path, self.context, trusted=self.context.trusted) new_context = Context(Doc(), self.context.path, self.context, trusted=self.context.trusted)
for attribute, value in e.attributes.items(): for attribute, value in e.attributes.items():
new_context.set_metadata(attribute, value) new_context.set_metadata(attribute, value)
return self.create_Group(*e.content, new_context=new_context, inline=True) return self.create_Group(*e.content, replaced=e, new_context=new_context, inline=True)
if "c" in e.attributes: if "c" in e.attributes:
# Commands can be called multiple ways, this handles the following syntax: # Commands can be called multiple ways, this handles the following syntax:
# []{c=commandname} and # []{c=commandname} and
e = InlineCommand(*e.content, identifier=e.identifier, classes=e.classes, attributes=e.attributes) command = InlineCommand(*e.content, identifier=e.identifier, classes=e.classes, attributes=e.attributes)
return self.transform(e) attach(command, e.parent, e.location, e.index)
return self.transform(command)
if len(e.content) == 1 and isinstance(e.content[0], Str): if len(e.content) == 1 and isinstance(e.content[0], Str):
## Handle special command shorthand [!commandname]{} ## Handle special command shorthand [!commandname]{}
if re.match(r"^![\w.]+$", e.content[0].text): if re.match(r"^![\w.]+$", e.content[0].text):
e = InlineCommand(identifier=e.identifier, classes=e.classes, attributes={**e.attributes, "c": e.content[0].text[1:]}) command = InlineCommand(identifier=e.identifier, classes=e.classes, attributes={**e.attributes, "c": e.content[0].text[1:]})
return self.transform(e) attach(command, e.parent, e.location, e.index)
return self.transform(command)
## Handle import [#ksp_formatitko as ksp]{}, [#ksp_formatitko]{type=module} or [#path/file.md]{type=md} ## Handle import [#ksp_formatitko as ksp]{}, [#ksp_formatitko]{type=module} or [#path/file.md]{type=md}
# Import a python module as commands (type=module, the default) or # Import a python module as commands (type=module, the default) or
@ -186,7 +223,9 @@ class TransformProcessor(NOPProcessor):
if not "type" in e.attributes: if not "type" in e.attributes:
e.attributes["type"] = "module" e.attributes["type"] = "module"
if e.attributes["type"] == "md": if e.attributes["type"] == "md":
importedDoc = import_md(open(self.context.dir + "/" + e.content[0].text[1:], "r").read()) filename = self.context.dir + "/" + e.content[0].text[1:]
self.context.add_dep(filename)
importedDoc = import_md(open(filename, "r").read())
self.transform(importedDoc.content) self.transform(importedDoc.content)
elif e.attributes["type"] == "module": elif e.attributes["type"] == "module":
matches = re.match(r"^(\w+)(?: as (\w+))?$", e.content[0].text[1:]) matches = re.match(r"^(\w+)(?: as (\w+))?$", e.content[0].text[1:])
@ -196,7 +235,9 @@ class TransformProcessor(NOPProcessor):
module_name = matches.group(1) if matches.group(2) is None else matches.group(2) module_name = matches.group(1) if matches.group(2) is None else matches.group(2)
self.context.add_commands_from_module(module, module_name) self.context.add_commands_from_module(module, module_name)
elif e.attributes["type"] == "metadata": elif e.attributes["type"] == "metadata":
data = json.load(open(self.context.dir + "/" + e.content[0].text[1:], "r")) filename = self.context.dir + "/" + e.content[0].text[1:]
self.context.add_dep(filename)
data = json.load(open(filename, "r"))
key = "" if not "key" in e.attributes else e.attributes["key"] key = "" if not "key" in e.attributes else e.attributes["key"]
self.context.import_metadata(data, key) self.context.import_metadata(data, key)
else: else:
@ -208,7 +249,7 @@ class TransformProcessor(NOPProcessor):
# This is a shorthand for just printing the content of some metadata. # This is a shorthand for just printing the content of some metadata.
elif re.match(r"^\$[\w.]+$", e.content[0].text): elif re.match(r"^\$[\w.]+$", e.content[0].text):
val = self.context.get_metadata(e.content[0].text[1:], False) val = self.context.get_metadata(e.content[0].text[1:], False)
if isinstance(val, MetaInlines): if isinstance(val, MetaInlines): # TODO: Trust transform for this
e = Span(*val.content) e = Span(*val.content)
e = self.transform(e) e = self.transform(e)
elif isinstance(val, MetaString): elif isinstance(val, MetaString):
@ -219,19 +260,20 @@ class TransformProcessor(NOPProcessor):
raise TypeError(f"Cannot print value of metadatum '{e.content[0].text[1:]}' of type '{type(val)}'") raise TypeError(f"Cannot print value of metadatum '{e.content[0].text[1:]}' of type '{type(val)}'")
return e return e
return e return super().transform_Span(e)
def transform_CodeBlock(self, e: CodeBlock) -> Union[CodeBlock, Div, Null]: def transform_CodeBlock(self, e: CodeBlock) -> Union[CodeBlock, Div, Null]:
if "markdown" in e.classes and "group" in e.classes: if "markdown" in e.classes and "group" in e.classes:
includedDoc = import_md(e.text) includedDoc = import_md(e.text)
return self.create_Group(*includedDoc.content, new_context=Context(includedDoc, self.context.path, self.context, self.context.trusted)) return self.create_Group(*includedDoc.content, replaced=e, new_context=Context(includedDoc, self.context.path, self.context, self.context.trusted))
if "python" in e.classes and "run" in e.classes: if "python" in e.classes and "run" in e.classes:
if not self.context.trusted: if not self.context.trusted:
return nullify(e) return nullify(e)
command_output = parse_command(e.text)(BlockCommand(), self.context) command_output = parse_command(e.text)(BlockCommand(), self.context, self)
e = BlockCommand().replaceSelf(*([] if command_output is None else command_output)) command = BlockCommand().replaceSelf(*([] if command_output is None else command_output))
return self.transform(e) attach(command, e.parent, e.location, e.index)
return self.transform(command)
if "python" in e.classes and ("define" in e.attributes or "redefine" in e.attributes): if "python" in e.classes and ("define" in e.attributes or "redefine" in e.attributes):
if not self.context.trusted: if not self.context.trusted:
@ -239,7 +281,9 @@ class TransformProcessor(NOPProcessor):
return handle_command_define(e, self.context) return handle_command_define(e, self.context)
if "c" in e.attributes: if "c" in e.attributes:
return self.transform(CodeCommand(e.text, identifier=e.identifier, classes=e.classes, attributes=e.attributes)) command = CodeCommand(e.text, identifier=e.identifier, classes=e.classes, attributes=e.attributes)
attach(command, e.parent, e.location, e.index)
return self.transform(command)
# Pass down metadata 'highlight' and 'highlight_style' as attribute to CodeBlocks # Pass down metadata 'highlight' and 'highlight_style' as attribute to CodeBlocks
# OG now has Context so this is not needed per se, but I'm keeping this here for the handling of attribute > context > default value # OG now has Context so this is not needed per se, but I'm keeping this here for the handling of attribute > context > default value
@ -252,9 +296,9 @@ class TransformProcessor(NOPProcessor):
def transform_Command(self, e: Command) -> Union[Div, Span]: def transform_Command(self, e: Command) -> Union[Div, Span]:
if not self.context.get_command(e.attributes["c"]): if not self.context.get_command(e.attributes["c"]):
raise NameError(f"Command not defined '{e.attributes['c']}'.") raise NameError(f"Command not defined '{e.attributes['c']}'.")
command_output = self.context.get_command(e.attributes["c"])(e, self.context) command_output = self.context.get_command(e.attributes["c"])(e, self.context, self)
e = e.replaceSelf(*([] if command_output is None else command_output)) e = e.replaceSelf(*([] if command_output is None else command_output))
return self.transform(e) return e
def transform_Whitespace(self, e: Whitespace) -> Whitespace: def transform_Whitespace(self, e: Whitespace) -> Whitespace:
if bavlna(e, self.context): if bavlna(e, self.context):

View file

@ -37,7 +37,7 @@ def parse_string(s: str) -> list[Union[Str, Space]]:
# we ever want to disable or enable some of panflute's markdown extensions, # we ever want to disable or enable some of panflute's markdown extensions,
# this is the place to do it. # this is the place to do it.
def import_md(s: str, standalone: bool=True) -> Union[Doc, list[Element]]: def import_md(s: str, standalone: bool=True) -> Union[Doc, list[Element]]:
return convert_text(s, standalone=standalone, input_format="markdown-definition_lists-latex_macros") return convert_text(s, standalone=standalone, input_format="markdown-definition_lists-latex_macros", extra_args=["--strip-comments"])
def import_md_list(s: str) -> list[Element]: def import_md_list(s: str) -> list[Element]:
return import_md(s, standalone=False) return import_md(s, standalone=False)

View file

@ -36,9 +36,9 @@ def bavlna(e: Whitespace, c: Context) -> bool:
if prevC in operators and nextC in numbers: if prevC in operators and nextC in numbers:
return True return True
if isinstance(e.prev, Math) or isinstance(e.next, Math): # if isinstance(e.prev, Math) or isinstance(e.next, Math):
# Add no-break spaces around TeX math. # # Add no-break spaces around TeX math.
return True # return True

View file

@ -1,8 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset='utf-8'>
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/katex@0.16.4/dist/katex.min.css' integrity='sha384-vKruj+a13U8yHIkAyGgK1J3ArTLzrFGBbBc0tDp4ad/EyewESeXE/Iv67Aj8gKZ0' crossorigin='anonymous'>
</head>
<body>

View file

@ -3,12 +3,13 @@ title: 'Wooooo a title'
subtitle: 'A subtitle' subtitle: 'A subtitle'
are_we_there_yet: False are_we_there_yet: False
lang: "en" lang: "en"
header-includes: |
<style>
body {
color: forestgreen;
}
</style>
--- ---
:::: {.header_content}
::: {partial="test-top.html" type="html"}
:::
::::
[#test-files/test-import.md]{type=md} [#test-files/test-import.md]{type=md}
[#test.json]{type=metadata key=orgs} [#test.json]{type=metadata key=orgs}
@ -198,13 +199,24 @@ ii. wym bro
```python {define=bash} ```python {define=bash}
import subprocess import subprocess
c = subprocess.run(["bash", "-c", element.text], stdout=subprocess.PIPE, check=True, encoding="utf-8") c = subprocess.run(["bash", "-c", element.text], stdout=subprocess.PIPE, check=True, encoding="utf-8")
return [pf.Para(pf.Str(c.stdout))] return [pf.CodeBlock(c.stdout)]
``` ```
```bash {c=bash} ```bash {c=bash}
cat /etc/hostname cat /etc/os-release
``` ```
::: {.group lang=cs}
```python {.run}
return processor.transform([
*parse_string("V "),
pf.Link(pf.Str("odevzdávátku"), url="https://ksp.mff.cuni.cz/z/odevzdavatko/"),
*parse_string(" si necháte vygenerovat vstupy a odevzdáte příslušné výstupy. Záleží jen na vás, jak výstupy vyrobíte.")
])
```
:::
```html ```html
<div> <div>
hahahahaah hahahahaah