SiberSafe S1000D Evaluation Guide

Transcription

1 This manual is property of SiberLogic Inc and is available for use ONLY by authorized personnel. Reproduction of this manual in whole or in part without written permission from SiberLogic Inc is strictly prohibited. This manual is made available for authorized personnel to perform their assigned duties and is not designed to be contrary to any applicable statutory, federal or foreign regulation. Publication No. Revision No. 002 SiberSafe CMS Page 1

2 List of Effective Data Modules Document Title Data Module Code Issue Date Evaluation Overview A1-AAA A-A904-A Author Studio Configuration A1-AAA A-A103-A Author Studio Login A1-AAA A-A103-A Create SNS A1-AAA A-A102-A Create a data module with an explicit information code A1-AAA A-A109-A Check out a data module for editing A1-AAA A-A109-A Author a descriptive data module A1-AAA A-A109-A Author a procedural data module A1-AAA A-A106-A Add a data module reference to a data module A1-AAA A-A106-A Add an illustration to a data module A1-AAA A-A109-A Editor commands A1-AAA A-A109-A Import illustrations A1-AAA A-A102-A Create an sns-based publication module A1-AAA A-A10B-A Publish a publication module A1-AAA A-A10B-A List of effective data modules Page 2

3 Table of Contents Evaluation Overview Evaluation Overview Configure for evaluation Author Studio Login... 7 Author S1000D content Author Studio Configuration Create SNS Create a data module with an explicit information code Author a descriptive data module Author a procedural data module Check out a data module for editing Add a data module reference to a data module Editor commands Import illustrations Add an illustration to a data module Publish S1000D content... Create an sns-based publication module Publish a publication module Table of Contents Page 3

4 Evaluation Overview Evaluation Overview Procedure 1 Download your installation package from ftp://ftp.siberlogic.com/download/ evaluation/ssf-author-studio.exe 2 Execute and locally install the installation package 3 Launch through Microsoft Windows application menu (it will appear under SiberLogic category) 4 Configure as described in : Author Studio Configuration using the following Host Name: 5 Log into our SiberSafe Evaluation Server as described in : Author Studio Login using the following credentials: User name: s1000d Password: evaluation 6 Familiarize yourself with the Editor commands described in SiberSafe Editor: Editor commands 7 Create the Standard Numbering System (SNS) structure as described in : Create SNS 8 Create and author your descriptive data modules as described in SiberSafe Editor: Author a descriptive data module 9 Create and author your procedural data modules as described in SiberSafe Editor: Author a procedural data module 10 Instantiate and generate your publication module(s) as described in : Create an sns-based publication module 11 Publish your publication module(s) into PDF (using the FO publishing channel) or into IETM as described in : Publish a publication module A1-AAA A-A904-A SiberSafe CMS Page 4

5 Configure for evaluation Author Studio Configuration 1 is a client component of a client-server environment. Before you can start working with Studio you need to configure server connection parameters. To do so, 1. Launch the. 2. Press the Options button. 3. In the dialog that appears, press the Add button to add a host. 4. In the Edit Host dialog, enter: The name of the new host The host URL A1-AAA A-A103-A Page 5

6 The path to the working folder. The working folder is a file folder on your desktop that will be used by the as temporary storage for your content and system information. It will be synchronized with repository after you logon and after you check in or out your files. 5. Finally, click OK. The newly added host will appear in the Hosts dialog. 2 If the XHTML-based legacy content transformation features of are to be used, it has to be configured to open.xhtml documents in the built-in XML editor using the following steps: 2.1 Select Login/Preferences menu command. 2.2 Expand the General/Editors/File Associations branch. 2.3 Add a new ".xhtml extension using "Add" button at the top of the dialog box and associate it with the buitin XML editor using the "Add" button at the bottom of the dialog box. A1-AAA A-A103-A Page 6

7 Author Studio Login Before logging in to the SiberSafe server, make sure that the SiberSafe server and Web Access service are running. Perform the following steps to log in to the SiberSafe : 1. Launch the. 2. Press the Login button and select the appropriate host from the selector in the dialog that appears. 3. Click OK. 4. In the dialog that appears, enter your user name and password in the corresponding fields. Click OK. 5. In the Select Working Stream dialog, select the stream you are going to work with. If the stream you need is not visible, reconfigure stream visibility. To do so, a. Press the Select visible streams button. A1-AAA A-A103-A Page 7

