Form:MintyDocsManual - Revision history

Bgrenon at 19:34, June 5, 2020

2020-06-05T19:34:58Z

Bgrenon: 1 revision imported

2019-06-06T17:21:21Z

1 revision imported

Bgrenon at 00:47, May 28, 2019

2019-05-28T00:47:53Z

DannaShirley at 21:12, January 8, 2019

2019-01-08T21:12:28Z

DannaShirley at 21:11, January 8, 2019

2019-01-08T21:11:22Z

DannaShirley at 21:10, January 8, 2019

2019-01-08T21:10:24Z

DannaShirley at 18:53, January 8, 2019

2019-01-08T18:53:19Z

DannaShirley at 18:48, January 8, 2019

2019-01-08T18:48:03Z

DannaShirley at 18:43, January 8, 2019

2019-01-08T18:43:09Z

DannaShirley at 18:38, January 8, 2019

2019-01-08T18:38:42Z

@@ Line 84: / Line 84: @@
 What did you add/change? {{{standard input|summary}}}
+{{#css:
 {{{standard input|save}}} {{{standard input|cancel}}}
 </includeonly><noinclude>[[Category:Article_Cargo]][[Category:MintyDocs]]</noinclude>

← Older revision		Revision as of 00:47, May 28, 2019
Line 87:		Line 87:

	{{{standard input\|save}}} {{{standard input\|cancel}}}		{{{standard input\|save}}} {{{standard input\|cancel}}}
−	</includeonly><noinclude>[[Category:Article_Cargo]]</noinclude>	+	</includeonly><noinclude>[[Category:Article_Cargo]][[Category:MintyDocs]]</noinclude>

@@ Line 22: / Line 22: @@
 This field defines the type of form for most topics in your manual. Typically, this is the '''Article''' form. }} {{{field|defaultform|input type=dropdown|values from category=ActiveForms|mapping template=ActiveForms}}}
