Skip to content
This repository has been archived by the owner on Jun 22, 2023. It is now read-only.

Update page title guidance and docs cleanup #244

Merged
merged 4 commits into from
Feb 15, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/app/design/guidelines/buttons-links/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<stache
layout="container"
pageTitle="Buttons and links"
pageTitle="Buttons and Links"
navTitle="Buttons and links"
showTableOfContents="true">

<stache-page-summary>
Expand Down
4 changes: 2 additions & 2 deletions src/app/design/guidelines/call-out-info/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<stache
layout="container"
pageTitle="Call out information"
pageTitle="Call Out Information"
navTitle="Call out information"
showTableOfContents="true">

<stache-page-summary>
Expand Down
4 changes: 2 additions & 2 deletions src/app/design/guidelines/content-containers/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<stache
layout="container"
pageTitle="Content containers"
pageTitle="Content Containers"
navTitle="Content containers"
showTableOfContents="true">

<stache-page-anchor>
Expand Down
4 changes: 2 additions & 2 deletions src/app/design/guidelines/error-handling/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<stache
layout="container"
pageTitle="Error handling"
pageTitle="Error Handling"
navTitle="Error handling"
showTableOfContents="true">

<stache-page-summary>
Expand Down
4 changes: 2 additions & 2 deletions src/app/design/guidelines/filtering-lists/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<stache
layout="container"
pageTitle="Filter lists"
pageTitle="Filter Lists"
navTitle="Filter lists"
showTableOfContents="true">

<stache-page-summary>
Expand Down
4 changes: 2 additions & 2 deletions src/app/design/guidelines/form-design/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<stache
layout="container"
pageTitle="Form design"
pageTitle="Form Design"
navTitle="Form design"
showTableOfContents="true">

<stache-page-summary>
Expand Down
4 changes: 2 additions & 2 deletions src/app/design/guidelines/managing-records/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<stache
layout="container"
pageTitle="Manage records"
pageTitle="Manage Records"
navTitle="Manage records"
showTableOfContents="true">

<stache-page-anchor>
Expand Down
21 changes: 9 additions & 12 deletions src/app/design/guidelines/page-layouts/index.html
Original file line number Diff line number Diff line change
@@ -1,27 +1,24 @@
<stache
layout="container"
pageTitle="Page design"
pageTitle="Page Design"
navTitle="Page design"
showTableOfContents="true">

<stache-page-anchor>
Page <stache-code>&lt;title&gt;</stache-code>
Page title
</stache-page-anchor>

<p>Use the following format for the page's HTML <stache-code>&lt;title&gt;</stache-code> element:</p>
<p><span class="sky-emphasized">&lt;Page title&gt; - &lt;Product title&gt;</span></p>
<p>Example: <span class="sky-emphasized">Gifts list - Raiser's Edge NXT</span></p>

<p>For pages with tabbed subnavigation, use the following format:</p>
<p><span class="sky-emphasized">&lt;Tab title&gt; - &lt;Page title&gt; - &lt;Product title&gt;</span></p>
<p>Example: <span class="sky-emphasized">Portfolio - Work center - Raiser's Edge NXT</span></p>

<p>Additional page title guidelines:</p>
<p>
Use the following format for page titles: <span class="sky-emphasized">&lt;Page title&gt; - &lt;Product title&gt;</span>. For example: <span class="sky-emphasized">Gifts list - Raiser's Edge NXT</span>. And for pages with tabbed subnavigation, use the following format: <span class="sky-emphasized">&lt;Tab title&gt; - &lt;Page title&gt; - &lt;Product title&gt;</span>. For example: <span class="sky-emphasized">Portfolio - Work center - Raiser's Edge NXT</span>. In addition, follow these guidelines for page titles:
</p>
<ul>
<li>Keep titles short.</li>
<li>Make titles unique.</li>
<li>Provide concise descriptions of each page's contents or purpose. Titles should stand on their own and make sense out of context.</li>
<li>Start with the most meaningful, differentiating terms so that they can be scanned in browser tabs, window lists, and browser bookmarks.</li>
</ul>
<p>
For information about how to use <a href="https://angular.io/docs/ts/latest/cookbook/set-document-title.html">the Angular <stache-code>Title</stache-code> service</a> and the <stache-code>title</stache-code> configuration property to specify the title, see <a stacheRouterLink="learn/reference/configuration" fragment="app">the configuration reference</a>.
</p>

<stache-page-anchor>
Grid system
Expand Down
4 changes: 2 additions & 2 deletions src/app/design/styles/borders/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<stache
layout="container"
pageTitle="Borders and shadows"
pageTitle="Borders and Shadows"
navTitle="Borders and shadows"
windowTitle="Borders and shadows"
showTableOfContents="true">

Expand Down
1 change: 0 additions & 1 deletion src/app/design/styles/color/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<stache
layout="container"
pageTitle="Colors"
windowTitle="Colors"
showTableOfContents="true">
Expand Down
1 change: 0 additions & 1 deletion src/app/design/styles/icons/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<stache
layout="container"
pageTitle="Icons"
windowTitle="Icons"
showTableOfContents="true">
Expand Down
1 change: 0 additions & 1 deletion src/app/design/styles/motion/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<stache
layout="container"
pageTitle="Motion"
windowTitle="Motion"
showTableOfContents="true">
Expand Down
1 change: 0 additions & 1 deletion src/app/design/styles/spacing/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<stache
layout="container"
pageTitle="Spacing"
windowTitle="Spacing"
showTableOfContents="true">
Expand Down
1 change: 0 additions & 1 deletion src/app/design/styles/typography/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<stache
layout="container"
pageTitle="Typography"
windowTitle="Typography">

Expand Down
2 changes: 1 addition & 1 deletion src/app/learn/reference/configuration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
</li>
<li>
<p>
<stache-code>title</stache-code> — Controls the page title at the template level for the <stache-code>skyux serve</stache-code> command while waiting for the application to load. After it loads, you can use the Angular <a href="https://angular.io/docs/ts/latest/cookbook/set-document-title.html">title service</a> to set the page title. The default is <stache-code>Blackbaud - SKY UX Application</stache-code>, so if you do not want this default to appear in the title bar while the application loads, use the <stache-code>title</stache-code> to provide your preferred title.
<stache-code>title</stache-code> — Controls the page title at the template level for the <stache-code>skyux serve</stache-code> command while waiting for the application to load. After it loads, you can use <a href="https://angular.io/docs/ts/latest/cookbook/set-document-title.html">the Angular <stache-code>Title</stache-code> service</a> to set the page title. The default is <stache-code>Blackbaud - SKY UX Application</stache-code>, so if you do not want this default to appear in the title bar while the application loads, use the <stache-code>title</stache-code> to provide your preferred title.
</p>
</li>
</ul>
Expand Down