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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# TODO
## Issues
* [ ] Bug in `pandoc` with `citeproc` ignoring citation inside LaTeX blocks.
Affecting the PDF format. Test available at `test/pandoc`.
Consider to test with the latest pandoc and citeproc versions.
Consider an upstream bug report.
If needed, also apply corrections in the existing downstream projects.
* [ ] Support to be hosted under relative URLs, perhaps using the HTML
`<base>` tag.
## Refactor
* [ ] Create a `bookup` script:
* [ ] Able to read all the YAML config files, which should be the central
places to hold all the configuration.
* [ ] With templating support to customize the existing templates.
This may make the `snippets` files to be compiled during build time.
* [ ] Which then dispatch compilation etc to the other scripts.
* [ ] Merge `structure` and `templates` folders?
* [ ] Detect the `slides` folder and add a link to it in the compiled docs.
## Improvements
* [ ] Archive:
* [ ] Data deduplication (and compression of old archives), to save space.
* [ ] Slides:
* [ ] Improved slides workflow (compilation etc).
* [ ] Citation:
* [ ] How to cite, by using `@projectName` in the frontmatter.
* [ ] Add the corresponding BibTeX entry.
* [ ] Recent changes:
* [ ] Build the recent changes section through a `snippets/changes.md` file?
This is partially implemented, but commented.
As an alternative (or meanwhile), the notebook can be used.
* [ ] Alternativelly, build the recent changes using a `snippets/changes.yml`
or just `_changes.yml` that gets compilet into a `snippets/changes.md`
and into a RSS file that goes in the build.
* [ ] Localization:
* [ ] Make sure to properly localized the build date string.
* [ ] Setup a PO-file workflow for translating the structure and templates?
* [ ] Formats:
* [ ] Fix the EPUB output:
https://bookdown.org/yihui/bookdown/e-books.html
https://github.com/rstudio/bookdown/issues/1179
https://github.com/rstudio/bookdown/issues/1387
https://github.com/rstudio/bookdown/blob/main/NEWS.md#major-changes
* [ ] ZIM format using the `zim-tools` package for the book and the notes.
* [ ] Update the current available output formats.
* [ ] Backmatter:
* [ ] Customized lists of definitions, hypothesis, etimologies, examples etc in the PDF version:
https://tex.stackexchange.com/questions/180747/editing-format-of-list-of-theorems-in-thmtools
https://tex.stackexchange.com/questions/16494/generating-lists-of-custom-environment
* [ ] Lists of definitions, hypothesis, etimologies, examples etc in the HTML version.
Possible implementations:
https://stackoverflow.com/questions/40735727/create-index-of-definitions-theorems-at-end-of-bookdown-book?rq=4
* [ ] Misc:
* [ ] 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?
## Documentation
* [ ] Improve the documentation.
* [ ] Add a reference to:
* [ ] Books using Bookup.
* [ ] Similar projects, like:
* [ ] [Repositórios da Editora Hedra](https://github.com/hedra-editora).
|
