Documentation: miscellaneous (WIP)

[Mark2Mark]

Collecting things I found in the Documentation here.

• [x] GSMetric > TOC[^1] is missing font

• GSFont:

  • [ ] TOC is missing formatVersion
  • [ ] TOC is missing previewRemoveOverlap
  • [ ] TOC is missing kerningRTL
  • [ ] TOC is missing kerningVertical
  • [ ] TOC is missing tempData
  • [ ] TOC is missing previewRemoveOverlap
  • [ ] TOC is missing disablesAutomaticAlignment

• GSGlyph:

  • [ ] is missing font
  • [ ] is missing locked
  • [ ] is missing direction & storeDirection

• GSGlyphInfo:

  • [ ] TOC is missing case
  • [ ] Docu has "unicode2" but accessing it returns AttributeError: 'GSGlyphInfo' object has no attribute 'unicode2'

• GSLayer:

  • [ ] TOC is missing metrics
  • [ ] TOC is missing completeOpenBezierPath
  • [ ] TOC is missing isAligned
  • [ ] TOC is missing italicAngle
  • [ ] TOC is missing tempData
  • [ ] isAligned, isSpecialLayer, isMasterLayer, italicAngle are readonly. The docu doesn’t say that.
  • [ ] TOC is missing transform()

• [ ] CSS: Can we implement a sticky (sub-) header for the classes? A lot of properties are the same in many classes. When using the search and landing on one of the properties, it is hard to know, for which class/object the currently seen property is. One has to scroll up a lot, just to find out about that. A sticky header is simple. Just wrap the entire column that contains the header (e.g. GSFont, GSGlyph, ...) and the content in a div. Then set position: sticky; on the header. See here for an example.

• [ ] Can the properties and methods be sorted alphabetically? Both in the TOC as well in the detailed content. That would make it easier to spot missing items and also generally easier to navigate the documentation. Could also be done with a little JS.

  • [ ] e.g. familyName and familyNames are not next to each other.

[^1]: "TOC": Table of Content (the hyperlinks above the details)

[Mark2Mark]

Should GSPath.closed be readOnly? @schriftgestalt

• The unit test wanted to test this[^1], the documentation does not state it.
• One can set it to false via scripting, which opens the path by removing the last segment.

[^1]: The test was not catching that, but I implemented a way to catch readOnly properties that can be mutated.

[schriftgestalt]

You need to be able to open the path, or close it. so this should be settable.