Documentation

Digital Hub Documentation

The Digital Hub is the Well-Formed Document Workflow’s web-based suite of tools designed to easily transform structured documents.

Users and Organizations

User and organization management applies to access to the Digital Hub and the related downloads. Managed through the organization page, information about individual users includes only what is strictly necessary.

User Info

  • email address: The primary identifier for a user.
  • name: This can be a full or partial name.
  • password
  • organization
  • role

Roles

  • admin: Scribe only. A Scribe admin has complete access to all files and user information (except passwords).
  • manager: A manager has access to all the users and projects associated with his or her organization. A manager can add or delete users for that organization.
  • user: A user has access to all projects within his or her organization. A user can upload and download files and has full access to the downloads on scribenet.com. A user can only delete projects for which he or she is the project owner.
  • freelancer: A freelancer can access and modify projects for which he or she has been listed as the “Current User.” A freelancer can create new projects. Users and managers within a freelancer’s organization have access to these projects. Freelancers cannot run e-book conversions.

Organization Settings

An organization manager or a Scribe admin can edit the organization’s conversion settings. These settings are inherited by every project made within the organization. When an organization’s settings change, only new projects created within that organization inherit the new changes. Organization setting changes will not be applied to preexisting projects.

Organization Files

An organization manager or an admin can add or delete organization files (CSS, publisher logo, etc.). In the file tab for every project associated with an organizaton, there is a button labeled “Add Organization Files.” (The button does not appear if an organization does not have any files.) This launches a modal listing all the organization’s files, and users can choose which ones the project should inherit. When an organization file is selected for a project, a copy of the file will be added to the project. Users can choose to delete that copy from the individual project without affecting the repository of organization files.

Images

For information on how to prepare images locally for inclusion in e-books, see Image Processing.

Image Conversions

Images coming from proprietary software (i.e., Adobe PhotoShop) can have proprietary encodings that prevent them from being understood correctly by other image software. The Digital Hub uses open-source image libraries to perform image conversions. Sometimes this means that the conversion will experience problems with Adobe’s colorspace encodings when trying to convert CMYK to RGB. Because of this, Scribe’s recommendation for best practice is to convert the colorspace before uploading images to the Digital Hub. (TIFF to JPEG will generally be acceptable. Best results will be achieved, however, by running batch conversions locally before adding images to a Hub project.)

Image Settings and Metadata

Images in the Digital Hub are used only for embedding in e-books. The Digital Hub will maintain one version of each image in the files tab. Images will be processed with the options users specify when the images are uploaded. If processing has been disabled, the image will be included unchanged. After images have been uploaded, the set in the files tab is the set that will be used in the e-book. Images cannot be reprocessed outside of uploading. If a user wants to reprocess an image, the images will need to be reuploaded.

The Digital Hub will not adjust the DPI of images.

The default maximum height and width is set to 600 pixels. For images marked as the cover, this number is 1800. The default image format is JPEG.

Supported Formats

The Digital Hub will accept the following image formats:

  • JPEG
  • PNG
  • SVG
  • TIFF

The Digital Hub will process the following image formats to resized JPEG or PNG:

  • JPEG
  • PNG
  • TIFF

The Digital Hub will not accept postscript formats (PDF, EPS).

Global and Individual Image Settings

When uploading image files, users can perform the following actions for the whole group of images:

  • Turn off image processing
  • Set the maximum height and width
  • Set the default image format to JPEG or PNG

By clicking the gear icon next to an image name in the uploader screen, users can adjust settings for that image that will override the group settings.

Cover Images

Each image in the upload screen has a “Set cover” button. When selected, this indicates that the image is the book cover. Its default maximum width and height for processing will be 1800 pixels. Users can override this in the settings panel for that image.

  • Markup for the cover will not be added to ScML. If a user converts an older ScML file with the cover markup, it will still work.
  • If a cover image is present and marked in the Hub, the cover will automatically be added to e-book output.

Short Descriptions

The project page to allows users to add a short description as a field near the image name. This text will be applied to the image element in subsequent HTML/ePub conversions as alt text. This is useful and encouraged for accessibility in digital publications.

  • Alt text added in the Hub is limited to 150 characters and cannot contain HTML/XML control characters (<>, &, ”, ’).
  • This alt text will only be applied to image elements in HTML output (pure HTML or ePub). If there is existing alt text for an image element in ScML, that existing alt text is left in place in the HTML. Otherwise, the alt text entered in the Hub is applied. If there is no alt text provided, an empty alt attribute is applied. This is required for validation in ePub3.

Project Creation

The project creation wizard provides users with a single path to create a project. After a project is created, file conversions can be run through the project page.

Only the “Code” field is required.

  • Project codes can only contain letters, numbers, hyphens, and underscores.
  • Project codes must be three characters or longer.

From this step, users can click the following:

  • “Submit and Continue” to keep using the project creation wizard.
  • “Submit and Go to Project Page” to leave the project creation wizard and go to the project page. The project will include only the metadata added at that time.

Note: If anything is entered incorrectly while in the project creation wizard, do not use the browser’s back button. Changes to metadata can be applied through the project page.

Enter Basic Metadata

Enter basic metadata: project code, title, publisher, and subjects (BISAC). The “Publisher” field is automatically filled with the name of the user’s organization.

Add Creators

Options are available for author, editor, translator, illustrator, and designer. Click “Add Another Creator” to generate fields for all to be included.

ISBNs

Add ISBNs for each applicable format.

