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

Add acronym and abbreviation markdown guidance #1675

Merged
merged 6 commits into from Aug 22, 2014
Merged

Add acronym and abbreviation markdown guidance #1675

merged 6 commits into from Aug 22, 2014

Conversation

@fofr
Copy link
Contributor

@fofr fofr commented Aug 20, 2014

  • Code review
  • Product review
  • Departments and policy checked copy

  • The style guide refers to “abbreviations and acronyms”, we should be consistent. All acronyms are abbreviations.
  • Update the example to include multiple acronyms and some example content
  • 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
  • Include specifics about what should be listed (plurals, not possessives) and caveats to avoid (spaces in markdown)
  • Improve typography with en dashes, smart quotes
    • Also, eg not e.g.

screen shot 2014-08-20 at 12 43 27

fofr added 5 commits Aug 20, 2014
* 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)
@fofr fofr force-pushed the AH-acronym-help branch from 440e9fe to 11487c0 Aug 20, 2014
@bishboria
Copy link
Contributor

@bishboria bishboria commented Aug 20, 2014

👍

* 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
@fofr fofr merged commit 57c80b9 into master Aug 22, 2014
1 check passed
1 check passed
default Build #3926 succeeded on Jenkins
Details
@fofr fofr deleted the AH-acronym-help branch Aug 22, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.