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

documentation for font features #444

Merged
merged 8 commits into from
Feb 26, 2021
Merged

documentation for font features #444

merged 8 commits into from
Feb 26, 2021

Conversation

Crissov
Copy link
Contributor

@Crissov Crissov commented Feb 22, 2021

No description provided.

@alerque
Copy link
Owner

alerque commented Feb 22, 2021

Thanks for the contribution. Can you tell me how this was created/generated? It is more complete and in a format I'd prefer that the existing ODT based documentation. Obviously one is documenting the FEA source and the other more the OpenType feature end of things, but there is also substantial overlap. Ideally I'd like to settle on who we are documenting for and in what format and bring these together a bit.

@Crissov
Copy link
Contributor Author

Crissov commented Feb 26, 2021

JFTR, the markdown was taken from the documentation I did for the CSS file in #431. Unfortunately, there's nothing generated automatically yet.

@alerque
Copy link
Owner

alerque commented Feb 26, 2021

Docs are kind of a disaster right now. We have a preview image that needs LaTeX to regenerate, LibreOffice sources with generated PDFs stored in Git, and several assorted Markdown files.

While I love markdown and could setup conversion to PDF as part of the build release process, there are two things that don't play very nicely yet. 1 is math, 2 is "live" previews of the font and features being documented using the actual font. Both can be handled but it's a complicated mess.

However I think all that's about to change. With math support about to land in SILE we'll have access to a relatively lightweight way to keep sources in a text based format and have math and previews of the current font baked into PDFs with each rebuild.

All that to say I think I'm going to go ahead and merge this now and work on merging the different documentation bits and massaging them into a better format for distribution later.

- align the content of top-level headings
- consistently mark up letters with italics and use title-case for letter names
- remove irrelevant remarks on the state of CSS
- add some paragraph and line breaks for better diffability in the future
- some improvements to phrasing
alerque
alerque previously approved these changes Feb 26, 2021
@alerque alerque merged commit 03f46a0 into alerque:master Feb 26, 2021
@Crissov Crissov deleted the patch-1 branch February 26, 2021 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants