Adding Sections to an FAQ

A How-To Recipe
July 2006

Overview

Once you have followed the instructions on adding an FAQ Master Page you will have something that looks like the following. This How To describes the next step in the process.

SnagitFAQMasterPage.png

Figure 1: FAQ Example

General Considerations

The general process is to create each Section page and then to insert the necessary markup language and edit it to fit your choices. Note that there are two dummy questions to provide a starting point for adding your own.

Markup Framework

Each section header in the above view is a link. To create each section click on the link. You will be taken to a new page box. Click on the "Create New Empty Page" link.

Replace the existing content (placeholder) with the following text noting that there is a different set of text for each section.

Section 1

Presented below is example text and markup for section 1 of FAQ.

#pragma section-numbers 1
<<HTML( <div class="faq"> )>>
[[Anchor(top)]]

= Title 1 =
<<HTML( <div class="toplink"> )>> [:FaQs: FAQ Master Index] <<HTML( </div> )>>
This section explains where to find the documents related to Support work.

'''''Table of Contents'''''

[[TableOfContents]]


----

== How do I insert a question with an in-line answer? ==

Just follow the format in this simple exchange.

[[TopOfPage]]


== How do I insert a question with an long answer that I want in a file? ==

Provide the minimum text and insert a link to a file. for instance, you might say -
The answer is contained in this file [[Color(red)]] Insert link here [[EndColor]] 
See the help for instructions on how to load a file and establish a link.

[[TopOfPage]]

Section 2

Presented below is example text and markup for section 2 of FAQ.

#pragma section-numbers 1
[[SetSection(2)]]
<<HTML( <div class="faq"> )>>
[[Anchor(top)]]

= Title 2 =
<<HTML( <div class="toplink"> )>> [:FaQs: FAQ Master Index] <<HTML( </div> )>>
'''''Table of Contents'''''
[[TableOfContents]]

----

== How do I insert a question with an in-line answer? ==

Just follow the format in this simple exchange.

[[TopOfPage]]


== How do I insert a question with an long answer that I want in a file? ==

Provide the minimum text and insert a link to a file. for instance, you might say -
The answer is contained in this file [[Color(red)]] Insert link here [[EndColor]] 
See the help for instructions on how to load a file and establish a link.

[[TopOfPage]]

Section 3

Presented below is example text and markup for section 3 of FAQ.

#pragma section-numbers 1
[[SetSection(3)]]
<<HTML( <div class="faq"> )>>
[[Anchor(top)]]
= Title 3 =
<<HTML( <div class="toplink"> )>> [:FaQs: FAQ Master Index] <<HTML( </div> )>>
'''''Table of Contents'''''
[[TableOfContents]]

----

== How do I insert a question with an in-line answer? ==

Just follow the format in this simple exchange.

<<HTML( <div class="toplink"> )>> [#top Top of Page] <<HTML( </div> )>>


== How do I insert a question with an long answer that I want in a file? ==

Provide the minimum text and insert a link to a file. for instance, you might say -
The answer is contained in this file [[Color(red)]] Insert link here [[EndColor]] 
See the help for instructions on how to load a file and establish a link.

[[TopOfPage]]

When the pages have been created, edit the "Title 1," Title 2," and Title 3" text to show your own preferred headings. These should be the same as the ones you used in the Master Page.



Univ/CIE/KA/FaQ/SectionS (last edited 2015-03-06 18:11:27 by localhost)