aboutsummaryrefslogtreecommitdiff
path: root/TODO.md
blob: a1532f0826d22170d71dfb3e36ce67be87152f68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# TODO

## Basic

* [ ] Add license and version information in the notebook.
* [ ] Add link to the notebook in the main book HTML.
* [ ] Move `slides` to `content/slides`?
* [ ] Localization support, by detecting the `lang` YAML parameters and using
      templates from `templates/{book,notes}/$lang`.
* [ ] Improve the documentation, including:
  * [ ] Translate to English.
  * [ ] Add a reference to books using Bookup.
  * [ ] Similar projects:
    * [ ] [Repositórios da Editora Hedra](https://github.com/hedra-editora).

## Improvements

* [ ] Suport for a `BASE_URL` environment variable?
      It would be applied as a template variable in `%%base_url%%` placeholers,
      allowing the compile material to have links among themselves.
* [ ] Optionally add a small reference to the Bookup website in the book
      frontmatter?

## Issues

* [ ] Bug in `pandoc` or `citeproce` ignoring citation inside LaTeX blocks.
      Affecting the PDF format. Test available at `test/pandoc`.
      Consider an upstream bug report.
      If needed, also apply corrections in the existing downstream projects.

## Bonus

* [ ] GitLab CI.
* [ ] Localization support?
  * It makes sense to localize common strings in the book structure.
  * But maybe it does not make much sense to localize strings in PO files for
    the content itself, since long text translations may need an engine that is
    not line based. Needs more thinking.