Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
equidox_user_guide [2017/08/25 10:36]
dtuleta [Settings]
equidox_user_guide [2017/08/25 11:52] (current)
dtuleta [Zone Types: Overview]
Line 139: Line 139:
  
 ====Settings:​ Search ==== ====Settings:​ Search ====
- 
-=== What is Search? === 
  
 Administrators can connect **Equidox** to a **Search Appliance** to help locate PDF content. Name the collection in the  **Name** textbox, select the **Add** button to the right of the field, and then select **Save** to save changes. Select the {{:​trash_icon.png?​20|}} and then **Save** to delete a collection. Administrators can connect **Equidox** to a **Search Appliance** to help locate PDF content. Name the collection in the  **Name** textbox, select the **Add** button to the right of the field, and then select **Save** to save changes. Select the {{:​trash_icon.png?​20|}} and then **Save** to delete a collection.
Line 268: Line 266:
  
 Manage and organize document permissions by selecting which users and groups can or cannot view and edit certain documents. A new document will be automatically shared with a group when uploaded by a user assigned to that group. Administrators can grant access to view and edit a document by manually sharing documents with groups and individual users. Manage and organize document permissions by selecting which users and groups can or cannot view and edit certain documents. A new document will be automatically shared with a group when uploaded by a user assigned to that group. Administrators can grant access to view and edit a document by manually sharing documents with groups and individual users.
- 
-In Equidox, the user can use Groups to manage and organize document permissions. Managing document permissions will dictate which users/​groups can or can not view and edit certain documents. When a document is uploaded by user that is assigned to a group, the document will automatically be shared to all users within that group. Furthermore,​ administrative users have the ability to manually share documents to Groups and Users to grant them access to editing a document. 
  
 === Sharing a Document === === Sharing a Document ===
Line 275: Line 271:
 Administrators can share documents with other users. Select a document. Click the green Share button in the top right corner of the Document Detail page. Select “Share with Others” or “Share with a Group” on the modal pop-up window. The “Share with Others” option presents a list of other users to share the document with and grant editing permissions. The “Share with a Group” option presents a list of groups to share the document with and grant editing permissions to all users within that group. Administrators can share documents with other users. Select a document. Click the green Share button in the top right corner of the Document Detail page. Select “Share with Others” or “Share with a Group” on the modal pop-up window. The “Share with Others” option presents a list of other users to share the document with and grant editing permissions. The “Share with a Group” option presents a list of groups to share the document with and grant editing permissions to all users within that group.
  
-When signed in as an account with Administrative properties, the user has the ability to share a document. To do this, the user must first select a document to edit. From the Document Detail page of the document, administrators will see a green Share button in the top right corner of the window. By selecting this, a modal will appear with two headers; "Share with Others"​ and "Share with a Group"​. 
- 
-Upon selecting the pick-list from under the "Share with Others"​ header, the user will be presented with a list of users in which the user can share the document with. Sharing a document with a user will grant that user access to editing the document, but not any other users in that group (unless specified). Furthermore,​ selecting the pick-list from under the "Share with a Group" header will present the user with a list of groups to share the document with. Sharing a document with a group will grant all users within that group access to editing the document. 
  
 {{:​share_document.png?​400|}} {{:​share_document.png?​400|}}
Line 284: Line 277:
  
 ==== Document Detail: Output Tab ==== ==== Document Detail: Output Tab ====
- +Users can edit the file name or preview the HTML document before download. Equidox allows users to choose the proper Output, which is currently WCAG 2.0 AA compliant HTML. Users can download the entire document or individual pages when they are ready to export the remediated documentThe file is downloaded in a zip file, and from there the user dictates what they want to do with the document in terms of saving it or importing it into a CMS or LMS, if applicable.
-Edit the file name or preview the HTML document before ​ From this tab, users can edit the file name or preview the HTML document before download. Equidox allows users to choose the proper Output, which is currently WCAG 2.0 AA compliant HTML. We are also working on additional outputs like PDF-UA and ePub, and users will receive alerts when these updates are completed. Users can elect to download the entire document or individual pages when they are ready to output to HTMLWhen users click Download HTML the file is downloaded in a zip file, and from there the user dictates what they want to do with the document in terms of saving it or importing it into a CMS or LMS, if applicable.+
  
 {{:​output_tab.png?​400|}} {{:​output_tab.png?​400|}}
Line 295: Line 287:
 === Selecting Document pages to download === === Selecting Document pages to download ===
  
-The user can download the entire document in HTML or download a selection of pages from the document. The entire document will be downloaded if the All radio box is selected when the user clicks Download HTML. To download a selection of pages from the document the user can enter the desired page numbers into the text box. Comma separate individual pages or use a hyphen to define an ascending order range of pages to download. Page selections in an invalid format will not download.+The user can download the entire document in HTML or download a selection of pages from the document. The entire document will be downloaded if the All radio box is selected when the user clicks Download HTML. To download a selection of pages from the document the user can enter the desired page numbers into the text box. 
  
 Examples: Examples:
