aboutsummaryrefslogtreecommitdiff
path: root/TODO.md
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2024-06-06 08:42:24 -0300
committerSilvio Rhatto <rhatto@riseup.net>2024-06-06 08:42:24 -0300
commitddbf070bded29947f6e6595f29d99a7c08822462 (patch)
treea0a47aa9f28f4ff0e0042cf8b37d6da842c8b681 /TODO.md
parent515bdd658d91020c73f82b70ff001015b359adc0 (diff)
downloadbookup-ddbf070bded29947f6e6595f29d99a7c08822462.tar.gz
bookup-ddbf070bded29947f6e6595f29d99a7c08822462.tar.bz2
Misc improvements
Diffstat (limited to 'TODO.md')
-rw-r--r--TODO.md43
1 files changed, 12 insertions, 31 deletions
diff --git a/TODO.md b/TODO.md
index b518255..d2999fe 100644
--- a/TODO.md
+++ b/TODO.md
@@ -1,43 +1,24 @@
# 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.
+## Basic
+
+* [ ] Package a Bookdown-based publishing solution in a project named `bookup`
+ ("a bookdown-based publishing solution")
+ or similar, to ease book editing and authorship.
* [ ] 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/`.
+* [ ] Create a basic documentation.
+* [ ] Notebook support.
+* [ ] Website support.
+
+## 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.
-* [ ] 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.