8 b. In the Invisible Streams pane, select the stream you want to make visible and press the arrow button to move the selected stream to the Visible Streams pane. c. If you want to make a stream invisible,, select the desired stream in the Visible Streams pane and press the arrow button to move the selected stream to the Invisible Streams pane. d. Finally, press OK. 6. You can also take advantage of the Synchronize working folder function, which makes it possible to synchronize the selected stream with the working folder. This may be necessary if you retrieved the file to your working folder and then made changes to the file in the repository. Obviously, the repository file will contain changes that are not present in the working folder. If you enable the Synchronize function, the changes from the repository file will be added to the version in the working folder. This will prevent the changes to the repository file from being overwritten when you return the file from your working folder to the repository. To enable the function, tick the Synchronize working folder checkbox. If you want to disable this function, you just need to clear the Synchronize working folder checkbox. 7. Finally, press OK. 8. If you decide to tick the Synchronize working folder checkbox, you will have to wait for the synchronization to be completed. 9. Once you have logged in, all the SiberSafe functions will become available in the the Author Studio. A1-AAA A-A103-A Page 8

9 Author S1000D content Create SNS Procedure 1 In the Explore Repository of the, switch to the Semantics mode. 2 Switch to the SNS perspective. 3 Select the project where you want to create an SNS. A1-AAA A-A102-A Page 9

10 4 In the Relationship combo-box, select Project Includes System. 5 Enter the name of the new SNS in the Label field. 6 Press the Add Resource button. 7 The newly created SNS will appear under the project. A1-AAA A-A102-A Page 10

11 Create a data module with an explicit information code Procedure 1 In the Explore Repository of the, switch to the Semantics mode. 2 Switch to the SNS perspective. 3 Select the project where you want to create an SNS. A1-AAA A-A109-A Page 11

12 4 In the Relationship combo-box, select SNS Item Applies To Data Module. 5 Enter the name of the new data module in the Label field. 6 In the Resource Type combo-box, select a data module type. 7 Press the Add Resource button. 8 The newly created data module will appear under the selected system. 9 Assign the newly created data module its information code: 9.1 Open another Explorer widget and switch it into the IC (Information Code) Perspective. 9.2 In the IC Perspective, navigate to the desired Information Code. Use "+" button to select a specific code under a code category. 9.3 Use 'drag-and-drop' or 'copy-and-paste' techniques to associate desired information code with the newly created data module. 10 Generate a definition topic for the data module. A1-AAA A-A109-A Page 12

13 11 Apply the Edit command to the data module. 12 The new data module will open in the editing environment. Observe the techname element match the name of the previously selected SNS item and the previously entered data module placeholder title and the infoname match the name of the previously selected information code. A1-AAA A-A109-A Page 13

14 Check out a data module for editing Procedure 1 In the Semantics mode, switch to the SNS perspective. 2 Navigate to the data module that needs editing. 3 Press the Edit button. 4 The definition topic of the selected data module will open in the. A1-AAA A-A109-A Page 14

15 5 If the data data module has no definition topic, you will be prompted to generate one. Press the Generate button in the dialog that appears. The newly generated definition topic will open in the. A1-AAA A-A109-A Page 15

16 Author a descriptive data module Procedure 1 Check out an existing descriptive data module as described in : Check out a data module for editing or create a new one as described in : Create a new data module with a task-based information code or : Create a data module with an explicit information code 2 Add plain (not numbered/levelled) paragraphs by inserting <para> elements into the <description> section of the descriptive data module. 3 Add levelled (numbered) paragraphs and sub-paragraphs by inserting <levelledpara> elements into the <description> of the descriptive data module. 4 Add tables using "Insert Table" command in the main toolbar of (refer to SiberSafe Editor: Editor commands ) 5 Add illustrations as described in SiberSafe Editor: Add an illustration to a data module 6 Add bulleted lists by insering <randlist> elements and <listitem> sub-elements. 7 Add numbered lists by inserting <seqlist> elements and <listitem> sub-elements. 8 Add warnings and cautions using <warning> and <caution> elements, respectively. A1-AAA A-A109-A SiberSafe Editor Page 16

