✎ equidox_user_guide [Equidox by Onix TM Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Equidox by Onix™ User Guide ======

NOTE: Certain hyperlinks point to the Equidox KnowledgeBase and can only be accessed by authorized users.
===== Introduction to Equidox™ ===== 
Equidox was designed by Onix to simplify and improve the PDF remediation workflow. The easy-to-use interface streamlines the conversion of inaccessible PDF to HTML, EPUB, or PDF-UA. Equidox is hosted in the Google Cloud (GCP) and can be accessed from any web browser for collaborative preparation of WCAG 2.0 AA documents. This user guide outlines the powerful functionality of Equidox and best practices for PDF remediation. 


==== Signing-in to Equidox ====
Sign in with an **Equidox** account or a **Google** account which is determined during the account registration.

**NOTE**: Users must be created by a system administrator. Once an administrator has created an account, the user will receive a //confirmation/activation email//. 

=== Equidox Sign in ===

Once registered, a user can enter a valid username and password into the **Your Username** and **Password** fields and select the **Sign in** button. A valid username and password will point to the Equidox homepage.

=== Google Sign in ===

The user can sign in using a Google account if specified by the system administrator. Reply to the email confirmation (upon account creation) and select the **Sign in with Google** button to open a new Google sign in window. Follow the steps to sign in with the registered Google account. A successful sign in will point to the Equidox homepage.

{{:sign_in.png?400|}}

//Equidox sign in screen//

===== Primary Sidebar =====
The Primary Sidebar tabs provide access to any page in Equidox. From top to bottom, the tabs are listed: 
  * **Home**
  * **Documents**
  * **Import**
  * **Notifications**
  * **Settings**
  * **Help**
  * **Sign out**

**NOTE**: The search tab is only available if Equidox is connected to a **Search Appliance**.

{{:primary_sidebar.png?400|}}

//Primary Sidebar//

==== Documents ====

The Documents tab  {{:grid_icon.png?20|}}  presents a list of all active documents in Equidox. The documents will primarily be ordered by the date which they were last edited.

Use **color labels** to easily identify related documents in the color label. **Filter** documents based on owner, import/modified date, label, and name.

{{:documents.png?400|}}

Equidox Documents Page

==== Search Appliance ====

A search appliance helps users find specific documents to import for conversion. The **Search Appliance** {{:magnifying_glass.png?20|}} tab allows users to sync their search appliance with Equidox.

{{:search.png?400|}}

//Equidox Search Appliance Page//

Enter criteria in the **Search** tab to set a query to execute on the search appliance. Activate the search appliance with the **Search** button to retrieve documents to import into Equidox from the filtered collection.

==== Import Documents ==== 
The **Import Documents** {{:upload_icon.png?20|}} tab allows the user to select files from their computer to upload into Equidox.

{{:import_documents_page.png?400|}}

//Equidox Import Documents Page//

=== Import Locally ===

Click anywhere on the import area to display an “**Open file…**” dialogue. Navigate the filesystem to find document(s) to import into **Equidox** or drag-and-drop a document in the **Drop files to upload** box.

=== Import URL ===

The **URL** tab allows the user to import a document through a URL. Copy and paste URL(s) on a separate lines(s) into the URL text box and select the import button.
**NOTE**: Currently, only public facing files are accepted in Equidox. Files requiring authentication will not be imported.

==== Notifications ====

Select the **Notifications** {{:list_icon.png?20|}} tab to view all of the notifications generated for the account. Time-stamps allow the user to identify how new or old a notification is. Delete a notification by selecting the red cross icon {{:red_cross_icon.png?20|}} . The user can delete all notifications by selecting the **Trash** icon {{:trash_icon.png?20|}} at the top of the screen. Notifications link to the respective document by selecting the blue title link in the notification. Notifications appear when a document is finished importing and when the status of a document has changed. 

If a document finishes importing or a document status changes while the user is away from the notifications page, a modal popup will appear in the bottom right corner of the screen. The number on the **Notification** icon indicates the number of new notifications.

==== Settings ====

Select the **Settings**  tab to manage labels, groups, accounts, and the search appliance within Equidox.

{{:settings.png?400|}}

//Equidox Settings Page//

==== Help ====

Select the question mark  on the sidebar to open the **Help** tab to access various support resources: Help Videos, Release Notes, and a link to this End User Guide.  

{{:help.png?400|}}

//Equidox Help Page//

The **Help Videos** illustrate the steps required to complete a specific task in Equidox. The **FreshDesk** enables a user to create and manage tickets to alert the Equidox team of potential bugs. A link to the **End User Guide** is located near the top of the page as an instructional reference on Equidox features.

==== Sign Out ====
 
**Sign Out** of Equidox and return to the Sign In page by selecting the {{:power_icon.png?20|}} symbol at the bottom of the sidebar. The user can also select **Sign Out** from the drop down list in the top right corner of the user’s email account page to sign out as well. 


===== Settings =====

==== User: Profile ====

Select the email address in the top right corner of the page to view a user profile. Select **Profile**, modify the profile information, and **Save** the changes to the account.

{{:user_profile.png?400|}}

//Settings - User Profile//

**NOTE**: An Equidox profile will display a Google account picture if created with a Gmail address.


==== Settings: Labels ====

**Labels** allow users to organize documents in specific groups and simplify the process of searching for documents. The **Sort by** bar on the **Documents** tab allows the user to sort the labels by specific attributes . The user can select the **+** to create an additional label. The Filter refines the list down to a specific label. Each label displays color, name, a brief description, and the trash {{:red_cross_icon.png?20|}} button to delete the label.

{{:labels.png?400|}}

//Settings - Labels Page//


==== Settings: Groups ====

**Groups** allow admins to restrict access for specific groups and specific documents. Users will only be able to work on documents that have been assigned to the same group as the user. Enter the **group name** and **description** (optional) into the appropriate fields and select the green **Create** button. Select the {{:red_cross_icon.png?20|}} to delete and unassign all documents to the group.

{{:groups.png?400|}}

//Settings - Groups Page//

==== Settings: Accounts ====

The Accounts tab allows administrators to create and manage **Equidox** user accounts. Administrators can see if accounts are registered, change the group(s) users are assigned to, change administrator permissions, change passwords, and delete/create users.

====Settings: 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.

{{:settings_search.png?400|}}

//Settings - Search Page//




==== Google Sign in (Single Sign-On) ====

**Google SSO** allows users to sign in to Equidox using their G Suite or Gmail account.  Sign in as an administrator. Click on **Settings, Accounts**, and **New Account**. Fill in the required information and select the **Google Account** checkbox.

{{:google_account_create.png?400|}}

//Administrator view of New Account dialogue//

Equidox will query the mail server to confirm the account is handled by a Google (or Gmail) server once the account is created. Click the activation link in the **Equidox** email to access the **Sign in** page for Google Accounts.
(**Note:** in some cases, organizations may hide their mail servers entries to avoid spam).

{{:google_confirmation.png?400|}}

//Equidox Google user activation screen//

The dialogue will ask the user to sign in using a Google account. The invitation email address must match the Google account used to sign in. If the email addresses do not match, activation will be denied by the server for security reasons.

{{:user_activation_screen.png?400|}}

//Equidox user activation screen//

=== Login to Existing Account (Google or Other) ===

Users who activate Equidox using a Google account must initially click on the **Sign in with Google** button. Users can sign in with the username/password combination or the **Sign in with Google** button once they validate their account.

{{:sign_in.png?400|}}

//Equidox Google login screen//


=== Changing a user password ===

Non-Google account users can click **Forgot your password?** to send an email with password reset directions. Google account users can click **Forgot your password?** to send an email with password reset directions through the Google Password Manager. Equidox is not authorized to change or reset passwords for Google accounts. Click the **Delete** button on the **Account Settings** page to delete an account.



===== Documents =====

==== Documents: Search, Filters, and Labels ====

The **Documents {{:grid_icon.png?20|}}** tab presents a list of all active documents in Equidox. The documents will primarily be ordered by the date which they were last edited.

=== Assigning Labels ===

Each document can be color **labeled** to easily identify related documents with the same label. Assign labels to a document by selecting **Edit** which links to the **Document detail** page where the **Label** field can be selected. Select one of the labels from the drop-down list and click **Save** under the **Language** field. 

Filter documents based on its owner, imported or modified date, label and name.

{{:documents.png?400|}}

//Equidox Documents page//

=== Grid and List View ===

The user can choose to display documents in a **List view** or **Grid View** by selecting the respective **list** {{:list_icon.png?20|}} or **grid** {{:grid_icon.png?20|}} icons in the top right corner of the page.

{{:documents_grid_view.png?400|}}

//Documents Page in Grid View format//

==== Document Detail ====

Open a document to view **Properties, Metadata, Images, History, Permissions,** and **Output** tabs and modify the document details. The **Properties** tab displays all of the properties of the document. **Title, Label**, and **Language** attributes can be modified. **Original URL, Created Date, Last Modification Date, Producer,** as well as the number of images and pages in the document are also displayed. Share a document with other users and delete a document in the upper right hand corner of the screen. 

{{:document_detail_page.png?400|}}

//Equidox Document Details Page//

==== Document Detail: Selecting a Page ====

Select a document to view the **Document Details Page** and choose one of the pages in the **Page Preview** list to be redirected to the **Page Editor**.

==== Document Detail: Properties Tab ====

The properties of a document can be managed by changing the label, title, and assignment to different users. If required, enter a new title in the **Title** bar and choose a new label from the **Label** bar. Use the **Language** drop-down menu to select the language of the document. Click **Download original document/PDF** header to download the original document. View the page count in the **Pages** bar.

{{:properties.png?400|}}

//Equidox Document Details Page - Properties tab//

==== Document Detail: Metadata Tab ====

Select **Metadata** to view and edit the names and values pertaining to each piece of metadata. Click + to create and save or {{:red_cross_icon.png?20|}} to delete metadata.

{{:metadata_tab.png?400|}}

//Equidox Document Details Page - Metadata tab//

=== Inserting Metadata ===

Add more metadata search terms to make it easier to retrieve documents. Select a document and open the **Metadata** tab. Enter or modify the name and value in the metadata fields. Select the + icon to save the changes.

=== Deleting Metadata ===

Remove search terms by deleting metadata from a document. Select the **Metadata** tab and click the red cross {{:red_cross_icon.png?20|}} icon  to delete.

==== Document Detail: Images Tab ====

Select **Images** for a **list view** of all the images in the document.  From here, the user is presented with a preview of the image, description of the image, and the page number the image appears on. The field will read **No Description** if no description has been assigned yet. Select the image preview, page number or pencil symbol to open the **Page Editor** to locate the image and enter a description on the control panel.

{{:images_tab.png?400|}}

//Equidox Document Details Page - Images tab//

==== Document Detail: History Tab ====

The History tab shows users and the changes they have made to the document.

{{:history.png?400|}}

//Equidox Document Details Page - History tab//

==== Document Detail: Permissions ====

=== Group Permissions ===

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.

=== Sharing a Document ===

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.


{{:share_document.png?400|}}

//Equidox Document Details Page - Share Document//

==== 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 document. 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|}}

