There are different shortcodes available for use. Currently, they are used to set basepaths for environment-specific URLs and for Font Awesome icons that we want to include. The general syntax for shortcodes is [[type: name]].
Site Basepath URLs
Site URLs set the basepath for our internal applications. Internally, we have several different environments so using shortcodes allows the links to these applications to be environment specific. Note: Use double brackets, not single.
[url: store] = https://estore.cap.org
- Site: Online store
- Example: "https://estore.cap.org/xyz" should be replaced with [url: store]/xyz"
- test link
[url: learn] = https://education.cap.org
- Site: Learning site
- Example: "https://education.cap.org/xyz" should be replaced with "[url: learn]/xyz"
- test link
[url: elss] = https://elss.cap.org/elss
Font Awesome Icons
Select, pre-loaded icons from the Font Awesome icon library are listed below.
Format: [icon: icon-name] (note: use double-brackets)
- edge 44 and down
- edge 80 and up
mailto:email@example.com?subject=subject line goes here
#inApplicationCode = Indicates that the page URL is embedded in an Internal Application. Impact: Changing the URL may require a code build/release.
- All lower case
- Short, descriptive title (reflects content)
- Use hyphens/dashes to separate words
- Do not use any spaces
- Do not use special characters
- Include year when relevant/related to content of asset
- cancer-protocol-ampulla-vater-v4010 or cp-ampulla-vater-v4010 (this is how Ryan brought them in)
We manually add lock icons when linking to protected content. Ideally, the icon should be placed to the left of the link itself. There are exceptions to this based on content layout. Use judgment as needed.