17 Author a procedural data module Procedural data modules are used to create a hierarchy of steps and substeps. Procedure modules can also contain description of necessary spares, equipment and supplies, required personnel, time to complete, and safety alerts. Procedure modules end with required actions after job completion (put away equipment etc.) The element must be populated with <preliminaryrqmts>, <mainprocedure> and <closerqmts> elements. The <mainprocedure> element can contain the following elements: <proceduralstep> is used to ducument a step in a procedure. A step can be broken down into substeps by including another element <proceduralstep>. A procedural step can contain any common element. <figure> is used to insert images. The figure consists of a title and one or more illustrations. It can also contain a legend. <multimedia> is used to contain multimedia objects. <foldout> is used to contain a figure, or table which is larger than the default size <table> is used to contain tables. To insert tables, use the Insert Table button in the toolbar To insert other elements, press CTRL+ENTER and select the desired element from the drop-down menu. A1-AAA A-A106-A SiberSafe Editor Page 17

18 Add a data module reference to a data module Procedure 1 In the Repository Explorer, switch to the SNS perspective and open a data module for editing as described in : Check out a data module for editing 2 Place the Repository Explorer and Edit console next to each other. 3 In the Repository Explorer, pick up the data module to be inserted. 4 Drag the data module to the Edit console and drop it at the desired location. A1-AAA A-A106-A SiberSafe Editor Page 18

19 A1-AAA A-A106-A SiberSafe Editor Page 19

20 Add an illustration to a data module Procedure 1 If the illustration(s) to be referenced has not yet been placed into the repository, imoprt your illustration(s) as described in : Import illustrations 2 Open a data module for editing. 3 Insert a figure tag and specify the figure title by inserting a title tag within the figure tag. 4 In the Repository Explorer, switch to the Folder mode. 5 In the Link Type Selector combo box, select graphic link type. 6 In the Content Explorer widget, navigate to the illustration you want to add to the data module. 7 Select the illustartion in the Repository Explorer, drag-and-drop it to the desired location in the data module in the Edit console. 8 Set the caret within the figure element where the graphic tag is to be inserted. A1-AAA A-A109-A SiberSafe Editor Page 20

21 9 The inserted image will appear in the current document. A1-AAA A-A109-A SiberSafe Editor Page 21

22 Editor commands Save to the working folder (CTRL+S) Stores locally all the unsaved modifications to the currently open document in the currently active Editor widget. Check in Saves locally and then sends to the central repository all the unsaved modifications of the currently open document in the currently active Editor widget. The document is subsequently unlocked in the central repository. Undo check in Closes the currently open document in the currently active Editor widget discarding both the locally saved or unsaved changes; unlocks the document in the repository. Validate Validates the XML document in the currently active Editor widget against its schema or DTD. The validation error log can be seen in the Validation Log widget (see below how to open one). Edit attributes Opens an XML Attribute Editor in a separate view. The Attribute Editor displays the attributes of the currently selected element in the currently active Editor widget. Duplicate selection Creates a duplicate of the selected content and inserts it next to the selection, if valid. Insert an element (CTRL +ENTER) Shows a pop-up menu with the choice of elements valid for insertion at the current location in the document. The element list can be further filtered by typing in a sequence of characters to be looked for in element names. Select the element to be inserted and either click on it or press ENTER to insert. Split an element (ENTER) Splits the current element in two, if possible (if valid from the schema or DTD validation standpoint). This is a convenient way of adding new paragraphs, list items etc. Replace an element (CTRL +ALT+ENTER) Shows a pop-up menu with the choice of elements valid that are valid to replace the current element at the current location in the document. The element list can be further filtered by typing in a sequence of characters to be looked for in element names. Select the element to be inserted and either click on it or press ENTER to insert. Forcefully delete the selection (CTRL+SHIFT+DEL) Removes the selection regardless of whether or not this operation invalidates the document. Move one word to the right (CTRL+RIGHT) Moves the caret one word to the right. A1-AAA A-A109-A SiberSafe Editor Page 22