//Equidox Document Details Page - Output tab//

==== Output to HTML ====

=== 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. 

Examples:
  * Valid selections: 1, 2, 3 or 1-3
  * Invalid selection: 3-1

=== Generate Page IDs ===

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 will not work.

Alternate: using Anchor (refer)

=== Filename ===

Edit the name of the document being exported in the Filename textbox.

{{:output_html.png?400|}}

//Equidox Document Details Page - Output HTML//

==== Output to PDF ====

Follow the same instructions for HTML output

{{:output_pdf.png?400|}}

//Equidox Document Details Page - Output PDF//

==== Output to EPUB ====

Follow the same instructions for HTML output

{{:output_epub.png?400|}}

//Equidox Document Details Page - Output Epub//

==== Page Editor ====

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 ===

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 ===

The **page number** displays which page of the document is being edited.

=== Last saved ===

The **Last Saved** field is a time-stamp displaying when the document was most recently saved. 

=== 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. 

{{:page_information.png?400|}}

//Equidox Page Editor - Page Information//

==== Zones Auto-Detection ====

=== Sensitivity (Apply to all pages) ===

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|}}

//Page Editor - Low Sensitivity//

{{:high_sensitivity.png?400|}}

//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. 

=== Reading Order ===

The user selects the **Re-Order** button, Equidox will re-order the reading order of the page accordingly.

