pandocs icon indicating copy to clipboard operation
pandocs copied to clipboard

Add Glossary

Open avivace opened this issue 4 years ago • 10 comments

I think a preliminary section mentioning some jargon and commonly used acronyms (e.g. LSB, MSB) could be helpful. It could also introduce some of the standards and rules we adopt in the document, adding some clarifications (e.g. units, bases)

Please see further in the thread for particular sticking points.

avivace avatar Feb 23 '21 20:02 avivace

As per #287, "dots" is introduced twice.

ISSOtm avatar May 14 '21 13:05 ISSOtm

@avivace requested that I make a new issue, but I'll just hijack this one.

I think a glossary with links to each section the terms appear in would be great. It could additionally include definitions that appear on mouse-over of the term when the main body of the document (maybe with a delay).

brainard52 avatar May 19 '21 16:05 brainard52

I can try adding markup for that as part of #292.

ISSOtm avatar May 19 '21 19:05 ISSOtm

I can try adding markup for that as part of #292.

Nice. If you have a plaintext release of pandoc, I can extract a list of words that aren’t typically in an english dictionary for you

brainard52 avatar May 19 '21 19:05 brainard52

Does this Markdown render do the job?

ISSOtm avatar May 19 '21 21:05 ISSOtm

That’s great. If this works, we might even be able to integrate the glossary generation into the build.

brainard52 avatar May 19 '21 22:05 brainard52

To add: "CGB mode"

avivace avatar May 24 '21 15:05 avivace

Markup possibilities: https://github.com/commonmark/commonmark-spec/wiki/Deployed-Extensions#abbreviation https://github.com/commonmark/commonmark-spec/wiki/Deployed-Extensions#definition-list

ISSOtm avatar May 25 '21 20:05 ISSOtm

Needs to be added to the Glossary: https://github.com/gbdev/pandocs/pull/350#discussion_r979296228

avivace avatar Nov 02 '22 10:11 avivace

Needs to be added to the Glossary: https://github.com/gbdev/pandocs/pull/534#pullrequestreview-1819981650

avivace avatar Jan 17 '24 18:01 avivace