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

Glossaries not implemented #2

Closed
fletcher opened this issue Feb 9, 2017 · 4 comments
Closed

Glossaries not implemented #2

fletcher opened this issue Feb 9, 2017 · 4 comments
Assignees
Milestone

Comments

@fletcher
Copy link
Owner

fletcher commented Feb 9, 2017

Need to implement glossary support.

@fletcher fletcher added this to the 0.2 milestone Feb 9, 2017
@fletcher fletcher self-assigned this Feb 9, 2017
@fletcher fletcher added the core label Feb 9, 2017
@fletcher fletcher added this to TODO in Release MMD 6.0 Feb 9, 2017
@fletcher
Copy link
Owner Author

I'm considering changing the way that glossaries work. When first implemented, I basically coopted the footnote syntax to take on an extra feature.

MMD-6 represents a good stopping point to consider re-thinking this (along with other things.) I think that coming up with a more cohesive strategy for abbreviations and acronyms makes sense, but I'm not sure yet what that will look like.

I welcome thoughts and input!

@fletcher fletcher moved this from TODO for Next Milestone to On Deck in Release MMD 6.0 Feb 11, 2017
@sgbotsford
Copy link

sgbotsford commented Feb 11, 2017

A use for acronyms that I have frequently seen is TANSTAAFL (There ain't No Such Thing as a Free Lunch) on the first use of a term. Another common practice I've seen is to put the first occurrence of a new word in italics with the definition following in parentheses if short, or as a footnote if long.

word: (Expansion/Definition) would be a natural way of doing it.

I think html5 allows the creation of new tags that can be styled with CSS. Is HTML 5 well enough supported that you can drop support for the earlier ones? This would require some form of user based mapping between MD constructs and tags. If done right, then the HTML5 mapping would be a superset of the html<5 mappings.

@fletcher fletcher modified the milestones: 6.0, 0.2 Feb 14, 2017
@fletcher fletcher moved this from On Deck to In Progress in Release MMD 6.0 Mar 2, 2017
@fletcher fletcher moved this from In Progress to Almost done in Release MMD 6.0 Mar 2, 2017
@fletcher
Copy link
Owner Author

fletcher commented Mar 2, 2017

I added support for glossary terms to the develop branch. The syntax is different than previous versions of MMD.

Previously, glossary entries hijacked the footnote syntax. This was an artifact of the fact that HTML doesn't support glossaries, and that the original LaTeX output was created by transforming HTML into LaTeX.

In MMD-6, footnotes, citations, and glossary terms are all converging on the same parsing structure. They rely on different leading characters inside the brackets (e.g. [^foo], [#foo], and now [?foo]). All three allow inline variants as well as definition by reference. In the case of glossary terms, the inline variant requires that the term itself immediately follow the ? and be wrapped in parentheses.

Let's talk about [?MultiMarkdown], as well as [?(Markdown) Markdown is a lightweight...].

[?MultiMarkdown]: MultiMarkdown is a "descendant" of Markdown.

I'm still tinkering with this, but let me know what you think!

@fletcher fletcher moved this from Almost done to Completed in Release MMD 6.0 Mar 4, 2017
@fletcher
Copy link
Owner Author

fletcher commented Mar 5, 2017

I think the new glossary syntax is better than the old one. There may still be room for some improvement.

See https://github.com/fletcher/MultiMarkdown-6/wiki/Changes-from-MMD-5 for more information.

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

No branches or pull requests

2 participants