diff options
Diffstat (limited to 'content')
| -rw-r--r-- | content/notes/00-changelog/changelog.md | 260 | ||||
| -rw-r--r-- | content/sections/00-intro/intro.md | 10 | ||||
| -rw-r--r-- | content/sections/02-features/features.md | 3 | ||||
| -rw-r--r-- | content/sections/10-structure/structure.md | 2 | ||||
| -rw-r--r-- | content/sections/15-installation/installation.md | 2 |
5 files changed, 274 insertions, 3 deletions
diff --git a/content/notes/00-changelog/changelog.md b/content/notes/00-changelog/changelog.md new file mode 100644 index 0000000..1b2a16b --- /dev/null +++ b/content/notes/00-changelog/changelog.md @@ -0,0 +1,260 @@ +# Changelog {#changelog .unnumbered} + +<!-- DO NOT manually edit this file: it's generated from _changes.yml --> +<!-- Any updates here will be overwritten --> + +This section can be used to register changes in the text versions. + +## Version 0.6.0 - 2025-12-14 {#v0.6.0 .unnumbered} + +* Improved introduction telling about *living books* and versioning + features. +* Check for `snippets/changes.md` file before trying to include it. + +## Version 0.5.9 - 2025-11-23 {#v0.5.9 .unnumbered} + +* Fix href attribute syntax in the pt-br template. + +## Version 0.5.8 - 2025-11-23 {#v0.5.8 .unnumbered} + +* Additional fix for Atom and RSS feed generation when Bookup is + vendorized. + +## Version 0.5.7 - 2025-11-23 {#v0.5.7 .unnumbered} + +* Fix Atom and RSS feed generation when Bookup is vendorized. + +## Version 0.5.6 - 2025-11-23 {#v0.5.6 .unnumbered} + +* Fix changelog generation when Bookup is vendorized. + +## Version 0.5.5 - 2025-11-23 {#v0.5.5 .unnumbered} + +* Fix Atom dates in changelog entries. +* Add consistent anchors to changelog entries in the Markdown output. + +## Version 0.5.4 - 2025-11-23 {#v0.5.4 .unnumbered} + +* Do not include version in feeds if the dates are empty. +* Fix changelog entries. +* Merge changelog entries in a single source file. +* Make sure `changelog.md` is converted as Markdown. + +## Version 0.5.3 - 2025-11-22 {#v0.5.3 .unnumbered} + +* Rename `_changes.yml` as `_changelog.yml`. + +## Version 0.5.2 - 2025-11-22 {#v0.5.2 .unnumbered} + +* Link the change log in the HTML frontmatter. +* Add a small reference to the Bookup website in the HTML frontmatter. + +## Version 0.5.1 - 2025-11-22 {#v0.5.1 .unnumbered} + +* Minor fixes in the RSS and Atom generation. + +## Version 0.5.0 - 2025-11-22 {#v0.5.0 .unnumbered} + +* Changelog improvements: + * Considered to build the recent changes section through a + `snippets/changes.md` file. This was partially implemented, but + commented. Then moved in favor of a YAML file, documented below. + * Build the recent changes using a `snippets/changes.yml` or just + `_changes.yml` that gets compiled into a `snippets/changes.md` + and into RSS and Atom files that goes in the build. Adapted from + example available at + https://recursewithless.net/projects/pandoc-feeds.html + * Added RSS/Atom feed support, adapted from recipe available at + https://recursewithless.net/projects/pandoc-feeds.html. + * Add RSS/Atom `rel` elements in the HTML head. + * Validate the generated feeds (RSS and Atom). + * Add a regular link like "Follow updates in this book". + * Document the feature. + +## Version 0.4.1 - 2025-11-20 {#v0.4.1 .unnumbered} + +* Add anchors in the notebook HTML preamble. + +## Version 0.4.0 - 2025-11-20 {#v0.4.0 .unnumbered} + +* Add anchors in the HTML preamble. + +## Version 0.3.3 - 2025-11-18 {#v0.3.3 .unnumbered} + +* Minor fix int the frontmatter citation mechanism. + +## Version 0.3.2 - 2025-11-18 {#v0.3.2 .unnumbered} + +* Support for separate publisher URL snippet. + +## Version 0.3.1 - 2025-11-18 {#v0.3.1 .unnumbered} + +* Apply fixes to the frontmatter citation mechanism. + +## Version 0.3.0 - 2025-11-18 {#v0.3.0 .unnumbered} + +* Citation: + * How to cite, by using ~~`@projectName`~~ an example in the HTML + frontmatter. + +## Version 0.2.5 - 2025-01-18 {#v0.2.5 .unnumbered} + +* Fix lookup for `js` folder for notes when the book is built under + `build/book` (then search won't work because `build/book/js` won't + be available). + +## Version 0.2.4 - 2024-10-06 {#v0.2.4 .unnumbered} + +* Apply the previous `NULL` fix to the portuguese template. + +## Version 0.2.3 - 2024-10-06 {#v0.2.3 .unnumbered} + +* Fix a `NULL` at the end of TOC in the PDF version. It was inserted + at the TeX source, due to an empty `R` block. +* Removes the unused `biblio-style` config. + +## Version 0.2.2 - 2024-09-29 {#v0.2.2 .unnumbered} + +* Display label before the book URL. + +* Fix publisher metadata information on the PDF output. This required + changing changing the "publisher" metadata from `_common.yml` to + `snippets/publisher.txt`. + +## Version 0.2.1 - 2024-09-16 {#v0.2.1 .unnumbered} + +* Fix TOC spacing between section numbers and section titles when + there are many sections making the section number too big. + +## Version 0.2.0 - 2024-08-16 {#v0.2.0 .unnumbered} + +* Provision: ensure a recent ggplot2 is used. + +## Version 0.1.9 - 2024-07-13 {#v0.1.9 .unnumbered} + +* Fix link to the Bookup site in the documentation. + +## Version 0.1.8 - 2024-07-13 {#v0.1.8 .unnumbered} + +* Template translation fix. +* Put list of etimologies before the list of definitions, as they may + usually come first (at least historically). + +## Version 0.1.7 - 2024-06-29 {#v0.1.7 .unnumbered} + +* Do not include the references block at the end of every file + processed. + +## Version 0.1.6 - 2024-06-19 {#v0.1.6 .unnumbered} + +* Apply fixes to the archive/permalink logic. + +## Version 0.1.5 - 2024-06-19 {#v0.1.5 .unnumbered} + +* Archive after doing a build, making sure that the current tag is + already in the archive (and hence can have a permalink upfront). + +## Version 0.1.4 - 2024-06-11 {#v0.1.4 .unnumbered} + +* Fixes: + * Make sure the archive folder has some basic links. +* Features: + * Fine-grained control of lists of tables, figures etc. + * Scaffolding to support a "Recent changes" section in the + compiled book. + * Documentation: Bookup features, and minor fixes. +* Misc: + * Considered to move `slides` to `content/slides`, but decided to + not do it for now. + +## Version 0.1.3 - 2024-06-10 {#v0.1.3 .unnumbered} + +* Fixes: + * Fix bibliography handling. + +## Version 0.1.2 - 2024-06-10 {#v0.1.2 .unnumbered} + +* Features: + * Improved BibTeX bibliography handling. + +## Version 0.1.1 - 2024-06-10 {#v0.1.1 .unnumbered} + +* Fixes: + * GitLab pages. + +## Version 0.1.0 - 2024-06-10 {#v0.1.0 .unnumbered} + +* Fixes: + * Cover page dimensions. + +## Version 0.0.9 - 2024-06-10 {#v0.0.9 .unnumbered} + +* Fixes: + * GitLab pages. + +## Version 0.0.8 - 2024-06-10 {#v0.0.8 .unnumbered} + +* Features: + * Localization support: + * Detect the `lang` YAML parameters and use templates from + `{templates,structure}/{book,notes}/$lang`. + * Compile the `_output.yml` from a template, setting the + `includes` from the appropriate language-based structure + files. + * Translate documentation to English. + +## Version 0.0.7 - 2024-06-09 {#v0.0.7 .unnumbered} + +* Features: + * GitLab CI. + +## Version 0.0.6 - 2024-06-09 {#v0.0.6 .unnumbered} + +* Features: + * Notebook: + * Add link to the notebook in the main book HTML. + * Add license and version information in the notebook. + * Add the repository URL into the documentation. + * Improvements towards localization. +* Issues: + * Add a `test` folder for quick experiments. + +## Version 0.0.5 - 2024-06-09 {#v0.0.5 .unnumbered} + +* Features: + * Improved compilation procedures. + * Unified configuration for book and notes. + +## Version 0.0.4 - 2024-06-08 {#v0.0.4 .unnumbered} + +* Fixes: + * Use `book` instead of `compiled`. + * Use `build` instead of `public`. + * Use `content/sections` instead of `content/published`. + * List of definitions and etimologies breaks build if they're + empty (`99-end.tex`). +* Misc: + * Considered to setup a testbed for quickly trying things. But + decided that's not needed for now, as it's possible to simply + try on this repository directly. + +## Version 0.0.3 - 2024-06-08 {#v0.0.3 .unnumbered} + +* Features: + * Notebook support. + * Website support. + +## Version 0.0.2 - 2024-06-06 {#v0.0.2 .unnumbered} + +* Features: + * Improved documentation. + +## Version 0.0.1 - 2024-06-06 {#v0.0.1 .unnumbered} + +* Features: + * Package a Bookdown-based publishing solution in a project named + `bookup` ("a bookdown-based publishing solution") or similar, to + ease book editing and authorship. + * Use the repository [ensaios](https://ensaios.fluxo.info) as + base. + * Create a basic documentation. diff --git a/content/sections/00-intro/intro.md b/content/sections/00-intro/intro.md index 169069a..1d207f4 100644 --- a/content/sections/00-intro/intro.md +++ b/content/sections/00-intro/intro.md @@ -1,7 +1,8 @@ # Introduction {#intro} -Bookup^[@bookup] is a set of templates, scripts and workflows for book -authoring in HTML, PDF and other formats. +Bookup^[@bookup] is a framework for _living books_, composed by a set of +templates, scripts and workflows for book authoring in HTML, PDF and other +formats. It's a modular software component based on [Bookdown][]. @@ -9,6 +10,11 @@ It was created to solve the problem of editing many books simultaneously: Bookup helps to keep an uniform scheme instead of having to implement and fix funcionalities across many repositories in parallel. +Bookup also allows for making these books publicly available as +work-in-progress material ("living books"), as it fully integrates with Git +tags for versioning, a change log to register major changes and RSS/ATOM feeds, +so others can track down new book revisions. + [Bookup][] makes book production similar to working with other codebases. But [Bookup][] is very opinionated. diff --git a/content/sections/02-features/features.md b/content/sections/02-features/features.md index 606ed1f..2f5aa08 100644 --- a/content/sections/02-features/features.md +++ b/content/sections/02-features/features.md @@ -17,6 +17,9 @@ Main Bookup features: * Adds the compilation metadata: * Version based on Git tag or commit. + * Compilation date. * Localization support: templates can be easily translated to other languages. + +* RSS, Atom and Markdown changelogs. diff --git a/content/sections/10-structure/structure.md b/content/sections/10-structure/structure.md index 263a764..b3432ff 100644 --- a/content/sections/10-structure/structure.md +++ b/content/sections/10-structure/structure.md @@ -21,3 +21,5 @@ A Bookup project folder structure looks like this: * `vendor/bookup`: where the Bookup codebase actually resides: * `content`: Bookup documentation. * `vendor/{Fuse.js,}`: dependencies. +* `_changelog.yml`: to track changes in your book, used to build RSS and Atom + feeds, as well as a ChangeLog in Markdown format. diff --git a/content/sections/15-installation/installation.md b/content/sections/15-installation/installation.md index d2133d2..8cfb941 100644 --- a/content/sections/15-installation/installation.md +++ b/content/sections/15-installation/installation.md @@ -22,7 +22,7 @@ Bookup installation procedure. * `LICENSE`. * `DISCLAIMER`. * `images/cover.png`. -* `snippets/{contact,cover,keywords,project,url,volume}.txt`. +* `snippets/{contact,cover,keywords,project,url,volume,publisher,publisher-url}.txt`. * `snippets/changes.md`. ## Optional files |