Differences

This shows you the differences between two versions of the page.

--- exam_document_build [2017/03/16 13:39]
steveclarke
+++ exam_document_build [2017/03/21 11:10] (current)
steveclarke [Publish Options]
@@ Line 1: / Line 1: @@
 ===== Build New Document =====
-The Build New Document pages allows the User to build [[Exam_ocuments|Exam Documents]], Item Documents view previously created Exam Documents or to create new ones.  The Exam Reports are reached via the context menu from the [[exam_entry|Exam Entry]] tool.
+The Build New Document pages allows the User to build [[Exam_document|Exam Documents]], [[item_entry#bulk_actions|Item Documents]] and [[attachment_entry#bulk_actions|Attachment Documents]].
-Right click a row in the Exam grid and choose the **Document**.
+{{:buildnewdocument.png?600|}}
-{{:examentrycontextdocument.png?600|}}
+The Build New Document Page has many options for building documents. As this page is shared between Exam Documents, Item Documents and Attachment Documents, not all options are available for each build.  There are many areas to this page: Option Set (in orange), Publish Options (in green), Templates (in blue) and Include Fields in purple).  These areas are discussed below.
-This will navigate the User to the Exam Document list page.
+==== Create New Document ===
+To create a New Document click the **Start Document Build** button (in red).  This will navigate the User to a Document Build processing page. Here, the user can see the Document build processing via the progress bars and status text.  The User can cancale processing by clicking the **Request Cancel** button.
-==== Exam Document List ====
+{{:buildnewdocumentprocessing.png?600|}}
-The Exam Document List page consists of a grid to select a previous Exam Document for viewing or deleting.  There is also a **Build New Document** button for creating a new Exam Document.
-{{:examdocumentlist.png?600|}}
+When complete a green success massage will display and the User can click the ** Download Result** button to download the created document.  Clicking the hyperlink in the bottom left returns the User to the previous page.
-=== Viewing an Exam Document ===
+{{:buildnewdocumentprocessed.png?600|}}
-All prior created Exam Documents are displayed in the Exam Document List grid.  The grid lists the Exam Title, Instance, Status, document type, when the document was created and who it was created by. To view an Exam Document double click the Download Document icon (in green).  For more on filtering and sorting grids, click [[general_navigation_grids|here]].
+==== Option Sets ====
+{{:buildnewdocumentoptionset.png?600|}}
-=== Deleting an Exam Document ===
+The Build New Document Page has many options for building documents.  So many, that it can be a lot of work to set all of the options for a specific document build.  This is where Option Sets come in.  An //Option Set// is a recording of all of the selected document build options that are selected.  In choosing an //Option Set// the User loads all of the saved option values for building the document.
-To delete an Exam Document, click the X (in blue) on the right of the document row.
+=== Selecting an Option Set ===
+To select an Option Set, select the Option Set form the **Select Option Set** drop down list.  This will load all of the option values saved with this Option Set.
+=== Modifying an Option Set ===
+To modify an Option Set, select it from the ** Select Option Set** drop down list.  Change any of the document build options, then click the **Save** button.
+=== Deleting an Option Set ===
+To delete an Option Set, select it from the ** Select Option Set** drop down list.  Then click the **Delete** button.
+=== Creating an Option Set ===
+To create a new Option Set, enter a name for the Option Set in the **Enter New Name** box and click the **Save As** button.
+==== Publish Options ====
+{{:buildnewdocumentpublishoptions.png?600|}}
+^Field^Description^
+|Language|Determines the language of the document being printed.|
+|Output Format|CE supports PDF, DOCX (open document) and Secure Exam Output.  Note: Secure Exam Output requires SecureExam software. See [[start#Other Software|SecureExam]]|
+|Exam Instance|For Exams with multiple [[stats_terminology#instance|Instances]], the Instance must be selected so Document Build knows which sequence to order the Items in.|
+|Water Mark|A text field to include a simple Water Mark on each page of the document.|
+|Item Numbering|Controls how Items are numbered in the document formats are: 1., 1), A., A), a., a), i., i)|
+|Option Numbering|Controls how options of the Items are numbered in the document formats are: 1., 1), A., A), a., a), i., i), (A)|
+|Table of Contents|If checked a table of contents is added to the start of the document.  Each section of the Exam gets a TOC entry.|
+|Display Exam Value|If checked the maximum point value for the Exam if all Items are answered correctly is displayed.|
+|Suppress Repeated Attachments|Items can be linked to Attachments.  If consecutive Items are linked to the same Attachment, then the Attachment is rendered for each Item.  If this option is checked, then the Attachment image is rendered for the first Item and a maessage //This image appliex to the following {xxx} item// appears.|
+|Section Title|If checked, the Title of the Section appears at the start of each Exam Section.|
+|Section Description|If checked, the Description of the Section appears at the start of each Exam Section.|
+|Section Value|If checked, the maximum point value for the Section appears at the start of each Exam Section.|
+|Item ID|If checked the Item's unique ID (as generated by CE) is displayed before each Item.|
+|Item Text|If checked the Item text (stem and options) is displayed before each Item.|
+|Item Value|If checked, the maximum point value for the Item appears before each Item.|
+|Item Answer|If checked, a red * appears next to each option of the Item that is flagged as correct.|
+|Page Break after Item|If checked a page break will occur in the document after each item, rendering one Item per page.|
+Note: If [[concepts#track changes|Track Changes]] is implemented there is an additional option as to whether to Include Track Changes or render the Item Text as if all changes have been accepted.
+==== Templates ====
+{{:buildnewdocumenttemplates.png?600|}}
+The document build process uses many templates to control the appearance of the various objects (cover pages, end pages, section titles, item text, option text, meta data, etc.).
+=== Templates ===
+^Template^Description^
+|Exam Template|Cover page for the Exam document.  This page or pages is added as to the start of the document.  This template may contain proprietary tags.|
+|Exam End Template|End page for the Exam document.  This page or pages is added as to the end of the document.|
+|Item Template|This template is used for controlling how the Items are rendered.  Font, margins, line spacing, placement of elements are all controlled by this template.  This template contains proprietary tags.|
+|Option Template|This template is used for controlling how the options of Items are rendered.  Font, margins, line spacing, placement of elements are all controlled by this template.  This template contains proprietary tags.|
+|Item Fields Template|When fields are Included on a document (see Include Fields below) this template is used to control the format of how they appear.  This template contains proprietary tags.|
+|Meta Template|When [[item_edit_meta|meta fields]] are Included on a document (see Include Fields below) this template is used to control the format of how they appear.  This template contains proprietary tags.|
+|Stats Template|When Stats fields are Included on a document (see Include Fields below) this template is used to control the format of how they appear.  This template contains proprietary tags.|
+|Section Template|This template controls how Section labels at the start of each Section are formatted.  This template contains proprietary tags.|
+|Other Text Template|This template controls how other text rendered in the document appears.  This text includes messages about repeated Attachments, tables of content, etc.|
+=== Template Files ===
+These templates are either HTML files or Word documents that are stored within the {CE}\Components\IW\APP_Data\Templates\{Language}\ folders on the CE server.  Placing files into these folders will add them to the respective Template drop down lists.
+[[start|TDA]] can assist with customizing or modifying templates as the formatting is proprietary to the Item Writing Application.
+==== Include Fields ====
+{{:buildnewdocumentincludefields.png?600|}}
+Include fields is used to include additional information about the Exam or the Items and the objects they are linked to (Authors, Competencies, References, Copyrights, etc.)  Checking any field will have that field appear inline with the Exam or the respective Item during document build.
+Most fields are formatted using the Item Fields Template (see above).  [[item_edit_meta|Rich text or (meta)]] fields linked to the Item are controlled using the Meta Template (see above).  Stats fields are controlled using the Stats Template (see above).
+=== Stats ===
+To Include Statistical data, a Stats Set must be selected.  Exams can have multiple [[stats_concepts#stats results set|Stats Results sets]] calculated for them.  Each Stats Results set is based on the Sessions of registrants that were calculated.  To view a particular Stats Results set, the Stats results set must be selected.  To do this, click the **Select Stats** button.
+This will open a Stats Selector.  Here, the user can use the Stats Selector grid to filter to the Stats Result they wish to view.  For more on grid navigation, click [[general_navigation_grids|here]].  Once they select a Stats Result set, click the **Select** button.
+=== Stats Fields ===
+There are two types of Stats fields that can be added to a document.  The first type is the specific field.  Examples include: Difficulty, Point Biserial Exam, Value High.  Unless otherwise specified each field is a specific field.  Click [[stats_item|here]] for more on these fields.  Other stats listing are below.
+**Top 50/Bottom 50 Distribution**
+{{:buildnewdocumenttop50.png?600|}}
+For each option and all options combined (Total), displays:
+  * the count of candidates who scored in the bottom 50% of the Exam who selected the option
+  * the count of candidates who scored in the top 50% of the Exam who selected the option
+  * total count of candidate who selected the option.
+**Distractor Analysis**
+{{:buildnewdocumentdistractoranalysis.png?600|}}
+For each option and all options combined (Total), displays:
+  * the count of candidates who scored in the top 27%of the Exam who selected the option
+  * the count of candidates who scored in the middle 46% of the Exam who selected the option
+  * the count of candidates who scored in the bottom 27% of the Exam who selected the option
+  * total count of candidate who selected the option.
+  * The point biserial of candidates who selected this option.
-=== Creating an Exam Document ===
-To create a new Exam Document click the **Build New Document** button (in red).  This will navigate the user to the [[exam_document_build|Build New Document]] page.