Add acronym and abbreviation markdown guidance #1675
Merged
Conversation
* http://smartquotesforsmartpeople.com * Hyphens join words and separate syllables, en dashes denote a break in a sentence – http://en.wikipedia.org/wiki/Dash
* The style guide refers to “abbreviations and acronyms”, we should be consistent. All acronyms are abbreviations. * Update the example to include some content containing an acronym * Explain how acronyms are found within content, and what happens when one is found. Include an `abbr` tag to illustrate the hover effect. * Mention that the code itself isn’t displayed, it’s confusing when it initially disappears
* Be consistent with our content style guide
* By including the href we get the default link styles and cursor pointer we want * Bootstrap defaults to using a target specified in the href of a link
* Based on http://alphagov.github.io/inside-government-admin-guide/creating-documen ts/markdown.html#acronyms * Include specifics about what should be listed (plurals, not possessives) and caveats to avoid (spaces in markdown) * Add a second acronym to example so that markdown looks like a list (the asterisk begins to make more sense in this context)
|
|
* Guidance around plurals and possessives confused users during research session * Copy above worked in explaining how acronym markdown behaves and how it’s different to other types of markdown * Extra guidance did not match out style guide (lists should have a lead-in sentence and shouldn’t be capitalised)
fofr
added a commit
that referenced
this pull request
Aug 22, 2014
Add acronym and abbreviation markdown guidance
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
abbrtag to illustrate the hover effect.