23 Move one word to the left (CTRL+LEFT) Moves the caret one word to the left. Move to the end of the line (END) Moves the caret to the end of the current line. Move to the start of the line (HOME) Moves the caret to the end of the current line. Move a page down the document (PAGEDOWN) Moves the caret one screen down the document. Move a page up the document (PAGEUP) Moves the caret one page up the document. Move to the end of the document (CTRL+END) Moves the caret to the end of the document. Move to the start of the document (CTRL+HOME) Moves the caret to the start of the document. Undo (CTRL+Z) Undoes the most recent change in the document. Redo (CTRL+Y) Restores the most recently undone change in the document. Copy (CTRL+C) Copies the selection into the clipboard. Paste (CTRL+V) Pastes the clipboard contents into the current location in the document, if valid. This command will fail if the insertion results into an invalid document. Cut (CTRL+X) Copies the selected content into the clipboard and attempts to remove it from the document. This command will fail if the removal results into an invalid document. Open validation log (ALT +SHIFT+Q,X) Opens the validation log view ( SiberSafe Editor: Validate content). Remove the previous character or the selection (BACKSPACE) Removes the previous character or tag. Remove the next character or the selection (DEL) Removes the next character or tag. Fix spelling (F8) Shows the list of available spelling alternatives in Spelling Editor ( SiberSafe Editor: Spell-check content). Previous spelling error (F6) SiberSafe Editor: Spell-check content A1-AAA A-A109-A SiberSafe Editor Page 23

24 Next spelling error (F7) SiberSafe Editor: Spell-check content Push spelling (F9) SiberSafe Editor: Spell-check content Generate hotspot definitions SiberSafe Editor: Generate the hotspot table for a CGM illustration Up-issue a data module Sets the publishing date of the data module to the current date, increments the issue number, resets to 0 the in-work number, removes the change markup and annotation markup. Insert comment Inserts an XML command at the current location in the document. Insert table Insert a CALS table template the current location in the document. This command will fail if a CALS table is not valid at the current location. Insert Object From Disk Inserts a reference to an illustration or multimedia object from the local disk by first uploading it to the CSDB, similar to SiberSafe Editor: Add an illustration to a data module Insert Link Inserts a cross-reference to another data module or data module fragment, similar to SiberSafe Editor: Add a data module reference to a data module Insert Object Inserts a reference to an illustration or a multimedia object alredy stored in the CSDB, similar to SiberSafe Editor: Add an illustration to a data module A1-AAA A-A109-A SiberSafe Editor Page 24

25 Import illustrations Procedure 1 In the Repository Explorer, right-click on the stream and press the Add Content button. Fig 1: Toolbar command: Add Content 2 Select the Import Archived Content option and click Next. A1-AAA A-A102-A Page 25

26 Fig 2: Dialog: Add Content (tab: Select Action) 3 Select the destination folder, where the content will be imported, and click Next. A1-AAA A-A102-A Page 26

27 Fig 3: Dialog: Add Content (tab: Select Target Location Path) 4 In the Select File From Disk window, press the Browse button, select the archive with illustrations to be imported and click Finish. A1-AAA A-A102-A Page 27

28 Fig 4: Dialog: Add Content (tab: Select File From Disk) 5 The imported illustrations will appear in the repository. A1-AAA A-A102-A Page 28

29 Fig 5: Imported content A1-AAA A-A102-A Page 29

30 Publish S1000D content Create an sns-based publication module Procedure 1 In the Explore Repository of the, switch to the Semantics mode. 2 Switch to the SNS perspective. 3 Select the project you want to create a publication module for. A1-AAA A-A10B-A Page 30

31 4 In the Relationship combo-box, select Project Includes Publication Module. 5 Enter the name of the new data module in the Label field. 6 In the SNS Publication Module combo-box, select a data module type. 7 Press the Add Resource button. 8 The newly created publication module will appear under the selected project. A1-AAA A-A10B-A Page 31

32 Publish a publication module Procedure 1 Select the publication module to be published. 2 Press the button Publish Object. 3 In the dialog that appears, select a publication group and press the Next button. 4 Next, select a saving option and press the Finish button. A1-AAA A-A10B-A Page 32

33 5 Once the publication has completed, save the document to a local disk. Alternatively, if the Leave on Server delivery option was selected, the published materials can be downloaded from the server using Publishing Jobs... command from Content Explorer toolbar. A1-AAA A-A10B-A Page 33

34 SiberSafe CMS Page 34