=== Page Orientation ===

Select **Landscape** or **Portrait** in the **Page Orientation** menu and select **Rotate** to change the orientation of the page.
 
==== Zones ====

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.

=== 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. 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|}}

//Page Editor - Zone being created//

=== Ordering Zones ===

Change the reading order by selecting a zone and changing the **Order** number in the the sidebar. Zones appear in the order they are created if the **Order** is not changed.

{{:zone_order.png?400|}}

//Page Editor - Zone Properties and Order//


==== Pages Tab ====

The **Pages** tab displays all pages in the document on the left side toolbar. Select any page to view in the page editor.

{{:page_editor_-_pages_tab.png?400|}}

Page Editor - Pages Tab

==== Using Page Controls ====

Page controls are located in the top right corner of the conversion page and allow the user to save, zoom in/out, and preview the output.

{{:page_controls.png?400|}}

//Page Controls//

=== Save This Layout ===

The first option {{:save_icon.png?20|}} saves all changes made to the page.

=== 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. An administrator can review the work of another user and prevent any future edits.

=== Preview This Page ===

The third option {{:monitor_icon.png?20|}} allows the user to preview the HTML version of the page.

=== Zoom In/Out ===

The fourth and fifth options {{:magnifying_glass.png?20|}} zoom the page in and out.

