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

feat: Add resilient master file document basic support (1.0) #51

Merged
merged 8 commits into from
Aug 2, 2023

Conversation

Omikhleia
Copy link
Owner

@Omikhleia Omikhleia commented Jul 16, 2023

Closes #18

To do:

  • master document file inputter 1.0 (minimal working)
  • master document file syntax check (schema)
  • documentation
  • rockspec update
  • check what happens when one \includes a master document in another document (lol): fix and document
  • working example - or try using it for the resilient documentation, and get rid of SIL as much as doable
  • Improvements on initial master document prototype
    • check how to handle book parts (see comment)
    • filenames in content section might not be sufficient, we may need an object (file, format) in case the extension is not one expected and the appropriation logic fails

Moved out of scope:

  • possible refactors (utils, etc.): moved under the umbrella of 2.1-alpha #50 as it encompasses more things than addressed in this PR

@Omikhleia Omikhleia self-assigned this Jul 16, 2023
@Omikhleia Omikhleia marked this pull request as draft July 16, 2023 10:49
@Omikhleia Omikhleia mentioned this pull request Jul 2, 2023
7 tasks
@Omikhleia Omikhleia force-pushed the master-document branch 2 times, most recently from 649cc6f to 1e39063 Compare July 22, 2023 17:57
@Omikhleia Omikhleia added this to the 2.1 milestone Jul 23, 2023
@Omikhleia Omikhleia changed the title feat: Add resilient master file document basic support (0.0) feat: Add resilient master file document basic support (1.0) Jul 23, 2023
@Omikhleia Omikhleia mentioned this pull request Jul 23, 2023
@Omikhleia
Copy link
Owner Author

Comment on parts: Jupyter has this interesting structure -- https://jupyterbook.org/en/stable/structure/toc.html#use-parts-to-organize-chapters

format: jb-book
root: index
parts:
  - caption: Name of Part 1
    chapters:
    - file: path/to/part1/chapter1
    - file: path/to/part1/chapter2
      sections:
      - file: path/to/part1/chapter2/section1
  - caption: Name of Part 2
    chapters:
    - file: path/to/part2/chapter1
    - file: path/to/part2/chapter2
      sections:
      - file: path/to/part2/chapter2/section1

And automatic header shifting for Markdown -- https://jupyterbook.org/en/stable/structure/sections-headers.html#how-headers-and-sections-map-onto-to-book-structure -- although they use a “next-header-deeper” nesting strategy which I find weird.

There are some good ideas to consider there.

@Omikhleia Omikhleia marked this pull request as ready for review August 1, 2023 00:06
@Omikhleia Omikhleia merged commit 5282d4d into 2.1a Aug 2, 2023
@Omikhleia Omikhleia deleted the master-document branch August 2, 2023 19:24
@Omikhleia Omikhleia linked an issue Aug 4, 2023 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Master documents
1 participant