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

Documenting text functions and improving documentation outline #360

Closed
gmischler opened this issue Mar 9, 2022 · 1 comment · Fixed by #363
Closed

Documenting text functions and improving documentation outline #360

gmischler opened this issue Mar 9, 2022 · 1 comment · Fixed by #363
Assignees

Comments

@gmischler
Copy link
Collaborator

In the context recent changes to various text functions (most recently #343 / #350) it has come up that there is no in-depth explanation of those functions and their differences (let alone the new positioning options) other than in the docstrings. Since I've modifying some of that functionality already, I probably should also add such a page, though in a seperate PR to keep things manageable.
In addition, while looking through the docs, I found that the TOC seems to have grown a lot over time without anyone adding much structure to it, which makes it quite hard to find any specific information. I tried to play around with it a bit and this is the most reasonable structure I could come up with:

  • Tutorial
    • English
    • Français
    • Deutsch
    • ...
  • Page Layout
    • Page Format and Orientation
    • Margins
    • Templates
    • Tables
  • Text Content
    • Adding Text (new)
    • Line Breaks
    • Page Breaks
    • Text Styling
    • Unicode
    • Emojis, Symbols & Dingbats
  • Graphics Content
    • Images
    • Shapes
    • Barcodes
    • Drawing
    • SVG
    • Charts & Graphs (formerly "Maths")
  • PDF Features
    • Links
    • Metadata
    • Annotations
    • Presentation Mode
    • Document Outline & Table of Contents
  • Processing Web Content
    • HTML
    • Web2Py
  • Reading and Postprocessing
    • pdfrw
    • Borb
  • Development
    • Development Guidelines
    • Logging
  • API
  • FAQ

Any objections when I modify it that way, or any better ideas? There are a few items that could go in several places.
Do I understand this right, that the documentation outline is defined in mkdocs.yml? Is there an easy way to test its processing locally?

@Lucas-C
Copy link
Member

Lucas-C commented Mar 11, 2022

Wow, that's a great plan, thanks @gmischler !

No objection at all, I've been thinking aboutre-structuring the docs' ToC for a few months, without taking the time to do it so far. Much appreciated 😊

I think some page contents are maybe a bit outdated (Unicode & Web2Py for example) but they could be edited later on.

Go on, please submit a PR! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants