Difference between revisions of "Form: Article"
From Genesys Documentation
| Line 12: | Line 12: | ||
{{{for template|Article}}} | {{{for template|Article}}} | ||
| − | + | Is this a standalone article? | |
{{{field|Standalone|input type=radiobutton|values=Yes,No|default=No|mandatory}}} | {{{field|Standalone|input type=radiobutton|values=Yes,No|default=No|mandatory}}} | ||
==Define this page== | ==Define this page== | ||
| + | <toggledisplay showtext="[+] Set up the main parameters for this article" hidetext="[-] Set up the main parameters for this article"> | ||
| + | <div style="background-color: #e9e9e9; | ||
| + | border: 1px solid #cccccc; | ||
| + | padding: 20px; | ||
| + | border-radius: 3px"> | ||
<div class="clearfix"> | <div class="clearfix"> | ||
<div class="col-md-4" style="padding-left: 0;"> | <div class="col-md-4" style="padding-left: 0;"> | ||
| − | + | Display title <sup>{{FormTip| | |
| − | Set up the H1 for your page. It should have some meat to establish context. The display name is also used in search results and links. | + | Set up the H1 for your page. It should have some meat to establish context. The display name is also used in search results and links.}}</sup> |
{{{field|DisplayName}}} | {{{field|DisplayName}}} | ||
| − | + | ||
| + | Platform | ||
{{{field|Platform|input type=checkboxes|values=PureEngage,PureConnect,PureCloud}}} | {{{field|Platform|input type=checkboxes|values=PureEngage,PureConnect,PureCloud}}} | ||
| − | |||
| − | |||
</div> | </div> | ||
<div class="col-md-4"> | <div class="col-md-4"> | ||
| − | + | TOC title <sup>{{FormTip|(Optional) Choose a shorter name for the left-hand navigation tree/TOC. Be careful to keep your Display and TOC page names logically consistent.}}</sup> | |
{{{field|TocName}}} | {{{field|TocName}}} | ||
| Line 37: | Line 41: | ||
<div class="col-md-4" style="padding-right: 0;"> | <div class="col-md-4" style="padding-right: 0;"> | ||
| − | + | Global tags <sup>{{FormTip|Enter any global metadata tags that apply to this page. These tags are used to populate portal pages and other global lists - as well as dynamic books.}}</sup> | |
{{{field|Tags|input type=tokens|size=50|values=High-availability,Architecture,BestPractices|placeholder=Select metadata}}} | {{{field|Tags|input type=tokens|size=50|values=High-availability,Architecture,BestPractices|placeholder=Select metadata}}} | ||
| − | + | Related topics tags <sup>{{FormTip|Set up a "dimension" tag to enable a "related topics" widget between a tightly-coupled set of pages. For example "email" could be a dimension that applies to a set of pages within your doc or doc set pertaining to email.}}</sup> | |
{{{field|Dimension|input type=tokens|size=50|values=Journey|placeholder=Set related topics dimension}}} | {{{field|Dimension|input type=tokens|size=50|values=Journey|placeholder=Set related topics dimension}}} | ||
| Line 47: | Line 51: | ||
</div> | </div> | ||
<div> | <div> | ||
| − | + | Contextual statement <sup>{{FormTip|Add an introductory sentence to set up the context for this page. This sentence will be highlighted in the library card, and also re-used on portal pages and other global lists. Make it good!}}</sup> | |
{{{field|Context|input type=textarea|editor=tinymce|mandatory|maxlength=500}}} | {{{field|Context|input type=textarea|editor=tinymce|mandatory|maxlength=500}}} | ||
| Line 53: | Line 57: | ||
<div> | <div> | ||
| + | </div> | ||
| + | </toggledisplay> | ||
==Add or re-order sections== | ==Add or re-order sections== | ||
{{SectionReordingLimitationNote}} | {{SectionReordingLimitationNote}} | ||
| Line 60: | Line 66: | ||
<div class="clearfix"> | <div class="clearfix"> | ||
<div class="col-md-8" style="padding-left: 0;"> | <div class="col-md-8" style="padding-left: 0;"> | ||
| − | + | Section heading{{FormTip| | |
===Set the heading for your section=== | ===Set the heading for your section=== | ||
Enter the H2 heading for this section. This heading populates the Bootstrap in-page navigation widget that appears in the right sidebar. | Enter the H2 heading for this section. This heading populates the Bootstrap in-page navigation widget that appears in the right sidebar. | ||
| − | + | Sample: | |
[[File:Sampleheading.png]]}} | [[File:Sampleheading.png]]}} | ||
{{{field|sectionHeading|input type=text|placeholder=Enter the H2 for this section}}} | {{{field|sectionHeading|input type=text|placeholder=Enter the H2 for this section}}} | ||
| − | + | FAQ section heading{{FormTip| | |
===Convert this section into an FAQ=== | ===Convert this section into an FAQ=== | ||
| − | You can convert any section into an FAQ. Create a useful | + | You can convert any section into an FAQ. Create a useful question as your heading. |
The FAQ sections for this guide appear if you add an FAQ page to this guide. | The FAQ sections for this guide appear if you add an FAQ page to this guide. | ||
| − | + | Note: Use FAQs judiciously. Every "converted section" FAQ will be included in a general FAQ repository (Cargo) and will be re-used in various ways in the future. | |
===To add an FAQ page to this guide:=== | ===To add an FAQ page to this guide:=== | ||
| − | #Click | + | #Click Manage Content -> Edit manual in the right sidebar. |
| − | #Add | + | #Add FAQ to the Alternate Form field in the manage manual form. |
#Add an FAQ section and page to your topics list | #Add an FAQ section and page to your topics list | ||
#When you open the red link for this new FAQ topic, select "FAQ" from the list of available alternate forms. | #When you open the red link for this new FAQ topic, select "FAQ" from the list of available alternate forms. | ||
| − | + | Sample FAQ page: | |
[[File:FAQSample.png]] | [[File:FAQSample.png]] | ||
}} | }} | ||
| Line 90: | Line 96: | ||
</div> | </div> | ||
<div class="col-md-4" style="padding-left: 0;"> | <div class="col-md-4" style="padding-left: 0;"> | ||
| − | + | Type of section{{FormTip| | |
===Select the type for this section=== | ===Select the type for this section=== | ||
| − | You have two choices: | + | You have two choices: structured or unstructured. |
====Unstructured==== | ====Unstructured==== | ||
| Line 103: | Line 109: | ||
{{{field|Type|input type=radiobutton|values=Unstructured,Structured|mandatory|default=Unstructured|show on select=Unstructured=>Unstructured;Structured=>Structured|}}} | {{{field|Type|input type=radiobutton|values=Unstructured,Structured|mandatory|default=Unstructured|show on select=Unstructured=>Unstructured;Structured=>Structured|}}} | ||
| − | + | Anchor{{FormTip| | |
===Set an anchor for this section=== | ===Set an anchor for this section=== | ||
Use this ID for creating direct links to this section. | Use this ID for creating direct links to this section. | ||
| Line 109: | Line 115: | ||
Use an anchor for your direct section links so that you are free to change the section heading without breaking any incoming links. | Use an anchor for your direct section links so that you are free to change the section heading without breaking any incoming links. | ||
| − | + | Note: The ID must be unique to this particular article. It does not need to be unique across the system.}} | |
{{{field|anchor|placeholder=Add ID for anchor links to this section}}} | {{{field|anchor|placeholder=Add ID for anchor links to this section}}} | ||
| Line 116: | Line 122: | ||
<div id="Unstructured"> | <div id="Unstructured"> | ||
<br/> | <br/> | ||
| − | + | Text | |
{{{field|freetext|input type=textarea|editor=tinymce}}} | {{{field|freetext|input type=textarea|editor=tinymce}}} | ||
| Line 125: | Line 131: | ||
<div class="col-md-2" style="padding-left: 0;"> | <div class="col-md-2" style="padding-left: 0;"> | ||
<br/> | <br/> | ||
| − | + | Alignment{{FormTip| | |
===Choose the alignment for this section=== | ===Choose the alignment for this section=== | ||
| − | You can choose from two possible layouts for structured sections: | + | You can choose from two possible layouts for structured sections: horizontal and vertical. |
Horizontal layout is the default. In this layout, images appear on the left, and accompanying text appears on the right. | Horizontal layout is the default. In this layout, images appear on the left, and accompanying text appears on the right. | ||
| Line 137: | Line 143: | ||
<div class="col-md-10" style="padding-left: 0;"> | <div class="col-md-10" style="padding-left: 0;"> | ||
<br/> | <br/> | ||
| − | + | Image or video (only one of either) | |
| − | Image: {{{field|image|placeholder=Paste the filename for your image}}} | + | Image: {{{field|image|placeholder=Paste the filename for your image}}} Animated GIF?{{{field|gif|input type=radiobutton|mandatory|values=No,Yes|default=No}}} |
Vimeo ID: {{{field|video|size=60|placeholder=Enter the Vimeo ID for the video you want to embed}}} | Vimeo ID: {{{field|video|size=60|placeholder=Enter the Vimeo ID for the video you want to embed}}} | ||
| Line 145: | Line 151: | ||
</div> | </div> | ||
<br/> | <br/> | ||
| − | + | Supporting text | |
{{{field|structuredtext|input type=textarea|editor=tinymce}}} | {{{field|structuredtext|input type=textarea|editor=tinymce}}} | ||
| − | + | Add extra full-width text beneath the horizontal text-image pair? {{{field|fullwidth|input type=radiobutton|mandatory|values=Yes,No|default=No|show on select=Yes=>fullwidth}}} | |
<div id="fullwidth"> | <div id="fullwidth"> | ||
{{{field|structuredtextwide|input type=textarea|editor=tinymce}}} | {{{field|structuredtextwide|input type=textarea|editor=tinymce}}} | ||
</div> | </div> | ||
| − | + | Hide this section from published pages | |
{{{field|Status|input type=checkbox}}} | {{{field|Status|input type=checkbox}}} | ||
| − | |||
</div> | </div> | ||
Revision as of 13:03, March 28, 2019
This is the "Article" form. To create a page with this form, enter the page name below; if a page with that name already exists, you will be sent to a form to edit that page.