60 lines
2.3 KiB
Markdown
60 lines
2.3 KiB
Markdown
+++
|
|
title = "References"
|
|
+++
|
|
|
|
## Cross-references
|
|
|
|
**Infusion** provides an easy mechanism to cross-reference patterns, by title, using the `pattern` shortcode. For example, I can reference the {{% pattern "Notes & warnings" %}} pattern. Here's what the markdown looks like, including the shortcode:
|
|
|
|
{{<codeBlock>}}
|
|
I can reference the {{% pattern "Notes & warnings" %}} pattern here.
|
|
{{</codeBlock>}}
|
|
|
|
This saves you having to worry about pathing and decorates the generated link with a bookmark icon, identifying the link as a pattern reference visually.
|
|
|
|
{{% note %}}
|
|
The title argument you supply to the shortcode must be exactly the same as the referenced pattern's `title` metadata value and is case sensitive.
|
|
{{% /note %}}
|
|
|
|
## WCAG References
|
|
|
|
[WCAG 2.0](https://www.w3.org/TR/WCAG/) is the _de facto_ standard for accessible interfaces. When writing about inclusive design patterns, sometimes you'll want to refer to WCAG to highlight which success criteria the pattern meets.
|
|
|
|
Instead of having to copy and paste content and links to WCAG, **Infusion** provides a shortcode mechanism that lets you simply list the success criteria by number:
|
|
|
|
{{<codeBlock>}}
|
|
{{% wcag include="1.2.1, 1.3.1, 4.1.2" %}}
|
|
{{</codeBlock>}}
|
|
|
|
This generates a list of references that includes the names of each criterion and links to them directly. Like this:
|
|
|
|
{{% wcag include="2.1.1, 4.1.2" %}}
|
|
|
|
{{% note %}}
|
|
You don't have to leave spaces after the comma separators. They are optional.
|
|
{{% /note %}}
|
|
|
|
### Full descriptions
|
|
|
|
Sometimes, you'll want to include the full descriptions of the success criteria inline. This is possible by setting `descriptions` to `true`:
|
|
|
|
{{<codeBlock>}}
|
|
{{% wcag include="1.3.1, 4.1.2" descriptions="true" %}}
|
|
{{</codeBlock>}}
|
|
|
|
Here's the more verbose output:
|
|
|
|
{{% wcag include="2.1.1, 4.1.2" descriptions="true" %}}
|
|
|
|
## Inclusive Design Principle references
|
|
|
|
Some inclusive design concepts are not reducible to success or fail criteria. This is why The Paciello Group wrote the [Inclusive Design Principles](http://inclusivedesignprinciples.org/). These can be listed by name.
|
|
|
|
{{<codeBlock>}}
|
|
{{% principles include="Add value, Be consistent" descriptions="true" %}}
|
|
{{</codeBlock>}}
|
|
|
|
Here's the output with `descriptions="true"`:
|
|
|
|
{{% principles include="Add value,Be consistent" descriptions="true" %}}
|