-  * Valid selection: 1, 2, 3 +  * Valid selections: 1, 2, 3 or 1-3
-  * Valid selection: ​1-+
-  * Valid selection: 1-2, 3+
   * Invalid selection: 3-1   * Invalid selection: 3-1
  
Line 306: Line 296:
  
 The user can toggle the option to generate page IDs. Toggling this on will export page IDs with the rest of the document upon export. ## internal HREF reference! The user can toggle the option to generate page IDs. Toggling this on will export page IDs with the rest of the document upon export. ## internal HREF reference!
-<span id=”page2”/>​ so you can create a link <a href=”#​page2”>​ so if you have created a link that refer to a specific page in the document you will need to generate the Page IDs or the links won’t ​work.+<span id=”page2”/>​ so you can create a link <a href=”#​page2”>​ so if you have created a link that refer to a specific page in the document you will need to generate the Page IDs or the links will not work.
  
 Alternate: using Anchor (refer) Alternate: using Anchor (refer)
Line 320: Line 310:
 ==== Output to PDF ==== ==== Output to PDF ====
  
-=== Filename === +Follow ​the same instructions for HTML output
- +
-Edit the name of the document being exported in the Filename textbox. The document will export as its original name if this field is left blank.+
  
 {{:​output_pdf.png?​400|}} {{:​output_pdf.png?​400|}}
Line 330: Line 318:
 ==== Output to EPUB ==== ==== Output to EPUB ====
  
-=== Select Document pages to download === +Follow ​the same instructions for HTML output
- +
-The user can export ​the entire document as Epub or download a selection of pages in the document. The entire document will be downloaded if the All radio box is selected when the user clicks the Download Epub button. To download a selection of pages from the document the user can enter the desired page numbers into the text box. Comma separate individual pages or use a hyphen to define an ascending order range of pages to download. Page selections in an invalid format will not download. +
- +
-Examples: +
-  * Valid selection: 1, 2, 3 +
-  * Valid selection: 1-3 +
-  * Valid selection: 1-2, 3 +
-  * Invalid selection: 3-1 +
- +
-=== Filename === +
- +
-Edit the name of the document being exported in the Filename textbox. The document will export as its original name if this field is left blank.+
  
 {{:​output_epub.png?​400|}} {{:​output_epub.png?​400|}}
Line 350: Line 326:
 ==== Page Editor ==== ==== Page Editor ====
  
-After a document has been selected, the user can select specific pages for editing from the page browser. Launch the Page Editor by selecting a page and use the tools change the page properties and create or manage reading zones.+The user can select specific pages for editing from the page browser. Launch the **Page Editor** by selecting a page and use the tools change the page properties and create or manage reading zones.
  
 === Page Information === === Page Information ===
  
-The Page Information section gives a brief summary/​description of page details and allows the user to add and save notes to a page.+The **Page Information** section gives a brief summary/​description of page details and allows the user to add and save notes to a page.
  
 === Page number === === Page number ===
  
-The page number displays which page of the document is being edited.+The **page number** displays which page of the document is being edited.
  
 === Last saved === === Last saved ===
  
-The Last Saved field is a timestamp ​displaying when the document was most recently saved. ​+The **Last Saved** field is a time-stamp ​displaying when the document was most recently saved. ​
  
 === Notes === === Notes ===
  
-The notes field is to help users to communicate keep track of any relevant information in the document. Notes have no effect on the exported document. ​+The **Notes** ​field is to help users to communicate keep track of any relevant information in the document. Notes have no effect on the exported document. ​
  
 {{:​page_information.png?​400|}} {{:​page_information.png?​400|}}
Line 376: Line 352:
 === Sensitivity (Apply to all pages) === === Sensitivity (Apply to all pages) ===
  
-The **Sensitivity** slider adjusts ​the auto-detection of reading zones which determines ​the size, granularity,​ and reading order of zones on the page. The user can adjust the zone sensitivity ​slider until a desired sensitivity is reached. This automated process may require some manual adjusting. Select **Apply to all pages** to set the sensitivity level to all remaining pages in the document.+The **Sensitivity** slider adjusts the size, granularity,​ and reading order of zones on the page. The user can adjust the slider until a desired ​auto-detection ​sensitivity ​level is reached. Select **Apply to all pages** to set the sensitivity level to all remaining pages in the document.
  
 {{:​low_sensitivity.png?​400|}} {{:​low_sensitivity.png?​400|}}
