aboutsummaryrefslogtreecommitdiff
path: root/TODO.md
blob: 78189fbd93b736d740e8cdce701174287004e6c9 (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
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# TODO

## Issues

* [ ] Disable first paragraph indentation in PDF output on Debian trixie
      (branch `fix/trixie`).
* [ ] Fix PDF compilation issues on Debian trixie (branch `fix/trixie`):
  * [x] Research:
    * Use cite and bibitem even with citeproc:
      https://github.com/jgm/pandoc/issues/9031#issuecomment-1694744040
    * pandoc - Undefined control sequence using citeproc to convert MD to PDF with a template:
      https://tex.stackexchange.com/questions/695228/undefined-control-sequence-using-citeproc-to-convert-md-to-pdf-with-a-template
  * [x] Tests at `tests/citeproc-with-cite-and-bibitem`.
  * [ ] Integrate (just merge branch `fix/trixie`) when the time comes.
* [ ] Bug in `pandoc` with `citeproc` ignoring citation inside LaTeX blocks.
      Affecting the PDF format. Minimum working example available at
      `test/pandoc/citeproc-conversion-bug`.
      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.
* [ ] Upstream on `tufte-latex` the fix for `\titlecontents{section}` when
      there are many sections within a chapter: increase, or make customizable,
      the width between the section number and the section title.
* [ ] Bibliography should honor the `urldate` BibTeX field.

## Refactor

* [ ] Consider merging `ChangeLog.md` with `_changelog.yml`.
* [ ] 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:
  * [ ] Add the corresponding BibTeX entry.
  * [ ] How to cite, by using ~~`@projectName`~~ an example in the PDF
        frontmatter.
* [ ] Localization:
  * [ ] Make sure to properly localize 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
  * [ ] Backcover.
  * [ ] Book flaps (and/or dust jacket).
* [ ] Misc:
  * [ ] Spell checking as a `Makefile` target.
  * [ ] 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.
  * [ ] Add a small reference to the Bookup website in PDF book frontmatter.
  * [ ] Add the lists of tables, images etc in the PDF table of contents.

## Documentation

* [ ] Improve the documentation.
* [ ] Add that, with Bookup, books can be written and logged like another
      coding project: good practices learned from computer programming can
      be fed back into book writing.
* [ ] Tell about _living books_, meant to be versioned, have feeds and an
      archive, so others can properly follow updates and cite specific versions.
* [ ] Document the "Bookup Stack": which piece of software is at which level,
      and used for what.
* [ ] Add a reference to:
  * [ ] Books using Bookup.
  * [ ] Similar projects, like:
    * [ ] [Repositórios da Editora Hedra](https://github.com/hedra-editora).