=== Shortcuts ===

The sixth option {{:i_icon.png?20|}} displays a list of keyboard shortcuts to speed up the conversion process.

=== Close ===

The final option {{:red_cross_icon.png?20|}} closes the page editor and returns to the **Document Detail** page.


==== Page Editor: Shortcuts ====

There are a number of shortcuts to speed up the conversion process.
  * P - Change Selected Zone to a default Text
  * A - Change Selected Zone to an Anchor
  * H - Change Selected Zone to a Heading
  * I - Change Selected Zone to Ignore (hide)
  * F - Change Selected Zone to a Field
  * U - Change Selected Zone to a URL (link)
  * L - Change Selected Zone to a List
  * T - Change Selected Zone to a Table
  * B - Change Selected Zone to a Blockquote container
  * Q - Change Selected Zone to a Quote
  * G - Change Selected Zone to a Graphic
  * C - Change Selected Zone to a Citation
  * Delete + x - Remove the selected zone
  * M - Toggle the Merge Attribute
  * K - Toggle the Break Lines Attribute
  * V - Toggle the visible Attribute
  * Up arrow - Move Zone up
  * Down arrow - Move Zone down
  * Left arrow - Move Zone left
  * Right arrow - Move Zone right
  * Ctrl + s - Save Page
  * Ctrl + p - Preview page
  * Ctrl + x - Clear Layout
  * Ctrl + i - Zoom in
  * Ctrl + o - Zoom Out
  * Ctrl + m - Mark page as validated
  * Ctrl + h - Show this help window
  * Alt + b - Show Page Options
  * Alt + z - Show Zone options
  * Alt + p - Show list of pages

==== Working with Zones ====

Create zones around a specific assets and use editing techniques to convert the document into an accessible format.

{{:creating_zone.png?400|}}

//Page Editor - Creating a Zone//

==== Zone Position ====

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**, **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.

{{:zone_position.png?400|}}

//Page Editor - Zone Position fields//

==== Global Zone Properties ====

**Global Zone Properties** apply to all zones.

=== Name ===

The zone list will refer to different zones by their zone name. The zone name is automatically populated but can be modified by changing the name in the **Name** textbox.

=== Type ===

The **zone type** drop down list allows the user to select the correct HTML tag for the zone when exporting a document.

=== Language ===

The **language** drop down list allows the user to select the correct language of text in the zone.

=== Order ===

The **Order** field represents the order in which the zone will appear and be read in the HTML output of the document.

=== Remove Zone ===

The **Remove Zone** button allows the user to remove zones they do not want to be included in the export of the document.

{{:zone_properties.png?400|}}

//Page Editor - Zone Properties//

=== Merge Zone ===

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|}}

//Page Editor - Merge Zone toggle//

=== Break Lines ===

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|}}

//Page Editor - Break Lines toggle//

==== Zone Source ====

=== Zone Source PDF (Default) ===

