Difference between revisions of "Form: Article"

From Genesys Documentation
Jump to: navigation, search
 
(65 intermediate revisions by 6 users not shown)
Line 3: Line 3:
 
To create a page with this form, enter the page name below;
 
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.
 
if a page with that name already exists, you will be sent to a form to edit that page.
−
 
+
__TOC__
  
 
{{#forminput:form=Article}}
 
{{#forminput:form=Article}}
−
 
 
</noinclude><includeonly>
 
</noinclude><includeonly>
 
<div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div>
 
<div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div>
 
{{{info|edit title=Editing {{#explode:{{FULLPAGENAME}}|/|3}} }}}
 
{{{info|edit title=Editing {{#explode:{{FULLPAGENAME}}|/|3}} }}}
 +
 
{{{for template|Article}}}
 
{{{for template|Article}}}
−
'''Is this a standalone article?'''
+
<div class="toggle-wrap">
−
{{{field|Standalone|input type=radiobutton|values=Yes,No|default=No|mandatory}}}
+
<toggledisplay linkstyle font-size:larger showtext="Set up your page" hidetext="Set up your page">
 +
<div class="toggle-content row">
 +
<div class="col-md-2 form-label">Standalone article?{{FormTip|
 +
Select Yes if your topic doesn't belong to a manual. A How It Works page, for example, doesn't belong to a manual.}}</div>
 +
<div class="col-md-10">{{{field|Standalone|input type=radiobutton|values=Yes,No|default=No|mandatory}}}</div>
  
−
==Define this page==
+
<div class="col-md-2 form-label">Display title {{FormTip|
−
<div class="clearfix">
+
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.}}</div>
−
<div class="col-md-4" style="padding-left: 0;">
+
<div class="col-md-10">{{{field|DisplayName|size=100%}}}</div>
−
'''Display title''' <sup>{{#ppin:
 
−
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.|&nbsp;Help|width=600|mandatory}}</sup>
 
  
−
{{{field|DisplayName}}}
+
<div class="col-md-2 form-label">TOC title {{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.}}</div>
 +
<div class="col-md-10">{{{field|TocName|size=100%}}}</div>
  
−
'''Platform'''
+
<div class="col-md-2 form-label">Contextual statement {{FormTip|Add an introductory "contextual" sentence to set up the context for this page - a snapshot of what the reader can expect to learn or accomplish from reading this page.
  
−
{{{field|Platform|input type=checkboxes|values=PureEngage,PureConnect,PureCloud}}}
+
The goal is this:
 +
*A user reaches this page through search, or a link.
 +
*They need to understand as quickly as possible whether this page is worth reading for their purposes.
 +
*The two best places to establish context are the title of the page, and this intro sentence.
 +
*If the reader determines that no, this is the wrong page, header or sidebar links should direct them to higher level pages to guide them further.
  
 +
Here are a two examples of successful contextual statements:
  
−
</div>
+
[[File:ContextExample_hist.png]]
−
<div class="col-md-4">
 
−
'''TOC Title''' <sup>{{#ppin:(Optional) Choose a shorter name for the left-hand navigation tree/TOC. Be careful to keep your Display and TOC page names logically consistent.|&nbsp;Help|width=600}}</sup>
 
  
−
{{{field|TocName}}}
+
[[File:ContextExample_intraday.png]]
  
−
</div>
 
−
<div class="col-md-4" style="padding-right: 0;">
 
  
−
'''Global tags''' <sup>{{#ppin: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.|&nbsp;Help|width=600}}</sup>
+
{{NoteFormat|These context statements are saved in Cargo and can be re-used on portal pages and other global lists. Consider this secondary purpose as well: how this statement can give context to a link or list, letting a reader know what to expect before they click to come to this page.}}
 +
}}</div>
  
−
{{{field|Tags|input type=tokens|size=50|values=High-availability,Architecture,BestPractices|placeholder=Select metadata}}}
+
<div class="col-md-10 ve-height">{{{field|Context|input type=textarea|editor=visualeditor|mandatory|maxlength=500}}}</div>
  
−
'''Related topics tags''' <sup>{{#ppin: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.|&nbsp;Help|width=600}}</sup>
+
<div class="col-md-2 form-label">EPPO head links</div>
−
 
+
<div class="col-md-10 row" style="padding-left: 15px;">
−
{{{field|Dimension|input type=tokens|size=50|values=Journey|placeholder=Set related topics dimension}}}
+
<div class="col-md-4">
 +
{{{field|Dimension|input type=tokens|size=30|values=Journey}}}<br/>
 +
<span class="form-label bottom">Related topics tags {{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.}}</span>
 
</div>
 
</div>
 +
<div class="col-md-4">
 +
{{{field|UseCase|input type=tokens|size=50|values={{#cargo_query:tables=SMART_Meta|fields=ID|no html}}|mapping template=UseCaseMap}}}<br/>
 +
<span class="form-label bottom">Use cases{{FormTip|Select the use case(s) related to this topic.}}</span>
 
</div>
 
</div>
−
<div>
 
−
'''Contextual statement''' <sup>{{#ppin: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!|&nbsp;Help}}</sup>
 
−
 
−
{{{field|Context|input type=textarea|editor=tinymce|mandatory|maxlength=500}}}
 
 
</div>
 
</div>
 +
<div class="col-md-2 form-label">Feature coming soon? {{FormTip|Tag this article to apply the Feature Coming Soon banner on this page:
 +
{{ComingSoon}}
  
−
<div>
+
You can also apply this setting globally to the version as a whole:
−
==Add or re-order sections==
 
−
{{SectionReordingLimitationNote}}
 
−
{{{field|Section|holds template}}}
 
−
{{{end template}}}
 
−
{{{for template|Section|multiple|embed in field=Article[Section]|displayed fields when minimized=sectionHeading}}}
 
−
<div class="clearfix">
 
−
<div class="col-md-8" style="padding-left: 0;">
 
−
'''Section heading'''{{FormTip|
 
−
===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.
 
  
−
'''Sample''':
+
Apply the global setting using '''Manage content''' -> '''Edit version''' and the banner will appear on all pages within this version.}}</div>
−
[[File:Sampleheading.png]]}}
+
<div class="col-md-10">{{{field|ComingSoon|input type=radiobutton|values=Yes,No|default=No|mandatory}}}</div>
  
−
{{{field|sectionHeading|input type=text|placeholder=Enter the H2 for this section}}}
+
<div class="col-md-2 form-label">Platform</div>
 +
<div class="col-md-10">{{{field|Platform|size=40|input type=tokens|values=GenesysEngage-onpremises,PureConnect,GenesysCloud}}}</div>
  
−
'''FAQ section heading'''{{FormTip|
+
<div class="col-md-2 form-label">Genesys Multicloud CX settings</div>
−
===Convert this section into an FAQ===
+
<div class="col-md-10 row" style="padding-left: 15px;">
−
You can convert any section into an FAQ. Create a useful '''question''' as your heading.
+
<div class="col-md-4">{{{field|Role|input type=tokens|size=100%|cargo table=PEC_User_Role_MasterList|cargo field=Role}}}<br/>
 +
<span class="form-label bottom">User roles{{FormTip|Select the user role(s) for this page. For example, if this is an article in Agent Setup, the user role would be Administrator.}}</span></div>
  
−
The FAQ sections for this guide appear if you add an FAQ page to this guide.
+
<div class="col-md-4">{{{field|Application|input type=tokens|size=100%|cargo table=PEC_Applications_MasterList|cargo field=Application}}}<br/>
 +
<span class="form-label bottom">Applications{{FormTip|Select the main application(s) for this page. For example, if this is the "How Outbound works" page, the main applications would be CX Contact, Outbound, and Outbound Administration.}}</span></div>
 +
</div>
  
−
'''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.
+
<div class="col-md-2 form-label">Genesys Cloud settings</div>
−
 
+
<div class="col-md-10 ve-height">{{{field|Prereq|input type=textarea|editor=visualeditor}}}
−
===To add an FAQ page to this guide:===
+
<span class="form-label bottom">Prerequisites section {{FormTip|This is intended to hold permissions related information for GenesysCloud content. For example:
−
#Click '''Manage Content -> Edit manual''' in the right sidebar.
 
−
#Add '''FAQ''' to the '''Alternate Form''' field in the manage manual form.
 
−
#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.
 
−
 
 
−
'''Sample FAQ page''':
 
−
[[File:FAQSample.png]]
 
−
}}
 
−
 
 
−
{{{field|FAQHeading|input type=text|placeholder=(Optional) Enter question to enable FAQ|size=70}}}
 
  
 +
[[File:PCPreqSample.png]]
 +
}}</span></div>
 +
<div style="clear:both;"></div>
 +
</div>
 +
</toggledisplay>
 
</div>
 
</div>
−
<div class="col-md-4" style="padding-left: 0;">
 
−
'''Type of section'''{{FormTip|
 
−
===Select the type for this section===
 
−
You have two choices: '''structured''' or '''unstructured'''.
 
  
−
====Unstructured====
+
{{{field|Section|holds template}}}
−
This section consists of basically an H2 heading and free text.  
+
{{{end template}}}
 +
{{{for template|Section|multiple|embed in field=Article[Section]|displayed fields when minimized=sectionHeading|add button text=Add a section}}}
 +
<div class="row" style="padding-left:15px;">
 +
<div class="col-md-2 form-label">Section heading{{FormTip|
 +
===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.
  
−
====Structured====
+
Sample:
−
This section is meant for visual first, cloud-style content. It requires an image or video to be included. There are other layout choices available. By default, layout is a horizontal left-right alignment of image and accompanying text. You can also choose a vertical layout: where image appears first, and accompanying text shows up below.
+
[[File:Sampleheading.png]]}}</div>
−
}}
+
<div class="col-md-10">{{{field|sectionHeading|input type=text|size=80}}}</div>
  
−
{{{field|Type|input type=radiobutton|values=Unstructured,Structured|mandatory|default=Unstructured|show on select=Unstructured=>Unstructured;Structured=>Structured|}}}
+
<div class="col-md-2 form-label">Anchor ID{{FormTip|
−
 
 
−
'''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 105:
 
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.}}
+
Note: The ID must be unique to this particular article. It does not need to be unique across the system.}}</div>
 +
<div class="col-md-10">{{{field|anchor|size=27}}}</div>
  
−
{{{field|anchor|placeholder=Add ID for anchor links to this section}}}
+
<div class="col-md-2 form-label">Section alignment{{FormTip|
−
</div>
 
−
</div>
 
−
<div id="Unstructured">
 
−
<br/>
 
−
'''Text'''
 
−
 
 
−
{{{field|freetext|input type=textarea|editor=tinymce}}}
 
−
 
 
−
</div>
 
−
<div id="Structured">
 
−
<div class="clearfix">
 
−
<div class="col-md-2" style="padding-left: 0;">
 
−
<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: '''horizontal''' and '''vertical'''.
+
You can choose from two possible layouts: 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, you must select an image which appears to the left, and accompanying text appears on the right.
  
−
Vertical layout places the image above the accompanying text, which appears below the image.}}
+
Vertical layout lets you add content full width, images or text, as you see fit.}}</div>
 +
<div class="col-md-10">{{{field|alignment|input type=dropdown|existing values only|default=Vertical|values=Horizontal,Vertical|show on select=Horizontal=>Horizontal}}}</div></div>
  
−
{{{field|alignment|input type=dropdown|values=Horizontal,Vertical}}}
+
<div id="Horizontal">
 +
<div class="row" style="padding-left: 15px;">
 +
<div class="col-md-2 form-label">Media</div>
 +
<div class="col-md-10 row" style="padding-left:15px;">
 +
<div class="col-md-4">{{{field|Media|input type=combobox|values=Image,GIF,Video|existing values only}}}<br/>
 +
<span class="form-label bottom">Media type</span></div>
 +
<div class="col-md-4">{{{field|image|size=27}}}<br/>
 +
<span class="form-label bottom">Filename or Vimeo ID</span></div>
 +
<div class="col-md-10">{{{field|AltText|input type=text|size=100|maxlength=125}}}
 +
<span class="form-label bottom">Alt-Text</span></div>
 +
</div>
 
</div>
 
</div>
−
<div class="col-md-10" style="padding-left: 0;">
+
</div>
−
<br/>
+
<div class="form-label">Section text</div>
−
'''Image or video (only one of either)'''
+
<div class="col-md-12">{{{field|structuredtext|input type=textarea|editor=visualeditor}}}</div>
  
−
Image: {{{field|image|placeholder=Paste the filename for your image}}} '''Animated GIF?'''{{{field|gif|input type=radiobutton|mandatory|values=No,Yes|default=No}}}
+
<div id="Horizontal">
 +
<div class="form-label">Wide section text{{FormTip|Add extra full-width text beneath the horizontal text-image pair (optional)}}</div>
 +
<div class="col-md-12 ve-height">{{{field|structuredtextwide|input type=textarea|editor=visualeditor}}}</div>
 +
</div>
 +
<div class="row" style="padding-left:15px;">
 +
<div class="col-md-2 form-label">FAQ question{{FormTip|
 +
===Convert this section into an FAQ===
 +
You can convert any section into an FAQ. Create a useful question as your heading. 
  
−
Vimeo ID: {{{field|video|size=60|placeholder=Enter the Vimeo ID for the video you want to embed}}}
+
The FAQ sections for this guide appear if you add an FAQ page to this guide.
−
</div>
 
−
</div>
 
−
<br/>
 
−
'''Supporting text'''
 
  
−
{{{field|structuredtext|input type=textarea|editor=tinymce}}}
+
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:===
 +
#Click Manage Content -> Edit manual in the right sidebar.
 +
#Add FAQ to the Alternate Form field in the manage manual form.
 +
#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.
  
−
'''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}}}
+
Sample FAQ page:
−
<div id="fullwidth">
+
[[File:FAQSample.png]]
−
{{{field|structuredtextwide|input type=textarea|editor=tinymce}}}
+
}}</div>
−
</div>
+
<div class="col-md-10">{{{field|FAQHeading|input type=text|size=80}}}</div>
−
</div>
 
−
</div>
 
  
 +
<div class="col-md-2 form-label">Hide from published?</div>
 +
<div class="col-md-10">{{{field|Status|input type=radiobutton|values=Yes,No|default=No|mandatory}}}</div></div>
 
{{{end template}}}
 
{{{end template}}}
 +
 +
{{#css:
 +
.form-label {clear:both}
 +
.col-md-2, .col-md-4, .col-md-10, .col-md-12 { padding-left:0; margin-bottom: 15px;}
 +
.col-md-4 p { margin-bottom: 0; }
 +
.select2-container-multi .select2-choices { border-color: #BBB; background-image: none; }
 +
.select2-container-multi .select2-choices .select2-search-field input { font-family: roboto; }
 +
.select2-container-multi .select2-choices .select2-search-field { height: 30px; }
 +
input { font-size: 16px; }
 +
.form-label { font-weight: 500; text-align:left; }
 +
.bottom { font-size: 80%; margin-top: -10px; font-weight: 300; }
 +
.radioButtonItem, .checkboxLabel { padding-top: 0; margin-bottom: 0; font-weight: 300}
 +
.ve-height .ve-area-wrapper .ve-ce-documentNode { min-height: 100px; }
 +
.ve-area-wrapper .ve-ce-documentNode { padding: 0.6em 0.8em; min-height: 325px; max-height: 500px; overflow-y: scroll; }
 +
#mw-content-text .select2-container .select2-choice { height: 34px; line-height: normal; }
 +
div.pfComboBox { margin-bottom: 0; }
 +
#pf-expand-all { margin: 20px 0 30px 0; }
 +
#pf-expand-all a { background-color: #5d3e5d; border: 2px solid #5d3e5d; padding: 0.45em 2.50em; color: white; margin-top: 20px; border-radius: 3px; }
 +
.panel-title { padding: 10px; }
 +
.panel>.panel-heading { padding: 0 }
 +
.toggle-wrap { margin: 20px 0 25px; }
 +
.toggle-wrap>a{ display: block; padding: 10px; color: #333; background-color: #f5f5f5; border: 1px solid #ddd; border-top-left-radius: 3px; border-top-right-radius: 3px; }
 +
.toggle-wrap>a:before { content: '\f0d7'; float: left; font-family: FontAwesome; margin-right: 10px; text-decoration: none; }
 +
.toggle-content { padding: 10px 20px; border: 1px solid #ddd; border-top: none; border-bottom-left-radius: 3px; border-bottom-right-radius: 3px; }
 +
.multipleTemplateInstanceTable table > tbody > tr > td, .multipleTemplateInstanceTable table > tbody > tr > th {
 +
    padding: 5px;
 +
    background-color: white !important;
 +
    border: 1px solid lightgrey; }
 +
}}
  
 
{{{standard input|summary}}}
 
{{{standard input|summary}}}
Line 164: Line 195:
  
 
{{{standard input|save and continue}}}{{{standard input|save}}} {{{standard input|preview}}} {{{standard input|changes}}} {{{standard input|cancel}}}
 
{{{standard input|save and continue}}}{{{standard input|save}}} {{{standard input|preview}}} {{{standard input|changes}}} {{{standard input|cancel}}}
−
</includeonly><noinclude>[[Category:Article_Cargo]][[Category:ActiveForms]]</noinclude>
+
</includeonly><noinclude>[[Category:Article_Cargo]][[Category:ActiveForms]][[Category:MintyDocs_Cargo]]</noinclude>

Latest revision as of 19:45, June 14, 2022

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.


Retrieved from "https://all.docs.genesys.com/Form:Article (2025-06-19 19:10:04)"