aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2024-06-11 14:14:40 +0100
committerSilvio Rhatto <rhatto@riseup.net>2024-06-11 14:14:40 +0100
commitbe4adbd61ad75572aabf613e5b9e9a54534dcbaf (patch)
treec4512274b76d8c9237b308d80deece300d6fc77d
parent5b324d5bae27a5c81748f2d8988db26459b1536a (diff)
downloadbookup-be4adbd61ad75572aabf613e5b9e9a54534dcbaf.tar.gz
bookup-be4adbd61ad75572aabf613e5b9e9a54534dcbaf.tar.bz2
Feat: some more partial documentation improvements
-rw-r--r--ChangeLog.md8
-rw-r--r--TODO.md4
-rw-r--r--content/sections/10-structure/structure.md4
l---------snippets/changes.md1
-rw-r--r--structure/book/en/99-biblio.md9
-rw-r--r--structure/book/en/99-end.md19
-rw-r--r--structure/book/en/99-end.tex4
-rw-r--r--structure/book/pt-br/99-biblio.md9
-rw-r--r--structure/book/pt-br/99-end.md19
-rw-r--r--structure/book/pt-br/99-end.tex4
10 files changed, 60 insertions, 21 deletions
diff --git a/ChangeLog.md b/ChangeLog.md
index b8e4866..fc51527 100644
--- a/ChangeLog.md
+++ b/ChangeLog.md
@@ -4,8 +4,14 @@
### Features
+* [x] Scaffolding to support a "Recent changes"
+ section in the compiled book.
* [x] Documentation: Bookup features, and minor
- fixes.
+ fixes.
+
+### Misc
+
+* [~] Move `slides` to `content/slides`?
## v0.1.3 - 2024-06-10
diff --git a/TODO.md b/TODO.md
index 2f08137..e9a53b1 100644
--- a/TODO.md
+++ b/TODO.md
@@ -3,11 +3,13 @@
## Basic
* [ ] Slides:
- * [ ] Move `slides` to `content/slides`?
* [ ] Improved slides workflow (compilation etc).
* [ ] Citation:
* [ ] How to cite, by using `@projectName` in the frontmatter.
* [ ] Add the corresponding BibTeX entry.
+* [ ] 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.
## Issues
diff --git a/content/sections/10-structure/structure.md b/content/sections/10-structure/structure.md
index f43dc4a..263a764 100644
--- a/content/sections/10-structure/structure.md
+++ b/content/sections/10-structure/structure.md
@@ -7,9 +7,11 @@ A Bookup project folder structure looks like this:
* `drafts`: you can leave here texts still being composed.
* `sections`: here goes the material to be compiled in book format.
* `notes`: keep texts here to be compiled as a notebook companion.
-* `slides`: slides in Markdown format.
+ * `slides`: keep the slides sources here.
* `site`: an optional website used as base; if that exists, the book will be
place inside the `build/book` folder.
+* `slides`: if this folder is available, it will be considered as the compiled
+ slides folder and will be included in the `build/slides` folder.
* `build`: the compiled book (HTML, PDF and other formats):
* `notes`: the compiled notebook.
* `book`: the compiled book, if there's a `site` folder available,
diff --git a/snippets/changes.md b/snippets/changes.md
new file mode 120000
index 0000000..41c10a6
--- /dev/null
+++ b/snippets/changes.md
@@ -0,0 +1 @@
+../ChangeLog.md \ No newline at end of file
diff --git a/structure/book/en/99-biblio.md b/structure/book/en/99-biblio.md
deleted file mode 100644
index 83817b6..0000000
--- a/structure/book/en/99-biblio.md
+++ /dev/null
@@ -1,9 +0,0 @@
-\backmatter
-
-<!-- Neat way to have HTML comments: https://stackoverflow.com/a/43902043 -->
-<!-- This seems not to be the case anymore: https://bookdown.org/yihui/bookdown/citations.html -->
-<script type="text/html">
-`r if (knitr::is_html_output()) '# Bibliografia'`
-</script>
-
-# Bibliography
diff --git a/structure/book/en/99-end.md b/structure/book/en/99-end.md
new file mode 100644
index 0000000..d0c8b8d
--- /dev/null
+++ b/structure/book/en/99-end.md
@@ -0,0 +1,19 @@
+\backmatter
+
+<!-- Neat way to have HTML comments: https://stackoverflow.com/a/43902043 -->
+<!-- This seems not to be the case anymore: https://bookdown.org/yihui/bookdown/citations.html -->
+<script type="text/html">
+`r if (knitr::is_html_output()) '# Bibliography'`
+</script>
+
+# Bibliography
+
+<!-- Neat way to have HTML comments: https://stackoverflow.com/a/43902043 -->
+<!-- This seems not to be the case anymore: https://bookdown.org/yihui/bookdown/citations.html -->
+<script type="text/html">
+```{r echo=FALSE, results='asis'}
+if (knitr::is_html_output()) {
+ cat(readLines('snippets/changes.md'), sep='\n')
+}
+```
+</script>
diff --git a/structure/book/en/99-end.tex b/structure/book/en/99-end.tex
index 0cf238b..fb48277 100644
--- a/structure/book/en/99-end.tex
+++ b/structure/book/en/99-end.tex
@@ -33,3 +33,7 @@ Lists of tables, figures etc.
% Print the index
\printindex
+
+% ChangeLog
+% This is commented until a LaTeX version is available
+%\IfFileExists{snippets/changes.md}{\input{snippets/changes.md}}{}
diff --git a/structure/book/pt-br/99-biblio.md b/structure/book/pt-br/99-biblio.md
deleted file mode 100644
index c5385cb..0000000
--- a/structure/book/pt-br/99-biblio.md
+++ /dev/null
@@ -1,9 +0,0 @@
-\backmatter
-
-<!-- Neat way to have HTML comments: https://stackoverflow.com/a/43902043 -->
-<!-- This seems not to be the case anymore: https://bookdown.org/yihui/bookdown/citations.html -->
-<script type="text/html">
-`r if (knitr::is_html_output()) '# Bibliografia'`
-</script>
-
-# Bibliografia
diff --git a/structure/book/pt-br/99-end.md b/structure/book/pt-br/99-end.md
new file mode 100644
index 0000000..ba2d787
--- /dev/null
+++ b/structure/book/pt-br/99-end.md
@@ -0,0 +1,19 @@
+\backmatter
+
+<!-- Neat way to have HTML comments: https://stackoverflow.com/a/43902043 -->
+<!-- This seems not to be the case anymore: https://bookdown.org/yihui/bookdown/citations.html -->
+<script type="text/html">
+`r if (knitr::is_html_output()) '# Bibliografia'`
+</script>
+
+# Bibliografia
+
+<!-- Neat way to have HTML comments: https://stackoverflow.com/a/43902043 -->
+<!-- This seems not to be the case anymore: https://bookdown.org/yihui/bookdown/citations.html -->
+<script type="text/html">
+```{r echo=FALSE, results='asis'}
+if (knitr::is_html_output()) {
+ cat(readLines('snippets/changes.md'), sep='\n')
+}
+```
+</script>
diff --git a/structure/book/pt-br/99-end.tex b/structure/book/pt-br/99-end.tex
index 1959646..098fdd8 100644
--- a/structure/book/pt-br/99-end.tex
+++ b/structure/book/pt-br/99-end.tex
@@ -33,3 +33,7 @@ Listas de tabelas, figuras etc.
% Print the index
\printindex
+
+% ChangeLog
+% This is commented until a LaTeX version is available
+%\IfFileExists{snippets/changes.md}{\input{snippets/changes.md}}{}