Equidox scans the page to convert assets into a tag tree.

=== Zone Source OCR ===

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. 
 
{{:image07.png?400|}}

//Pager Editor - Zone Source - OCR//

=== Zone Source Custom ===

Select the Custom Zone Source to manually enter the content for a zone.

==== Zone Types: Overview ====

=== Text: ===

Select **Text** to indicate a zone consists of text based content and to use an appropriate tag in the HTML output.

=== Heading: ===

Select **Heading** to indicate a zone is intended to be read as a heading by a text-to-speech tool. The heading level can be modified to distinguish between headings and subheadings.

=== Table: ===

Select **Table** to indicate a zone is a table.  A summary and caption can be added to help the text-to-speech tool describe the context of the table. The user can access the table editor to make manual edits and adjustments to the table.

=== Link: ===

Select **Link** to indicate a zone is a hyperlink. The user can add an anchor to the link for future readers to access when they click on the link.

=== List: ===

Select **List** to indicate a zone is a list. The user can create a caption and summary for the list to help the text-to-speech tool describe the context of the list.

=== Anchor: ===

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: ===

Select **Ignore** to hide zones, repeated, inaccurate or irrelevant content.

=== Blockquote: ===

Select **Blockquote** to indicate a zone is a quote from another source. A blockquote is identified by an indentation of the quote and a blue line on the left side of the zone.

=== 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: ===

Select **Quote** to indicate a zone is a quote defined by quotation marks at the beginning and end of the zone.

=== Cite: ===

Select **Cite** to indicate the zone consists of a proper title of a work. This can be used to identify the title of book, movie, piece of art, etc. Exclude the author’s name from the Cite zone type. 

=== Footnote and Footnote Link: ===

Select **Footnote Link** to indicate a zone consists of a footnote marker corresponding to a footnote at the bottom of a document.

=== 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.

Label and form element in a single, assign the correct value. Wrap all control in a form zone; assign form values.
ALT-Key functionality - TBD by Eric:   

=== OCR: ===

Select **OCR** to indicate a zone was generated via the optical character recognition tool. The OCR zone type is generally used for scanned PDF documents.

==== Using Zone Type: Text ====

Text zones will appear in the HTML preview in the sequence of creation if no changes were made to the zone order.

=== Text Tag ===

Use Text Tags to apply styles to text zones (i.e. italicizing, bold, color).

=== Text Indentation ===
Choose between single or double indentations of individual text zones in the exported document.

==== Using Zone Type: Heading ====

Select **Heading** to indicate a zone is to be read as a heading by a text-to-speech tool. The heading level can be modified to distinguish between headings and subheadings. A lower heading level will output a larger heading. A higher heading level will output a smaller heading.

=== Heading Level ===

The **heading level** can be adjusted by manually entering the number or using the arrows in the Level field under **Heading Properties**. A lower heading level will output larger text. A higher heading level will output smaller text.

=== Use as Template ===

Toggle the **Use as Template** option under **Heading Properties** to apply the same settings to zones of similar size and properties throughout the document. This feature is useful when large documents have multiple pages with similar layouts.

==== Using Zone Type: Table ====

Select Table to indicate a zone is a table.  A summary and caption can be added to help the text-to-speech tool describe the context of the table. The user can access the table editor to make manual edits and adjustments to the table.

=== Table Summary ===

Add or modify the description of the table in the **Summary** text box.

=== Table Caption ===

Add or modify the Table Caption in the **Caption** text box. Captions will be read aloud by text-to-speech tools to describe the context of the table.

=== Table Editor ===

Select the blue **Table Editor** button to open the Table Editor. From here, the user can adjust cell sizes, row count, column count, headers, and table orientation. Equidox will automatically export the adjustments and apply the correct HTML tags for text-to-speech tools. The **Table Editor** is capable of converting complex tables in a few minutes rather than a few hours.

**NOTE**: Learn more about the Table Editor

{{:table_properties.png?400|}}

//Page Editor - Table Properties//

==== Using Zone Type: Link ====

Select Link to indicate a zone is a hyperlink. Add an anchor in the Link Properties for the link to point to when clicked.

=== Link URL/Anchor ===