Line 386: Line 362:
 //Page Editor - High Sensitivity//​ //Page Editor - High Sensitivity//​
  
-Move the sensitivity slider to the right to increase the size and decrease the number of zones. Move the sensitivity slider to the left to decrease the size and increase the number of zones. Select Apply to all pages to set the sensitivity level to all remaining pages in the document. Applied changes will remain when the user saves their work.+Move the sensitivity slider to the right to increase the size and decrease the number of zones. Move the sensitivity slider to the left to decrease the size and increase the number of zones. ​
  
 === Reading Order === === Reading Order ===
  
-The user can modify the column count of the page. When the column count is selected and the user selects the **Re-Order** button, Equidox will re-order the reading order of the page accordingly.+The user selects the **Re-Order** button, Equidox will re-order the reading order of the page accordingly.
  
 === Page Orientation === === Page Orientation ===
Line 398: Line 374:
 ==== Zones ==== ==== Zones ====
  
-=== What is a zone? === +Zones separate ​different assets ​from one another to give the user flexibility while editing the page. Auto-detected zones will appear but additional zones can be created by clicking and dragging the mouse over the desired area. Zone editing options appear on the side bar when a zone is selected.
- +
-Zones are separate from one another to give the user flexibility while editing the page. Auto-detected zones will appear but additional zones can be created by clicking and dragging the mouse over the desired area. Zone editing options appear on the side bar when a zone is selected.+
  
 === Creating a Zone === === Creating a Zone ===
  
-Zones allows the user to select a specific area of the document (i.e. text, image, list, block quote) for editing. Left click and drag the edge of zone to change its size. Left click inside ​the zone and drag to move it to a new location.+Zones allows the user to select a specific area of the document (i.e. text, image, list, block quote) for editing. Left click and drag the edge of zone to change its size. Select ​the zone and drag to move it to a new location. Edit zone properties such as name, type, language, order and size.
  
 {{:​creating_zone.png?​400|}} {{:​creating_zone.png?​400|}}
Line 418: Line 392:
 //Page Editor - Zone Properties and Order// //Page Editor - Zone Properties and Order//
  
-=== Editing a Zone === 
- 
-Select a zone to edit properties such as name, type, language, order and size. Change the zone **Order** field to change the order in which a text-to-speech tool will read the zone once the document is exported. 
  
 ==== Pages Tab ==== ==== Pages Tab ====
Line 444: Line 415:
 === Mark Page as Validated === === Mark Page as Validated ===
  
-The second option {{:​check_mark_icon.png?​20|}} validates the work of other users and locks all changes made to the page. This feature is helpful when an administrator ​reviews ​the work of another user and wants to prevent any future ​or accidental ​edits.+The second option {{:​check_mark_icon.png?​20|}} validates the work of other users and locks all changes made to the page. An administrator ​can review ​the work of another user and prevent any future edits.
  
 === Preview This Page === === Preview This Page ===
  
-The third option {{:​monitor_icon.png?​20|}} allows the user to preview the HTML version of the page they are editing.+The third option {{:​monitor_icon.png?​20|}} allows the user to preview the HTML version of the page.
  
 === Zoom In/Out === === Zoom In/Out ===
Line 507: Line 478:
 ==== Zone Position ==== ==== Zone Position ====
  
-Modify the location of the zone in the Zone Position section of the Page Editor toolbar.+Modify the location of the zone in the Zone Position section of the Page Editor toolbar ​or click and drag the zone to the desired location.
  
-=== Left === +**Left**, ​**Top** ​**Width** **Height** show the distance between the edge of the zone and the respective edge of the page. Change ​by either manually typing in the field, using the arrows to increase/​decrease the value, dragging the edge of the zone, or dragging the entire zone to the desired position.
- +
-**Left** ​shows the distance between the edge of the zone and the left side of the page. Change by either manually typing in the fieldusing the arrows to increase/​decrease the valuedragging the edge of the zoneor dragging the entire zone to the desired position. +
- +
-=== Top === +
- +
-**Top** shows the distance between the edge of the zone and the top of the page. Modify ​by either manually typing in the field, using the arrows to increase/​decrease the value, dragging the edge of the zone, or dragging the entire zone to the desired position+
- +
-=== Width === +
- +
-**Width** represents the width of the zone. Modify by either manually typing in the field, using the arrows to increase and decrease the value, or dragging the edge of the zone.  +
- +
-=== Height === +
- +
-**Height** represents the height of the zone. Modify by either manually typing in the field, using the arrows to increase and decrease the value, or dragging the edge of the zone.+
  
 {{:​zone_position.png?​400|}} {{:​zone_position.png?​400|}}
Line 559: Line 516:
 === Merge Zone === === Merge Zone ===
  
