Auctria Callouts
Auctria Callouts Summary
Auctria Callouts are containers for content in the User Guide, including theme defaults like TIP and WARNING, and custom badges like <Advanced/> and <New/>. Bars, which expand on badges, are used to designate pages and sections, and can be aligned and displayed in columns. Callouts can be mixed and matched, and include identifiers that are case-sensitive.
page summary
A Callout is a special container, or wrapper, for a block of content in the User Guide.
Below are the current Callouts that are available; and, aside from those noted as "theme default", all are custom creations added to help provide additional "color" and emphasis where needed.
Theme Defaults
TIP
tip
WARNING
warning
DANGER
danger
Badges
The Badges used in the User Guide function as small "flags" to help provide better context for the content is is attached to. Below is a list of the current tags in their default state. The most basic Badge being used as <Badge/>.
<Advanced/> (advanced) <Archived/> (archived) <Badge/> (tip) (the default) <Hidden/> (hidden) <Link/> ∞ - Note if the Link badge is found in conjunction with the <IndexLink /> component, the <IndexLink type="link" /> component should be used to replace both. <Moved/> (moved) <New/> (new) <Updated/> (updated) <WIP/> (work in progress) (Work-In-Progress)
Each Badge can have its text customized making the above more for convenience than necessity. Below you will find the full-width or "Bar" version of these badges.
Bars
Bars will use the same color schemes as the Theme Defaults (see above) and will have a naming convention and usage based on expanding the <Badge/> components.
These will ideally be used to designate pages and sections of pages more clearly and replace the User Guide v1 page title badges as needed.
Default <Bar/>
Advanced Bar <AdvancedBar/>
Archived Bar <ArchivedBar/>
Basic Bar <BasicBar/>
Hidden Bar <HiddenBar/>
Intermediate Bar <IntermediateBar/>
Internal Bar <Internal/>
Designed to be used for pages that are hidden, ignored, and not for the general public.
Optional Bar <Optional/>
This can be used in sections of how-to and QSG pages to indicate an optional task or step.
Placeholder Bar <PlaceholderBar/>
Replacement Bar <ReplacementBar/>
Example with link to replacement page <ReplacementBar slug="Home"/>
WIP Bar <WIPBar/>
Alignment
right
middle
left (creating a forced wrap of content to the right)
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Sed convallis tristique sem. Nulla metus metus, ullamcorper vel, tincidunt sed, euismod in, nibh. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Morbi lacinia molestie dui.
Columns
half (first instance)
half (second instance)
^^ Producing a two-column display.
third (first instance)
third (second instance)
third (third instance)
^^^ Producing a three-column display.
Callout Quick Notes
You can "mix and match" Callouts although, in general, this is not commonly done in the User Guide.
The examples all use their default "Title" attribute (first line, if there is bold text); and, all contain the callout's specific identifier. NOTE - the identifier is case-sensitive.
Callouts
The "hideaway" callout is here -- hiding the contents of its container. 😉
Placeholder text.
- ideas
Placeholder text.
- feet
Placeholder text.
- glossary
WARNING
Placeholder text.
- redlight
Placeholder text.
- red
IMPORTANT
Placeholder text.
- yellowlight
Placeholder text.
- yellow
NOTE
Placeholder text.
- greenlight
Placeholder text.
- green
INFORMATION
Placeholder text.
- info
Placeholder text.
- blue
Auctria Pro-Tip from Launch Services!
- protip
Auctria Callouts
- page-summary
... placeholder:{{ $frontmatter.intro }}
page summary
Pre-Requisites
- prereq
Checklist
- checklist
Reminders
- reminder
Recommended Reading
- recread
More Reading
- read
Read More
- readmore
Related Key Topics
Last reviewed: April 2024