Select the link to redirect to the specified URL in the **URL/Anchor** text box. Modify the anchor by entering the desired URL in the text box. The link can anchor to any valid location such as pages within the document, outside web pages, and even email addresses.

=== Link Description ===

Modify the description of the link in the **Description** text box for text-to-speech tools to describe the context of the link.

==== Using Zone Type: List, List Body, and List Item ====

=== List, List Body, and List Item ===

Indicating that a zone is a **List, List Body, and List Item** are all part of generating list objects with child list items. This can be used on any type of ordered or unordered list etc.

=== List ===

Select **List** from the **Type** drop down menu in the **Zone Properties** section to indicate a zone is a list. Create and modify the caption and summary in the List Properties section.

**Note**: **List** zones are marked with a green indicator.

=== List Caption ===

Add or modify the List Caption in the Caption text box. Captions will be read aloud by text-to-speech tools to describe the context of the list.

=== List Summary ===

This field is for a summary of the list. This can be modified by changing the text within the text box. These changes will be saved with the rest of the page.

=== List Type ===

Select Unordered or Ordered in the List Properties section. An unordered list will output various types of bullet points when displaying the list. An ordered list allows the user to select the list style (lowercase, uppercase, roman numerals, numbers, etc.) in the output.

=== List Reversed ===

Display the list in the reverse order with the **Reversed** toggle at the bottom of the List Properties section.

=== List Detect ===

Select the blue **Detect** button to create a text zone around each element of the list. This automated process may require some manual adjusting it some elements are undetected.

{{:list_properties.png?400|}}

//Page Editor - List Properties//

=== List Body ===

##Need more information on these

=== List Item ===


==== Using Zone Type: Anchor ====

An anchor type is to be used with the link type. The 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 HTML output. Anchor can also be used for anchoring pages to a table of contents.

=== Anchor ID ===

In order for an anchor zone to be usable, it is crucial to give the anchor a proper **Anchor ID**. This can be any string of alphanumeric characters that will be used as a reference ID for links. 

{{:create_anchor_zone.png?400|}}

//Page Editor - Creating a useable Anchor zone//

=== Using the Anchor ===

To begin, the user must first create a link zone. Once the link zone is created, the user can set the URL/Anchor field to the **Anchor ID** of the anchor the user would like to link to with a # in front of it.

**Example**: Anchor ID = sample_anchor, URL/Anchor = #sample_anchor

{{:anchor_link.png?400|}}

//Using the Anchor Zone with a Link//

==== Using Zone Type: Graphic ====

Indicating that a zone is a graphic will generate an image of set zone for the HTML document. This can be used on any image, symbol, formula etc. that is not identified by EQUIDOX™ as an image. Alt text or long description can also be added to define or explain the image/graphic.

=== Graphic Description ===

This field is a description of the graphic. It is used for accessibility purposes. It can be modified by entering text into the Description (Alt) text box. The data will be saved with the rest of the page.

=== Graphic Long Description ===

This field is an optional longer alternate description of the graphic that allows more characters. It is used for accessibility purposes. It can be modified by entering text into the Long Description text box. The data will be saved with the rest of the page.

{{:graphic_properties.png?400|}}

//Page Editor - Graphic Properties//

=== Graphic Editor ===

By selecting the blue **'Edit'** button, the user will be redirected to the **Graphic Editor**. From here, the user can modify fields of the graphic such as the description, long description, and the graphic name.

==== Using Zone Type: Blockquote ====

Select **Blockquote** to indicate a zone is a quote from another source. A blockquote is identified by an indentation of the quote and a blue line on the left side of the zone.


==== Using Zone Type: Quote ====

Identifying a zone as a **quote** results in set zone having quotation marks at the beginning and the end of the zone.

==== Using Zone Type: Cite ====

Select **Cite** to indicate the zone consists of a proper title of a work. This can be used to identify the title of book, movie, piece of art, etc. Exclude the author’s name from the Cite zone type.

==== Using Zone Type: Footnote and Footnote Link ====

Select **Footnote Link** to identify a zone consists of a footnote marker corresponding to a footnote at the bottom of a document.

=== To Anchor ===

## NEED INFO

=== Footnote Link Description ===

Add or modify a description of the footnote link in the **Description** text box.

==== Using Zone Type: Form and Field ====

