This is a collection of known documentation gaps in Keyman Developer, collected from a variety of locations. When the time is ripe, they can be split out into separate issues as needed.
[ ] Update content to use <kbd> and <samp> elements. This way we get nice formatting for keys and sample text
[ ] Remove class="xref", class=”link”, from <a> and type=”disc” from ul elements
[ ] Analyse all headers in reference documentation for consistency (Inconsistent use of <h1>, <h2> etc. Also content within headers in Reference sections is inconsistent.)
[ ] Add a banner to 6.0, 7.0, 8.0 docs to note that they are old. If possible, include a link to latest version of doc.
[ ] Make this search engine aware, with meta to indicate old content. So search engines prioritise the latest content?
[ ] Package tutorial needs rewrite with regard to Keyman Cloud keyboard repository; to encourage good design…
[ ] Rewrite 8.0 keyboard developer guide
[ ] The keyboard metadata .json file format needs a reference page in /developer/somewhere/
[ ] kmw_embedcss needs docs on css rules that are sensible to use
[ ] kmw_embedjs needs docs on js API and guide on interacting with KMW (mobile, embedded, desktop)
[ ] Document deep linking keyman: protocol for all Keyman Engine platforms (also see sillsdev/keyman#52)
Specifying "(such as Gentium)" could be a minor problem, since the original Gentium font isn't readily available. One is more likely to find "Gentium Basic" or "Gentium Plus". An alternative would be Doulos SIL or Charis SIL.
mcdurdin
commented
4 years ago
from @mcdurdin
This is a collection of known documentation gaps in Keyman Developer, collected from a variety of locations. When the time is ripe, they can be split out into separate issues as needed.
<kbd>and<samp>elements. This way we get nice formatting for keys and sample text<a>and type=”disc” from ul elements<h1>,<h2>etc. Also content within headers in Reference sections is inconsistent.)from @DavidLRowe (1) On the page: http://help.keyman.com/developer/9.0/guides/develop/tutorial/step-7, there's a very minor change to the French text:
'Alors Alice demanda, "O est ma chatte?"'
I think O should be Où (and Ö should be Öù in the later line).
(2) On the page: http://help.keyman.com/developer/9.0/guides/develop/advanced-keyboard-development-example
Specifying "(such as Gentium)" could be a minor problem, since the original Gentium font isn't readily available. One is more likely to find "Gentium Basic" or "Gentium Plus". An alternative would be Doulos SIL or Charis SIL.