When producing an e-book, the Digital Hub will use ISBNs with the following priorities:

  • ePub: the Hub will check for an ePub ISBN, then a MOBI ISBN, and then a print ISBN.
  • MOBI: the Hub will check for a MOBI ISBN, then an ePub ISBN, and then a print ISBN.
  • If there is no ISBN, a placeholder will be added.

File Uploader

Upload files, set image processing settings, and select a cover image.

After this step, users are directed to the project page.

Uploads are restricted to files of 100 MB or smaller.

Project Page

Overview

The project page contains all files associated with a project. Through the project page, users can change settings, manage and convert files, and edit project information.

  • The Files list shows all files present in the project. For .docx, .sam, and .scml files, the checks and stats will be available. Click on the “Details” field to access information about the file size, origin, and time of last modification. Click “Basic Info” to return to the original view.
  • Project Information includes the project code and title as well as metadata (BISAC codes, ISBNs, etc.). This information can be added or revised.
  • Alerts and Updates shows information about the recent activity of a project. Conversion alerts will list potential issues. Critical issues, including validation errors or problems that would prevent conversions, will be listed with the files directly.
  • User Access shows the current owner of the project. This project will appear in the project list for the user indicated.
  • File conversions are performed in the banner at the top of the page. Click “Edit Settings” to change any settings from the organization’s defaults. Only when both “input” and “output” types are selected will the settings and “Convert” buttons become available.
  • Options are available to upload, download, or delete files.
  • Click Project List to return to your full list of Digital Hub projects.

File Checks

File checks are run against all .docx, .xml, .sam, and .scml files. These checks provide information about validation errors and aspects that may be problematic for conversions.

The “Checks” button for individual files is color-coded based on the level of errors (or potential errors):

  • Green indicates that a file passes all basic checks.
  • Blue indicates an alert that is not an error but may require further action in the final output (e.g., the presence of private use area Unicode).
  • Yellow indicates a potential problem. Users can assess whether it will be best to proceed with the conversion or to address the issue(s) and reupload the file.
  • Red means the file cannot be converted. For example, this will happen if a Word document has not been properly saved as .docx or if a .sam or .scml file is not well-formed. If a file has a red warning and a conversion is run, the Digital Hub will flash a warning (“Your input files contain one or more critical errors.”) and the file will not be converted.

Line numbers are reported for sam and ScML file check errors. XML files receive pass/fail checks only.

File Stats

The Stats window provides the following information about individual files or all files present for a group:

  • Word Count.
  • Character Count (excluding code tags).
  • Styles. A list of all styles used in the document as well as their frequency. Elements that are not ScML styles will be highlighted in yellow.
  • Special Characters. The character and its name, frequency, and Unicode codepoint will be listed, as well as a regular expression search that can be used to find the character in Sublime Text.
  • Images. A list of all images indicated in the file. Image names highlighted in yellow have not been uploaded to the project.

Stats can be sorted by either element name or element count.

Project URLs will use the project ID number from the database (e.g., /wfdw/projects/57).

Project codes can also redirect to a project. For example, if a project’s code is “scr-example,” the URL ending with “/wfdw/projects/code/scr-example” will redirect to that project.

To search for a project within an organization, use the search field at the top of the screen when viewing the project list or a project page.

Project Expiration

Projects that are inactive for 120 days are removed from the system. An email message will be sent to the project owner seven days before the project is removed. To retain the project, any changes made to the project record will restore it to active status. Changes include uploading files, performing a conversion, or editing the project’s metadata.

Available Conversions by File Type

Note: Users are warned and prevented from running multiple simultaneous conversions in a project record.

.docx (MS Word)

The Digital Hub can convert files of this format into any of the following:

  • .docx (Refined MS Word)
  • .epub (ePub2 or ePub3)
  • .mobi (KindleGen Mobi; automatic with conversion to ePub formats)
  • .txt (InDesign Tagged Text)
  • .sam (Scribe Abbreviated Markup)
  • .scml (Scribe Markup Language)
  • .html (HyperText Markup Language)

Note: It is recommended that .scml is created and reviewed before any conversion to e-book or HTML formats.

.xml (InDesign XML)

The Digital Hub can convert files of this format into any of the following:

  • .docx (MS Word)
  • .epub (ePub2 or ePub3)
  • .mobi (KindleGen Mobi; automatic with conversion to ePub formats)
  • .txt (InDesign Tagged Text)
  • .sam (Scribe Abbreviated Markup)
  • .scml (Scribe Markup Language)
  • .html (HyperText Markup Language)

Note: It is recommended that .xml files are converted to .sam and reviewed in that format before proceeding with any further conversions.

.sam (Scribe Abbreviated Markup)

The Digital Hub can convert files of this format into any of the following:

  • .docx (MS Word)
  • .epub (ePub2 or ePub3)
  • .mobi (KindleGen Mobi; automatic with conversion to ePub formats)
  • .txt (InDesign Tagged Text)
  • .scml (Scribe Markup Language)
  • .html (HyperText Markup Language)

Note: It is recommended that .scml is created and reviewed before any conversion to e-book or HTML formats.

.scml (Scribe Markup Language)

The Digital Hub can convert files of this format into any of the following:

  • .docx (MS Word)
  • .epub (ePub2 or ePub3)
  • .mobi (KindleGen Mobi; automatic with conversion to ePub formats)
  • .txt (InDesign Tagged Text)
  • .html (HyperText Markup Language)

ePub Rezipper

The ePub Rezipper is a tool available only to WFDW subscribers for ePubs created using the Digital Hub. After making any local changes to your ePub, this tool can be used to zip and download a revised ePub.

For instructions and information about this tool, see ePub Rezipper Help.