Identifying a zone as a **Form** results in the zone being set as an HTML form in the exported document. Setting a zone as a **Field** within a form allows the user to add fields in which the user can input data and submit it. There can be a variety of fields within the same form which range from radio-boxes to pick-lists. 

=== Form Name ===

This field represents a link to the form that the field is a part of. This zone can be modified by entering text into the Description text box. The data will be saved with the rest of the page.

=== Field Name ===

This field represents the name of the field. This zone can be modified by entering text into the Description text box. The data will be saved with the rest of the page.

=== Field Type ===

This field allows the user to select between a variety of field types for the user to enter information into in the document. This ranges from text boxes to drop down lists. This field can be modified by selecting one of the options from the drop down list and filling out its values accordingly.

=== Field Default Value ===

This field represents what value will be in the field before the user selects or interacts with it. It is used as a placeholder for user input in the exported document. This value can be modified by entering text into the Description text box. The data will be saved with the rest of the page.

=== Label Zone ===

##This field simply represents which zone will be linked to the field zone such that they stay together upon export. This field can be set by either selecting the zone the user would like to use as the label through the picklist or by creating a zone that covers both the field and label zone while holding down the alt-key. If done correctly, the zone will appear to be blue while creating and will automatically set the label zone upon release. 

{{:field_properties.png?400|}}

//Page Editor - Field Properties//

==== Using Zone Type: OCR ====

Any zone that was generated via the tool’s optical character recognition should be listed as **OCR** zone type. This lets the user know that this content was most likely a scanned PDF imported into **Equidox**.

==== Table Editor ====

=== Using the Table Editor ===

When the user is presented with the table editor, there is a control panel on the left side of the screen, much like the one on the conversion page, but with tools pertaining to converting a table.

Above the **Zone Properties** there are options to **Save, Preview**, as well as **Zoom in** and **Zoom out**. These are all functions that are available on the conversion page. The difference with the control panel on the **Table Editor** is that it has more detailed tasks pertaining to editing a table, and does not have tasks available that are irrelevant to the table. Such tools can be seen in the image below.

{{:table_editor.png?400|}}

//Equidox Table Editor//

Under **Zone Properties** the zone **Name, Caption**, and **Summary** are presented. This information is able to be modified.

Sliding the sensitivity bar to the left will create more columns and rows, while sliding the sensitivity bar to the right will create less columns and rows. Simply, by selecting two cells in the same column or row and pressing and holding the **Shift-key**, the user can span multiple cells.

=== Editing a Table ===

Editing a table allows the user to make the necessary adjustments to make the table accessible to a screen reader.

Create a zone over the table. Change the zone type to **Table**. Open the **Table Editor** by selecting the button on the sidebar.

{{:accessing_table_editor.png?400|}}

//Page Editor - Table Properties and accessing  the Table Editor//

Modify the cell detection sensitivity in the **Page** tab and click **Apply**. Span across cells by selecting a cell, holding shift, selecting an additional cell, and clicking **Span** in the **Cells** tab.

{{:span_columns.png?400|}}

//Table Editor - Column Merge//

{{:span_row.png?400|}}

//Table Editor - Row Merge//


Click and drag column/row guides to change size. Select **Merge Right** or **Merge Down** in the toolbar to merge columns and rows.

{{:table_split_and_merge.png?400|}}

//Table Editor - Row/Column Split and Merge// 

Select **Table** and toggle **IDs** in the Table Properties section to have **Equidox** automatically generate the table IDs.

{{:table_ids.png?400|}}

//Page Editor - Table ID’s//

Save all changes using the **Save This Table** {{:save_icon.png?20|}} option on the top right of the screen. **Preview the HTML** {{:monitor_icon.png?20|}} table by selecting Preview this Table  on the top right of the screen.

{{:sample_table.png?400|}}

## The Table Editor **Guides** will appear as blue lines that go across the table. These lines represent where each of the rows and columns will be searching for text in each table cell. All of the Guide-lines can be moved by selecting them and dragging them either horizontally (for rows) or vertically (for columns).

{{:table_editor.png?400|}}

//Table Editor//
Equidox by Onix TM Wiki

Site Tools

User Tools

Site Tools

Page Tools

User Tools
