aboutsummaryrefslogtreecommitdiff
path: root/TODO.md
blob: b518255b41da6565f2ba401b216c367be87ae223 (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
# TODO

* [ ] Empacotar solução de publicação baseada em Bookdown num projeto de nome
      `bookup` ("a bookdown-based publishing solution" ou similar, para
      facilmente realizar a editoração e autoria de livros.
* [ ] Usar como base o código do repositório `ensaios`, com eventuais adendos
      do repositório `cybersni`. Inicialmente, não é necessário investir tempo em
      generalizar tudo ao máximo. O importante é criar uma base comum para os meus
      livros, e talvez no futuro generalizar para que possa ser usado por outras
      iniciativas.
* [ ] Setup procedure:
  * [ ] Vendorizantion (`bookup` and bibliography repositories).
  * [ ] Symlinking.
  * [ ] Basic files:
    * `images/cover.png`.
    * `_bookup.yml`.
    * `_biblio.yml`.
    * `LICENSE`.
    * `DISCLAIMER`.
    * `snippets/`.
* [ ] 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.
* [ ] Book folder structure:
  * `archive`: to hold archives (older book versions).
  * `content`: book content:
    * `drafts`: leave here texts still being redacted.
    * `published`: here goes all the material to be compiled.
  * `notes`: notebook.
  * `slides`: slides in Markdown format.
  * `site`: optional HTML used for the base site; if this exists, the book will
    be placed under `public/book` or something like that.
  * `public`: compiled book (HTML, PDF and other formats):
    * `notes`: compiled notebook.
    * `book`: compiled book if there's a `site` folder, otherwise book contents
      will be placed in the root of the public folder.
  * `biblio`: bibliography.
  * `images`: images folder.
  * `vendor/bookup`:
    * `content`: used when no content is available (Bookup documentation).
    * `vendor/{Fuse.js,}`: dependencies.