-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add footnotes interface guidelines (#723)
* add footnotes interface guidelines * fix alt text
- Loading branch information
Showing
9 changed files
with
76 additions
and
2 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+97.5 KB
apps/docs/content/components/Footnotes/images/dont-use-disclaimer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
--- | ||
title: Footnotes | ||
description: Use footnotes to display contextual information and cite sources in the page content. | ||
--- | ||
|
||
import ComponentLayout from '../../../src/layouts/component-layout' | ||
export default ComponentLayout | ||
|
||
import anatomy from './images/anatomy.png' | ||
import doPosition from './images/do-position.png' | ||
import doReturnLinks from './images/do-use-return-urls.png' | ||
import dontReturnLinks from './images/dont-use-return-urls.png' | ||
import doUseDisclaimer from './images/do-use-disclaimer.png' | ||
import dontUseDisclaimer from './images/dont-use-disclaimer.png' | ||
|
||
## Anatomy | ||
|
||
<img | ||
src={anatomy} | ||
alt="Footnotes as an ordered list of citations, with visual indicators marking items and return urls" | ||
/> | ||
|
||
## Usage | ||
|
||
### Position | ||
|
||
Footnotes should generally appear at the bottom of the page. | ||
|
||
<DoDontContainer stacked> | ||
<Do> | ||
<img src={doPosition} alt="" /> | ||
<Caption>Place footnotes towards the end of a page.</Caption> | ||
</Do> | ||
</DoDontContainer> | ||
|
||
### Return links | ||
|
||
Citations in the format of a numbered list should feature both a local description and a link to return the user to the original context. | ||
|
||
<DoDontContainer> | ||
<Do> | ||
<img src={doReturnLinks} alt="" /> | ||
<Caption> | ||
Include sufficient descriptions for each citation, alongside a return | ||
link. | ||
</Caption> | ||
</Do> | ||
<Dont> | ||
<img src={dontReturnLinks} alt="" /> | ||
<Caption> | ||
Don't require users to manually locate the original context for each | ||
citation. | ||
</Caption> | ||
</Dont> | ||
</DoDontContainer> | ||
|
||
### Paragraphs | ||
|
||
Use paragraphs to present disclaimers or similar types of content. | ||
|
||
<DoDontContainer> | ||
<Do> | ||
<img alt="" src={doUseDisclaimer} /> | ||
<Caption>Use paragraphs for context-agnostic items of text.</Caption> | ||
</Do> | ||
<Dont> | ||
<img alt="" src={dontUseDisclaimer} /> | ||
<Caption> | ||
Don't use paragraphs to represent citations or numbered lists. | ||
</Caption> | ||
</Dont> | ||
</DoDontContainer> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters