1 - Pearson
E-Book+ Release 4.4 Content Manager Workflow
Functional User Document
Version No: 15.0
Project Name: eText
|Date |Version |Author |Description |
|13-Jan-2009 |1.0 |Sumeet Rathod |Created document draft |
|10-June-2009 |9.0 |Sumeet Rathod/Dilip |Features related to CM R3.0 |
| | |Kumar |Audio Text Synch Up Workflow. |
| | | |Enhanced Offline Package Validation logic. |
| | | |Support the ingestion of White board assets. |
| | | |Enhanced CustomBasket to support all the types of links for standards basket |
| | | |type. |
| | | |Added CustomHotSpots Spreadsheet to support the ingestion of hotspots using |
| | | |spreadsheet. |
| | | |Enhanced CustomGlossary to support CustomHotSpots. |
| | | |Enhanced Standard eBook Workflow to be used through UI. |
| | | |Removed Publish and Un-Publish tabs from UI and made them Workflow specific. |
|20-July-2009 |10.0 |Sumeet Rathod/Dilip |Features related to CM R3.1 |
| | |Kumar |Default value for Role column will be “all” in the Custom Basket Spreadsheet. |
| | | |“Comments” will be supported in all the custom spreadsheet i.e. CustomBasket, |
| | | |CustomTOC, CustomHotspot and CustomGlossary. |
| | | |Updated the use of “Commnets” column for Custom Hotspot Spreadsheet. |
| | | |Updated the steps for Harvest Media for “Audio Text” assets |
|21-Jan-2010 |11.0 |Pracheta Mahapatra |Features related to CM R3.2 |
| | | |Enhanced Search feature in Content Manager by Book ID, Global Book ID |
| | | |Enhanced error Logs and notification email subject |
| | | |Auto ingestion of non-synched audio XML using spreadsheet |
| | | |Deletion of obsolete titles from CM |
|16-Nov-2010 |12.0 |Rajat Mittal |Features related to CM R4.2 |
| | | |iPad processing workflow. |
| | | |Enhanced Custom Basket to support assessment type basket and other new |
| | | |linktypes as well. |
| | | |Enhanced Custom Hotspot to support ltilink type hotspots and other new |
| | | |linktypes as well. |
| | | |Auto media harvesting. |
|08-Dec-2010 |13.0 |Amit Taran |Features related to CM R4.3 |
| | | |Enhanced Custom Basket to support eText mode, Plugin, PluginRequired & iPad |
| | | |Column (all are optional fields) to Mark up of HTML Assests of URL Type |
| | | |(wrapping FLV/SWF) & publish to viewer adjustments (iPad only) |
| | | |Enhanced Custom Hotspot to support Plugin, PluginRequired & iPad Column (all |
| | | |are optional fields) to Mark up of HTML Assests of URL Type (wrapping FLV/SWF) |
| | | |& publish to viewer adjustments (iPad only) |
| | | |Enhanced Custom Audio Text to support on-page visual cue i.e., newly added |
| | | |columns in custom audio spreadsheet are useIcon, Width and Height. |
|15-Apr-11 |14.0 |Pracheta Mahapatra |Features related to CM R4.3.4 |
| | | |Enhanced UI to facilitate ingestion of 1:1 and many:many replacement pages, so |
| | | |that pages are not processed needlessly. |
| | | |Incorporated UI to configure Content Manager Manfest and Authoring Ingestion |
| | | |Manifest. |
| | | |Incorporated UI to update metadata elements in BookInfo xml. |
| | | |Ability to delete folders for specified earlier versions on the content manager|
| | | |ftp. |
| | | |Continue PDF Processing even if few PDFs encounter problems during Processing |
| | | |Optimize PDFs prior to Ingestion |
| | | |Persist Title selection from tab to tab in Content Manager UI |
| | | |Introduce a higher level of access to the content manager. |
| | | |Migrate etext data into subdirectories |
| | | |Include links for bookinfo.xml and basket.xml in the "eBook creation success" |
| | | |email body. |
| | | |Include links for process pages html report in the "eBook creation success" |
| | | |email body. |
|24-May-11 |15.0 |Arun Sharma |Features related to CM R4.4 |
| | | |Export button in workflow tabs of the Content Manager to initiate a backup |
| | | |export of current version in Authoring |
| | | |Other name of the author is rendered on work flow status page. |
| | | |Support alternative link for ingestion |
| | | |Add URL to preview the created optimized iPad pdfs. |
| | | |Develop a workflow to capture positioning of zoom boxes. |
| | | |New language supported |
| | | |UI Improvements in Accessibility workflow |
| | | | |
Table of Contents
1 Purpose 17
2 Target Audience 17
3 Features 17
3.1 Release2.0 17
3.2 Release3.0 17
3.3 Release3.1 17
3.4 Release3.2 18
3.5 Release4.2 18
3.6 Release4.3 18
3.7 Release4.4 18
4 Simple eBook Workflow Steps 20
4.1 Custom TOC Spreadsheet 20
4.1.1 Naming Convention 20
4.1.2 Sample Custom TOC Spreadsheet 21
4.1.3 Custom Toc Spreadsheet Validation Checks 21
4.1.4 Custom TOC Description and Use Cases 22
4.1.5 Custom TOC – General Important Points 27
4.2 Custom Basket Spreadsheet: 27
4.2.1 Custom Basket XML Creation using Custom Basket Spreadsheet 27
4.2.2 Sample Custom Basket Spreadsheet 28
4.2.3 Spreadsheet Naming Convention 28
4.2.4 Simple eBook Custom Basket Spreadsheet Description 28
4.2.5 Custom Basket Spreadsheet Validations 36
4.2.6 Basket Details 37
4.2.7 Simple eBook Custom Basket Spreadsheet – Important Instructions for special characters in WINDOWS Platform: 37
4.2.8 Simple e-Book Custom Basket Spreadsheet – Important Instructions for special characters in MACINTOSH Platform: 37
4.3 Custom Glossary Spreadsheet: 37
4.3.1 Glossary XML Creation using Glossary Spreadsheet 37
4.3.2 Sample Glossary Spreadsheet 37
4.3.3 Spreadsheet Naming Convention 37
4.3.4 Simple eBook Glossary Spreadsheet Description 38
4.3.5 Simple eBook Glossary Spreadsheet – Important Instructions for special characters in WINDOWS Platform: 44
4.3.5.1 Equations Represented as Image: 44
4.3.5.2 Equations Represented as Expression: 44
4.3.5.3 Sup/Sub Script Characters: 45
4.3.5.4 Symbols: 46
4.3.5.5 Foreign Language Characters 46
4.3.6 Simple e-Book Glossary Spreadsheet – Important Instructions for special characters in MAC Platform: 48
4.3.6.1 Equations Represented as Image: 48
4.3.6.2 Equations Represented as Expression: 48
4.3.6.3 Sup/Sub Script/Accented Characters: 50
4.3.6.4 Symbols: 51
4.3.7 Custom Glossary Spreadsheet Validations 51
4.3.8 To View Glossary in the Authoring/Viewer Server 52
4.4 Custom HotSpots Spreadsheet 52
4.4.1 Regioninfo XML Creation using Custom HotSpots Spreadsheet 52
4.4.2 Sample Custom HotSpots Spreadsheet 52
4.4.3 Spreadsheet Naming Convention 52
4.4.4 Simple eBook Custom HotSpots Spreadsheet Description 53
4.4.5 Custom HotSpots Spreadsheet Validation Checks 57
4.4.6 eBook Custom HotSpots Spreadsheet – Important Instructions for special characters in WINDOWS Platform: 58
4.4.7 eBook Custom HotSpots Spreadsheet – Important Instructions for special characters in MACINTOSH Platform: 58
4.4.8 Custom Hotspots Ingestion Use Cases: 58
4.4.9 Glossterm Type Hotspot Ingestion: 61
4.5 Custom Audio Text Spreadsheet 62
4.5.1 Non-Synched Audio XML creation using Custom AudioText Spreadsheet 62
4.5.2 Sample Custom Spreadsheet 62
4.5.3 Spreadsheet Naming Convention 62
4.5.4 Simple eBook Custom Audio Text Spreadsheet Description 63
4.5.5 Custom Audio Text Spreadsheet Validation Checks 63
4.6 XML Processing Logic 64
4.7 PDF Processing Logic 64
4.8 iPad PDF Processing Logic 65
4.8.1 Preview iPad PDFs 66
5 Multi-state Variant Ingestion 66
6 XML Validation 68
6.1 BookInfo XML Validation 68
6.2 RegionInfo XML Validation 69
6.3 Basket XML Validation 69
6.4 Manifest XML Validation 70
6.5 Glossary V1 XML Validation 70
6.6 Glossary V2 XML Validation 70
6.7 Customicon XML Validation 71
6.8 Print XML Validation 71
6.9 Bookpreference XML Validation 71
6.10 Zoominfo XML Validation 71
6.11 Whiteboard Manifest XML Validation 72
6.12 Content Manager Audio Manifest XML Validation 72
6.13 Authoring Audio Manifest XML Validation 73
6.14 Page Level Audio XML Validation 73
6.15 Page Level Audio XML Validation 74
7 E-Book+ Accessibility Workflow 76
7.1.1 NIMAS Source Content Validation 76
7.1.2 NIMAS Source Content Conversion to Accessible HTMLs 77
7.1.3 Validation of Accessible HTMLs 77
7.1.4 Publish Accessible HTMLs 78
8 Improvements in Accessibility workflow 78
8.1 Multi flow sidebar implementation 78
8.1.1 HTML rendering without Sidebar Multi Flow 80
8.1.2 HTML rendering with Sidebar Multi Flow 81
8.2 Prevent dragging images 82
8.3 MathML header include 82
8.3.1 System Requirement 82
8.3.2 MathML rendering in IE 82
[pic] 82
8.3.3 MathML rendering in Browsers except IE 82
9 Offline Viewer Packaging Workflow 83
9.1.1 PSN: Validation and Packaging 86
9.1.2 OCAS: Validation and Packaging 87
9.1.3 CD-ROM: Validation and Packaging 88
10 Standard eBook Workflow 88
10.1 Process the eBook Package created by eBook Conversion Toolkit 89
10.2 Glossary Spreadsheet: 90
10.3 Custom Hotspot Spreadsheet: 90
10.4 Basket Spreadsheet: 90
10.5 XML Processing Logic 90
10.6 PDF Processing Logic 90
11 Selection Feature 91
12 Server Usage Report 91
12.1 Sample Server Usage Report 91
13 Content Cleanup and Archival Strategy 91
13.1 Sample Notification Report 93
14 Re-ingesting a Title 93
14.1 Re-ingestion of bookinfo xml 93
14.2 Re-ingestion of basket xml 93
14.3 Re-ingestion of regioninfo xml 94
14.4 Re-ingestion of glossary xml 94
14.5 Re-ingestion of pdf files 94
14.6 Re-ingestion of iPad PDF files 97
15 Media Harvesting 97
15.1 Auto Media Harvesting (Preferred approach) 97
On pressing the Validate button, Content Manager will automatically download the assets referenced in the XML files (basket, glossary and page) will download them one by one. This approach ensures that only the assets referenced in the XML are downloaded. 97
15.2 Acquiring assets from a given folder 97
15.3 Approach to enter the Media Assets Field: 98
16 High-Res to Low-Res PDF conversion 100
17 Audio-Text Workflow 102
18 Zoom Area Ingestion 103
19 Custom Icon XML Ingestion 103
19.1 XML Structure 103
19.2 User Workflow for custom icons and Toolbars 105
19.3 Display on Authoring/Viewer 107
19.3.1 Toolbars: 107
19.4 Other Custom icons: 108
20 Enhanced Search Feature by Global Book ID and Book ID 109
21 Deletion of obsolete titles from Content Manager 110
22 Enhanced Error Logs and notification email subject 110
23 Content Manager Test Harness (CM to Authoring only) 110
24 Content Producer: CM user can choose authoring instance 111
25 Enhanced UI to facilitate ingestion of 1:1 and many: many replacement pages 111
25.1 Replace Selected Pages Workflow 112
25.2 Restore manifest 115
25.3 Replace Selected Pages Validation Checks 115
26 GUI to configure the Content Manager and Authoring Ingestion manifest 116
26.1 Manage Manifest Workflow 116
26.2 Manage Manifest Business Rules 117
27 GUI to update Metadata elements in BookInfo XML 118
27.1 Manage BookInfo Workflow 119
27.2 Manage Bookinfo Business Rules 120
28 Ability to delete unnecessary folders from FTP 123
28.1 Delete unnecessary folders from FTP Workflow 123
28.2 Delete unnecessary folders from FTP Business Rules 125
29 Ability to Continue PDF processing after encountering errors 126
30 Ability to Optimize PDFs prior to Ingestion 126
30.1 Optimize PDF Processing Workflow 127
30.2 Optimize PDF Processing and Normal PDF Processing Workflow Diagram 128
30.2.1 Normal PDF Processing 128
30.2.2 Optimized PDF Processing 129
30.3 Optimize PDF Processing Business Rules 129
31 Persist Title Selection from tab to tab in Content Manager UI 129
32 Introduce higher level Access to Content Manager 131
32.1 Content Manager Workflow 131
32.2 Workflow Status 132
32.3 User Administration 133
32.4 Server Access Report 134
32.5 Admin Access 134
33 Migrate eText Content into Subdirectories 136
33.1 Migrate titles Workflow 136
33.2 Migrate titles Business Rules 138
34 Include Links to download Bookinfo and Basket XML after successful XML creation 139
35 Include Link to download ProcessedPages HTML report in email 139
35.1 Sample processed pages html report 140
36 Other name of the author is rendered on work flow status page 140
36.1 Update Other Name 140
36.2 Business Rules 141
37 Develop a workflow to capture positioning of zoom boxes 144
37.1 Prerequisites 144
37.2 ZoomInfo XML creation 145
38 eText export from Content Manager 146
38.1 Export Workflow 146
38.2 Business Rules 147
39 New Language Supported 147
40 Frequently Asked Questions 148
41 Error Reporting 151
Purpose
The purpose of the document is to describe the complete functional workflow of Content Manager Server Side for the Release 4.3 to the Pearson Production Users and NIMAS Vendors.
Target Audience
Users of Content Manager Application are the audience of this document.
Features
1 Release2.0
o Decoupled the Acquire metadata for Standard eBook workflow
o Automated the uploading the ebook package to the Authoring server FTP for Standard eBook.
o Added the search features.
o Added the business unit level of folder hierarchies in the Content Manager FTP.
o Added the colour coding for the states.
o Created glossary2.xml using the Custom Glossary spreadsheet.
o Created basket.xml using the Custom Basket spreadsheet.
o Supported the left image, right image and description in the Custom TOC spreadsheet.
o Managed pdf2swf, pdf2text and pdf2thumbnail processing and error messaging.
o Enhanced workflow on the basis of manifest xml
o Enhanced the validations logics
o Added Accessibility Workflow to create the accessible html from the source nimas xml
o Offline validation and packaging.
o Automated version management in case of standard eBook.
o Automated the process of creation of derivative packages.
o Added feature for extracting Server Usage Data.
o Enhanced UI with selection feature.
o Deletion of Titles on the basis of Archival Cycle from the CM and Authoring FTP.
o Automation of Media Assets downloading from Media Server.
o Transformation of High res PDF files to Low res PDF files.
2 Release3.0
o Audio Text Synch Up Workflow.
o Enhanced Offline Package Validation logic.
o Support the ingestion of White board assets.
o Enhanced CustomBasket to support all the types of links for standards basket type.
o Added CustomHotSpots Spreadsheet to support the ingestion of hotspots using spreadsheet.
o Enhanced CustomGlossary to support CustomHotSpots.
o Enhanced Standard eBook Workflow to be used through UI.
o Removed Publish and Un-Publish tabs from UI and made them Workflow specific.
3 Release3.1
o Added the support of extra column in all the spreadsheet for example CustomTOC, CustomGlossary, CustomBasket, CustomHotspot.
o Add the default value support for the “Role” column in the Custom Basket Spreadsheet.
o Populate the value of “Commnets” column of CustomHotspot spreadsheet as the note tag of regioninfo XML.
4 Release3.2
o Enhanced Search feature in Content Manager by Book ID and Global Book ID.
o Enhanced error Logs and notification email subject. The Global Book ID is present in email subject of all the notification emails, in the name of the log files and as 1st line in the log files.
o Auto ingestion of non-synched audio XMLs using Custom Audio Text Spreadsheet in authoring/viewer tool.
o Deletion of obsolete titles from Content Manager.
5 Release4.2
o iPad processing workflow.
o Enhanced Custom Basket to support assessment type basket.
o Enhanced Custom Hotspot to support ltilink type hotspots.
o Auto media harvesting.
6 Release4.3
o Enhanced Custom Basket to support eText mode, Plugin, PluginRequired & iPad Column (all are optional fields) to Mark up of HTML Assests of URL Type (wrapping FLV/SWF) & publish to viewer adjustments (iPad only)
o Enhanced Custom Hotspot to support Plugin, PluginRequired & iPad Column (all are optional fields) to Mark up of HTML Assests of URL Type (wrapping FLV/SWF) & publish to viewer adjustments (iPad only)
o Enhanced Custom Audio Text to support on-page visual cue i.e., newly added columns in custom audio spreadsheet are useIcon, Width and Height.
7 Release4.4
o An Export button in the workflow tabs of the Content Manager to initiate a backup (export) of the current version of an eText from the Authoring server.
o Other name of the author is rendered on workflow status page.
o Support an alternate media link for ingestion
o Add URL to preview the iPad pdfs created by the Content Manager.
o Develop a workflow to capture positioning of zoom boxes.
o New languages supported
o UI Improvements in the Accessibility workflow
Simple eBook Workflow Steps
1 Custom TOC Spreadsheet
1 Naming Convention
Name of the spreadsheet should be CustomToc.xls.
Valid names:
o CustomToc.xls
o cg_lewinski_fecon_CustomToc.xls
o Freeman_CustomToc.xls
o AnnCustomToc.xls
o Pearson_CustomToc.xls
After creation of Glossary Spreadsheet it needs to be copied on the “assets” folder in the FTP as given below
[pic]
2 Sample Custom TOC Spreadsheet
[pic]
3 Custom Toc Spreadsheet Validation Checks
Following validation checks has been added on the “CstomTOC” spread sheet.
|S.No |Validation |
|1 |All columns have names as specified in the CustomTOC-Specs. |
|2 |All columns follow the occurrence order as specified in the CustomTOC-Specs. |
|3 |Each Spread Sheet must have at least one value in PDF File name column. |
|4 |The PDF File name specified in Spread Sheet should be physically present in HI-RES-PDF folder. |
|5 |If PDF File name column is non empty then following validations are done: |
| | |
| |A. If Include in TOC column has value as yes, following validations are done: |
| | |
| |i. PDF Page Number or combination of Start Page Number and End Page Number columns should be non empty. |
| |ii. Start Page Number column should be non empty even if PDF Page Number column is non empty. |
| |iii. TOC Level column should be non empty. |
| |iv. Page Count column should be non empty. |
| | |
| |B. If Include in TOC column has value as no, following validations are done: |
| | |
| |i. PDF Page Number or combination of Start Page Number and End Page Number columns should be non empty. |
| |ii. Page Count column should be non empty. |
| |iii. TOC Level column should be empty. |
| |iv. Role column should be empty. |
|6 |If PDF File name column is empty then following validations are done: |
| | |
| |i. TOC Entry column should be non empty. |
| |ii. Start Page Number column should be non empty even if PDF Page Number column is non empty. |
| |iii. TOC Level column should be non empty. |
| |iv. Include in TOC column should not have value as no |
|7 |Each Spread Sheet must have at least one value as chapter in Role column. |
|8 |If Role is defined as chapter, following validations are done: |
| | |
| |i. Both Start Page Number and End Page Number fields are mandatory. |
| |ii. Both Start Page Number and End Page Number fields have numbers with same prefix value. |
|9 |Toc Level for any given row should either be less than or should be greater than the preceding row’s level by 1 or should be |
| |equal. |
4 Custom TOC Description and Use Cases
This section elaborates the template of the Simple e-Book Spreadsheet and also provides the description of the columns mentioned in the Spreadsheet.
|S. No. |Column Name |Mandatory |Column Description / Rules |
|1 |PDF FILE NAME |NO |This is an optional column and its value will be Name of PDF File e.g. ABC.PDF. There are several use cases on how to populate |
| | | |the PDF FILE NAME Column because many a times the PDF for a title have variations. These variations are: |
| | | |One PDF File containing complete book |
| | | |Chapter by chapter PDF |
| | | |Page by Page PDF |
| | | | |
| | | |Use Case 1: Single PDF File containing complete book |
| | | |The following screen shot depicts the lay out of the Simple e-Book Spreadsheet when single PDF File contains the complete book. |
| | | |In this use case User should make sure that PDF FILE NAME Column contains the name of the PDF only once. If User repeats the |
| | | |name of the PDF file in multiple rows of the PDF FILE NAME column then system will throw a validation error message. Another |
| | | |important thing to notice here is, in the TOC ENTRY Column User can mentioned the TOC Sections like Front Matter, Chapter 1, |
| | | |Chapter 2 etc. |
| | | | |
| | | |[pic] |
| | | | |
| | | |Use Case 2: Chapter by chapter PDF |
| | | |The following screen shot depicts the lay out of the Simple e-Book Spreadsheet when there are Chapter-by-Chapter PDFs for a |
| | | |title. In this use case User should make sure that PDF FILE NAME Column contains the name of the PDF only once for a chapter. If|
| | | |User repeats the name of the PDF file in multiple rows of the PDF FILE NAME column then system will throw a validation error |
| | | |message. |
| | | | |
| | | |[pic] |
| | | |Use Case 3: Page by Page PDF |
| | | |The following screen shot depicts the lay out of the Simple e-Book Spreadsheet when there are page-by-page PDFs for a title. |
| | | | |
| | | |[pic] |
| | | | |
| | | |Important Note: |
| | | |In the Simple e-Book Spreadsheet, there should be minimum one row with proper value (e.g. ABC.PDF) in the PDF FILE NAME Column. |
| | | |System will throw a validation error if in all the rows the value of PDF FILE NAME Column is blank/empty. |
| | | |The name of the PDF FILE NAME Column should match with the PDF Files kept in the Simple e-Book Package. If file names does not |
| | | |match between the PDF FILE NAME Column value and PDFs kept in the package then system will throw a validation error. |
|2 |TOC ENTRY |NO |The value of this column is populated in the ToCEntry section of the Book Information XML. |
| | | | |
| | | |There are several use cases around TOC ENTRY column because it is directly dependent upon the PDF FILE NAME Column and INCLUDE |
| | | |IN TOC Column. Since TOC ENTRY Column is not mandatory and can have value as blank/empty so it is really important that User is |
| | | |aware of following use cases to make sure that Book Information XML gets generated successfully and Ingestion to Authoring |
| | | |Server goes flawlessly. |
| | | | |
| | | |Use Case 1: |
| | | |TOC ENTRY Column – BLANK/EMPTY |
| | | |INCLUDE IN TOC Column – YES |
| | | |PDF FILE NAME Column – Name of the PDF e.g. ABC.PDF |
| | | | |
| | | |Resolution: In this use case the ToCEntry section of the Book Information XML will be populated using the value present in PDF |
| | | |File Name Column i.e. ABC.PDF. |
| | | | |
| | | | |
| | | |Use Case 2: |
| | | |TOC ENTRY Column – BLANK/EMPTY |
| | | |INCLUDE IN TOC Column – YES or NO |
| | | |PDF FILE NAME Column – BLANK/EMPTY |
| | | | |
| | | |Resolution: In this use case User will have to enter a valid value (e.g. Front Matter etc) in either TOC Entry Column or PDF |
| | | |FILE NAME column and cannot put blank/empty value in both these Columns together. Also User need to make sure that Include in |
| | | |TOC Column has value as YES. |
| | | | |
| | | |Use Case 3: |
| | | |TOC ENTRY Column – Front Matter |
| | | |INCLUDE IN TOC Column – NO |
| | | |PDF FILE NAME Column – BLANK/EMPTY |
| | | | |
| | | |Resolution: In this use case User will have to make sure that value of INCLUDE IN TOC Column has value as YES. If it is no then |
| | | |system will throw a validation error and will log the validation error in the log file which will be sent to the User as an |
| | | |attachment in the notification e-mail. |
|3 |PDF Page |NO |The PDF PAGE NUMBERS Column of the Simple e-Book Spreadsheet represents the various PAGE RANGES appearing in a single PDF. This |
| |Numbers | |specially holds true for the title which are either represented in Single PDF or Chapter-by-Chapter PDFs. The main purpose of |
| | | |this Column is to cover different page ranges within a single PDF. Many a times single PDF has page ranges in ARABIC, ROMAN or |
| | | |TIP IN pages e.g. in the given screen shot below for CHAPTER1.PDF there are 10 pages numbered in ARABIC, 5 pages numbered in |
| | | |ROMAN numeral and 2 TIP IN Pages 4A, 4B after Page 4 and PDF PAGE NUMBERS Column depicts the format to represent it. |
| | | | |
| | | |[pic] |
| | | | |
| | | |Important Notes: |
| | | |Page ranges mentioned in the PDF PAGE NUMBERS column should be continuous and should be as per their appearance in the PDF file.|
| | | |For example, in the example mentioned below if by mistake User puts the page range 5 to 10 before 1 to 4 then system will throw |
| | | |a validation error. |
| | | |The different page ranges should be separated by COMMA as shown in the example above. |
| | | |A single page number like 4A, 4B is valid Page Range and can be entered in the PDF PAGE NUMBER column as shown above. |
| | | |The PDF PAGE NUMBERS Column need to be populated only for those entries where PDF FILE NAME Column has proper value in it. If |
| | | |PDF FILE NAME Column is blank/empty then PDF PAGE NUMBERS Column should also be blank/empty, as shown above in the example for |
| | | |ROW NO 3 (TOC ENTRY: The Scope of Anthropology). |
| | | |If a Chapter PDF start from page number 11 and ends on page number 25 with no TIP IN Pages in between or no other page range |
| | | |like ROMAN in between then in that case there is no need to populate the PDF PAGE NUMBER Column. Although if User wants they can|
| | | |put value “11 to 25” in the PDF PAGE NUMBER Column. But if User wants to be more precise then in this case User can enter values|
| | | |in the START PAGE NUMBER and END PAGE NUMBER Column as shown above where Chapter 2 page range is from 11 to 25 and it is |
| | | |populated in the START PAGE and END PAGE. In this scenario if User populates the PDF PAGE NUMBERS Column with value “11 to 25” |
| | | |and also populates START PAGE NUMBER and END PAGE NUMBER with values 11 and 25 then in this case PDF PAGE NUMBERS column will |
| | | |take precedence. |
|4 |Stat Page |NO |The START PAGE NUMBER Column of the Simple e-Book Spreadsheet represents the start page of each chapter PDF. The values in this |
| |Number | |Column could either be ARABIC or ROMAN Numerals or ALPHA NUMERAL. |
| | | | |
| | | |Important Notes (Please also refer the Important Notes section of the Column PDF PAGE NUMBERS for additional notes on START PAGE|
| | | |NUMBER): |
| | | |The START PAGE NUMBER Column has a dependency on the INCLUDE IN TOC Column. If for a row INCLUDE IN TOC Column has value as |
| | | |“YES” then START PAGE NUMBER Column cannot be left blank/empty (even if page range is specified in "PDF PAGE NUMBERS" Column). |
| | | |This field is used to determine the start page number of TOC entry. |
| | | | |
| | | | |
| | | |The START PAGE NUMBER Column and END PAGE NUMBER Column is mandatory if for a row, ROLE Column has value as “CHAPTER” and |
| | | |INCLUDE IN TOC Column has value as "YES". |
|5 |End Page |NO |The END PAGE NUMBER Column of the Simple e-Book Spreadsheet represents the end page of each chapter PDF. The values in this |
| |Number | |Column could either be ARABIC or ROMAN Numerals or ALPHA NUMERAL. |
| | | | |
| | | |Important Notes (Please also refer the Important Notes section of the Column PDF PAGE NUMBERS for additional notes on START PAGE|
| | | |NUMBER): |
| | | |The END PAGE NUMBER Column has a dependency on the PDF FILE NAME, INCLUDE IN TOC Column and ROLE Column. Basically END PAGE |
| | | |NUMBER Column cannot be blank/empty if for a row |
| | | |PDF FILE NAME Column is not blank/empty and has some value e.g. ABC.PDF |
| | | |INCLUDE IN TOC Column is not blank/empty and has value as YES |
| | | |ROLE Column has value as “CHAPTER” |
| | | | |
| | | |Following screen shot depicts the above-mentioned rules where END PAGE NUMBER Column has value: |
| | | |[pic] |
| | | | |
| | | |Other than above-mentioned use case, END PAGE NUMBER Column can have empty/blank value. |
|6 |TOC Level |NO |The purpose of this Column is to mention the level at which a particular TOC Entry should be placed. The TOC LEVEL Column is |
| | | |mandatory and cannot be left blank/empty if value of INCLUDE IN TOC Column is “YES”. |
| | | | |
| | | |Important Note: |
| | | |User should make sure that the level of a TOC Entry is as per the original FRONT MATTER PDF file. All primary TOC Entry will |
| | | |have TOC LEVEL Column value as “1” while corresponding sub levels will have value as “2”, “3” and so on. |
| | | |The value of the TOC LEVEL Column for any row should either be equal to or less than or greater than the TOC LEVEL Column value |
| | | |present in the preceding row. Although difference between the TOC LEVEL values between 2 rows can either be 0 or 1 but it cannot|
| | | |go beyond 1. |
|7 |Include in TOC|YES |The purpose of this Column is to indicate whether a TOC ENTRY value mentioned in this column needs to be added in the BOOK |
| | | |INFORMATION XML file or not. This field will have value as either “YES” or “NO”. If value is “YES” then TOC ENTRY Column value |
| | | |will be added in the BOOK INFORMATION XML whereas if value is NO then it will not be added. |
| | | | |
| | | |Important Note: Please refer the TOC ENTRY Column for additional use cases on INCLUDE IN TOC Column. |
|8 |Page Count |NO |The purpose of this Column is to provide the total page count of the PDF. This Column is mandatory if PDF FILE NAME Column is |
| | | |not blank/empty and has some value in it e.g. ABC.PDF. For a given row, this Column contains the total number of pages in the |
| | | |PDF File. |
|9 |Role |NO |The purpose of this Column is to indicate whether TOC ENTRY is having role as CHAPTER or not. As of now the valid value of this |
| | | |Column is only CHAPTER. But keeping in mind future scalability it will have more values to represent FRONT MATTER, REAR MATTER |
| | | |etc. |
| | | | |
| | | |Important Note: |
| | | |This Column can either be left blank/empty OR can have its value as CHAPTER. But other than this, ROLE Column cannot have any |
| | | |other value. |
| | | |In the Simple e-Book Spreadsheet, it is mandatory to have minimum one TOC ENTRY with ROLE as |”CHAPTER”. If none of the TOC |
| | | |ENTRY has ROLE Column value as “CHAPTER” then system will throw a validation error. |
|10 |Left image |No |The purpose of this Column is to add the image at the left of tocentry. |
| | | |Note: This not working fine currently in the eBook Application. |
|11 |Right image |No |The purpose of this Column is to add the image at the right of tocentry. |
| | | |Note: This not working fine currently in the eBook Application. |
|12 |shortdesc |No |The purpose of this Column is to add the description for the tocentry and this will be reflected in the bread crumb bar text. |
| | | |Note: This not working fine currently in the eBook Application. |
|13 |LinkX |No |This is an optional column. |
| | | |Unit of measure is POINTS and reference point is upper left corner. |
|14 |LinkY |No |This is an optional column. |
| | | |Unit of measure is POINTS and reference point is upper left corner. |
1 Custom TOC – General Important Points
|S.No |Important Points |
| |The PDF File names mentioned in the Simple e-Book Spreadsheet should also be present in the HI-RES-PDF Folder. |
| |The name of the worksheet should always be "Simple e-Book spread-sheet". Please refer the screen shot below: |
| | |
| |[pic] |
| | |
| |There should be at least one empty row between the Column header and the actual rows with the data. Please refer the attached |
| |screen shot: But system does not allow any empty rows between consecutive set of records. |
| | |
| |[pic] |
3 Custom Basket Spreadsheet:
The Curriculum Group will follow the Simple eBook Workflow steps to ingest the content in the Content Manager Content Base.
1 Custom Basket XML Creation using Custom Basket Spreadsheet
For Curriculum Group, the Custom Basket XML will be created using the Custom Basket Spreadsheet. The Custom Basket Spreadsheet format is standard and it need to be created manually. After creation of Custom Basket Spreadsheet it needs to be copied on the “assets” folder of the TITLE folder in the FTP.
[pic]
2 Sample Custom Basket Spreadsheet
[pic]
3 Spreadsheet Naming Convention
Name of the spreadsheet should be CustomBasket.xls.
Valid names:
o CustomBasket.xls
o cg_lewinski_fecon_ CustomBasket.xls
o Freeman_CustomBasket.xls
o AnnCustomBasket.xls
o Pearson_CustomBasket.xls
4 Simple eBook Custom Basket Spreadsheet Description
This section elaborates the template of the Simple e-Book Custom Basket Spreadsheet and also provides the description of the columns mentioned in the Spreadsheet.
|S. No. |Column Name |Mandatory |Column Description / Rules |
|1. |Basket Name |Yes |This is a mandatory column and it represents name of the basket that should appear on the Authoring/Viewer Tool |
| | | |Left Nav. |
| | | |The Spreadsheet Columns are Case-insensitive. |
| | | |For a given basket the value in this column needs to be entered only once if there is more than one BASKET ENTRY. |
| | | |Following screen shot depicts that for a given BASKET NAME “Custom1”, there are multiple BASKET ENTRIES: |
| | | | |
| | | |Basket Name |
| | | |Basket Type |
| | | |Basket Entry |
| | | |Basketentry Level |
| | | |Basketentry Type |
| | | | |
| | | |Custom1 |
| | | |Custom |
| | | |General Foundation |
| | | |1 |
| | | |video |
| | | | |
| | | | |
| | | | |
| | | |DNA |
| | | |2 |
| | | |audio |
| | | | |
| | | | |
| | | | |
| | | |Prenatal |
| | | |Development |
| | | |3 |
| | | |powerpoint |
| | | | |
| | | | |
| | | | |
| | | |General Foundation |
| | | |3 |
| | | |video |
| | | | |
| | | | |
| | | | |
| | | |Biological Foundations 1 |
| | | |1 |
| | | |video |
| | | | |
| | | | |
| | | | |
| | | |Biological Foundations 2 |
| | | |1 |
| | | |video |
| | | | |
| | | |Custom2 |
| | | |standards |
| | | |General Foundation |
| | | |1 |
| | | |video |
| | | | |
| | | | |
| | | | |
| | | |DNA |
| | | |1 |
| | | |audio |
| | | | |
| | | | |
| | | | |
| | | |Prenatal |
| | | |Development |
| | | |2 |
| | | |powerpoint |
| | | | |
| | | | |
| | | | |
| | | |General Foundation |
| | | |2 |
| | | |audio |
| | | | |
| | | | |
| | | | |
| | | |Biological Foundations 1 |
| | | |3 |
| | | |audio |
| | | | |
| | | | |
| | | | |
| | | |Biological Foundations 2 |
| | | |3 |
| | | |audio |
| | | | |
| | | | |
| | | | |
| | | |Cell Cycle |
| | | |3 |
| | | |crossreference |
| | | | |
| | | |English Glossary |
| | | |Glossary |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | |There should be minimum one BASKET NAME in the spreadsheet and in absence of it the Content Manager Application |
| | | |will throw a validation error and will not proceed with the ingestion. |
| | | |The size limitation on the basket name is 255 chars. |
|2. |Basket Type |Yes |This is a mandatory column and it represents the type of the basket that should appear on the Authoring/Viewer Tool|
| | | |Left Nav. |
| | | |For a given basket the value in this column needs to be entered only once. |
| | | |This column can have following possible values: |
| | | |Custom |
| | | |Standards |
| | | |Glossary |
| | | |Assessment |
|3. |Basket Entry |Yes |This is a mandatory column except for BASKET TYPE as “Glossary”. It represents name of the BASKET ENTRY that should|
| | | |appear on the AUTHORING/VIEWER Tool’s Left Nav. |
| | | |If User does not enter any value in the BASKET ENTRY column then Content Manager Application will throw a |
| | | |validation error and system will not proceed with the ingestion. |
| | | |There should be minimum one BASKET ENTRY per BASKET NAME in the spread sheet if BASKETENTRY TYPE is other than |
| | | |GLOSSARY. |
| | | |The size limitation on the basket entry is 255 chars. |
|4. |Basketentry Level |Yes |This is a mandatory column except for BASKET TYPE as “Glossary”. |
| | | |It supports multilevel BASKETENTRY. |
| | | |Following sample depicts the possible values of this filed. |
| | | |Basket Name |
| | | |Basket Type |
| | | |Basket Entry |
| | | |Basketentry Level |
| | | |Basketentry Type |
| | | | |
| | | |Custom1 |
| | | |Custom |
| | | |General Foundation |
| | | |1 |
| | | | |
| | | | |
| | | | |
| | | | |
| | | |DNA |
| | | |2 |
| | | | |
| | | | |
| | | | |
| | | | |
| | | |Prenatal |
| | | |Development |
| | | |3 |
| | | |powerpoint |
| | | | |
| | | | |
| | | | |
| | | |General Foundation |
| | | |3 |
| | | |video |
| | | | |
| | | | |
| | | | |
| | | |Biological Foundations 1 |
| | | |1 |
| | | |video |
| | | | |
| | | | |
| | | | |
| | | |Biological Foundations 2 |
| | | |1 |
| | | |video |
| | | | |
| | | |Custom2 |
| | | |Standards |
| | | |General Foundation |
| | | |1 |
| | | |video |
| | | | |
| | | | |
| | | | |
| | | |DNA |
| | | |1 |
| | | | |
| | | | |
| | | | |
| | | | |
| | | |Prenatal |
| | | |Development |
| | | |2 |
| | | |video |
| | | | |
| | | | |
| | | | |
| | | |General Foundation |
| | | |2 |
| | | | |
| | | | |
| | | | |
| | | | |
| | | |Biological Foundations 1 |
| | | |3 |
| | | |audio |
| | | | |
| | | | |
| | | | |
| | | |Biological Foundations 2 |
| | | |3 |
| | | |audio |
| | | | |
| | | | |
| | | | |
| | | |Cell Cycle |
| | | |3 |
| | | |crossreference |
| | | | |
| | | |English Glossary |
| | | |Glossary |
| | | | |
| | | | |
| | | | |
| | | | |
|5. |Basketentry Type |Yes |This is an optional column and it represents referenced FILE TYPE of each BASKET ENTRY. It will be mandatory only |
| | | |for the leaf level basket entry. |
| | | |This column can have following possible values: |
| | | | |
| | | | |
| | | |audio |
| | | |crossreference |
| | | |flash |
| | | |image |
| | | |url |
| | | |toclink |
| | | |media |
| | | |video |
| | | |excel |
| | | |pdf |
| | | |word |
| | | |powerpoint |
| | | |glossaryterm |
| | | |indexlink |
| | | |email |
| | | |virtuallearningasset |
| | | |ltilink |
| | | |ipadapp |
| | | |jazzasset |
| | | |facelessaudio |
| | | |h264 |
| | | |chromelessurl |
|6. |Link Value |Yes |This is an optional column and its value depends upon the BASKETENTRY TYPE. Following table depicts the possible |
| | | |file formats/values for a given BASKETENTRY TYPE: |
| | | |S. No. |
| | | |Basketentry Type |
| | | |Possible File Formats/values in the LINK VALUE column (Link Type) |
| | | | |
| | | |1 |
| | | |audio |
| | | |mp3 |
| | | | |
| | | |2 |
| | | |crossreference |
| | | |pagenumber |
| | | | |
| | | |3 |
| | | |flash |
| | | |swf |
| | | | |
| | | |4 |
| | | |image |
| | | |image |
| | | | |
| | | |5 |
| | | |url |
| | | |url |
| | | | |
| | | |6 |
| | | |toclink |
| | | |pagenumber |
| | | | |
| | | |7 |
| | | |media |
| | | |url |
| | | | |
| | | |8 |
| | | |video |
| | | |flv |
| | | | |
| | | |9 |
| | | |excel |
| | | |url |
| | | | |
| | | |10 |
| | | |pdf |
| | | |url |
| | | | |
| | | |11 |
| | | |word |
| | | |url |
| | | | |
| | | |12 |
| | | |powerpoint |
| | | |url |
| | | | |
| | | |13 |
| | | |email |
| | | |email |
| | | | |
| | | |14 |
| | | |virtuallearningasset |
| | | | |
| | | | |
| | | |15 |
| | | |indexlink |
| | | |pagenumber |
| | | | |
| | | |16 |
| | | |glossaryterm |
| | | |glossaryterm |
| | | | |
| | | |17 |
| | | |ltilink |
| | | |ltilink |
| | | | |
| | | |18 |
| | | |ipadapp |
| | | |Ipadapp (map://) |
| | | | |
| | | |19 |
| | | |jazzasset |
| | | |jazzasset |
| | | | |
| | | |20 |
| | | |facelessaudio |
| | | |mp3 |
| | | | |
| | | |21 |
| | | |chromelessurl |
| | | |url |
| | | | |
| | | |22 |
| | | |h264 |
| | | |Mov,mp4 |
| | | | |
| | | |If for a given BASKETENTRY TYPE, User enters LINK VALUE as URL then URL can have relative path or absolute path. |
| | | |If LINKVALUE is pointing to an asset like FLV, PPT file etc then the location of these assets could be relative or |
| | | |absolute. These files will be located on a media server. |
| | | |Note: Custom Basket Spread does not have the “link type” column therefore the above mapping has been used to assign|
| | | |the link type for the given basket entry. “virtuallearningasset” “facelessaudio”, “chromelessurl”, “h264” are all |
| | | |link types. By default Content Manager assigns “url” as basketentry to virtuallearningasset and chromelessurl, |
| | | |audio to facelessaudio and video to h264 linktype. |
| | | |Absolute Path: |
| | | |For an example if the absolute path of the any assets is |
| | | | then |
| | | |spreadsheet should be populated as given below. |
| | | | |
| | | | |
| | | | |
| | | | |
| | | |Basketentry Type |
| | | |Link Value |
| | | | |
| | | | image |
| | | | |
| | | | |
| | | | |
| | | |Relative Path: |
| | | |For example following paths are configured in the Authoring server |
| | | |[pic] |
| | | | |
| | | |For the given basketentry type as “media” the link type will be “url” (as per the mapping list given in the above |
| | | |list). Now look into the configured value of “url” in the authoring server. As per the above screenshot |
| | | | is configured for url. If any media assets |
| | | |resides at then spreadsheet |
| | | |should be populated as given below |
| | | |Basketentry Type |
| | | |Link Value |
| | | | |
| | | | Media |
| | | | /test/test.pdf |
| | | | |
| | | |Note: For the given basketentry type as “media” user can not assign any assets located at the location configured |
| | | |for flv/image/mp3/swf/virtuallearningasset in the media server. |
| | | |This is applicable for all the basketentry type as audio, flash, image, url, media, video, excel, pdf, word, |
| | | |powerpoint, virtuallearningasset, chromelessurl, h264, facelessaudio and jazzasset |
|7. |Role |Yes |This is an optional column and its possible values are “student” or “teacher” or”all”. |
| | | |If User does not enter any value in the ROLE column then Content Manager Application will use “all” as the default |
| | | |value. |
| | | |User need to make sure that they do not put any value other than the list mentioned below: |
| | | |”student” |
| | | |”teacher” |
| | | |“all” |
|8. |LinkX |No |This is an optional column but it may be required when BASKETENTRY TYPE is CROSSREFERENCE. |
| | | |Unit of measure is POINTS and reference point is upper left corner. |
|9. |LinkY |No |This is an optional column but it may be required when BASKETENTRY TYPE is CROSSREFERENCE. |
| | | |Unit of measure is POINTS and reference point is upper left corner. |
|10. |LinkWidth |No |This is an optional column but it may be required when BASKETENTRY TYPE is CROSSREFERENCE. |
| | | |Unit of measure is POINTS and reference point is upper left corner. |
| | | |Note: This is currently not supported in the eBook Application |
|11. |LinkHeight |No |This is an optional column but it may be required when BASKETENTRY TYPE is CROSSREFERENCE. |
| | | |Unit of measure is POINTS and reference point is upper left corner. |
| | | |Note: This is currently not supported in the eBook Application |
|12. |MediaWidth |No |This is an optional column and may be required only when BASKETENTRY TYPE is |
| | | |Video |
| | | |Flash |
| | | |Image |
| | | |URL |
| | | |virtuallearningasset |
| | | |h264 |
| | | |Jazzasset |
| | | |Chromelessurl |
|13. |MediaHeight |No |This is an optional column and may be required only when BASKETENTRY TYPE is |
| | | |Video |
| | | |Flash |
| | | |Image |
| | | |URL |
| | | |Virtuallearningasset |
| | | |h264 |
| | | |Jazzasset |
| | | |Chromelessurl |
|14. |Lang |Yes |For the glossary basket type, this is a mandatory column and a valid language locale must be provided when the |
| | | |glossary language is other than English, .. |
| | | |If the Basket Type is ‘glossary’ and the respective ‘Lang’ column is left blank, then the default value will be |
| | | |‘en_US’. If an appropriate value is provided in the Lang column, then this value will be used. |
| | | |The language locale is case-sensitive. |
| | | |For the ‘glossary’ basket type, , the Lang value provided in the custom basket spreadsheet will be validated |
| | | |against the ‘language’ column of the custom glossary spreadsheet. |
|15. |Wrap |No |This is an optional column. |
| | | |The possible values in this column are yes or no. |
| | | |The default value is “yes” |
|16. |Accordion |YES |This is a mandatory column and possible values in this column are YES or NO which represents whether a BASKET ENTRY|
| | | |needs to appear in the Authoring/Viewer Left Navigation or not. |
| | | |Default value is “yes” |
|17. |Platform |No |This is an optional column. |
| | | |The possible values in this column are any eText supported platform. |
|18. |iPad |No |This is an optional column. |
| | | |The possible values in this column are yes or no. |
| | | |The default value is “yes” |
|19. |Plug in |No |This is an optional column. |
| | | |The possible values in this column can be any plugin name. |
|20. |Plugin Required |No |This is an optional column. |
| | | |The possible values in this column are yes or no. |
| | | |The default value is “no” |
|21. |eText Mode |No |This is an optional column. |
| | | |The possible values in this column are “All” or “Flex” or “iPad”. |
| | | |The default value is “All” |
| | | |The value for basket type TOC, Glossary is “All” and for basket type assessment is “Flex”. |
|22 |Alternate Media Link|No |This is an optional column. |
| | | |The Alternate Media Link provides an alternative resource for the linkvalue. |
| | | |The linkvalue provided in this column has higher precedence than the linkvalue provided in Linkvalue column for |
| | | |following link types: |
| | | |SWF |
| | | |URL |
| | | |VLA |
| | | |CHROMELESSURL |
| | | |Alternate media links are alternative to the link types which are not supported on the iPad device. For example SWF|
| | | |and FLV files do not load on iPad, for these kinds of assets alternate media assets will be displayed on iPad. |
| | | |For any other link type, if alternate media link is provided then content validation will fail for that title. |
Note: User can add any extra column in the spreadsheet.
5 Custom Basket Spreadsheet Validations
Following validations checks has been added on the Custom Basket Spreadsheet.
|S.No |Validation |
| |All columns have names as specified in the CustomBasket-Specs. |
| |All columns follow the occurrence order as specified in the CustomBasket-Specs. |
| |Each Spread Sheet must have at least one value in Basket Name column. |
| |Each Basket should have at least one value in Basket Entry column if basket type is not glossary. |
| |The value in Basket Name column should be unique for the spread-sheet. |
| |Basketentry Level column cannot be left blank. |
| |Basketentry Level for any given row should either be less than or should be greater than the preceding row’s level by 1 or should |
| |be equal. |
| |For the row having leaf Basketentry Level Value, Basketentry Type and Link Value columns are mandatory. |
| |The Basketentry Type column can have one of the following values: crossreference, indexlink, audio, video, flash, image, url, |
| |toclink, media, excel, word, pdf, powerpoint, glossaryterm, email, virtuallearningasset, ltilink, ipadapp, facelessaudio, |
| |chromelessurl, jazzasset, h264. |
| |Role column cannot be left blank. |
| |Value in role column should be one of the following: all, teacher, student. |
| |If Basket Type column has value as glossary then following columns are mandatory: Lang, Accordion, and Wrap. |
| |If Basket Name column has value in it then Basket Type column is mandatory |
| |The value in Basket Type column should be one of following: custom, standards, glossary |
| |Platform column should not be null for any basketentry in assessment type basket. |
| |All basketentries in assessment type basket should have same value in Platform column. |
| |Ltilink basketentry type can only be used in assessment type basket. |
| |In eText Mode column, the value for basket type TOC, Glossary is “All” and for basket type assessment is “Flex”. |
| |If an alternate media link is provided for any other link types besides the following link types, then content validation will |
| |fail. |
| |SWF |
| |URL |
| |VLA |
| |chromelessURL |
| |If the Basket Type is ‘glossary’ in the custom basket spreadsheet, and the respective ‘Lang’ column is left blank, then the default|
| |value will be ‘en_US’.If an appropriate value is provided in the Lang column, then this value will be used. |
| |For the ‘glossary’ basket type, the Lang value provided in the custom basket spreadsheet will be validated against the ‘language’ |
| |column of the custom glossary |
6 Basket Details
• Standards baskets icons for names –
The basket name given in the bakset.xml for the “standards” basket name will be reflected in the "standards" link that appears in top ribbon for the CG Skin. System does not allow changing the “standards” icon, only custom icons and custom toolbar can be changed.
• Standard basket can have all the types of links supported by basket specification.
• Basket Entry and Basket Names both have limitation of 255 characters.
7 Simple eBook Custom Basket Spreadsheet – Important Instructions for special characters in WINDOWS Platform:
Please refer section Important Instruction for Special Characters in Windows Platform
8 Simple e-Book Custom Basket Spreadsheet – Important Instructions for special characters in MACINTOSH Platform:
Please refer section Important Instruction for Special Characters in MAC Platform
4 Custom Glossary Spreadsheet:
Custom Glossary spread sheet will be used to create the glossary2.xml, which will be used for the all the CG skin in the Authoring server.
1 Glossary XML Creation using Glossary Spreadsheet
The Glossary Spreadsheet format is standard and it need to be created manually. After creation of Glossary Spreadsheet it needs to be copied on the “assets” folder in the FTP as given below
.[pic]
2 Sample Glossary Spreadsheet
[pic]
3 Spreadsheet Naming Convention
Name of the spreadsheet should be CustomGlossary.xls.
Valid names:
o CustomGlossary.xls
o cg_lewinski_fecon_CustomGlossary.xls
o Freeman_CustomGlossary.xls
o AnnCustomGlossary.xls
o Pearson_CustomGlossary.xls
4 Simple eBook Glossary Spreadsheet Description
This section elaborates the template of the Simple e-Book Spreadsheet and also provides the description of the columns mentioned in the Spreadsheet.
|S. No. |Column Name |Mandatory |Column Description / Rules |
|1 |Glossary Languages |Yes |This is a mandatory column and it represents what languages need to be supported in the Glossary. |
| | | |The 1st row of the Glossary Spreadsheet should always start with Glossary Languages. |
| | | |If for a title there are multiple languages then languages should be separated by COMMA and there should not be any |
| | | |space between COMMAS. |
| | | |The Spreadsheet Columns are Case-sensitive. |
| | | |The languages need to be entered as their LOCALE. For example, if there are 3 languages i.e. English US and Spanish |
| | | |and French then it need to be entered as |
| | | |Glossary Languages |
| | | |es_US,en_US,fr_FR |
| | | | |
| | | | |
| | | |In the above-mentioned example the 1st language i.e. es_US is the primary language and rests of the languages are |
| | | |translation languages. |
| | | |Language Code |
| | | |Description |
| | | | |
| | | |es_US |
| | | |Spanish |
| | | | |
| | | |en_US |
| | | |English |
| | | | |
| | | |fr_FR |
| | | |French |
| | | | |
| | | |it_IT |
| | | |Italian |
| | | | |
| | | |en_CA |
| | | |English Canadian |
| | | | |
| | | |de_DE |
| | | |German |
| | | | |
| | | |nl_NL |
| | | |Dutch |
| | | | |
| | | |ja_JP |
| | | |Japanese |
| | | | |
| | | |ko_KR |
| | | |Korean |
| | | | |
| | | |sv_SE |
| | | |Swedish |
| | | | |
| | | |zh_CN |
| | | |Chinese |
| | | | |
| | | |pt_BR |
| | | |Brazilian |
| | | | |
| | | |no_NO |
| | | |Norwegian |
| | | | |
| | | |tr_TR |
| | | |Turkish |
| | | | |
| | | |pl_PL |
| | | |Polish |
| | | | |
| | | |zh_TW |
| | | |Traditional Chinese |
| | | | |
| | | |If User leaves the GLOSSARY LANGUAGES column blank then Content Manager Application will throw a validation error and |
| | | |system will not proceed with the ingestion. |
|2 |Glossary Languages |Yes |This is a mandatory column and it represents whether Glossary Term in Viewer Tool will display corresponding Glossary |
| |Display Mode | |Definition for all the languages (as mentioned in the Glossary Languages) OR it will display corresponding Glossary |
| | | |Definition for primary language. |
| | | |The possible values in the column are: |
| | | |single |
| | | |multiple |
| | | |If User enters value other than “single” and “multiple” then Content Manager Application will throw a validation error|
| | | |and system will not proceed with the ingestion. |
| | | |Note: Currently “multiple” mode is not supported in the eBook+ Application. |
| | | | |
|3 |Master Glossary Term|Yes |This is a mandatory column and needs to be entered only once if there are multiple languages for the glossary. The |
| | | |following example elaborates it: |
| | | | |
| | | |Master Glossary Term |
| | | |Language |
| | | |Term |
| | | |Term Audio File |
| | | | |
| | | |House |
| | | |en_US |
| | | |rihanna2 |
| | | | |
| | | | |
| | | | |
| | | |es_US |
| | | |casa |
| | | | |
| | | | |
| | | | |
| | | |fr_FR |
| | | |maison |
| | | | |
| | | | |
| | | |Chair |
| | | |en_US |
| | | |rihan |
| | | | |
| | | | |
| | | | |
| | | |es_US |
| | | |casat |
| | | | |
| | | | |
| | | | |
| | | |fr_FR |
| | | |maisont |
| | | | |
| | | | |
| | | |In the above example, the “house” and “chair” are master glossary term having 3 languages associated with it i.e. |
| | | |Spanish and French. As there is a separate row to represent each language so there is no need to mention the MASTER |
| | | |GLOSSARY TERM for each row. |
| | | |The size limitation on the Master Glossary Term is 1000 chars. |
|4 |Language |Yes |This is a mandatory column. |
| | | |The languages need to be entered as their LOCALE. For example, if there are 3 languages i.e. English US and Spanish |
| | | |and French then it need to be entered as mentioned below. |
| | | |User needs to ensure language mentioned in the LANGUAGE column has TERM in that language only. |
| | | | |
| | | |Master Glossary Term |
| | | |Language |
| | | |Term |
| | | |Term Audio File |
| | | | |
| | | |House |
| | | |en_US |
| | | |rihanna2 |
| | | | |
| | | | |
| | | | |
| | | |es_US |
| | | |casa |
| | | | |
| | | | |
| | | | |
| | | |fr_FR |
| | | |maison |
| | | | |
| | | | |
| | | | |
| | | |If User enters a language in the LANGUAGE column which is not identified in the GLOSSARY LANGUAGE column then Content |
| | | |Manager Application will log this error as a warning in the validation log and a notification e-mail will be sent with|
| | | |a log attached. In this case system will proceed with the ingestion. It’s the responsibility of the User to make sure |
| | | |that languages are matching between GLOSSARY LANGUAGES column and LANGUAGE column. |
| | | |If User leaves the LANGUAGE column blank then Content Manager Application will throw a validation error and system |
| | | |will not proceed with the ingestion. |
|5 |Term |Yes |This is a mandatory column representing GLOSSARY TERM. |
| | | |User need to make sure that GLOSSARY TERM mentioned in this column is in the language mentioned in LANGUAGE column. |
| | | |If User leaves the LANGUAGE column blank then Content Manager Application will throw a validation error and system |
| | | |will not proceed with the ingestion. |
| | | |The TERM and corresponding LANGUAGE should always be unique and should not be repeated. Content Manager Application |
| | | |will throw a validation error and system will not proceed with the ingestion. |
| | | |The size limitation on the Term is 1000 chars. |
| | | | |
|6 |Term Audio File |No |This is an optional column representing the Audio file name for the GLOSSARY TERM. |
| | | |User needs to make sure that Audio File is in the language listed in the LANGUAGE column. |
| | | |Note: This is not supported by eBook+ Application currently. Please use “Term and Definition Audio File” column to |
| | | |ingest Audio File for glossary. |
|7 |Definition |No |This is an optional column representing the GLOSSARY DEFINITION. |
| | | |User needs to make sure that DEFINITION mentioned in this column is as per the language mentioned in LANGUAGE column. |
| | | |The size limitation on the Definition is 1000 chars. |
| | | | |
| | | |Please refer section for Instructions on special characters. |
|8 |Definition Audio |No |This is an optional column representing the Audio file name for the GLOSSARY DEFINITION. |
| |File | |User needs to make sure that Audio File is as per the language mentioned in LANGUAGE column. |
| | | |Note: This is not supported by eBook+ Application currently. Please use “Term and Definition Audio File” column to |
| | | |ingest Audio File for glossary. |
|9 |Term and Definition |No |This is an optional column representing the Audio file name for the GLOSSARY TERM AND DEFINITION. |
| |Audio File | |User need to make sure that Audio File is as per the language mentioned in LANGUAGE column. |
| | | |The media file will be located on a media server. |
| | | | |
| | | |The location of the media file could be relative or absolute. |
| | | |Absolute: |
| | | |The complete path of media path should be populated. For example if |
| | | | is the absolute path of the |
| | | |media then it should be populated as below. |
| | | |Term |
| | | |Term Audio File |
| | | |Term and Definition Audio File |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | |Relative: |
| | | |If is configured as mp3 path in the Authoring |
| | | |Server as given below. |
| | | |[pic] |
| | | |And the “test.mpe” file is located as |
| | | | then the relative path of the |
| | | |“test.mp3” should be populated as given below. |
| | | |Term |
| | | |Term Audio File |
| | | |Term and Definition Audio File |
| | | | |
| | | | |
| | | | |
| | | |Folder1/test.mp3 |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
|10 |Media File |No |This is an optional column representing the MEDIA FILE associated with the GLOSSARY TERM. |
| | | |Possible media file type values |
| | | |image |
| | | |swf |
| | | |flv |
| | | |h264 |
| | | |The location of the media file could be relative or absolute. |
| | | |Absolute: |
| | | |The complete path of media path should be populated. For example if |
| | | | is the absolute path of the |
| | | |media then it should be populated as below. |
| | | |Definition |
| | | |Media File |
| | | |Media File Type |
| | | | |
| | | | |
| | | | |
| | | |image |
| | | | |
| | | |Relative: |
| | | |If is configured as Image path in the |
| | | |Authoring Server as given below. |
| | | |[pic] |
| | | |And the “test.png” file is located as |
| | | | then the relative path of the|
| | | |“test.png” should be populated as given below. |
| | | |Definition |
| | | |Media File |
| | | |Media File Type |
| | | | |
| | | | |
| | | |folder1/test.png |
| | | |image |
| | | | |
| | | | |
| | | |Same rule is applicable for “swf”, “flv” and “h264” media types. Please make sure that “Media File Type” column is |
| | | |correctly populated as per the type of media file provided here. |
|11 |Media File Type |No |This is an optional column but if User has entered a value in the MEDIA FILE then MEDIA FILE TYPE column needs to have |
| | | |proper value in it. For example if User has mentioned MEDIA FILE NAME as HOUSE.SWF then MEDIA FILE TYPE column should |
| | | |have value as SWF. The following example elaborates it further. |
| | | |Definition |
| | | |Media File |
| | | |Media File Type |
| | | | |
| | | |Song which people like |
| | | |test.swf |
| | | |swf |
| | | | |
| | | | |
| | | |test.png |
| | | |image |
| | | | |
| | | | |
| | | |test.flv |
| | | |flv |
| | | | |
| | | | |
| | | |Test.mp4 |
| | | |H264 |
| | | | |
| | | | |
| | | |Possible media file type values |
| | | |image |
| | | |swf |
| | | |flv |
| | | |h264 |
| | | | |
| | | | |
| | | | |
|12 |Media Width |No | |
| | | |This is an optional column. |
| | | | |
| | | |Media Type |
| | | |Height and Width |
| | | | |
| | | |Swf |
| | | |No need not to specify media height and width in the spreadsheet. SWF assets have maximum allowable size of 376x190 |
| | | |(width*height). User have to make sure that ingested swf's size is not more than 376x190 (width*height) otherwise it |
| | | |will not be rendered properly in the Glossary popup. |
| | | | |
| | | |image |
| | | |No need not to specify media height and width in the spreadsheet. Image assets have maximum allowable size of 376x190 |
| | | |(width*height). User have to make sure that ingested image's size is not more than 376x190 (width*height) otherwise it |
| | | |will not be rendered properly in the Glossary popup. |
| | | | |
| | | |Flv |
| | | |The minimum dimensions for media height and width have been set to 400 (Height) & 600 (Width). Any values less than |
| | | |these will be ignored. There is no maximum limit and user can define the actual size of flv. |
| | | | |
| | | |H264 |
| | | |The minimum dimensions for media height and width have been set to 400 (Height) & 600 (Width). Any values less than |
| | | |these will be ignored. There is no maximum limit and user can define the actual size of h264 video. |
| | | | |
| | | | |
| | | |The following example elaborates it further: |
| | | |Media File Type |
| | | |Media Width |
| | | |Media Height |
| | | | |
| | | |Swf |
| | | | |
| | | | |
| | | | |
| | | |Image |
| | | | |
| | | | |
| | | | |
| | | |Flv |
| | | |650 |
| | | |410 |
| | | | |
| | | |H264 |
| | | |600 |
| | | |400 |
| | | | |
| | | | |
|13 |Media Height |No |This is an optional column. |
| | | |Media Type |
| | | |Height and Width |
| | | | |
| | | |swf |
| | | |No need not to specify media height and width in the spreadsheet. SWF assets have maximum allowable size of 376x190. |
| | | |User have to make sure that ingested swf's size is not more than 376x190 otherwise it will not be rendered properly in |
| | | |the Glossary popup. |
| | | | |
| | | |image |
| | | |No need not to specify media height and width in the spreadsheet. Image assets have maximum allowable size of 376x190. |
| | | |User have to make sure that ingested image's size is not more than 376x190 otherwise it will not be rendered properly |
| | | |in the Glossary popup. |
| | | | |
| | | |flv |
| | | |The minimum dimensions for media height and width have been set to 400 (Height) & 600 (Width). Any values less than |
| | | |these will be ignored. There is no maximum limit and user can define the actual size of flv. |
| | | | |
| | | |H264 |
| | | |The minimum dimensions for media height and width have been set to 400 (Height) & 600 (Width). Any values less than |
| | | |these will be ignored. There is no maximum limit and user can define the actual size of h264. |
| | | | |
| | | | |
| | | |The following example elaborates it further: |
| | | |Media File Type |
| | | |Media Width |
| | | |Media Height |
| | | | |
| | | |Swf |
| | | | |
| | | | |
| | | | |
| | | |Image |
| | | | |
| | | | |
| | | | |
| | | |Flv |
| | | |650 |
| | | |410 |
| | | | |
| | | |H264 |
| | | | |
| | | | |
| | | | |
|14 |Page Number | |This is an optional column and is required only if user wishes to create a hot spot for a GLOSSARY TERM. |
| | | |User can specify more than one page number by making them comma separated. |
| | | |User needs to make sure that these numbers should match numbering scheme used in TOC spreadsheet else Content Manager |
| | | |will throw an error and system cannot proceed with ingestion. |
| | | |User needs to provide value in this column against MASTER GLOSSARY TERM only. |
|15 |Comments | |This is an optional column. |
| | | |Data in this column will not be ingested by Content Manager. |
| | | |This column is used for production notes, comments, or feedback. |
5 Simple eBook Glossary Spreadsheet – Important Instructions for special characters in WINDOWS Platform:
Depending upon the title, the GLOSSARY MASTER TERM, TERM and GLOSSARY DEFINITION may contain (math equations, symbols, sup/sub script, accented characters etc) and User need to make sure that they fill this information correctly in the Spreadsheet. The following sections explain how to fill the spreadsheet data for special characters (GLOSSARY DEFINITION column has been taken as an example but same steps can be followed for GLOSSARY MASTET TERM and TERM).
1 Equations Represented as Image:
If GLOSSARY DEFINITION contains mathematical expression then User need to make sure of following:
o User should have the image representation of all the equations.
o Once User acquires the image representation of the equations then s/he need to populate the ”MEDIA FILE” column of the spreadsheet with the name of the image. Similarly as mentioned in the section 4.2, User need to populate the MEDIA FILE TYPE, MEDIA WIDTH and MEDIA HEIGHT columns also.
o User need not enter value in GLOSSARY DEFINITION column if equation is represented as an image. If for a TERM, User has filled GLOSSARY DEFINITION column and value in any of the column “Term Audio File”, “Definition Audio File”, “Term and Definition Audio File” and “Media File” then value entered in GLOSSARY DEFINITION supersedes and system will ignore values entered in other columns.
2 Equations Represented as Expression:
If GLOSSARY DEFINITION contains mathematical expression and User wants to enter these expressions directly in the spreadsheet then s/he needs to make sure of following:
o User should know the Unicode symbol of the expression. For example if User is trying to put expression √2 + √3 = 3.14 in the excel spreadsheet then he has to perform following steps:
1) In the Glossary Spreadsheet go to the DEFINITION column.
2) Click on INSERT ( SYMBOL from the Spreadsheet menu.
3) SYMBOL pop up box will appear.
4) On the SYMBOL pop up box go to the SUBSET menu and choose “MATHEMATICAL OPERATORS”.
5) After this select SQUARE ROOT symbol as mention below:
[pic]
6) In the above screen shot, the FROM drop down value should be UNICODE (HEX).
7) In the above screen shot, copy the value from CHARACTER CODE field.
8) Close the SYMBOL pop up.
9) On the DEFINITION column, copy the UNICODE character for the square root and prepend &#x in front of it and add semi-colon (;) at the end of it. The addition of &#x is required because XML processing requires it to understand that the given value is a Unicode character. The value in the spreadsheet for √2 should be √2
10) After performing the step 9 the spreadsheet will display expression √2 + √3 = 3.14 as follows:
[pic]
Important Note:
User need to follow the above-mentioned steps whenever s/he wants to display the expression in the EXCEL spreadsheet. For this they need to know the Unicode characters for each of the character.
3 Sup/Sub Script Characters:
If GLOSSARY DEFINITION contains Sup/Sub Script then and User need to make sure of following while filling the spreadsheet:
o If user is trying to enter following expression in the spreadsheet where 2 is the Super Script then User need to perform below-mentioned steps:
[pic]
➢ In the Glossary Spreadsheet go to the DEFINITION column.
➢ Enter ax2+bx+c=0.
➢ Select 2 as shown below:
[pic]
➢ Right Click and select “FORMAT CELLS”.
➢ On FORMAT CELLS pop up, select the check box “Superscript” and click “OK”.
[pic]
➢ After step 5, the DEFINITION Column should appear as follows:
[pic]
Important Note:
User need to follow the above-mentioned steps whenever s/he wants to display a character as Sub Script and select “Subscript” on the “FORMAT CELLS” pop up.
4 Symbols:
If User wants to insert some symbols on the DEFINITION column then s/he should follow the same steps as mentioned in the Equation Represented as Expression and instead of selecting the SUBSET as MATHEMATICAL OPERATORS s/he should select the SUBSET which has the desired symbol.
5 Foreign Language Characters
▪ Open the Character Map using the following step
[pic]
▪ Use the following character Map to copy the characters.
[pic]
▪ Select the required character and copy it. After copy paste it in the spreadsheet.
6 Simple e-Book Glossary Spreadsheet – Important Instructions for special characters in MAC Platform:
Depending upon the title, the GLOSSARY MASTER TERM, TERM and GLOSSARY DEFINITION may contain (math equations, symbols, sup/sub script, accented characters etc) and User need to make sure that they fill this information correctly in the Spreadsheet. The following sections explain how to fill the spreadsheet data for special characters (GLOSSARY DEFINITION column has been taken as an example but same steps can be followed for GLOSSARY MASTET TERM and TERM).
1 Equations Represented as Image:
o Same as Equation Represented as Image.
2 Equations Represented as Expression:
To insert equations as an expression MAC User has to use CHARACTER PALETTE feature of MAC OS. By default the Character Palette feature of MAC OSX is not enabled and User will have to perform following steps to enable it:
1) Open System Preferences and click International.
2) Click Input Menu and then click the checkboxes next to Character Palette and "Show Input menu in menu bar."
Once above mentioned 2 steps are performed successfully then User needs to perform steps to insert expressions.
If GLOSSARY DEFINITION contains mathematical expression and User wants to enter these expressions directly in the spreadsheet then s/he needs to make sure of following:
o User should know the Unicode symbol of the expression. For example if User is trying to put expression √2 + √3 = 3.14 in the excel spreadsheet then he has to perform following steps:
1) In the Glossary Spreadsheet go to the DEFINITION column.
2) Open the GLOSSARY SPREADSHEET, and place the insertion point where you want the special character or symbol to appear
3) Choose Edit > Special Characters to open the Character Palette (User should click on Desktop 1st before performing this step), or click the Input menu icon in the menu bar and choose Show Character Palette.
4) Choose the type of characters you want to see from the View pop-up menu at the top of the Character Palette window.
5) After this select SQUARE ROOT symbol as mention below: [pic]
6) In the above screen shot, hover the mouse on the SQUARE ROOT symbol and it will pop up a window with Unicode value. Note the Unicode value.
7) Close the SYMBOL pop up.
8) On the DEFINITION column, insert the UNICODE character for the square root and prepend &#x in front of it and add semi-colon (;) at the end of it. The addition of &#x is required because XML processing requires it to understand that the given value is a Unicode character. The value in the spreadsheet for √2 should be √2
9) After performing the step 9 the spreadsheet will display expression √2 + √3 = 3.14 as follows:
[pic]
Important Note:
User need to follow the above-mentioned steps whenever s/he wants to display the expression in the EXCEL spreadsheet. For this they need to know the Unicode characters for each of the character.
3 Sup/Sub Script/Accented Characters:
If GLOSSARY DEFINITION contains Sup/Sub Script then and User need to make sure of following while filling the spreadsheet:
o If user is trying to enter following expression in the spreadsheet where 2 is the Super Script then User need to perform below-mentioned steps:
[pic]
1) In the Glossary Spreadsheet type ax2+bx+c=0.
2) Select 2 as shown below:
[pic]
3) Go to VIEW(FORMATTING PALETTE.
4) Open FONT menu and select 2 as shown above.
5) On FONT menu click super script.
[pic]
6) After step 5, the DEFINITION Column should appear as follows:
[pic]
4 Symbols:
If User wants to insert some symbols on the DEFINITION column then s/he should follow the same steps as mentioned in the Equation Represented as Expression
7 Custom Glossary Spreadsheet Validations
Following validation checks has been applied on the Custom Glossary Spreadsheet.
|S.No |Validation |
|1 |masterterm should be unique. |
|2 |masterterm should not be empty. |
|3 |lang value of any glossterm should be in the list of glossary languages list. |
|4 |If media is present then media width, media height and media type should not be empty. |
|5 |Combination of term and lang value should be unique across the document. |
|6 |Each masterterm cannot have duplicate lang value. |
|7 |masterterm, term , lang should not be empty. |
8 To View Glossary in the Authoring/Viewer Server
Glossary can be part of accordion control in the Authoring server, only if the glossary basket details are provided in the basket.xml. Currently Content Manager does not add the glossary basket in the basket.xml automatically. User has to create the CustomBasket Spreadsheet and create the basket.xml, having glossary details.
Following is the sample example of Custom Basket Spreadsheet which should be used to create the basket.xml.
|Basket |Basket Type |Basket Entry |Basketentry Level |
|Name | | | |
|1. |Page Number |Yes |This is a mandatory column and it represents the in book page number on which hotspot should appear on the |
| | | |Authoring/Viewer Tool Left Nav. |
| | | |The Spreadsheet Columns are Case-insensitive. |
| | | |Value in this column should be a valid page number existing in bookinfo xml otherwise Content Manager will throw an|
| | | |error in generated regioninfo.xml validation |
|2. |Region Type |Yes |This is a mandatory column and it represents the type of the region that should appear on the Authoring/Viewer Tool|
| | | |Left Nav. |
| | | |For a given region the value in this column needs to be entered only once. |
| | | |This column can have one of following possible values: |
| | | | |
| | | |audio |
| | | |crossreference |
| | | |flash |
| | | |image |
| | | |url |
| | | |toclink |
| | | |media |
| | | |video |
| | | |excel |
| | | |pdf |
| | | |word |
| | | |powerpoint |
| | | |glossaryterm |
| | | |indexlink |
| | | |email |
| | | |ltilink |
| | | |ipadapp |
| | | |jazzasset |
|3. |LinkValue |Yes |This is a mandatory column. This value represents value for the hotspot. |
| | | |If the link type refers to any assets residing on media server then the relative path of the assets should be |
| | | |provided as the linkvalue. |
|4. |LinkType |Yes |This is a mandatory column. |
| | | |The value in this column depends on the value in REGION TYPE column. Following table shows the mapping used for |
| | | |filing value in this column. |
| | | |Region Type |
| | | |Link Type |
| | | | |
| | | |Audio |
| | | |mp3, facelessaudio, url,virtuallearningasset |
| | | | |
| | | |Video |
| | | |flv, h264, url,virtuallearningasset |
| | | | |
| | | |Crossreference |
| | | |Pagenumber |
| | | | |
| | | |Indexlink |
| | | |Pagenumber |
| | | | |
| | | |Toclink |
| | | |Pagenumber |
| | | | |
| | | |Flash |
| | | |url,swf |
| | | | |
| | | |Media |
| | | |url,virtuallearningasset |
| | | | |
| | | |Glossaryterm |
| | | |Glossaryterm |
| | | | |
| | | |Image |
| | | |image, url,virtuallearningasset |
| | | | |
| | | |url |
| | | |url,chromelessurl, virtuallearningasset |
| | | | |
| | | |Email |
| | | |Email |
| | | | |
| | | |Excel |
| | | |url,virtuallearningasset |
| | | | |
| | | |Word |
| | | |url,virtuallearningasset |
| | | | |
| | | |Pdf |
| | | |url,virtuallearningasset |
| | | | |
| | | |Powerpoint |
| | | |url,virtuallearningasset |
| | | | |
| | | |Ltilink |
| | | |Ltilink |
| | | | |
| | | |Ipadapp |
| | | |Ipadapp |
| | | | |
| | | |Jazzasset |
| | | |Jazzasset |
| | | | |
|5. |Name |No |This is an optional column. |
| | | |The value in this column is displayed as tool tip on hovering mouse over the hotspot in Authoring/Viewer |
| | | |Application. |
|6 |IsIcon |No |This is an optional column. |
| | | |The value in this column represents the type of hotspot. If it’s true then it’s a icon hotspot and if it’s false |
| | | |then it’s a region hotspot. |
| | | |If user leaves this column empty then default value will be "false". |
| | | |The possible values for this column are: |
| | | |True |
| | | |False |
|7. |Icon |No |This is an optional column. |
| | | |The value of this column will be populated in icon attribute of region tag. |
| | | |If user leaves this column empty then default value will be "none" if its corresponding isicon value is false else |
| | | |if the isicon value is true then the default value will be "custom1". |
| | | |The possible values in this column are: |
| | | |none |
| | | |audio |
| | | |email |
| | | |excel |
| | | |media |
| | | |pdf |
| | | |powerpoint |
| | | |url |
| | | |video |
| | | |word |
| | | |ltilink |
| | | |ipadapp |
| | | |jazzasset |
| | | |custom1 |
| | | |custom2 |
| | | |custom3 |
| | | |custom4 |
| | | |custom5 |
| | | |custom6 |
| | | |custom7 |
| | | |custom8 |
| | | |custom9 |
| | | |custom10 |
| | | |custom11 |
| | | |custom12 |
|8. |Role |No |This is an optional column and its possible values are “student” or “teacher” or ”all”. |
| | | |If user leaves this column empty then default value will be "all". |
| | | |User need to make sure that they do not put any value other than the list mentioned below: |
| | | |”student” |
| | | |”teacher” |
| | | |“all” |
|9. |x |No |These are optional columns. They will contain x and y coordinate for hotspot respectively. If these columns are |
| | | |left blank then default value will be generated for these columns. The business rules regarding generating of |
| | | |co-ordinates are mentioned below. |
| | | | |
| | | | |
| | | |When a page has recto orientation: |
| | | |i. Icon hotspots will be generated such that they are vertically aligned, starting from the upper right hand corner|
| | | |of the page. If there are more icon hotspots to be displayed than that can be placed in one column then the |
| | | |subsequent icon hotspots will form another column towards the immediate left of previous column, this process will |
| | | |continue till the last icon hotspot has been placed. |
| | | |ii. Region hotspots will be generated such that they are vertically aligned, starting from the upper left hand |
| | | |corner of the page. If there are more region hotspots to be displayed than that can be placed in one column then |
| | | |the subsequent region hotspots will form another vertical line towards the immediate right of previous line, this |
| | | |process will continue till the last region hotspot has been placed. |
| | | | |
| | | |When a page has verso orientation: |
| | | |i. Icon hotspots will be generated such that they are vertically aligned, starting from the upper left hand corner |
| | | |of the page. If there are more icon hotspots to be displayed than that can be placed in one column then the |
| | | |subsequent icon hotspots will form another column towards the immediate right of previous column, this process will|
| | | |continue till the last icon hotspot has been placed. |
| | | |ii. Region hotspots will be generated such that they are vertically aligned, starting from the upper right hand |
| | | |corner of the page. If there are more region hotspots to be displayed than that can be placed in one column then |
| | | |the subsequent region hotspots will form another column towards the immediate left of previous column, this process|
| | | |will continue till the last region has been placed. |
| | | | |
| | | |The verso/recto orientation will be governed by the tag of bookinfo xml. If this tag is missing or is|
| | | |empty then recto will be the default orientation. |
|10. |y |No | |
|11. |Height |No |This is an optional field. This represents height of the generated hotspot. |
| | | |If user leaves this column blank then CM generates default height as "14 points" for region hotspot and "28 points"|
| | | |for icon hotspot. |
|12. |Width |No |This is an optional field. This represents width of the generated hotspot. |
| | | |If user leaves this column blank then CM generates default width as "34 points" for region hotspot and "34 points" |
| | | |for icon hotspot. |
|13. |Linkx |No |This is an optional column but it may require when REGION TYPE is CROSSREFERENCE. |
| | | |Unit of measure is POINTS and reference point is upper left corner. |
| | | | |
| | | | |
|14. |Linky |No |This is an optional column but it may require when REGION TYPE is CROSSREFERENCE. |
| | | |Unit of measure is POINTS and reference point is upper left corner. |
| | | | |
|15. |MediaHeight |No |This is an optional column and is required only when REGION TYPE is |
| | | |Video |
| | | |Flash |
| | | |Image |
| | | |URL |
| | | |This is an optional column and is required only when LINKVALUE TYPE is |
| | | |virtuallearningasset |
|16. |MediaWidth |No |This is an optional column and is required only when REGION TYPE is |
| | | |Video |
| | | |Flash |
| | | |Image |
| | | |URL |
| | | |This is an optional column and is required only when LINKVALUE TYPE is |
| | | |virtuallearningasset |
|17. |Ready to be |No |This is an optional column. |
| |published | |The value in this column determines whether or not the hotspot will be published to the viewer. If user enters the |
| | | |value for this column as "yes" then the hotspot will be published to viewer and if it has value as "no" then it |
| | | |will not be published to the viewer and if user leaves this column blank then the default value will be "no". |
| | | |This value can be toggled through Authoring Application. |
|18. |Comments |No |This is an optional column. |
| | | |This is used for writing notes related to the hotspot. |
| | | |Its value will be populated as “notes” tag of the regioninfo XML. |
|19. |Platform |No |This is mandatory column for regiontype ltilink otherwise it’s an optional column. |
| | | |The possible values in this column are eText supported platform. |
|20. |iPad |No |This is an optional column. |
| | | |The possible values in this column are “Yes” or “No”. |
| | | |The default value is “Yes”. |
|21. |Plug in |No |This is an optional column. |
| | | |The possible values in this column can be any plugin name. |
|22. |Plugin Required |No |This is an optional column. |
| | | |The possible values in this column are “Yes” or “No”. |
| | | |The default value is “No”. |
|23 |Alternate Media Link|No |This is an optional column. |
| | | |The Alternate Media Link provides an alternative resource for the linkvalue. |
| | | |The linkvalue provided in this column has a higher precedence than the linkvalue provided in Linkvalue column for |
| | | |following link types. |
| | | |SWF |
| | | |URL |
| | | |CHROMELESSURL |
| | | |VIRTUALLEARNINGASSET |
| | | |Alternate media links provide an alternative to the link types which are not supported on the iPad device. For |
| | | |example, SWF and FLV files are not compatible with the iPad, so the alternate media assets will be displayed on |
| | | |iPad instead. |
| | | |For any other link type, content validation will fail if an alternate media link is included. |
| | | |The alternate media link is not supported for the FLV link type. A content producer must use the h264 format for |
| | | |videos which are to be included in the iPad view. |
10 Custom HotSpots Spreadsheet Validation Checks
Following validation checks has been performed on Custom Hotspot spreadsheet.
|S.No |Validation |
|1 |All columns have names as specified in the CustomHotspots-Specs. |
|2 |All columns follow the occurrence order as specified in the CustomHotspots-Specs. |
|3 |Page Number, Region Type, LinkValue and LinkType are the four mandatory columns. These columns should not be left empty |
|4 |The Region Type column can have one of the following values: audio, crossreference, email, flash, glossaryterm, image, indexlink, media, |
| |powerpoint, toclink, url, video, excel, pdf, word, ltilink, ipadapp, jazzasset. |
|5 |The region type should be mapped correctly with the link type. The mapping of valid values of link type column for above region types is |
| |mentioned in Regiontype-Linktype Mapping sheet. |
|s |The IsIcon column can have one of the following values: yes,no |
|7 |The Icon column can have one of the following values: none, audio, email, excel, media, pdf, powerpoint, url, video, word, |
| |ltilink,ipadapp,jazzasset, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12 |
|8 |Either glossary or glossary2 XML should be present in ebook//xml folder if region type is glossaryterm as |
| |Content Manager looks for its corresponding glossaryentryid in glossary or glossary2 xml. |
|9 |Both glossary and glossary2 XML should not co-exist in xml folder else Content Manager will log it as error. |
|10 |The Ready to be published column can have one of the following values (or it can be empty): yes,no |
|11 |Value in role column should be one of the following (or it can be empty): all, teacher, student. |
|12 |The alternate media link is supported for only the following link types : |
| |SWF |
| |URL |
| |CHROMELESSURL |
| |VLA |
| |If a video is to be included in the iPad view, it should be formatted as “h264”. |
11 eBook Custom HotSpots Spreadsheet – Important Instructions for special characters in WINDOWS Platform:
To enter the linkvalue for the region hotspot type glossaryterm user may require entering some special characters.
Please refer section Important Instruction for special characters in WINDOWS Platform.
12 eBook Custom HotSpots Spreadsheet – Important Instructions for special characters in MACINTOSH Platform:
To enter the linkvalue for the region hotspot type glossaryterm user may require entering some special characters.
Please refer section Important Instruction for special characters in MAC Platform
13 Custom Hotspots Ingestion Use Cases:
Following are the use case to ingest the regioninfo XML using the Custom Hotspot spreadsheet.
|S.No |Use Case |Ingestion Objective|CustomHotSpot Spreadsheet Contents |
| |Precondition | | |
|1. |Page Number |Yes |This is a mandatory column and it represents the book page number on which Audio Icon should appear on the |
| | | |Authoring/Viewer Tool Left Nav. |
| | | |The Spreadsheet Columns are Case-insensitive. |
| | | |Value in this column should be a valid page number existing in bookinfo xml otherwise Content Manager will throw |
| | | |Spreadsheet Validation error. |
|2. |Audio File |Yes |This is a mandatory column and it represents the name of the audio file which will be played on the |
| | | |Authoring/Viewer Tool upon clicking on the Audio Icon. |
| | | |Value in this column should be a valid audio file name (with or without relative path) existing in media server |
| | | |otherwise Content Manager will throw Content Validation error. |
|3. |Label |No |This is an optional column. |
| | | |The value in this column is displayed as tool tip on hovering mouse over the audio icon in Authoring/Viewer |
| | | |Application. |
|4. |Language |No |This is an optional column. |
|5. |Floworder |Yes |This is a mandatory column and it represents the order of audio files to be played on the Authoring/Viewer Tool |
| | | |upon clicking on the Audio Icon. |
| | | |If for a given page there are multiple audio files then value of "Floworder" must be started from 0 and incremented|
| | | |by 1 i.e. assigned as 0,1,2,3 etc else Content Manager will throw Spreadsheet Validation error. |
|6. |X |No |This is an optional column. |
| | | |If this column is non empty then the value given will be populated in the page level XML. |
| | | |If this column is empty then some system generated value will be populated in the page level XML. |
|7. |Y |No |This is an optional column. |
| | | |If this column is non empty then the value given will be populated in the page level XML. |
| | | |If this column is empty then some system generated value will be populated in the page level XML. |
|8. |Comments |No |This is an optional column. |
|9. |Use Icon |No |This is an optional column. |
| | | |The possible values in this column are “Y” or “N”. |
| | | |The default value is “Y”. |
|10. |W |No |This is an optional column. |
| | | |The default value is “33” |
|11. |H |No |This is an optional column. |
| | | |The default value is “34” |
14 Custom Audio Text Spreadsheet Validation Checks
Following validation checks has been performed on Custom Audio Text spreadsheet.
|S.No |Validation |
|1 |All columns have names as specified in the Custom Audio Text-Specs. |
|2 |All columns follow the occurrence order as specified in the Custom Audio Text-Specs. |
|3 |Page Number, Audio File and Floworder are the three mandatory columns. These columns should not be left empty |
|4 |Value in Page Number column should be a valid page number existing in bookinfo xml otherwise Content Manager will throw Spreadsheet |
| |Validation error. |
|5 |Value in Audio File column should be a valid audio file name (with or without relative path) existing in media server otherwise Content |
| |Manager will throw Content Validation error. |
|6 |For each page “Floworder” must be started from “0”. If for a given page there are multiple audio files then value of “Floworder" must be |
| |started from 0 and incremented by 1 i.e. assigned as 0,1,2,3 etc |
|7 |Label, Language, X, Y and Comments columns are optional. |
|8 |If column values of W or H is blank then default value for both (W/H) column will be 33, 34. |
5 XML Processing Logic
Following are the xml processing logic
1. If bookinfo xml already exists then application first tries to validate it. If bookinfo xml is not valid then it aborts the remaining operation
2. If bookinfo xml is valid and manifest xml does not exist then it creates the manifest xml on the basis of bookinfo xml and the available spreadsheets (for flag).
3. If bookinfo xml is valid and an invalid manifest xml exist then it aborts the remaining operation
4. If bookinfo xml is valid and a valid manifest xml exists then it processes the operation on the basis of operations selected using UI and the flagged set in the manifest xml (content manager section). For example if bookinfo=”1” is set in the manifest xml (content manager section) then even if bookinfo xml exists it will re-create the bookinfo xml. This is same for the remaining supported flag. (Supported flag which are being processed: bookinfo, glossary, basket, pdffiles).
6 PDF Processing Logic
Following are the pdf processing logic.
1. In the Simple eBook, PDF Processing is invoked on the basis UI and pdffiles flag value given in the manifest xml for the Content manager manifest section. PDF processing is performed only for the chapter pdf which is defined in the content manager manifest section. Following table explains Content Manager’s behavior on different selection combinations of UI and manifest.xml for PDF Processing:
|CM UI Selection |pdffiles Manifest Flag |CM PDF processing |Comments |
|uncheck |0 |No |NA |
|uncheck |1 |No |NA |
|check |0 |Yes |Manifest flag will be updated to 1 by the |
| | | |application |
|check |1 |Yes |NA |
2. Following operations are performed
a. PDF cropping if the chapter pdfs are not cropped
b. Split the Chapter PDF into the page level pdfs
c. Page level pdf to swf
d. Page level pdf to thumbnail
e. Page level pdf to text
f. Validation on created swf,text and thumbnail and logged for the missing assets in the “Simple-eBook-Transformation.log” for the Simple eBook and “ContentValidationReport.log” for the Standard eBook.
g. Create the “ProcessedPagesHTMLReport.html” report having status of each page for the pdf2swf, pdf2text and pdf2thumbnail. It also has the failure reason against each page which failed in pdf processing. This report is not attached in the email. It resides in the FTP at the //ebook//logs location.
7 iPad PDF Processing Logic
Following are the iPad pdf processing logic.
• In the Simple eBook, iPad PDF Processing is invoked on the basis UI and ipadfiles flag value given in the manifest xml for the Content manager manifest section. PDF processing is performed only for the chapter pdf which is defined in the content manager manifest section. Following table explains Content Manager’s behavior on different selection combinations of UI and manifest.xml for PDF Processing:
|CM UI Selection |ipadfiles Manifest Flag |CM iPadPDF processing |Comments |
|uncheck |0 |No |NA |
|uncheck |1 |No |NA |
|check |0 |Yes |Manifest flag will be updated to 1 by the |
| | | |application |
|check |1 |Yes |NA |
• Following operations are performed
a. Process page level cropped PDFs with PDF Enhancer tool to generate low-res PDF files. There are 6 different config files available with different processing properties. Following is the order of applying these files
|S No. |Order of PEC file |
|1 |150 DPI Hidden+Raster PEC |
|2 |100 DPI Hidden+Raster PEC |
|3 |75 DPI Hidden+Raster PEC |
|4 |150 Vector PEC |
|5 |100 Vector PEC |
|6 |75 Vector PEC |
b. If the generated low-res PDF file is less than the Soft Threshold, currently set to 300KB per page, limit then pick the next page level PDF else repeat step (a) with the next level PEC.
c. If even after applying all the 6 PEC files the size of the page remains greater than the Soft threshold then application finds the best size version of the page and moves ahead to the next page.
d. Following validations are performed on the created low-res PDF files:
• Check for the missing low-res PDF files
• Check whether all the generated PDF files are less than the Hard Threshold value (currently set to 450KB per page)
If any of the above validation fails then error message is sent to the user in “Simple eBook Transformation.log” for Simple eBook and “ContentValidationReport.log” for Standard eBook.
1 Preview iPad PDFs
In the ProcessedPagesHTMLReport.html, two new columns, ‘Preview iPad PDF’ and ‘Download iPad PDF’ have been added to provide an easy review of created iPad PDF very early in the title processing life cycle.
[pic]
When the ‘Preview iPad PDF’ link is clicked, a PDF will be displayed in a new browser window (if the browser is configured to display PDFs). When the ‘Download iPad PDF’ link is clicked, an open/save dialogue box will appear and the PDF can be saved as the .pdf.
For example, when the first ‘Download iPad PDF’ link above is clicked, then the iPad PDF will be saved with a file name of ”i.pdf”. The file name of this downloadable iPad PDF is derived from the page number, not the file name of the original source PDF.
Multi-state Variant Ingestion
A Schools eText may have multiple versions associated with it: (a) National Version and (b) several State Versions. This section elaborates the work flow around ingestion of the Multi-state Variant Creation, assuming a National or Master Version is ingested first in the Authoring Tool.
Steps and Business Rules: Multi-state Ingestion:
1) Production Team User has already ingested the NATIONAL VERSION of the title.
2) To ingest the STATE VERSION of the same title, Production Team User opens the
Authoring Tool and exports the EBOOK EXPORT package of the earlier ingested National Version.
3) Once user receives the email notification of successful eBook export, log on to the Content Manager web Application and select the title whose derivative (State Variant) needs to be created.
4) Now, browse through to the “Offline Packaging” tab. In the “Generate Derivative Package” section, the values corresponding to the “Parent eBook ID”, “Workflow”, “Business Unit” fields should be pre populated with those of the title whose derivative needs to be created. If the user wishes to verify the correctness of the parent eBook ID, he/she can do so by clicking on the “verify” button. If the entered eBook ID is correct then its workflow, business unit and name of title will be displayed on the UI otherwise failure message will be shown, as applicable.
5) Now, enter the name of the derivative title and press “Generate Derivative e-Book” button. Please refer to the screen shot below for details.
[pic]
Important Notes:
i. Here title refers to the name title folder created on CM FTP.
ii. User should refrain from creating the derivative package manually and should use the CM Application.
iii. Revalidation or uploading and publishing of derivative title should be done using the simple/standard ebook workflow, as applicable.
XML Validation
1 BookInfo XML Validation
|S.No |Validation |
| |Checking the well formed and structure of bookinfo xml |
| |Checking the title information as given in "titlefolder" tag in xml |
| |Checking the bookid (bookid="cm011111") consistency as given in xml |
| |Checking the version information (1.0) against manifest xml |
| |All chapter pdf(s) with page count information mentioned in the manifest xml must be in bookinfo xml and the page count should be same|
| |for the respective chapter(s) in bookinfo xml |
| |Id attribute value of tocentry ( ................
................
In order to avoid copyright disputes, this page is only a partial summary.
To fulfill the demand for quickly locating and searching documents.
It is intelligent file search solution for home and business.
Related searches
- algebra 1 pearson textbook online
- pearson algebra 1 workbook pdf
- pearson algebra 1 textbook pdf
- algebra 1 textbook pearson pdf
- gcse 9 1 combined science pearson qualifications
- pearson education geometry practice 5 1 answer key
- pearson edexcel level 1 2 2021
- pearson edexcel level 1 2 mathematics 2021
- pearson edexcel level 1 level 2 gcse 9 1 mathematics
- pearson edexcel level 1 level 2 gcse 9 1
- pearson edexcel level 1 level 2 gcse 9 1 mathematics markscheme
- pearson edexcel level 1 level 2 gcse 9 1 mathematics markscheme 2021