Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User manual revamp #122

Merged
merged 16 commits into from
Jan 31, 2025
Merged

User manual revamp #122

merged 16 commits into from
Jan 31, 2025

Conversation

Omikhleia
Copy link
Owner

@Omikhleia Omikhleia commented Jan 18, 2025

Docs:

  • Add backmatter = appendix with selected bibliography
  • Migrate Markdown chapters to Djot = faster, more feature (more consistent choice also)
  • Add an installation chapter = Requested by some friend. Reading GitHub README's is hard for non-tech people apparently. 😁 and such a chapter is expected in such a book. Well.
  • Add an introductory chapter = Some general goals for casual readers that would go far into the manual...
  • Review and expand some chapters = Also reusing (adapted versions) of images I had for a set of (unpublished) slides
  • Reorganize most of the old class-related SIL content into Djot (part of Kill the SIL :) #73)
  • Rewrite layout-related chapters in Djot (another part of Kill the SIL :) #73)
  • Add an introduction to book/page layouts = with an illustration of all the "frames" that goes with a layout...

Fixes:

  • Revert an erroneously changed line in styles = marked as "chore", the issue is only on the main branch not in a released version
  • Some more better support for null in YAML style files.1
  • On the way, small bugs were found in ptable.sile and markdown.sile, so there's a dependency update...

Features:

  • Add several predefined TOC-like symbols for Djot docs = A minor thing on the way, getting rid of direct SIL commands in the manual too.

Closes #73

Footnotes

  1. Bugs occur if a null is used on terminal leaf fields. This may happen when using some advance styling, and I started doing that in the docs: The null allows for explicit cancellation of inheritance on these leaf fields, which is kind of handy. I don't like the implementation, though, it's some monkey-patching for now. Styles will require a clean-up / refactor at some point. It's a compromise, trying to make the code work while toying with it and pushing it to its limits in the manual...

@Omikhleia Omikhleia added the documentation Improvements or additions to documentation label Jan 18, 2025
@Omikhleia Omikhleia added this to the 2.7.0 milestone Jan 18, 2025
Introduced when implementing "Better support null in YAML style files"
Noted here as a "chore" as this was just a few days ago and we haven't
tagged a release yet, but this is a bug fix.
We've already a lot of Djot chapters.
It parses faster and has more capabilities, so generalize it.
@Omikhleia Omikhleia self-assigned this Jan 19, 2025
@Omikhleia Omikhleia merged commit cfa9904 into main Jan 31, 2025
2 checks passed
@Omikhleia Omikhleia deleted the docs-manual-revamp branch January 31, 2025 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Kill the SIL :)
1 participant