-'''Alternate forms''':{{FormTip|In some cases, you will need more forms for different types of content. For example, an FAQ. In this case, select FAQ as an alternate form, and the next time you add a topic to your manual you can select FAQ from the list of available forms. You can select alternate forms after you begin building your manual if you identify a need for them later. However, read the following caveat carefully.
+'''Alternate forms''':{{FormTip|In some cases, you will need more forms for different types of content. For example, an FAQ. In this case, select FAQ as an alternate form, and the next time you add a topic to your manual you can select FAQ from the list of available forms.
 '''Caveat!''' In most cases, once you create a topic using a particular form, you won't be able to simply switch to a different form. For example, you won't be able to switch from an unstructured form to a structured form. If you do this, your existing content will probably be lost. Plan ahead and avoid switching forms after you've already added content. }}{{{field|alternateforms|input type=tokens|values from category=ActiveForms|mapping template=ActiveForms}}}

@@ Line 22: / Line 22: @@
 This field defines the type of form for most topics in your manual. Typically, this is the '''Article''' form. }} {{{field|defaultform|input type=dropdown|values from category=ActiveForms|mapping template=ActiveForms}}}
-'''Alternate forms''':{{FormTip|If you identify alternate forms, you'll be able to select one of them when you add a new topic to your manual.
+'''Alternate forms''':{{FormTip|In some cases, you will need more forms for different types of content. For example, an FAQ. In this case, select FAQ as an alternate form, and the next time you add a topic to your manual you can select FAQ from the list of available forms. You can select alternate forms after you begin building your manual if you identify a need for them later. However, read the following caveat carefully.
 '''Caveat!''' In most cases, once you create a topic using a particular form, you won't be able to simply switch to a different form. For example, you won't be able to switch from an unstructured form to a structured form. If you do this, your existing content will probably be lost. Plan ahead and avoid switching forms after you've already added content. }}{{{field|alternateforms|input type=tokens|values from category=ActiveForms|mapping template=ActiveForms}}}

@@ Line 19: / Line 19: @@
 '''Default form:''' {{FormTip|
-===Choose the main page type for this manual===
+===Choose the main form type for this manual===
-This field defines the type of page for most topics in your manual. Typically, this is the '''Article''' form. }} {{{field|defaultform|input type=dropdown|values from category=ActiveForms|mapping template=ActiveForms}}}
+This field defines the type of form for most topics in your manual. Typically, this is the '''Article''' form. }} {{{field|defaultform|input type=dropdown|values from category=ActiveForms|mapping template=ActiveForms}}}
 '''Alternate forms''':{{FormTip|If you identify alternate forms, you'll be able to select one of them when you add a new topic to your manual.
-In some cases, you will need forms for different types of content. For example, an FAQ. In this case, select FAQ as an alternate form, and the next time you add a topic to your manual you can select FAQ from the list of available forms. You can select alternate forms after you begin building your manual if you identify a need for them later. However, read the following caveat carefully.
+In some cases, you will need more forms for different types of content. For example, an FAQ. In this case, select FAQ as an alternate form, and the next time you add a topic to your manual you can select FAQ from the list of available forms. You can select alternate forms after you begin building your manual if you identify a need for them later. However, read the following caveat carefully.
-'''Caveat!''' In most cases, once you create a topic using a particular form, you probably won't be able to simply switch to a different form. Your existing content will be lost; switching forms after you've already added content is a time-consuming process. }}{{{field|alternateforms|input type=tokens|values from category=ActiveForms|mapping template=ActiveForms}}}
+'''Caveat!''' In most cases, once you create a topic using a particular form, you won't be able to simply switch to a different form. For example, you won't be able to switch from an unstructured form to a structured form. If you do this, your existing content will probably be lost. Plan ahead and avoid switching forms after you've already added content. }}{{{field|alternateforms|input type=tokens|values from category=ActiveForms|mapping template=ActiveForms}}}
 ==Define your manual==
 <div class="clearfix">
@@ Line 38: / Line 38: @@
 ===Magic Word===
-The display name also defines the <b>magic word</b> <nowiki>{{MINTYDOCSMANUAL}}</nowiki> that you can use as a variable for this document name in your content. These variables are highly encouraged!
+The display name also defines the <b>magic word</b> <nowiki>{{MINTYDOCSMANUAL}}</nowiki>. In this case <nowiki>{{MINTYDOCSMANUAL}} =</nowiki> <b>Genesys Altocloud Administrator's Guide</b>.
-In this case <nowiki>{{MINTYDOCSMANUAL}} =</nowiki> <b>Genesys Altocloud Administrator's Guide</b>.
+Wherever you use this magic word, the display name that you set here appears (including in links into your product). If you need to change the name of your manual later, you just have to change the magic word.
 }}
@@ Line 49: / Line 47: @@
 </div>
 <div class="col-md-4">
-'''Inherit''':{{FormTip|This field is used to inherit topics lists from previous versions. Not fully tested yet, please do not use.}}{{{field|inherit|input type=radiobutton|values=yes,no|mandatory|default=no}}}
+'''Inherit''':{{FormTip|This field is used to inherit topics lists from previous versions. It is not fully tested yet; please do not use.}}{{{field|inherit|input type=radiobutton|values=yes,no|mandatory|default=no}}}
 '''Pagination:''' {{FormTip|(Feature coming soon!) (Optional) Enable pagination view for this manual.}} {{{field|pagination|input type=radiobutton|values=yes,no|mandatory|default=no}}}
@@ Line 66: / Line 64: @@
 ==Here are the rules and syntax==
 * The top-level "About" page for your manual is automatically added to the topics list for you. This allows for a consistent front-page URL across the system.
-* Build all of your topics under top-level category headings. These non-link (non-URL) categories do '''not''' map to any URL, so you can change the text of the heading as you need to. Syntax: <nowiki>*- category name</nowiki>
+* Build all of your topics under top-level category headings. These categories are '''not''' links and they do '''not''' map to any URL. You can change the text of the heading as you need to. Syntax: <nowiki>*- category name</nowiki>
-* Try to use only one level of headings. If necessary, you can go two-levels deep. Avoid overloading the navigation tree.
+* Try to use only one level of headings. If necessary, you can use two levels. Avoid overloading the navigation tree.
-* Topic names are used to create the URLs for the corresponding pages. Therefore, once you create a topic here, you cannot modify its name. (A management UI will be coming in the future; for now, follow the rules here).
+* We use topic names to create the URLs for the corresponding pages. Once you create a topic here, you cannot modify its name. (A management UI will be coming in the future; for now, follow the rules here).
 ==Adding a new topic==

← Older revision	Revision as of 17:21, June 6, 2019
(No difference)

@@ Line 24: / Line 24: @@
 '''Alternate forms''':{{FormTip|If you identify alternate forms, you'll be able to select one of them when you add a new topic to your manual.
-In some cases, you will need forms for different type of content. For example, an FAQ. In this case, select FAQ as an alternate form, and the next time you add a topic to your manual you can select FAQ from the list of available forms.
+In some cases, you will need forms for different types of content. For example, an FAQ. In this case, select FAQ as an alternate form, and the next time you add a topic to your manual you can select FAQ from the list of available forms.
 '''Caveat!''' In most cases, once you create a topic using a particular form, you can't simply switch to a different page type. This may be possible for some limited, closely aligned forms, but if the underlying data structure is much different, it won't be possible. Switching page types will be a manual rebuild-your-content affair.}}{{{field|alternateforms|input type=tokens|values from category=ActiveForms|mapping template=ActiveForms}}}
@@ Line 65: / Line 65: @@
 ==Here are the rules and syntax==
-* The top-level "About" page for your manual is added to the topics list for you. This allows for a consistent front-page URL across the system.
+* The top-level "About" page for your manual is automatically added to the topics list for you. This allows for a consistent front-page URL across the system.
-* The navigation tree uses non-link (non-URL) categories to group your topics. All topics must be a built under a top-level category heading. This category heading does '''not''' map to any URL. You can change the text of the heading as you need to. Syntax: <nowiki>*- category name</nowiki>
+* The navigation tree uses non-link (non-URL) categories to group your topics. Build all of your topics under a top-level category heading. This category heading does '''not''' map to any URL. You can change the text of the heading as you need to. Syntax: <nowiki>*- category name</nowiki>
-* Topics can go two-levels deep. Recommendation is to try to keep to one level as much as possible. Avoid overloading the navigation tree.
+* Topics can go two-levels deep. However, we recommend using only one level if possible. Avoid overloading the navigation tree.
-* Once a topic is created, you cannot modify the topic name here. The name here is used to create the URL for the page. (A management UI will be coming in the future; for now, follow the rules here).
+* Once you create a topic, you cannot modify the topic name here because this topic name is also used to create the URL for the page. (A management UI will be coming in the future; for now, follow the rules here).
 ==Adding a new topic==
-#Add a new topic or subtopic to the list, following the syntax rules.
+#Add a new topic or subtopic to the list. Follow the syntax rules.
 #Save the form.
-#You will get returned to your manual. Look for the "red link" in the navigation tree.
+#Look for the "red link" in the navigation tree.
-#Click the red link and the page create form will open.
+#Click the red link and the '''Page create''' form opens automatically.
 }}