1
How to use the NAVSEA
Class 2 ETM DTD within the
Navy Publishing System at
NSWCCD-SSES
June 2010
2
Index
Slide Number
Section I. Overview of Revision Process……………………………..3- Legacy Flowchart
- NADCP Flowchart
Section II. Account Request Information……………………………...9
Section III. Arbortext Editor Setup Instructions……………………....13
Section IV. Initial Login Instructions…………………………………...32
Section V. Request / Create Project/SubProject…………………….48
Section VI. Editing SGML……………………………………………….69
Section VII. Publishing / End Project/SubProject………………...…..165
Section VIII. System Administration……………………………..……..192
3
Section I
Overview of Revision Process
Legacy TM Flowchart and
NADCP TM Flowchart
4
Legacy TMs
This chart will show the correct process for requesting,
editing and finalizing Legacy Tech Manuals for correct
Contenta processing
5
Requesting a Legacy Book-
done by creating a project in
Contenta (same as all TMs. Make
sure last review is FI in TDMIS).
Update Baseline- Done by
Compose, Baseline then
Baseline Updates
Update Baseline Fails Update Baseline Successful
Error Message-Not
Blessed.
Someone locked it, or
already been updated
Nothing happens–
Baseline was never run
Error Message-
Out of Sync. Out
of order or wasn’t
run in system
Contact previous TMMA
(via TM Track or TDMIS,
person who ran last)
A System Administrator
needs to delete “false”
Baseline (placeholder)
User runs Baseline-
Update Baseline
If given a change contact System Administrator, if not,
(Tools for TM) - Run Reissue Preparation- puts the manual in Revision Mode
6
First, Update/Edit Front Matter(Epic Check Out)
Insert Revision tag (if necessary)- in which case
Delete change num and change date tags
If there is a Rev num and Chg num,
Add “1” to Rev num and Chg num (if
change num is a letter value, contact
System Administrator)
Epic Check In (Front Matter)
Run Print Final, (not Baseline) (Tools for TM)
Update/Edit Body (Epic Check Out)
Run Print Final (Tools for TM) and
For TMPODS (Tools for TM - Compose)
MasterProject- Forward Project to EndProject Manager then
deletes Project
SubProject- Forward
to Final Review
7
NADCP TMs
This chart will show the correct process for requesting, editing and finalizing NADCP
Tech Manuals for correct Contenta processing
8
Requesting a NADCP Book- done by
creating a project in Contenta (same as all
TMs).
Compose Baseline (Tools for TM Object)
Epic Check Out- Edit SGML of Front,
(in accordance with TDMIS) BODY and REAR
Insert Revision tag (if necessary)-
Delete change num and change date tags
Epic Check In- (with all necessary changes up to date)
Re-run Compose- Baseline- (Tools for TM Object)
Run For TMPODS (Tools for TM - Compose)
MasterProject- Forward Project
to EndSubProject- Forward
Project to Final Review
Project Manager
then
deletes Project
9
Section II
Account Request Information
Gaining user account will allow
access to database
JCALS/Citrix/Contenta to edit TMs
10
Requesting Account
• Access to the NAVLOGTD Home Page is
provided only to those users that have a valid
DoD email certificate.
• To access the site, go to
https://navlogtd.navsses.navy.mil/
• Please ensure that you select your DoD
email certificate or an error will be displayed.
11
Requesting Account
The screen below will be presented.
Definitions for each option are on the next page
12
User Home Page Definitions
• CITRIX Login – Select to gain access to NAVLOGTD. (You must already have an account.)
• Request Access – Select this page to request access to NAVLOGTD. See next page for additional details.
• My Certificate Changed – Select this if you already have a CITRIX account, but your certificate has changed.
13
Request Access Page
• Selecting Request Access located on the Home
Page will display the screen on the next page.
Enter information in all required fields.
• You must select “Show Advanced Options”
and select the database(s) you need editor
access to.
• After completion, select “Submit” to begin
processing the application. Select “Cancel” to
end the transaction.
14
15
Section III
Arbortext Editor
Setup Instructions
Ordering and setting up the program Arbortext Editor which is used to
Edit SGML
(This can be setup before you gain access to Citrix/JCALS/Contenta or have any certificates
although it is suggested to request accounts first)
16
1. Obtain the program, Arbortext Editor with a
License
For NMCI users, 5.1F is the current approved version. Non-NMCI users should use version 5.1F or higher, no higher than version 5.3.
Ordering Arbortext Editor and a license can be done by contacting a sales representative at PTC:
North America(1) 888-PTC-3776 or (1) 888-782-3776
An Arbortext program disk can be used if one is available but one license is needed per user
An account should be created at www.ptc.com or with a sales rep over the phone to set an email address where licenses can be sent and managed.
17
2. Install Arbortext Editor with default settings
18
19
20
21
22
23
Both types of
licenses should be
chosen for
necessary flexibility.
24
25
The Server Code should be
copied and pasted to the website.
User/Server Name is the name
of your machine
The Key will be sent via
Email to the user account address.
Copy and Paste the Key into
the window above.
After the installation completes, this
window will appear containing the server
code and asking for a Key. If this does not
appear it can be found at, c:\Program Files\Arbortext\Editor\bin\licadmin.exe
The Key can be found when a request is
made for a license from the PTC website
26
When this message is received
Arbortext Installation
is complete, Click OK
The Key will be sent via
Email to the user account address.
Copy and Paste the Key into
the window.
Click Install Key
Arbortext should open but more
setup needs to be completed
for SGML/Contenta format
recognition.
27
3. Create a directory called doctypes at the
root of the c:\ drive
28
4. Paste the 970930na directory into this doctypes folder
NOTE: The 970930na
folder must be changed
to NOT be Read-only
29
5. Go to c:\Program Files\Arbortext\Editor\doctypes
and open the catalog file with a text editor such as
notepad.
30
6. Paste the following line of text to the bottom with no hard returns and no
extra spaces (spaces and returns are critical in this application).
Note: The drive letter should match the drive used for doctypes on your
PC, in this example d is used.
PUBLIC "-//USA-DOD//DTD NAVSEA ETM Class 2 REV C VER 1.2 970930//EN" "d:\doctypes\970930na\970930na.dtd“
31
7. Copy the five command files (.cmd) into the
c:\doctypes folder(These files may need to be changed so they are NOT Read-only)
32
8. Modify c:\ProgramFiles\Arbortext\Editor\lib\init.acl
Paste the following text into the bottom of this file using a text editor such as notepad:
source C:\doctypes\EpicEditCatDebug.cmd
source C:\doctypes\EpicEditCatUtils.cmd
source C:\doctypes\EpicEditCatComDlg.cmd
source C:\doctypes\EpicEditCatMain.cmd
33
To verify this setup worked correctly, there should be a
Content@ menu available when you open Arbortext
Abortext setup is now complete to handle TM editing and
the NAVSEA document type.
The next step is to obtain the correct Certificates in order
to access Citrix/JCALS/Contenta and TDMIS websites.
34
Section IVInitial Log In Instructions
35
8. Set Preferences
Once in Web Content@, Click Preferences
36
In the Checkout Directory and Import
Directory window, enter v:/checkout
Note: "v:\" is a mapped drive to your "c:\"
hard drive as seen by Content@. So
"v:\checkout" in Content@ is "c:\checkout"
on your hard drive.
Although any directory on the hard drive can
be used as a checkout directory,
"v:\checkout" was chosen as the standard
to avoid problems which may arise from
different file naming conventions used.
Hit “Ok” to exit Preferences
37
9. Set the ICA Client File Security
When the ICA Client Window
appears, the ICA Client File
Security should be set to
Full Access
and Never ask me again for
any application
This window can be accessed
when clicking on
icon on the
windows taskbar in the bottom right
corner.
Click “OK”
Initial Logon Complete.
38
Section V
Request / Create
Project / SubProject
This section details instructions on how to request a
manual and create a project or subproject
39
First step is to click the
Tools link next to the CP_username Project in the Inbox.
40
Click Create Project
Create Project
41
Click Yes/OK to Security Alerts
42
Choose Legacy or
NADCP Configuration
Enter Publication
Number of manual
Enter “project” as
Password
Hit Locate
43
Content@ searching for manual
44
If the manual is available, select the
box and choose your TMMA approver/Project Manager from the drop menu
Hit Create Projects
45
Sending Notification of request…
46
If Request was successful this message will appear. The TMMA
approver now has to send the Project which will show up in your inbox
with notification. Exit or select another manual
47
Creating a SubProject
After a Master project is sent to ones Inbox, the project can be
made a subproject and forwarded to another editors Inbox.
First click on Tools for the MasterProject.
48
Click
New Object and scroll to choose SubProject
49
Give a Name to the SubProject
Choose the Workflow Template
From the drop menu that
should have been setup
by a Program Manager
50
Hit “Ok” when finished making name and
selecting workflow
51
The SubProject should be visible.
Next, click Tools for the TM object
52
Click Reuse To Project
53
The Project should already be highlighted, Hit “Ok”
54
Verify the TM was copied into the SubProject by
expanding [+] the SubProject
55
To send a project to someone else in the workflow select the
Tools for the SubProject
56
Choose Forward
57
Choose the “User” in the workflow to receive the project
Hit “Forward”
The Project should disappear from the creators Inbox upon Forwarding to another.
58
The SubProject can be sent back to the sender by the same method of
clicking Tools for the TM clicking Forward then choosing recipient.
59
Section VI
EDIT SGML
The process of Epic Check In and Epic Check
Out along with SGML editing. Allows changes
and/or updates to be made to a TM which in turn
will generate a new PDF Manual.
60
Make sure preferences is set on Content@
The first time on Content@, the Preferences should be
set. For process, check the Initial Log In Instructions
section.
61
Step 1. Click on the Project or SubProject
62
Step 2. Expand TM Object
63
Step 3. Open Tools for SGML container
64
Step 4. Click Epic Check Out
65
Step 5. Click Yes/OK to Security Alerts
66
Two Warning windows may appear, if so, Click Yes and/or Always
67
Step 6. Click Yes at the AppletFile window
A window will appear and disappear quickly if export is successful
68
After Collapsing[-] and Expanding[+] the TM Object, the
SGML container will appear with a lock if Check Out was
successful
69
The SGML folder can now be found on your hard
drive in c:\checkout\epiccat
70
Inside each folder the SGML File along with
its grphc/tblfigentities are contained
71
Step 7. Opening the SGML File in Editor will allow
you to make necessary changes to that section
72
NOTE: To view all the tags click on View and check
Full Tags
73
View Full Menus
View Full Menus by clicking on “Tools” on the menu bar and then “Preferences…”
74
Then click on “Window” and check the “Full Menus” box (checking
“Command Line” may also be useful)
Hit “OK”
75
Editing the FRONT matter
The FRONT matter consists of the Cover page, Foreward, Table ofContents, List of Illustrations, List of Tables, Safety Summary,and the Record of Changes.
Editing the Front matter depends on having the correct TM information according to TDMIS. This requires a TDMIS (Technical Data Management Information System) account accessible only with the correct Certificate which will allow you to access technical information pertinent to each individual manual.
Access to the TDMIS website requires a certificate, a username and password will be given upon request (see Gaining Certificates and Access to Citrix/JCALS/Contenta/TDMIS).
Once access is allowed to TDMIS (with cert., username and password) the following procedure allows applicable info to be viewed.
76
1. Open the TDMIS homepage on the web,
(https://mercury.tdmis.navy.mil)
To find applicable information, click TMINS
77
2. Click Search Publications
78
3. Select Pub with
Change Data from
the drop down
menu to view the
TM with any applicable
Changes
4. Enter the TMIN
(Pub No) for
the TM
being edited ( * may
be used as a wild)
5. Click Find Books
79
6. Select the TM (Pub Number) that shows the latest Revision or the one
which is UD (Under Development).
The following page will show information that will need to match the information
on the Cover page of the TM in Arbortext.
80
The highlighted areas should show the correct data for the TM being edited. This TDMIS
information should match the Cover page of the manual.
Verify the correct Publication Number (Pub No), Distribution Statement (Dist Stat),
Stock Number (STKNO also NSN), Publication Date (Pub date), Title and Revision
Number (Rev No).
81
7. Changing the information on the Cover page in Arbortext is simple text
editing. Replacing the incorrect information on this page should not require any
tag modification. Verify correct STKNO (nsn), Pub No (docno) and Title
(nomen)
STKNO (nsn tag) Pub No (docno tag)
Title (nomen tag)
82
In regards to the Dist Stat, if the current statement is incorrect the whole
paragraph that follows needs to be changed to reflect the correct statement
which can be found on the Distribution Statement List. The Dist Stat is
found between the “notice” tags
Dist Stat (notice tag)
83
The incorrect Distribution Statement can be deleted but the “notice” tags should
be kept. The cursor should be placed between these tags when inserting the new
statement (new paragraph symbols will appear). Hard returns and new paragraphs
are done by simply entering text after placing the cursor to the right of the end
paragraph symbol or choosing “para split” after hitting Enter
84
8. Verify correct Publication Date (pubdate) from TDMIS.
(this date needs to be verified by TDMIS which may or may not be the latest change date)
Publication Date (pubdate tag)
85
If there is a Revision Number (Rev No) there should be a tag added in
Arbortext. Putting the mouse next to the “nsn” tag and hitting enter should
give a list of options of tags to insert click “revnum”. Between these
tags you should enter the correct Rev No from TDMIS
86
Between the “revnum” tags you should
enter the correct Rev No from TDMIS.
This note should now
be visible.
87
Manuals with Revision numbers may need to have a Superseding
Statement present on the cover page under the Dist Stat at the bottom
of the SGML in Arbortext.
This is determined by scrolling down the TDMIS page and clicking
“View more info..” at the bottom.
88
If present, the Pub No and Date should be used in the statement below
SUPERSEDING STATEMENT: THIS MANUAL SUPERSEDES XXXX-XX-
XXX-XXX DATED DD MMM YYYY AND ALL CHANGES THERETO.
89
9. Clarify Change data information on Cover page.
The change date should be deleted. “chgnum” tags should be used
with updates/changes to Revisions in which case the “chgnum”
should match the “revnum” (from TDMIS).
“chgdate” tag with included
text should be deleted
“chgnum” tag
90
10. Verify the correct Foreword is in place.
The correct foreword should be in place (after other
data unique to each manual). There may be one in place but
that should be updated to the following version. The
Foreword is located between the
“foreword” tags
(may be “foreword id=“fr1”).FOREWORD
91
This is the correct foreword.(“brk” tags need to be inserted before and after
the web address to show correctly)
Ships, training activities, supply points, depots, Naval Shipyards and Supervisors of Shipbuilding are
requested to arrange for the maximum practical use and evaluation of NAVSEA technical manuals. All errors,
omissions, discrepancies and suggestions for improvement to NAVSEA technical manuals shall be forwarded to:
COMMANDER,
CODE 310 TMDER, BLDG 1388
NAVSURFWARCENDIV NSDSA
4363 MISSILE WAY
PORT HUENEME CA 93043-4307
on NAVSEA/SPAWAR Technical Manual Deficiency/Evaluation Report (TMDER), NAVSEA form 4160/1. All
feedback comments shall be thoroughly investigated and originators will be advised of action resulting therefrom.
One copy of NAVSEA form 4160/1 is at the end of each separately bound technical manual 8-1/2 x 11 inches
or larger. Copies of NAVSEA form 4160/1 may be requisitioned from the Naval Systems Data Support Activity
Code 310 at the above address. Users are encouraged to transmit deficiency submittals via the Naval Systems
Data Support Activity web site located at:
https://nsdsa2.phdnswc.navy.mil/tmder/tmder-generate.asp?lvl=1
Individual electronic TMs do not contain NAVSEA form 4160/1 but are linked to an electronic version on
the resident CD-ROM. Therefore, we encourage the user to transmit deficiency submittals via the Naval Systems
Data Support Activity web site located above.
The SGML should look as such;
92
Break tags entered by placing the cursor before and right after the
address and hitting Enter and choosing “brk” at both spots.
93
11. Safety Summary should contain applicable information.(found between the “safesum” (“safesum id=“fr2”) tags
The Safety Summary is automatically built during publication so it is dependent on having correct tagging and information of Caution and Warning notes in the SGML. Any text put into this section in Arbortext will be deleted upon publishing.
94
12. Verify Record of Changes is correct.
The correct format and information included on the
Record of Changes should be as follows:
Found between the “chgrec” tags
95
Body EDITING
The Body contains most of the TM information and
is denoted by the “body” tags located after the
“front” tags and before the “rear” tags. The Rear
section contains any appendices information and
TMDER
96
Tables
Tables are identified by a table symbol and start with the tag that
looks like this;
97
1. Inserting Tables
Inserting a new table is easily done
by placing the cursor where the
table is to be placed in
Arbortext, hitting the Enter key
and and selecting table. Note:
If the drop menu does not
show the table option, a table
is not able to be inserted in
that position.
A pop up screen will then ask the
number of Columns and Rows.
(Select Rows and Columns and hit
OK, this information can still be
modified in the future if
necessary)
98
After hitting OK the table will appear between the tags labeled
“table”. The tables Attributes need to be established/modified
which can be done by placing the cursor to the right of “table” tag
and hitting Ctrl + D (Ctrl + A for some versions).
99
2. Modifying Table Attributes
The tables Attributes need to be established/modified which can be done by placing the cursor to the right of “table” tag (as in the previous slide) and hitting Ctrl + D (Ctrl + Afor some versions). Ctrl+D (Ctrl+A) is how you “Modify Attributes” and will always show a popup window whenever an entity has attributes.
At the Modify Attributes window, few attributes will need to be entered.
“1” should be entered in the “colsep”, “rowsep” and “tocentry” fields. This “1” = yes (“0” = no). “tocentry” tells
whether an item will be seen in the Table of Contents/ List of Tables
The “id:” needs to be declared as “t” and then the table number in the manual,
eg; “t2-2” This “id” will identify and point within the TM to this Table 2-2.
A “label” must also identify the table, this should be entered as the table number, eg; “2-2” (this label will be used when the table is given a title)
Hit “OK” when these fields are entered.
Shows element being modified
100
3. Inserting a Table Title
Inserting a table title is done by placing the cursor after the “table” tag and hitting Enter. On the dropdown menu click title.
The “title” tags will appear with the table label that was entered in the tables attributes. The title should be typed in after the (Cont.)
101
The table title will appear in red italics and then the blue italics will
appear before the (Cont.) (This is how it should look and will generate the
correct heading in a PDF)
Entering data into the table is done by putting text into the correct cells.
102
4. Declaring Table/Column Headers
Declaring table headers will allow headings in each column and ultimately
control the layout of the table. All tables should have or be given
headers. If there is no
logical header data a blank
header row should be inserted
Adding column headings can
be done on the left side
( view) in Arbortext by
expanding [+] “table” to see
the “tgroup” element.
Next, the “tgroup” element
Should be expanded [+]
showing the “colspec”s
and the “tbody” element
103
Place the cursor next to the
last “colspec” element of
the table (under “tgroup” in
the left panel view) and hit
Enter.
On the options list, choose
“thead”
This will cause a Table
Markup Error window to appear.
Ignore the error message.
The next step will fix this issue.
104
Place the cursor after the
word “row” (between the two
“thead” elements in the
left panel) and hit Enter.
Select “entry” from the option
list. This will allow the table
to reappear and there
should no longer be an
error message that appears
you will now be able to
add text to the column
heading cells.
Justification
All tables have a default alignment of left. The cell text can be aligned differently by placing the cursor in the correct cell and hitting Ctrl+D[Modify Attributes (Ctrl+A)] click the drop menu next to “align:” and choose the alignment.
Hit “OK”
105
106
5. Modifying Table Size(column/row/cell size)
Changing column width becomes important with spacing issues on page
layout. This is done by finding the “table” in question in the left window in
Arbortext ( view) and finding right below where its says, “tgroup”
Tables in portrait mode should be limited to 7in. and landscape limited to 10in.
in width. Larger tables will
need a “foldout” tag.
“table”
(Table 2-2)
“tgroup”
107
Expand [+] the “tgroup” and you
will see the column
specifications (colspec)
for each column in the table.
Changing column width can be done
by either clicking/expanding [+] on
The Attributes icon next to colspec.
(Note: If the units
are not inches they can
easily be changed by
typing “in” after the number)
108
Placing the cursor next to
“colspec” and hitting Ctrl + D
(Ctrl + A) will also allow you to
change width of the column in
the “colwidth” field
Enter the desired length of the
column in inches into the
“colwidth” field
109
NOTE: Changing height should not be done. The cell will expand
vertically to accommodate data entered.
Adding columns/ Deleting columns and Adding rows/ Deleting
rows can be done by placing the cursor in the necessary cell to add
change by right clicking the mouse and using the options Insert or
Delete
110
6. Deleting a Table
To delete a table, highlight the whole table including “table” tags and
hit Delete key.
111
Figures
Figures are identified by the following tags and symbols.
Start tag Figure symbol
The terms “figure” and “graphic” are used interchangeably and ultimately mean the
same thing, except when SGML tagging,. Figures/graphics do not appear in the
SGML file as they are kept within Content@. When using a “graphic” tag, a specific
figure within that folder on Content@ is called upon when the SGML is published into
a PDF.
End tag
Left panel graphic element
with figure number
112
Graphic Fetch- A folder containing a manuals graphics can be downloaded to
your local machine by doing a Graphics Fetch in Contenta. This may only be
necessary when verifying/modifying the graphics in the TM.
First step is to click Tools for the “BODY”
113
Click “Graphic Fetch”
Click Yes / OK to any Security Alerts
114
Choose Save
Navigate to the c:/checkout [C$ on ’Client’ (V:)] folder and click Save
115
When download is complete click Close
Hit Exit
116
There should now be a .zip folder in your c:/checkout folder containing
.tif files of the figures for the manual. (If there is figures in the Safety
Summary in the manual they will not be included in this .zip folder).
A figure can be added to or deleted from this folder which will then
need to be rezipped and loaded back onto Contenta. This is done by
Graphic Load.
Note: Any new or deleted figures need to be modified in the
Graphic Entities folder in Arbortext Editor.
117
Graphic Load
Graphic Load is used to load back a .zip folder into Contenta after a figure has
been modified on your desktop. The only a reason to do a Graphic Load is
because a figure was modified in some way. After a figure is modified on
your local machine, go to Contenta and click Tools for the TM.
118
Next, Click Graphic Load
Click Yes / OK to any
Security Alert(s)
119
Click Browse…
Click “OK” to Restrictions window
120
Navigate to the c:/checkout
[C$ on ’Client’ (V:)] folder,
choose file, and hit Open
Click
Load Graphics
121
After window appears, click Exit.
The modified graphic(s) should now appear in the
TM after publishing.
122
Inserting a Figure/Graphic
Start by placing the cursor at the correct place where the figure
will be inserted. Hit the Enter key (Insert MarkUp) and
choose the “figure” option. Note: If the drop menu does not
show the “figure” option, a figure is not able to be inserted in
that position.
123
Next step is to add the title of the Figure in the “title” tags. Doing this
will give the text that will be shown with the figure in the PDF as
seen below the tags in red italics in Editor.
124
The figure attributes need to be set.
This is done like all the rest, place the
cursor to the right of the “figure” tag
and hit Ctrl+D (Ctrl+A)
The “id:” needs to be declared as “f”
and then the figure number in the
manual, (“f2-2”) This “id” will
identify and point within the TM
to this Figure 2-2.
A “label” must also identify the
figure, this should be entered as
the figure number, (“2-2”)
(this label will be used with the
figure title label)
The “tocentry” should be “1”, “tocentry” tells whether an item will be seen
in the Table of Contents/ List of Illustrations
Hit “OK”
Element being modified
125
The “figure” start tag should now
appear with the figure info.
You can change the layout of the
figure on the page from “portrait” to
“landscape” by modifying attributes
(Ctrl+D, Ctrl+A) in the “orient:” field.
NOTE: When using portrait, limit the
height of the figure to less than 8.2
inches and landscape to 6.5 inches.
126
Graphic Entities
The Graphic Entities folder is used to tell Contenta which figures to call
upon when publishing. New figures should be added to the .zip
folder from Contenta and should then be added here.
This is done by clicking “Entities” on the menu bar in Editor and
choosing “Graphic…” (as with Inserting a “graphic” tag)
Choose “New…”
127
The “Name:” should be the
next available number.
The “File name:” should be
the TM number-fig#.tif
The “Notation:”
should be tif
Hit Ok
The new figure should now
be able to be inserted.
128
Inserting a “graphic” tag
Inserting a “graphic” tag should be done by placing the cursor next
to the figures “title” tag and go to the Menu bar and hit
“Entities” Choose “Graphic…” on the drop down menu.
129
The TMs Graphic Entities folder will appear with the figures Name,
File Name and Notation (tif).
Figure Name File NameNotation
130
To choose a figure to be inserted, click the correct figure, hit “Insert” then hit “Close”
The “graphic” tag should now be present, the next step is to clarify the figure size.
This is done by placing the cursor next to the “graphic” tag and hitting Ctrl+D (Ctrl+A)
131
The dimensions of the figure should
be placed in the “reprodep” (height)
And “reprowid” (width) fields.
Hit “OK”
The “graphic” tag should have the figures dimensions.
Element being modified
132
Modifying Graphics/ Figures (size)
Graphic size can be changed by modifying the graphic attributes. This
is done by placing the cursor next to the “graphic” tag and hitting
Ctrl+D (Ctrl+A). This will bring up the graphics attributes.
Element being modified
133
The graphics width and height
can be modified by changing
the inches in the
“reprowid” (width)
and “reprodep” (height) fields.
When the dimensions are modified
Hit “OK”
134
Inserting Foldouts
Inserting a foldout requires the use of a “foldout” tag outside of the “figure”
tags. Place the cursor in the correct position and hit Enter (Insert Markup),
select “foldout”.
135
The “foldout” tags should encompass the “figure” tags. This may require
copying of the data including tags and paste in between the “foldout”
tags. The format should look like this;
This note is automatically
inserted with addition of
“foldout” tag
“foldout” and “figure” start tags
“foldout” and “figure” end tags
136
Foldout Types
• There are two types of foldout that can be
created. Standard and Expanded.
– Standard size are for images that do not exceed
8.2 inches in height.
– Expanded are for images that are up to 10
inches in height.
NOTE: The expanded foldouts will have a offset of
2.5 inches from the right margin. This allows for
the insertion of the header and footer data.
137
The “foldout” attributes need to be modified to establish the page size.
Place the cursor inside the “foldout” start tag and hit Ctrl+D (Ctrl+A).
The Modify Attributes window will appear
and have the field for “pgstyle”.
This field should be filled in with
either; 2, 3, 4, 5, 6 or 7 for standard
And 22, 32, 42, 52, 62 or 72 for
expanded
See the next pages for exact page
dimensions for each foldout type.
Hit “OK”
The “foldout” start tag should now
have the “pgstyle” on it.
4
138
Foldout Dimensions
Standard Foldout Image Specification
Page Style Page Dimensions Max Image Height Max Image Width
2 11 x 17 8.2 inches 15.8 inches
3 11 x 22 8.2 inches 20.9 inches
4 11 x 34 8.2 inches 32.8 inches
5 11 x 44 8.2 inches 42.9 inches
6 11 x 52 8.2 inches 50.8 inches
7 11 x 62 8.2 inches 59.7 inches
Expanded Foldout Image Specification
Page Style Page Dimensions Max Image Height Max Image Width
22 11 x 17 10 inches 11 inches
32 11 x 22 10 inches 16 inches
42 11 x 34 10 inches 28 inches
52 11 x 44 10 inches 38 inches
62 11 x 52 10 inches 46 inches
72 11 x 62 10 inches 55.9 inches
82 11 x 90 10 inches 83.5 inches
139
Emphasis tag
The “emphasis tag” is used to make text bold, underlined, italics, etc…
First, place the curosr at the desired spot for the emphasized text and
Insert Markup (Enter key). Choose emphasis from the menu (if “emphasis”
doesn’t appear as a choice the tag can not
be in that position).
140
The text to be emphasized should be put inside these emphasis tags.
To set emphasis, place the cursor inside the tags and Modify Attributes(Ctrl+D, Ctrl+A)
emph:
b = bold
i = italics
u = underlined
Hit “OK”
141
“xref” tag
An “xref” tag is used to link text to another section of the electronic manual similar
to hypertext for quick referencing. This is done by Inserting Markup (Enter)
when the cursor is in the correct place of the text. Choose xref from the list.
142
The Modify Attributes window will appear.
xidtype: has a dropdown menu to choose
either table, figure, text or note.
The id of the reference should be
chosen.
The xrefid: is the id of the reference.
Every chapter, para, note, figure and table,
etc… is given an id which is found on their
start tag.
Figures have an id of “f” then the
figure number (f1-2) and subfigures use the id, “s” after the figure # (f1-2s2).
Tables work the same way with a “t” instead of “f” (t1-2).
Chapters have the id, “c” and chap # (c2).
Notes have the id, “n” and their number (n2),
Paragraphs have the id, “pa” and their # (pa3-2.2).
Warnings have an id, “w” and their # (w2).
If there is a question of what “xrefid” to use the id can be found on the
start tag of the reference to be linked.
Hit “OK” when finished.
143
Put the number of the figure, chapter, table, paragraph, info, etc…
between the “xref” tags.
Some example xref tags,
144
When to use the
“tocid”
The “tocid” is used when
Modifying Attributes to
anything that is added
while doing a change
that will need to show up
in the Table of
Contents.
145
Completeness Check
A complete check can be done after changes have been made on an SGML in Arbortext
before Epic Check In to see if the SGML was done or changed correctly. Click the
green checkbox at the top and see the message at the bottom.
146
When all changes are done and saved to the
SGML file, the next step is Epic Check In
Note: When saving and closing the SGML file in
Arbortext, the cursor should not be left within
any tags. The cursor should be left outside any
tags so the Epic Check In process proceeds without
error.
147
Epic Check In
(only for sections which were last Checked Out)
1. Click the Tools for the SGML Container
148
2. Click Epic Check In
149
3. Click Yes/OK to Security Alerts
150
Two Warning windows may appear, if so, Click Yes and/or Always
151
4. Click the … (Browse) button
152
5. The correct folder should appear. Single click
the name and hit OK
153
6. Click Check In
154
Successful Check In will show this box, hit Exit
155
After Collapsing[-] and Expanding[+] the TM Object, the
lock should be gone. Check In complete
156
Note: After a section of SGML is Checked In, a copy will
still remain in your c:\checkout\epiccat. This folder should be
managed and cleaned out when necessary to avoid confusion of
manual sections.
157
Section VII
Publishing / Compose
End Project / SubProject
Publishing or “Composing” generates a PDF file of the
SGML files along with the Graphics files. The NAVSEA
Publishing System uses a program which runs outside of
Content@ called the XML Professional Publisher (XPP).
Note: The process is different for Publishing NADCP TMs as opposed
to Legacy TMs.
158
Publishing NADCP TMs
The NADCP publishing process can be seen on the
NADCP TM Flowchart.
It begins with all sections of SGML being Checked In (unlocked)
Go to the Tools for the TM
159
Click Compose
160
Click Yes/OK to any Security Alerts
161
Click Baseline
162
These settings usually do not need changing, (if email address
is incorrect notify System Administrator) Click Ok
Should be “No”
163
Compose Baseline…working
At this point Content@ will export the SGML with Graphics
files and run XPP to generate a PDF to the project.
164
When “Data export complete,”
Hit Exit
When composing baseline, an
email is sent to the TM editor as
well as the System Admins. If
will notify you and the Sys
Admins of a successful or
unsuccessful Compose.
When compose is successful
collapsing [ - ] and
expanding [ + ] the project in
Content@, the PDF file should
now be available.
165
PDF file of TM
collapse and expand
166
Content View / Fetch
Content View and Content Fetch are an options on the Tools menu
for the PDF file in Content@
167
Content View will open the PDF file to be viewed.
Content Fetch will allow the PDF file to be saved to your
local machine and be viewed.
Content Fetch
Choose
Save
168
Navigate to the c:/checkout [C$ on ’Client’ (V:)] folder and click Save
After the file is saved, the PDF should be found in the
checkout folder and able to be viewed on your local
machine without a Content@ connection.
169
Compose - For TMPODS
When finishing a project and composing baseline,
For TMPODS should be done to make a separate
“foldouts” PDF along with the other TM PDF. This is
found under Compose on the Tools menu for the TM.
170
These settings usually do not need changing,
(if email address is incorrect notify System Administrator)
Click Ok
171
When Data export
complete,
Hit Exit
172
When compose is successful collapsing [ - ] and
expanding [ + ] the project in Content@, the PDF file of the foldouts
separated should now be available.
173
Publishing Legacy TMs
The Legacy publishing process can be seen on the Legacy TM
Flowchart.
After requesting the Project the next step is to Update Baseline.
Click Tools for the TM
174
Click Compose then Click Baseline Updates
175
Click Yes/OK to any Security Alerts
176
These settings usually do not need changing,
(if email address is incorrect notify System Administrator)
Click Ok
177
When Data export
complete,
Hit Exit
178
Next step will be to Run Reissue Preparation,
First click the Tools for the TM and choose
Reissue Preparation
This will put the TM in Revision Mode. The next step will be to do Epic Checkout of the FRONT matter and update the information on the Cover. This includes inserting correct Revision tag and other such info from TDMIS. Then do an Epic Check In of the FRONT matter. Next step is to run Print Final.
179
Running Print Final is done by clicking Tools for the TM
and choosing Compose then choose Print Final
180
These settings usually do not need changing,
(if email address is incorrect notify System Administrator)
Click Ok
181
When Data
export
complete,
Hit Exit
182
When compose is successful, collapsing [ - ] and
expanding [ + ] the project in Content@, the PDF file
should now be available.
Print Final PDF file of TM
collapse and expand
183
This Compose - Print Final is just to check if this
book was processed correctly. The PDF file
can be deleted and the BODY and REAR
matter of the TM can now be edited. Once all
corrections/updates are made to the whole TM
the Compose - Print Final should be done
again. The last step in publishing Legacy books
is to Compose - For TMPODS which is done by
the same process as the NADCP books by
clicking Tools for the TM, choosing Compose
then choosing For TMPODS.
184
Section VIII
System Administration
Section under construction