- Understand Developer Archives
- Understand Developer Archives
- "edf30824-adcd-4440-9304-39f0b63b8324
- The export process writes all of the selected content to a single compressed archive file with the extension odarc. The import process then takes a single odarc file as input to re-create the contents of the archive in the current Library. Therefore, to exchange documents between libraries, you need not open any archive files. However, if you plan to edit any documents contained in an archive outside the Developer, you need to
- extract
- Extract a Developer Archive
- Recompress a Developer Archive
- Import/Export Content
- Each archive file consists of several components representing the documents it contains and their relative structure. In particular, the archive consists of an archive manifest and a folder for each document, labeled with the Document ID. The manifest lists all of the Library folders and documents included in the archive, and each document folder in the archive contains all necessary information and files required to re-create the document in the Developer upon import. The specific contents of each archive folder therefore depend on the type of document, as summarized later in this section.
- Manifest File
- The manifest file therefore functions as a table of contents for the archive, defining the documents it contains and their relative folder structure. Upon import, the Developer reads the manifest and verifies that appropriate archive folders exist for all documents listed therein. All of the documents specified in the manifest must be present for the archive to be imported. This manifest information then directs how the archived documents are re-created during import from the contents of the archive folders.
- Warning!
- Module/Section Archive Folder
- section.xml: List of several properties of the module/section, including document schema, template, glossary (if assigned), screen resolution, and directly linked children
- linksto.xml: List of Document IDs of all documents directly linked as children of the module/section, as well as the template and glossary (if assigned)
- search.xml: Search proxy file used to speed text search, spell checking, and glossary markup in the Developer
- The archive folder for each topic contains the following three files, as well as a varying number of graphics files depending on the number of frames in the topic:
- Topic Archive Folder
- topic.xml: List of several properties of the topic, including document schema, template, glossary (if assigned), screen resolution,
- play modes
- linksto.xml: List of Document IDs of all linked attachments and link icons, as well as the template and glossary (if assigned)
- search.xml: Search proxy file used to speed text search, spell checking, and glossary markup in the Developer; includes all searchable text in the topic, such as bubble text, keywords, and decision frame text
- .png: Graphics files containing screenshots for all frames, numbered in the same order as the frames in the Frame Structure window of the Topic Editor
- n
- The archive folder for each package contains the following subfolder:
- Package Archive Folder
- Parts subfolder: Contains all package files and folders, if applicable
- The archive folder for each web page contains the following three files and one subfolder:
- Web Page Archive Folder
- webpage.xml: List of properties of the web page, including document schema and glossary (if assigned)
- linksto.xml: List of Document IDs of any packages or other web pages linked through hyperlinks inserted in the web page; also includes glossary (if assigned)
- search.xml: Search proxy file used to speed text search, spell checking, and glossary markup in the Developer; includes all searchable text in the web page, such as visible text and hyperlink tooltips
- Parts subfolder: Contains index.html, the web page document itself; also contains an images sub-subfolder for embedded graphics, if used in the web page
- Images inserted in a web page from a package are represented in index.html by the "file not available" indicator
- Note:
- Images inserted in a web page from a URL remain linked and visible in index.html.
- Glossary Archive Folder
- glossary.xml: List of glossary terms, including Document IDs or URLs of definition links, tooltips, and matching conditions (match whole word, match case)
- linksto.xml: List of Document IDs of packages and web pages used as definition links (does not include URL definition links)
- search.xml: Search proxy file used to speed text search, spell checking, and glossary markup in the Developer; lists text of all glossary terms and tooltips
- The archive folder for each role document contains the following file:
- Role Archive Folder
- roles.xml: List of the roles included in the role document
- search.xml: Search proxy file used to speed text search, spell checking, and glossary markup in the Developer; lists text of each role
- The archive folder for each template contains the following two files:
- Template Archive Folder
- template.xml: Detailed listing of all template components, such as context-specific template bubble text and associated sound files
- template.xsl: Style sheet transformation file for processing the template
- The contents of the archive folder for a publishing style depend on the specific output format selected. In general, each publishing style includes files with instructions for executing the publishing process (the two most important being project.xml and style.xml), as well as components needed to build the output. Also included are settings for the publishing style in the Developer Publishing Wizard and options pages.
- Publishing Style Archive Folder
- The types of components included in a publishing style vary depending on whether the selected publishing format is a document or Player output. For example, styles for document outputs include document templates, as well as logos, style sheets, and style sheet transformation files. Styles for Player-type outputs require many more components, including style sheets and associated transformation files, graphics and icons, framesets and default frame pages, and JavaScript programs for managing Player-specific functions such as displaying attachments.
- See the
- Customize Publishing Styles
- Publish Content