-Some zones can be merged. After the zone is selected, the user will be able to merge the zone with the zone previous to it by toggling ​**Merge** under the **Zone** tab. For example, if the user selects **Merge** while zone 4 is selected, zone 4 will be merged with zone 3. If the first zone on a page is selected, it will be merged with the last zone on the page before it.+Select a zone and toggle ​**Merge** under the **Zone** tab. For example, if the user selects **Merge** while zone 4 is selected, zone 4 will be merged with zone 3. If the first zone on a page is selected, it will be merged with the last zone on the page before it.
  
 {{:​merge.png?​400|}} {{:​merge.png?​400|}}
Line 567: Line 524:
 === Break Lines === === Break Lines ===
  
-To do this, select ​the zone to see the zone settings. From here, the user will be able enable the **Break Lines** setting by toggling ​the **Break Lines** box. This will cause the zone to be formatted in such a way that their line breaks are in the same place as in the original document.+Select ​the zone to see the zone settings ​and toggle ​the **Break Lines** box. This will format ​the zones so that their line breaks are in the same place as in the original document.
  
 {{:​break_lines.png?​400|}} {{:​break_lines.png?​400|}}
Line 573: Line 530:
 //Page Editor - Break Lines toggle// //Page Editor - Break Lines toggle//
  
-==== Using Zone Source ====+==== Zone Source ====
  
 === Zone Source PDF (Default) === === Zone Source PDF (Default) ===
  
-##Equidox scans the page under where the zone is for text to convert into a tag. +Equidox scans the page to convert ​assets ​into a tag tree.
-Text/ascii - actual content (including images)+
  
 === Zone Source OCR === === Zone Source OCR ===
  
-Equidox uses Optical Character Recognition (OCR) and automatically detects text in an imported document. OCR functionality is great for scanned documents. ​EQX as jpg for OCR. Quality of scan matters.  +Equidox uses **Optical Character Recognition** (OCR) and automatically detects text in an imported document. OCR functionality is great for scanned documents. ​ ​Select the OCR Zone Source option ​and select **Convert to Text**. The user is able to view and edit the text if there are errors to correct
- +
-The document will then go to the document section of the tool just like any other pdf and will be available for editing. The editing process in the tool is very similar to any other pdf imported into the tool. One major change is the Zone Source option ​which will now be labeled OCR with the text captured from the OCR beneath it as seen above. The user is able to view and edit the text if for some reason the proper text was not captured+
    
 {{:​image07.png?​400|}} {{:​image07.png?​400|}}
Line 592: Line 546:
 === Zone Source Custom === === Zone Source Custom ===
  
-##The user enters ​the content ​that the user would like for the zone. +Select the Custom Zone Source to manually enter the content for zone.
-Free text for HTML Only+
  
 ==== Zone Types: Overview ==== ==== Zone Types: Overview ====
Line 619: Line 572:
 === Anchor: === === Anchor: ===
  
-An **Anchor** type is to be used with the link typeThe link in the document will present the user with the anchor when the link is selected. Users will select the zone where they want the link, and change the field from text to link. Users should copy and paste the URL from the actual website in order to anchor ​the link in the proper zone. The link will then become active and clickable in the exported document. Anchors can also be used for anchoring pages to a table of contents.+An **Anchor** type is to be used with links ​Copy ​the URL and paste it in the anchor ​field. Anchors can also be used for anchoring pages to a table of contents.
  
 === Ignore: === === Ignore: ===
  
-Select **Ignore** to hide zones in the exported document. This is a useful feature for errors in the original document, repeated or irrelevant content.+Select **Ignore** to hide zones, repeated, inaccurate ​or irrelevant content.
  
 === Blockquote: === === Blockquote: ===
Line 631: Line 584:
 === Graphic: === === Graphic: ===
  
-Select **Graphic** to indicate that a zone is a graphic ​and to generate an image of the graphic in the HTML output. The graphic zone type can be used on any logo, symbol, formula, diagram, etc. that does not qualify as an image. Add alt text or a long description to help text-to-speech tools explain the graphic.+Select **Graphic** to indicate that a zone is a graphic. The graphic zone type can be used on any logo, symbol, formula, diagram, etc. that does not qualify as an image. Add alt text or a long description to help text-to-speech tools explain the graphic.
  
 === Quote: === === Quote: ===
Line 647: Line 600:
 === Form and Field: ===  === Form and Field: ===
  
-##Select **Form** to indicate a zone consists of multiple field items. Select **Field** to indicate a zone is capable to take user input as content within a form.+Select **Form** to indicate a zone consists of multiple field items. Select **Field** to indicate a zone is capable to take user input as content within a form.
  
 Label and form element in a single, assign the correct value. Wrap all control in a form zone; assign form values. Label and form element in a single, assign the correct value. Wrap all control in a form zone; assign form values.