Home

FrameMaker User Guide Templates

1. See also Appendix A 1 Further thoughts on multi author editing for other related issues Setting up your user guide document Make a base dir such as userguidebase Decide which template model to use as discussed in Section 1 1 Two document styles to choose from Set up the reference template for your document as follows a copy the template tar file e g normal tarto userguidebase b untar and rename the created directory e g tar xvf normal tar mv normal template c remove the file normal tar Customize the reference template for your document as specified in Section 1 3 Managing template customizations Set up the directory structure for your document as follows a in userguidebase create a document subdirectory and in it create the subdirectories according to the way you want to organise your document b copy from the template subdirectory the FrameMaker book file all the automatically updated files the cover the frontmatter and bibliography c add blank files for each chapter and appendix as specified in Section 1 6 Adding and deleting chapters FrameMaker User Guide Templates userguidebase document guide book frontmatter N l frontmatter fm DD imported gt logo eps usersguideTOC fm T chap1 ES chap1 fm imported chap2 E chap2 fm imported N screen xwd 7 apps 18 app1 fm nh app2 fm bibli
2. llle 44 FrameMaker User Guide Templates 41 Delivering the document 3 1 Routine book procedures 42 Be cue c Updating the FrameMaker book Updating a book file means to update all cross references paragraph and page numbering and to regenerate all automatically updated files Open the FrameMaker book file Select File Generate Update from the book File menu Make sure that all the automatically updated files are under Generate Click on Generate Printing to standard sized paper Entire books may be printed to a postscript file or sent directly to the printer by selecting File Print from the book window You may selectively suppress printing of individual files by double clicking on them in the Print column of the Print Files in Book dialog Make sure you update the book as explained above before printing Cutting the paper If you have chosen a page height that is smaller that the standard paper size you will need to cut the printed or photocopied output Section A 2 Changing the page layouts for different page sizes gives a complete list of the sets of predefined page layouts with the exact measurements and how the printed output should be cut FrameMaker User Guide Templates The running footer and background text 3 2 The running footer and background text m o p Nog The running footer normally showing the main title of the document and the background text on the outer edge of the page
3. 24 24 24 26 26 26 28 28 28 28 30 30 30 32 32 32 32 32 34 34 34 34 36 36 36 36 38 Contents Importance of the index Building the index Chapter 3 Delivering the document A4 3 1 Routine book procedures Updating the FrameMaker book Printing to standard sized paper Cutting the paper 3 2 The running footer and background text Resetting the variables in a single file Propagating to all other files in the book 3 3 Converting to WWW Before saving as HTML After saving as HTML Saving as PDF Dealing with changes to the template Appendix A Set up and maintenance procedures A 1 Further thoughts on multi author editing Version control of the entire document Author submissions of material in progress to editor Managing inter author cross references A 2 Changing the page layouts for different page sizes Page layouts for the cover the index and all other files Predefined page layouts Changing the page size Preliminary set up The cover page file The index file The other files Finishing A 3 Deleting and re adding automatically updated files Deleting an automatically updated file Re adding an automatically updated file A 4 Updating the formats of your document files File types P pad we os Updating each file A 5 Copying and creating Zany paragraphs Copying Zany paragraph formats Creating your own Zany paragrap
4. 28 Thezany paragrap formats 29 The frontmatter um 240 Appendices byfliography and index Chapter 3 Managing the FrameMaker book 34 Routinebook procedures 32 The running footer and background ted 33 Updating formats 34 Changing the page layouts fo different iege sizes 35 Convertingto WWW aud Appendix A Installation set up andmaintenance Framvedda her User Guide Te plates Illustration 1 5 Planning the skeleton for the document using the automatically generated table of contents as a convenient tool to navigate around your document Getting started 1 6 Adding and deleting chapters Each chapter should be in a separate file and maybe also in a separate subdirectory Thus to add a chapter you will need to make a copy of the chapter file template in your document directory structure Use your customized template Before adding chapter files to your FrameMaker book you should have already set up a reference template which will centralize all your customizations if any as explained in Section 1 3 Managing template customizations Use the template components of this reference template when adding component files to your book Adding content files Content files can be of type frontmatter chapter or appendix In all three cases the way to add files is the same The procedure for adding is given in the illustration You may need to add content files while sketching the table of contents for your documen
5. List of Figures List of Tables List of Listings Standard Index List of Paragraphs OUTLINE TOC LOF LOT LOL IX Paragraphs Paragraphs Paragraphs Paragraphs Paragraphs Markers of Type ChapterNoNumber ChapterNumber ChapterNumberAppendix ChapterNumberContents ChapterNumberIndex ChapterTitle ChapterTitleContents ChapterTitleIndex ChapterNoNumber ChapterNumber ChapterNumberA ppendix ChapterNumberIndex ChapterNumberOutline ChapterSection ChapterSubSection ChapterSubSubSection ChapterTitle ChapterTitleIndex ChapterTitleOutline FigureCaption TableCaption ListingCaption Index FrameMaker User Guide Templates 55 Set up and maintenance procedures A 4 Updating the formats of your document fies If you are in the authoring phase and you find you need to add or modify formats in a consistent manner throughout the files of your FrameMaker book you will need to first customize your reference template as discussed in Section 1 3 Managing template customizations and then update the formats of all your document files using the formats in your reference template This section describes the mechanical procedure performing this update File types Each component file in the book template defines a file type When updating your document files from the template it is necessary to update each file from the template file of the same type Updating each file 1 Open the book files of both your
6. one for the cover one for the index and one for everything else i e the outline toc frontmatter chapter bibliography and appendix Thus a predefined set of page layouts necessitate three different page layout format files Predefined page layouts Table A 1 provides the complete list of predefined sets of page layouts and the names of the three files in each set Table A 1 Sets of predefined page layouts to choose from Page layouts Paper size Cutting Filesets for the Master Page formats 210 x 297 A4 No normal frontmatter cover fm normal chapter chapter fm normal usersguidelX fm 210 x 254 AA Yes at lib MasterPages210x254Cover fm 254mm lib NormalMasterPages210x254 fm E lib MasterPages210x254Index fm 2 210x210 A4 Yes at lib MasterPages210x210Cover fm 210mm lib NormalMasterPages210x210 fm lib MasterPages210x210Index fm 210 x 279 4 A4 width x No lib MasterPages210x279Cover fm US Letter height lib NormalMasterPages210x279 fm lib MasterPages210x279Index fm 210 x 297 A4 No STOP frontmatter cover fm STOP chapter chapter fm STOP usersguidelX fm 210 x 254 AA Yes at lib MasterPages210x254Cover fm 254mm ___lib STOPMasterPages210x254 fm a lib MasterPages210x254Index fm to 210 x 210 A4 Yes at lib MasterPages210x210Cover fm 210mm lib STOPMasterPages210x210 fm lib MasterPages210x210Index fm 210 x 279 4 A4 width x No lib MasterPages210x279Cover fm US Letter height lib STOPMasterPages210x279 fm lib Mast
7. such as draft may be controlled through the two predefined FrameMaker user variables Documentiitle and Background Text These variables can first be reset in a single file of the book and then propagated to all other files of the book Resetting the variables in a single file Click into a text column Select Special Variable Use the Edit Definition dialog to change the value of the either the Documenttitle or the BackgroundTextuser variables Propagating to all other files in the book Make sure that the FrameMaker book file is open Open all files in the book Esc 0 by holding down Shift key clicking on the book File menu and selecting Open All Files in Book Select File ImportFormats from the book File menu Under Import from Document select the file which contains the correct variable settings Make sure that all formats except for Variable Definitions are de selected Make sure that all files are under Update Click on Import Update the book as explained in Section 3 1 Routine book procedures Save all files in the book Ese S by holding down Shift key clicking on the book File menu and selecting Save All Files in Book Note In the above procedure opening all files in the book and updating the book serve as a workaround to a FrameMaker bug with updating locked hypertext files e g the table of contents and index of these templates FrameMaker User Guide Templates 43 Delivering t
8. 50 page layouts for 49 cover fm 34 49 52 cross reference formats 20 Bibliography 36 cross references managing across authors 48 customizations standard 6 customizing 8 adding character tags 20 adding paragraph tags 30 and management 6 checklist for 6 naming new formats 6 reference template for 4 6 12 WWW conversion 46 Zany formats 32 cutting paper copies 42 49 D deleting automatically updated files 54 chapters 12 content files from book 13 delivering the document 41 directories icons 59 lib 8 49 50 51 52 58 normal 49 STOP 49 DL1Tem 20 docsys ptsun00 cern ch ix document consistency 6 delivering 41 directory structure 4 hierarchical structure 2 45 organization 2 presentation v setting up 4 styles 2 usability vi documentation vi and document usability vii and manpower problem vi as part of software vi different styles for 2 for FrameMaker viii planning vi production difficulty vii Documentlitle 43 double page spreads 3 26 FrameMaker User Guide Templates E editing F content 17 front matter 34 multi author 48 running text 20 FcnCall 6 30 Fcninput 6 30 FcnOutput 6 30 FcnParameters 6 30 FcnSynopsis 6 30 feedback ix Figure 24 FigureCaption 24 figures inserting 24 list of 55 file types 56 appendix 36 bibliography 36 chapter 6 12 cover 34 50 frontmatter 34 index 38 51 table of contents 10 updat
9. BodyTabular Like Body but also includes tab stops every 2cm Can be used to format simple tabular data without using tables BodyVerbatim A fixed width style for inserting bits and pieces of code or commands in the running text Conceptlem ConceptDescription A pair of paragraphs for formatting single concepts that need a title DLITerm DL1Description Hanging indents a pair of paragraphs for formatting definition lists Each of these has one or more variations DLITermRIHis a run in head thus the following description paragraph starts on the same line while DL1Description lt is for descriptions that need no indentation and DLIDescription gt is for descriptions that need a lot of indentation KeepRestOfPageClear A special paragraph to force empty space at bottom of page L1Bullet LIHyphen L1Aplha LINumber List paragraphs of level 1 For numbered and alphabetic items there are also special formats to reset numbering There is a corresponding set for level 2 LiContinuation LIContinuationVerbatim Continuation paragraphs for list items of level 1 There is a corresponding set for level 2 Quote QuoteBullet For quoted excerpts SideHeadStep A paragraph for numbering steps in a procedure Different from a numbered list as these steps can span different sections There is another format to reset numbering to 1 Character formats General character formats are pre defined in the template However it is likely that you will need
10. File menu select Rearrange Files Select the file to be removed from the book and click on Delete Click on Done Note This does not physically remove any files from the disk but simply modifies the book file Re adding an automatically updated file Each automatically updated file is different is a different case and needs to be treated individually Table A 2 lists the exact information necessary to re add each individual automatically updated file The general procedure to re add each of these files is as follows From the book File menu select Add File Select the appropriate type of Generated List or Generated Index from Table A 2 Select the component file to Add File Before or to Add File After Click on Add Specify the Filename Suffix from Table A 2 Make sure that all the source names specified in Table A 2 are under the Include column Make sure that Create Hypertext Linksis selected Set Starting Page Side to Rightand Page and Paragraph Numbering to Continue Click set FrameMaker User Guide Templates Deleting and re adding automatically updated files Next time you regenerate and update the book FrameMaker will look for a file in the same location as the book file with the same name as the book plus the specified filename suffix Table A 2 Specifications of the automatically updated files Generated List Type Filename Suffix Source type Source names Table of Contents
11. and consistently laid out with text set in as readable a manner as possible and with good lists of content index and other appropriate reference aids These features are essentially part of the presentation and in the case of these templates are all obtainable virtually for free As an author using templates frees you from worrying about the finnicky and time consuming aspects of presentation giving you more time and energy to devote to the contents vi FrameMaker User Guide Templates The problem addressed by these templates The problem addressed by these templates We all understand the importance of user documentation We also know that producing user documentation that is coherent both in content and in presentation is difficult how often are we frustrated when we are learning to use a new system and cannot find the information we need The problem currently How do we go about writing user documentation today We probably start from a template that at first sight does approximately what we want and then we start writing As we write we discover that we need to consistently create new format definitions or wrestle with whatever tool we have adopted to achieve what we very clearly want The situation is even worse if the authoring effort involves more than one author Inconsistencies can reach a point such that you completely loose the flexibility that the tool offers you to control a logically tagged document The res
12. can become very tedious to edit When imported by reference high quality graphics i e with large file sizes may be temporarily replaced with small lower quality ones This makes it more comfortable to edit the document while still being able to see and manipulate the graphics Advantages of importing by copy Guarantees that the FrameMaker file and the graphic stay together thus the file is easier to move around than a directory structure with relative pathnames e Some graphic file formats are not compatible across platforms When a graphic is imported by copy it is stored internally as a Framelmage or FrameVector formats which can be displayed on all platforms T Useful Tips If your document becomes slow to edit because of the graphics you can turn viewing them off completely by selecting View Options e To generate a list of all imported files select Add File from the book File menu generate a Listof Referencesusing Imported Graphicsas the source reference type e tis best to keep the number of different formats that you use for imported graphics to a minimum ideally one for bitmap and one for vector Many different formats may be inconvenient when you need to process the images or move the document across platforms FrameMaker User Guide Templates t J Base document directory FrameMaker book Subdirectory containing chapters A Chapter 1 A Chapter 2 Graphics subdirec
13. customization necessary Inserting a table Create a blank BodyPlaceHolderparagraph Select Table Insert Table and choose one of the pre defined formats or select one of your own definition All tables have an automatically numbered title TableCaption Basic pre defined table formats 2col 3Col 4Col 5Col Four simple formats for 2 column to 5 column tables respectively You will certainly need to customize tables to achieve straddling and irregular ruling It is advisable that instead of customizing extensively one of the pre defined formats you actually create your own new table formats If you have many differently customized tables but with the same tag name you run the risk of losing some of the customizations if you were to update table formats If you customize tables try to keep their general look and feel consistent throughout the document See also Section 1 3 Managing template customizations Useful Tips e To select cells and columns hold down CONTROL and Ssingle click to select cell double click to select column triple click to select entire table e To resize columns select a cell and drag the resize handle Note The width of tables should ideally always be the same as that of the main text column text column i e 13 6 cm You may make it wider if you need to but you should never make it narrower 22 FrameMaker User Guide Templates 1 Format View Record preamble Record
14. frontmatter chapter and appendix files that you need Update the running footer and any other variables for the added files as detailed in Section 3 2 The running footer and background text Update the book as explained in Section 3 1 Routine book procedures Deleting files from the book From the book file for your user guide select File Rearrange File In the Rearrange Files dialog click on the file name you want to delete to select it Click on Delete Note that this only removes the book reference to this file If you want to remove it from disk you will need to do so separately Illustration 1 6 Procedures for adding content files to the FrameMaker book and for deleting both content files and automatically updated files Getting started 17 Managing imported files 14 FrameMaker allows you to import both graphic and textual files by copy or by reference Importing by copy stores a description of the graphic or text inside the FrameMaker file while importing by reference stores only the path information for the graphic file on the disk Advantages of importing by reference The FrameMaker document is automatically updated when the graphic or text file changes e Less duplication e g if the same image is imported more than once in the same chapter it is not duplicated e Keeps the size of the FrameMaker file itself small Large graphics slow down FrameMaker A file containing many graphics
15. of index markers in a FrameMaker book One such tool is IXgen from Frank Stearns Associates 5 Please ask us about IXgen s availability at CERN 38 FrameMaker User Guide Templates Dpisaling tha F Ugdatzg a Teck ri lc nani decal m in all rper re Hn p mrsbarmwg ard bs regemary iy al gale Hir hp pda Har Y Cem tu Pieters bcn ctis d To Selec i armari ncn ir tha ek nana biaka ssh itat ali iba aniani ay ea ced dnb aoe adn o cx i ko Quemar Printing a stanstari sized paper T wlecting Mie Reet feet Fl Erk Hark treed le det Bent dinte E Baka mme yasqa abe Ihat Putting tse papar 4 Lie hare ibai ra B LUL EI ILI paga yedi ros d bend pigs did fma in Ea Loa imi Illustration 2 11 Index entries are created by inserting index markers in the text When Text Symbols are on index markers appear as a T As the index file is a locked for hypertext menus are different it can be used as a document navigation tool in a similar way as the table of contents see Section 1 5 The marker window shows the text contained in the selected marker Editing the content 40 FrameMaker User Guide Templates Chapter 3 Delivering the document To produce the printed or WWW versions of the document you will need to preform a few extra procedures such as updating and printing 3 1 Routine book procedures 42 3 22 The running footer and background text 43 3 3 Converting to WWW
16. rypa lar tia rgvara cusam reek li Gana roa Dora vcra rye lar ien Lond Bn D b mien laa er imaman coed sid nl Fagas masii rh rr ba icd aa 1 rua tau irc cpu maar Tra id Pertrdsazstun pi paa hopara masses 8 na diei yg nd Fleck t iE om ace o Te ee e Ten prepuem cies ee 1 Li T cg ecd a apr cq d ert Hn n mmm d dial En Ham Pe Beg red merri lkr Bel Dee d rompe d be oe Pak Pasai lel ba aequam odirbe Eois Fn a ds D Un iem om e eod i Pet I Lisa di mrki o b sba rm m mariai m ina Biei zi kn icu ia Ln p babina ha r EIER anc RP Began ie iua in aari m inks kl s mem da in is maad TEa ian seme an ica ta pea ana and ig da vua sari m iaa Bispira wisi mast Abiga IR parran ELLE LEM erg be IE sl O MVH urei ieena n dea regu de ekmar ir lia run laei ambri C Tue pagsa rart cha i ki Baa Une ed atra Rita pol mp pe p Mn Ron Ug FEF Belada am prie En BTRC omn Vang aacm let peg aet eed en md ic amm d re baina Tk ana ee ee bz 41 au a RI erect ba brr ees eed rupem aia d comer nane Li pegs ika Paf nac md o Hapai lu Wu Paisa uii tte beatae eei am vu equat das redas e Borse reri rp re rri beib RC el enim s PENE ie Pat omae nd HaT eds 1i Dia Euskara 12 ana cia pagan i ba ia ud za f a Lor E ima Tiek af H pr bel TH FTT mhia Sd IDE n s n E 5 pH HH D EHE U jen Ie ep ee merry learns Em irem Pm P Rn Bon beein bs mil and rim e paru da Feebee amd EF eedem Er IDUL Doer temei Cder am rn a rae pru on Reb ec mans caca P Gam
17. template book file window select File ImportFormats to pop up the Import Formats dialog box Set it up as follows a Make sure that in the Import from Document field the file NormalMasterPages210x210 fmis selected To workaround a FrameMaker bug with the update of files locked for hypertext t For same reason as previous FrameMaker User Guide Templates 51 Set up and maintenance procedures 52 11 12 13 14 b Make sure that all format options except for Page Layoutsare de selected c Make sure that all files are under Update except for the files cover fm and usersguideIX fm d Click on Import impari Forests impii iro Dorumeni Hanna icc leri agrar Es Iia ari arzi J Paragraph Formes Math Deiter Variabhi Dfii Chawmcimr Foote Darument Properties Cross Hriermncs Foret L Soler Desinitiens eae Te eer Fabia Fanmats Hatarina Pagi Wiis ling Remm LI Maral Page Birrcaics I Other armata Ovaries patente t Dont Upitale arias te v era H pT AE s 9354 m aa PORC Fine UE o Lipan Ones Ln Hn ndn Finishing Re set the page numbering of the frontmatter to roman a From the book window double click the file frontmatter frontmatter fm b Select FormatDocumentNumbering to pop up the Numbering Properties dialog c For Page Z Style select roman iv d Click set Repeat this for the outline and the t
18. web conversion See Section 3 3 6 FrameMaker User Guide Templates userguidebase E template N document usersguide book WA a guide book frontmatter A 4 ON frontmatter cover fm frontmatter fm cover fm rm L imported h frontmatter fm imported n usersguideOUTLINE fm N logo eps go ep h usersguideTOC fm usersguideTOC fm chapter 4 chapi e eX 7 N EL gt chapter fm A perna j fi iia in j D ra Urik RSE a DU chap1 fm Jmm ome imported imported tesa re ae cum rms uns cent cm n chap2 E chap2 fm imported N screen xwd E apps appendix A Ma Prim appendix fm Bons app2 fm xem ie bibliography fm biblio fm L imported L 5 imported A 0 B usersguidelX fm usersguidelX fm Illustration 1 3 All your customizations should be centralized in your reference copy of the template The illustration indicates the template master file for each component file in the document For example the Import Formats dialog is shown to indicate that formats for all chapters are maintained in the chapter template component file Getting started l 4 Page size options You may choose to set your document with one of three pre configured page heights The paper size however never changes Thus any documents produced with different page sizes are stil
19. 34 The appendix and the bibliography 36 GINO cd su Seley ida Eae Bose s 38 FrameMaker User Guide Templates 17 Editing the content 2 1 The chapterttle page and section headings The first page of each chapter is reserved for the chapter title page It contains the chapter number and title followed by an introductory paragraph and a local table of contents all top level sections contained in the chapter Chapters may have up to three levels of subsections The chapter title page The chapter title page contains a very specific sequence of paragraphs in the following order 1 1 ChapterNumber paragraph containing the chapter number or for frontmatter chapters just blank space 1 Chapterfitle paragraph for the title 1or more Body paragraphs for the chapter introductory paragraph 1 blank Body paragraph for spacing Qr Wm ce qe 1 ChepterSectionList paragraph for each ChapterSection paragraph in the chapter to make up the table of contents for the chapter Each will contain a cross reference to a ChapterSection paragraph using the ChapterSectionList cross reference format Sections and subsections There are three possible sub levels The higher level one is ChapterSection while the lower ones are ChapterSubSection and ChapterSubSubSection The sub section formats are numbered in the normal report style and not numbered in documents prepared with the STOP method The ChapterSection tag is set to start on a ne
20. 4 H HardSpaces 28 Header Footer 1 60 Header Footer 2 60 headings 18 hiding graphics 14 hierarchy level indicator 45 HTML converting to 44 hypertext files 39 51 in generated web 45 locking and unlocking 52 I icons 59 Illustration 26 IllustrationCaption 26 IllustrationPlaceHolder 26 IllustrationRight 26 illustrations 26 on left pages 26 Index on right pages 26 imported files generating a list of 14 managing 14 number of formats 14 tips 14 importing graphics by copy 14 graphics by reference 14 listings by copy 28 listings by reference 28 indentation and spacing in listings 28 index 38 51 building blocks 38 importance of 38 IXgen tool 38 markers 38 page layouts for 49 information chunks 2 Input 6 20 inserting figures 24 multiple spaces 28 tables 22 inside cover 34 installation 4 introduction 1 IXgen 38 K KeepRestOfPageClear 20 L L1Aplha 20 L1Bullet 20 L1Continuation 20 L1Hyphen 20 LiNumber 20 left brain 2 lib 8 49 50 51 52 58 linear logic 2 list of figures 55 listings 55 tables 55 Listing 24 listing list of 55 ListingCaption 24 ListingLine 24 25 ListingLineFirst 24 28 listings 24 importing by copy 28 importing by reference 28 indentation and spacing 28 longer than 1 page 24 FrameMaker User Guide Templates 65 Index 66 Listing Verbatim 24 28 logging template changes 6 logic linear and sequen
21. 4 chapters 12 content files to book 12 13 advantages of good documentation vi of importing by copy 14 of importing by reference 14 appendices 36 automatically updated files deleting 54 re adding 12 54 availability of templates ix B background text 43 BackgroundText 43 base directory 4 BiblioBody 36 bibliographic references 36 bibliography 36 61 Biblioltem 36 BiblioSection 36 Body 18 20 BodyPlaceHolder 20 22 24 25 BodyT bular 20 BodyVerbatim 20 Index book closing all files in 57 deleting files in 13 opening all files in 43 56 routine procedures 42 saving all files in 43 57 updating 42 book template 1 5 brain left and right side 2 breaking up information 2 C cerebral hemispheres 2 chapter tfm 6 49 58 ChapterNumber 18 chapters viii adding and deleting 12 section headings 18 splitting into files 60 title pages 18 ChapterSection 18 60 ChapterSubSection 18 ChapterSubSubSection 18 Chapterlitle 18 character formats 20 customizing 20 Input 6 20 Output 6 20 checklist for customizations 6 ChepterSectionList 18 chunks manageable 2 closing all files in book 57 comments sending ix component files 4 see also file types see also files ConceptDescription 20 Conceptiem 20 content editing 17 FrameMaker User Guide Templates 63 Index 64 conventions in this manual viii naming new format 6 converting to WWW 44 cover 34
22. 6 34 right brain 2 roman page numbering 34 routine book procedures 42 running footer 43 running header in multi file chapters 60 S saving all files in book 43 57 saving as PDF 46 section headings 18 sequential logic 2 setting up your document 4 set up procedures 47 SideHeadSection 6 30 SideHeadStep 20 SideHeadSubSection 6 30 Smart Spaces 28 Snippet 24 software required ix spaces hard 28 Index spacing and indentation in listings 28 special sections 30 splitting a chapter into several files 60 spreads 2 page 3 standard customizations 6 STOP 49 STOP method viii 2 STOP template illustrations 26 STOPMasterPages210x210 fm 49 STOPMasterPages210x254 fm 49 STOPMasterPages210x279 fm 49 structure 4 structured report style 2 structured writing 2 style 2 choosing 2 normal 2 of documentation 2 STOP 2 structured report 2 submissions of material to editor 48 subsection headings 18 support ix T table formats 22 2Col 3Col 4Col 5Col 22 Figure 24 Illustration 26 Listing 24 Snippet 24 ZanyTextSection 32 table of contents 10 TableCaption 22 tables inserting 22 list of 55 tips 22 task oriented approach 10 template customizations 6 8 managing 6 page layouts 49 templates and availability ix and efficiency vi vii and results vii availability ix chapter title page 18 customizing WWW conversion 46 directory structure 4 file types see f
23. European Laboratory for Particle Physics D Information Process and Technology Group ZA CH 1211 Geneva 23 Switzerland Mario Ruggier 15 July 1998 How to use the FrameMaker User Guide Templates Release 2 0 http www cem ch FrameMaker User Guide lemplates elease 2 Copyright CERN Geneva 1997 Copyright and any other appropriate legal protection of this documentation and associated computer program reserved in all countries of the world Organisations collaborating with CERN may receive this program and documentation freely and without charge CERN undertakes no obligation for the maintenance of this program nor responsibility for its correctness and accepts no liability whatsoever resulting from its use Program and documentation are provided solely for the use of the organisation to which they are distributed This program may not be copied or otherwise distributed without permission This message must be retained on this and any other authorised copies The material cannot be sold CERN should be given credit in all references This document has been prepared with Release 5 5 of the Adobe FrameMaker Technical Publishing System using the User s Guide template prepared by Mario Ruggier of the Information and Programming Techniques Group at CERN Only widely available fonts have been used with the principal ones being Running text Palatino 10 5 pt on 13 5 pt line spacing Chapte
24. IGHT Ct and tn iranis 3 1 Types of web pages 3 2 User definable variab 3 3 LIGHT variables 3 4 General project page 3 5 LIGHT object pages xd baci J beim CEP BT Cirrus Pkrvember 1397 Piberip Mimar Duais Borilin Btaria Fuggier LIGHT OO Webhlaaber s Guide Example of an automatically generated structured web Navigation aids include next previous buttons for linear navigation up top buttons to quickly go up the document tree and global and local tables of content as well as the index for jumping to specific pages Delivering the document 46 Create symbolic links contents htmland index html that point to the HTML files with the global table of contents and index respectively E g UNIX ln s ug 4 html contents html ln s ug le html index html Alternatively just copy the files cp p ug 4 html contents html cp p ug le html index html where ug 4 html and ug 1e html are replced with the actual names of the generated HTML files for your TOC and index Create a symbolic link welcome htm1 that points to the first file of the generated web E g UNIX ln s ug html welcome html Or alternatively just copy the file in the same way as in 2 Saving as PDF Saving as PDF is straight forward except for the setting up of bookmarks It is recommended that the same hierarchy as the FrameMaker table of contents is used Thus the list below Include Paragraphs of the Acrobat S
25. Lo M p BowY piun Trh Fen I acc ORE es T c 050 LES pees ipar meai tme Hin Licin j Regenerate and update your book document as explained in Section 3 1 Routine book procedures Save all files in the book of your document Esc fs or Shift key click on the book File menu to select Save All Files in Book Close all files in both books i e both your document and your reference template Esc fS or Shift key click on the book Hle menu to select Close All Files in Book FrameMaker User Guide Templates 57 Set up and maintenance procedures A 5 Copying and creating Zany paragraphs 58 10 To use a Zany paragraph see Section 2 8 The zany paragraph formats you need to create the format or import it from somewhere Copying Zany paragraph formats This should be considered as a template customization and so should be treated as explained in Section 1 3 Managing template customizations The best file to add them to first is probably chapter fmin your reference template as follows Open the file chapter fmof your reference template Open the file Zany m in the 1ib directory of the distribution From the File menu of your chapter template file select ImportFormats Under Import from Document select Zany fm Under Import and Update select only e Paragraph Formats Table Formats e Reference Pages Click on Import In the chapter template file s
26. With the insertion point in the IlustrationPlaceHolderparagraph hit RETURN This will create an IMlustrationCaption with the same number as the last defined ChapterSection 4 Place the insertion point again in the IustrationPlaceHolderparagraph and depending on whether the illustration is textual or graphical For textual illustrations insert an Illustration table and in it insert the text for graphical illustrations insert an anchored frame with the following properties Anchoring Position Below Current Line Alignment Center Width 16 9 cm Height 25 8 cm Into this anchored frame you can now import your graphics or create them with FrameMaker See Section 1 1 Two document styles to choose from t Ifyou prefer to have illustrations on the left and text on the right you will need to modify the autonumbering of the paragraph formats ChapterSection and IllustrationCaption Since in the logical order of the document flow the first autonumber increment would occur in IllusrationCa ption you will just need to remove the from the numbering scheme of ChapterSection and add it to the numbering scheme of IllustrationCaption 26 FrameMaker User Guide Templates File Edit Format View Special Graphics Table HTML files of code HTML files for diagrams Illustration 4 1 Control flow for the whole process The input data are the source files C and diagrams the LIGHT 00 configuration file and the templates
27. a Cross references imply links between files thus filenames and locations must be both known and stable b There may not be a suitable destination point in the target file Thus the owner of the source file must be able to specify one and the owner of the destination file must be able to create it Probably the simplest solution is to have a convention by which authors can mark cross references in their documents to be established later by the editor at book compile time Thus as an example inserting text such as XREF description in the document itself may be enough Another possible solution is to control the destination labels for cross references manually using Cross Ref markers exactly the same way as is done in LaTeX 7 This will allow you to insert cross references that point to a copy of the destination file When this file is replaced with the master e g when the editor compiles the book the cross reference will still work as the same destination label would also have been inserted into the master destination file FrameMaker User Guide Templates Changing the page layouts for different page sizes A 2 Changing the page layouts for different page sizes Page sizes are changed by importing page layout formats from the format files in the 1ib subdirectory of the distribution Page layouts for the cover the index and all other files Each book template uses three different types of page layout definition sets
28. a ra un rpm unt ha MASP IARE ERA IR PRI MCA res imma aa mama The principal differences between the two document styles can be seen from these examples of 2 page spreads The normal style does not restrict text to fit only on one page and figures tables and listings may be inserted wherever and whenever needed The STOP example expresses a single concept as a 2 page section one page for text and one page for an illustration Illustration 1 1 Getting started 1 2 Mle organization and set up The way you organize your files depends on your process i e on how you want to work For clarity we assume that the normal template is being used but this discussion applies also to the STOP template Organisation of the template and document files The template is a FrameMaker book file containing several component template files some of which are editable and others are automatically updated The template is delivered with the directory structure of the template subdirectory in the illustration Note that individual templates for editable component files i e cover frontmatter chapter appendix and bibliography are delivered in separate subdirectories The document is similarly organized For multiple authors it is best to have a subdirectory per chapter as this is easier to manage access rights for and to re assemble the book check in and check out of individual chapters For single authors a flat directory structure may be easier
29. bi Fibre F Pali CERTI Ei Fass KA Cur As ADAM O expla khadi sa run vu giri Ha ihi Fais FAL ATO bit rw li nd rnm Main patho Backen ui pido varka ADS bi ria bed pa par Lied tales Cheaper pi iaire ar ep epee deer teh per UKs ra Senge Piri c pnerericatense di UST Man milk ADAH C Tola Monegan pei rem mium ALT FH Ta abad Corpin Tiris Corm rica Hong LT bl dell ry ael Bathing Corp hban eyed med i LG Vi Boume sl a Fh LE Ls in ch HN SAID sels pa A Illustration 2 10 Examples of an appendix first page and a bibliography Also shown is the minimal paragraph catalog for the bibliography as opposed to the one shown in Section 2 2 Running text Keeping dedicated paragraph formats in the corresponding template files helps keep the each template file type less cluttered and easier to use Editing the content 2 11 The index Table 2 1 A document without an index has been likened to a country without a map and it is generally accepted that nearly every work of non fiction is far more useful if provided with such a chart in the form of an index 1 Importance of the index The index is the user s most important key for finding information in any document that is very likely to be read in a random sccess fashion This category of documents definately includes user guides and reference manuals One of the most common complaints about technical documents is the lack of an index or a poorly designed ind
30. book 1 7 Managing imported files Advantages of importing by reference Advantages of importing by copy Chapter 2 Editing the content 2 1 The chapter title page and section headings The chapter title page Sections and subsections 22 Running text x Paragraph formats Character formats 2 3 Tables Inserting a table Basic pre defined table formats 2Col 3Col 4Col 5Col 24 Figures listings and snippets Normal template Inserting a figure TL NE Listings and snippets Inserting Listings longer than 1 page 25 Illustrations STOP template Right page illustrations Formatting illustrations 2 6 Controlling indentation and spacing in listings Inserting multiple spaces E Importing a listing by copying Importing a listing by reference 2 7 Function calls Formatting separate units such as functions Customizing for more specific paragraph tags 2 8 The zany paragraph formats a deu Use only few zany paragraph formats Importing zany formats or creating new ones Using zany formats Zany sections 2 9 The front matter The cover and inside cover Editing the frontmatter file Roman page numbering 2 10 The appendix and the bibliography The appendices The bibliography References to bibliography titles 2 11 The index T xii FrameMaker User Guide Templates 10 10 10 10 x12 12 12 12 13 13 14 14 14 17 18 18 18 20 20 20 222 122 24 24
31. ces The appendices are just chapters that use the appendix template file Everything said previously about editing chapters also applies to appendices The only difference being that paragraph numbering in the appendices uses an alphabetic scheme The bibliography The bibliography should follow the appendices Entries are formatted using pairs of paragraph formats and can be grouped into sections Biblioltem Contains the document title identified by a number BiblioBody Contains the additional information for the title such as the authors publishibg house year etc BiblioSection To group entries into logical blocks not included in the TOC References to bibliography titles References to publications listed in the bibliography are nothing more than cross references to Biblioltem paragraphs in the bibliography file using the Bibliography cross reference format 36 FrameMaker User Guide Templates Set up and maintenance procedures Turiphum ep und pee ee per that ed ere me ete hap Tiia ragha cu redis mother acting Cha his iuc apc a Kc Liane ea tii Tieg ham bariak id ana barman im Mala makeing Ceapa Eri ib en Dp eogun EBri Zi ii 3 Harika Fha Desjardins Currie iki irquC ngay Lei Tha Fritip Ballei ioc ig Mikal Tenrurdl p Unckird Viren Boris TPCku ACH Tiara mr Duabus Syrkera B FTN Jnepeid ame VPorsbaaghs hl Ein ka Y Prudentii F Ebby W Lone Preetion Mal TI The Gad Syri me Fro pees Ed paai d
32. commended that you replace all spaces in imported listings to hardspaces This is done as follows Select the entire code listing Pop up the Edit Find Change or Esc ef as keyboard shortcut Set Find to Text and type a single space in the text field Set Change to To Text and type a single hardspace in the text field CNTL Space Make sure that Change All In is set to Selection Hit Change All In Accept the Cannot be undone OK to continue pop up Importing a listing by reference When importing text files by reference any white spaces in the source are retained The only adjustment you are allowed to do is to assign an appropriate paragraph tag to the entire inset e g ListingLineFirstor Listing Verbatim Tabular characters in the source file are problematic as tabs in Frame have a different meaning than tabs in ascii files It is better to replace any tabs in the source file with the appropriate spaces If this is not possible then I suggest you create a special paragraph format to simulate the same pattern of tab stops in the source Format Document Text Options FrameMaker User Guide Templates File Edit Format View Special Graphics Table Control files 4 1 ROB Emulators configuration fileq Tu ROB Emulator s configuration file is specified at the program call e g rob DMA m C rob cfg_rio20 If only the m option is given then the program tries to find the file named rob ctg 4 Listin
33. dyTabular 20 BodyVerbatim 20 ChapterNumber 18 ChapterSection 18 60 ChapterSubSection 18 ChapterSubSubSection 18 Chapterlitle 18 ChepterSectionList 18 ConceptDescription 20 Conceptiem 20 customizing 30 DL1Description 20 DLITerm DL1Description 20 FcnCall 6 30 Fcninput 6 30 FenOutput 6 30 FcnParameters 6 30 FcnSynopsis 6 30 FigureCaption 24 MustrationCaption 26 IllustrationPlac eHolder 26 KeepRestOfPageC lear 20 L1Aplha 20 L1Bullet 20 L1ContinuationVerbatim 20 L1Hyphen 20 LiNumber 20 ListingCaption 24 ListingLine 24 25 ListingLineFirst 24 28 Listing Verbatim 24 28 Quote 20 QuoteBullet 20 SideHeadSection 6 30 SideHeadStep 20 SideHeadSubSection 6 30 TableCaption 22 Zany see Zany formats part of software documentation vi PDF 46 planning user guide 10 pre defined formats characters see character formats cross reference see cross reference formats page layouts see page layouts paragraphs see paragraph formats reference pages see reference pages tables see table formats variable see variable formats presentation v and usability vi importance of vi printing to standard sized paper 42 procedures book routine 42 set up and maintenance 47 process 4 6 48 Q Quote 20 QuoteBullet 20 R re adding automatically updated files 12 54 reference pages Zanylcons 58 59 reference template 4 references bibliographic 36 required software ix Right 2
34. e argument of Choose the style early Section 1 1 applies Selecting a different page size or even switching from one to another is a simple procedure as long as it is done early on Doing it after most of the document is partitioned for a specific page size especially in the case of the STOP method may imply significant amount of manual adjustments and rewriting Centralize template customizations Changing page height is a template customization and thus should be treated as discussed in Section 1 3 Managing template customizations Default paper size is A4 8 FrameMaker User Guide Templates Tiha pmen Fn Figs er Adi mas rna om MQM in E mi iia FIF Tia TF mam miaa hamsi ien daia heresy und la arisquanrcang amaral ampan risas u praua t in Ma ampa sanam i pum ga Figan Li Tras dara ra bapang macer iang hadam i D lic fii sanam pm iimas da ska i ra paca iai rp rie papangig i ima Tas iana Bam Lan ina i a rda raa a ehari e pemi p y pend os eee Th mmi ee me a tiori ni emot ed eed amd rd h ien aD ee guum heg m tia iat api Fea ai iran tl in gas m ha sami mana 1 sapr By pcd a PARI pi xn press m iur edad shori Tiai TLF menm amm omma Jana ABAD a on maa amar asa aa aa an puro aw ley Tha Lori can cams raphy piai en miaa cma ia oa ia Fate uns Kim Fu pia orl i L 1 L t dem i L4 inigsacimae dela analysis Tom ireren rer pe rm iniri Seb si Pae o PI ee E mam alu
35. e event descriptor address found in the reply pipe The size hsiz and fsize arguments respectively return the event data size the event header size and the event trailer size The hype argument returns the event type The ev hev and tev arguments respectively return pointers to the event data the event header and the event trailer Guile bo oped the DATE ses 29 Illustration 2 7 Functions and other separate units can be formatted using two special paragraph formats SideHeadSection and SideHeadSubSection in conjunction with other formats for running text Editing the content 2 8 The zany paragraph formats Clarity and impact of special pieces of information are sometimes improved if they are associated with an easily identifiable visual image This information could be things such as notes warnings summaries hints bugs etc These templates provide you the option to import a selection of special zany paragraphs into your document each of which is associated automatically with an icon If the predefined set is not enough an easy formula for adding your own is provided An extensive list of graphic files for sample icons is also included to which you can also add your own creations Use only few zany paragraph formats You should only use up to around four different types of zany paragraphs in a given document using too many will undermine the effect of clarity and directness that you want to achieve Also the s
36. e normal report style may insert figures listings and snippets wherever necessary in the text These are all inserted in the same way as tables as there are pre defined table formats for each of them Inserting a figure 1 Create a blank BodyPlaceHolderparagraph 2 Select Table insert Table and choose the Figure pre defined format This creates a 1 celled boxed table with an autonumbered FigureCaption below it You may now insert an anchored frame in the single cell to contain your figure Listings and snippets Snippets differ from listings in that they have no caption and by default source lines are not numbered Thus you use snippets for very short listings of code commands source files etc that do not need to be captioned or line numbered Inserting 1 Create a blank BodyPlaceHolderparagraph 2 Select Tible Insert Table and choose either the Listing or the Snippet pre defined format In either case this creates a 1 celled boxed table The default paragraph format in the cell ListingLine is autonumbered and one per source line should be used thus producing automatic line numbering The ListingLineFirstparagraph format resets the line count to 1 If you d rather not have automatic line numbering you can just use the Listing Verbatim paragraph format instead Listing tables are automatically created with an autonumbered ListingCaption Snippets have no caption Listings longer than 1 page Do not use the List
37. e page layouts for different page sizes 10 impari ormer ts impui frase Document banter agenar fee PD Crear firi and Paragraph Foewals l Math Dedindtiors J Variable Danita J Qeri Foemats O Document Properties L Crest Reterence Formals nier Desinitionss LI Costiera Text Selaras Talie Fannats Paterne Pagid While Uprising Faar 1 Hanun Page Breaks Other Farmal Lannut Overriies kpisrie Bae Upriuin a as apin fra F im LI inper _ Ameni e E nid The index file Open the format file for the index page layouts 1ib MasterPages210x210Cover fm Open the index file usersguideIX fm inthe book From the book file window of your reference template select File ImportFormats to pop up the Import Formats dialog box Set it up as follows a Make sure that in the Import from Document field the file MasterPages210x210Index fmis selected b Make sure that all format options except for Page Layouts are de selected c Make sure that the only file under Update is the index file i e usersguideIX fm d Click on Import The other files Open the format file 1ib NormalMasterPages210x210 fm for the page layouts for all other files i e the outline table of contents frontmatter chapter bibliography and appendix Open all the automatically updated files namely the outline usersguideOUTLINE fm and the toc usersguideTOC fm From the reference
38. e paragraph catalog 32 FrameMaker User Guide Templates EEEN sty s IRE scc E wat A E gets V crabs Jt ad St address Then tt looks ar ROD having the same crate kl and taker its RI ds and VIME bare addresses df nas The program zuppoees that the ROR ids are going from Dto amber of ROBs in crabe L The curren version 1 3 cf ube 187 c8 the program domes nat sapport 422 1688l Rel DRGs COnRQUraRon We 777 The taxat fol D stributoe s contig ration file is specified at the program call eg L4 SEI e E led et ei oily the m eptien H giran Chen tie program fries f find the file amend Ard cfg jor br afg cdo QE Mete tor the Can version Thee Local Red Distributor peogram Ear find hls cwn craba Jd and the VIE ped ees af fts ROB in the T2 atap configuration fie spactt kd by the HET Ecemand Sinak tha CA version er hus Diamerrsrratar E dead net una tha TZ situp tenfiguration Vibe there b a pesasibsilibo to define the above par armatura directly in the Local Rol Distributors configuration fhe in tha following way Mam d Tune RAT eT eT Care Oaths meer pee ee ee eS The VAM E base address of the ROPs are given by the ROB_SRAM ommani Several fines canbe given starting with POB_BRAK The VME addresses rust be given in 3heerndar of ECB kis In the above aan ple BOB with 81 7 has VIE ert addres xD IDEE while ROB with ld amp has MONIEN 1 Illustration 2 8 Example of single zany paragraph and of a multiple parag
39. elect View Reference Pages Page down until you get to the Zanylcons reference page Each frame adds a little less than a kilobyte to the filesize Identify which ones you would like to keep and which ones you would rather not remember that you should not use too many different ones in any one document anyway For each one you want to throw away do Select the frame and take note of its name select Graphics Object Properties b Delete the frame by hitting Backspace c Pop up the Paragraph Catalog and click on Delete at the bottom of it d Delete the paragraph format with the same name as the frame you have just deleted Repeat this procedure for the frontmatter and appendix templates if you would also like to use zany paragraphs in those file types FrameMaker User Guide Templates Copying and creating Zany paragraphs 10 Creating your own Zany paragraph formats The few predefined zany formats are intended mostly as an illustration of the use of these special iconed paragraphs You are encouraged to create your own consistent set of such formats for your document sets This helps to improve the consistency of your document set as well as adding some identity All you need is an icon per zany format The 175 directory in the distribution contains an icons subdirectory with more than 50 icons that you can use Once you have made or selected and icon 6 you can make a new zany format form it as follows Creati
40. ended purpose 3 Part of the software User documentation is not an after thought of the software development process This archaic approach is a breeding ground of many problems There may be very little time left to produce the documentation before the final system delivery deadline Or due to a lack of documentation the system may not be reviewable by users prior to its completion and any change then will be quite expensive The only way to give documentation the importance it deserves is to accept the fact that it as an integral part of the system This implies that it is planned for along with the rest of the project and that appropriate resources are allocated for it Advantages of good documentation A user confronted with a possibly good but badly documented system will very likely draw judgement on the system based solely on the documentation The evaluation will probably stop not much after the initial frustration with the system due to its inadequate documentation Good documentation saves time and money as users can become familiar understand and properly use the system faster It can actually help reduce your manpower problem Importance of presentation How easily you can find and absorb what you are looking for in the user documentation of a system irrespective of whether you are a novice or an expert user of the system is largely a function of how the document is organized and presented Manuals should be clearly
41. eneral pajaci pages berau they urs HTML Tames and bacagsseseirtirapinie ge UT apie zr we produces enne Shan one page Cine HTM Senmplue tr asch trap YER aed ako ose j P larpilabe HS haia Du hane bai iii df LIGHT D amp ertum oT Hr sit pee EroectPaga TEMPLATE 20 Ai dascrited in Ina HIN gach gage has a das dali ncn aae TEMPLATE j a navigadan faune nag TEMVLATE and a man faune that car ba a emploie Res far OMT eng class darumentshar or rel eke fer hs case at urange fiar Djeci pipt hasplartes The ll bekia contains Se defeat Fera crc that creaba Hos moria pn pages co pant thing TEMPLATE b fue iare ed display Er rise gas n Pra nid A chin TEMPLATE used jo disp ar the Bocumsnisbon sskxied jo 3 single close eats o TEMPL T Hi tro rara sat thaz castas Ie Code ans fik ago panii Sr a Bnge amp OMT lenpl ala D dnm TE timp woes Schirm TEMPLATE in he tammi fal voll contain Goth he dan coge and He nissan fit nay TEMPLATE ts he Fame teat ciple rasigabon nenu far fie fies PLATE has the sare strectuno at Pre Cares pandin Donplaias for fias and TESH T anra TEMPLATE display Han D ampiciun TEJAPLATE ihisri iie H Bun de ronenipn JB 5 de 10 oF nuni Xl sinus i Syria of Pre variagies NE T isn parent apan pictur LIGHT OO page templates t alus Ern ie werk wen proci Ia wen LIGHT Ce in Pre Tello wari the generation of he wet pores Peavided with L
42. erPages210x279Index fm FrameMaker User Guide Templates 49 Set up and maintenance procedures 50 Changing the page size Changing the page size should be treated as a template customization and thus handled as discussed in Section 1 3 Managing template customizations This means that you should first change the page size of your reference template You can then create new chapters using the template files in your reference template As an example let us suppose that you want to change the page size of your reference template from the default of A4 to that of 210 x 210 mm The step by step procedure is as follows Preliminary set up If you have not yet done so set up your reference template as described in Section 1 2 File organization and set up Open the FrameMaker book file for your reference template with FrameMaker The cover page file Open the format file for the new cover page layouts lib MasterPages210x210Cover fm From the book file window of your reference template select File ImportFormats to pop up the Import Formats dialog box Set it up as follows a Make sure that in the Import from Document field the file MasterPages210x210Cover fmis selected b De select all format options except for Page Layouts c Double click on all files under Update except for the file cover fm to move them to Don t Update d Click on Import FrameMaker User Guide Templates Changing th
43. etup dialog should contain all heading paragraph tags using the same hierarchy as in the generated table of contents see Appendix A 3 Deleting and re adding automatically updated files To guarantee that hyperlinks within the document work properly in PDF it is better to produce one PDF file for the entire document as opposed to single ones for each source file Dealing with changes to the template Section 1 3 Managing template customizations discusses a systematic way to manage customizations to the template For each customization you make to the template you will need to update the BookHIMLand the BookHeadings reference pages accordingly Documentation is provided by the Adobe FrameMaker User Guide 4 FrameMaker User Guide Templates Appendix A Set up and maintenance procedures Peripheral set up and maintenance procedures that are only needed occasionally are collected in this appendix A Further thoughts on multi author editing 48 A 2 Changing the page layouts for different page sizes 49 A 3 Deleting and re adding automatically updated files 54 AA Updating the formats of your document files 56 A 5 Copying and creating Zany paragraphs 58 A 6 Splitting a chapter into several files 60 FrameMaker User Guide Templates 47 Set up and maintenance procedures A l Furtherthoughts on multi author editing 48 The main editor should decide how to orchestrate the multi author wri
44. ex 1 A good index adds value to any book e Users can find specific information efficiently e Users decide whether a manual is going to be useful or not depending on what they find or do not find in the index e Some users will outrightly refuse to use a manual unless it contains an index Building the index The job of the indexer is to make sure that all relevant statements in a manual are recorded in the index in such a way that the user can find them easily Important issues are conciseness extent of indexing as many as 10 per page appropriate use of logical headings and see or see also cross references To add index entries to your FrameMaker document you insert index markers in the text throughout the document The markers are then automatically compiled to build the index file which therefore should never be edited by hand Index markers have a specific syntax the basic building blocks of which are shown in Table 2 1 Basic building blocks for index entries For complete information and examples of index entries consult the FrameMaker documentation Building block Effect colon Separates levels in an entry semicolon Separates entries in a marker lt nopage gt Suppresses the page number in the entry lt CharacterTag gt Changes character format in the entry To change back to default you would need insert lt Default Para Font gt Additional tools exist to facilate the creation and management
45. fom where Se eres conemaneda spe ecpected The cell t rwmizkwr rice j fonction from l erarg maru c makau the pegatriiion cf all r schu ries iiad in the pies reg wep Then Ge preg har ks cill the mulino Illustration 2 4 Document following the normal report style may insert figures listings or snippets anywhere in the text All such objects are anchored in an empty BodyPlaceHolder paragraph Line numbering in listings is obtained by using the ListingLine paragraph format Editing the content 2 5 Illustrations STOP template The template that supports the STOP method provides pre defined formatting for full right page illustrations Right page illustrations The STOP method defines sections as 2 page spreads one for text and one for the illustration The template defines the right page to be the illustration page of STOP sections Illustrations may hold graphical informations such as drawings or screen dumps or textual material such as source code listings Formatting illustrations 1 Create a blank IllustationPlaceHolder paragraph This paragraph is set to start on a new text column thus should be put at the top of the following Right page 2 If the master page used is not IllustrationRight then assign this master page to the page where the IllustrationPlac eHolder paragraph is Select Format Page Layout Master Page Usage n Use Master Page Custom select IllustrationRight Click Apply 3
46. for unique pages and object pages The generated web is made of project pages and object pages Illustration 2 5 The various formatting elements of full page illustrations This example shows a graphical illustration thus an anchored frame is inserted in an IllustrationPlaceHolderparagraph Textual illustration would employ the Illustration table format The size and border of the text column for the image as well as the caption are specified on the IllustrationRight master page Editing the content 2 6 Contolling indentation and spacing in listings 28 DEO Ee O N By default the template files have Smart Spaces turned on This tells FrameMaker to not allow you to insert more than two or more adjacent spaces In general this is useful but for the special case of code listings it is not where white space is used to improve clarity This section describes a few tricks to control your white space in listings Inserting multiple spaces To insert multiple spaces while composing for example a code example directly into Frame use HardSpaces which are inserted with CNTL Spacebar You can see the hardspaces on screen by turning on View Text Symbols Importing a listing by copying When you copy a piece of code into Frame the original white space will normally be retained for you However if you then go and edit a line any sequences of adjacent white spaces will be collapsed to single spaces To avoid this problem it is re
47. g 4 1 The format ofthe file rob cfg Configuration file for ROB Emulator program Lines starting with are comments Empty lines are ignored EMO uu uuu Bau uuu uu u u u u u a Line not usedf ENT uuu rob evnt Line not used it is a possibility t for defining drive file s name forf t the further version of the progran F 10000 PETI tt Size of the ROIRC buffer in number J t of RORIC messages 2DR_BUFF 64 100 Size T2DR channel maximum size of aff uuuuuuuuuuuuuuuuuuuuuuuu TZDR record and mmber of messages This channel is not used by the it present version of the progran uuuuuuuuuuuuuuuuuuuuuuuu DIETE vu home users 1 edenes rob t2 conf tt Name of the T2 setup configuration file Here can the program find J his own and the FEX s SCI addresses J his ow ROB id uuuuuuuuuuuuuuuu uuuuuuuuuuuuuuuu Find Text Consider Case Use Wildcards L1 Find Backward Change To Text _ Clone Case s Document Selection EE Illustration 2 6 Controlling white spaces in listings by replacing them with hardspaces In this example text symbols are turned on Editing the content 2 7 Function calls Documentation for such things as function calls is more appropriate in a reference manual However p
48. h formats Creating a new Zany frame Creating a new Zany paragraph A 6 Splitting a chapter into several files Splitting the content i Setting the running header in subsequent files Bibliography Index 38 38 41 42 42 42 42 43 43 43 44 44 44 46 46 47 48 48 48 48 49 49 49 50 50 50 51 nod 52 54 54 54 56 56 56 58 58 59 59 59 60 60 60 61 63 FrameMaker User Guide Templates xiii Contents xiv FrameMaker User Guide Templates Chapter 1 Getling started Each user guide template comes in the form of a FrameMaker book that is pre configured with automatically updated lists such as tables of content and index To get going you simply need to create a document instance and then chapter and section headings according to your document plan A few template options are required to be set at this beginning stage thus you need to know what they consist of and how to select them 1 1 1 2 1 3 1 4 1 5 1 6 1 7 Two document styles to choose from 2 File organization and set up 4 Managing template customizations 6 Page size options os aoaaa 8 Planning your user guide ne yes 10 Adding and deleting chapters 12 Managing imported files Ls 14 FrameMaker User Guide Templates 1 Getting started l1 Two document styles to choose f
49. he document 3 3 Converting to WWW 44 The book template is pre configured for saving as HTML using the built in Book File Save As HIMLmodule of FrameMaker This configuration assumes that entire books as opposed to single individual files are saved as HTML However some document specific individualisation is required both before and after saving as HTML These steps are explained below Another possibility as a format appropriate for distribution on WWW is PDF supported by the new FrameMaker 5 5 Save as PDF feature explained below Before saving as HTML Go to the BookHTMLreference pages View Reference Pages locate the Systems Macros table and modify the following information as necessary The context links in macros StartOfDoc StartOfsubDoc and StartOfLastSubDoc The HTML code shown below is inserted at the top of every generated HTML page You may wish to change it lt small gt lt a href http www cern ch gt CERN lt a gt gt lt a href http www cern ch IPT gt IPT Group lt a gt a href http www cern ch FrameMaker gt FrameMaker at CERN lt a gt small The title text for the document in macros StartOfDoc StartOfsubDoc and StartOfLastSubDoc included in every generated HTML page The initial value is shown below small PROJECT User s Guide lt small gt The signature of each generated HTML page in macros EndOfDoc EndOfSubDoc and EndOflastSubDoc In particula
50. ile types for better results vii getting started 1 logging changes 6 normal tar 4 FrameMaker User Guide Templates 67 Index 68 options 1 package ix problem addressed by vii required software ix setting up 4 subdirectory 4 support ix two different styles 2 two page spreads 3 26 U updating formats 56 FrameMaker book 42 US Letter paper size 8 usability of documentation vii user documentation see documentation user guide templates see templates usersguideIX fm 49 51 52 usersguideOUTLINE fm bl usersguideTOC fm bl V variable formats FrameMaker User Guide Templates BackgroundText 43 Documentlitle 43 Header Footer 1 60 Header Footer 2 60 propagating across book 43 resetting in a single file 43 running footer 43 version control 48 W web generated 45 WWW converting to 44 Z zanni 32 Zany formats and file size 32 copying 32 58 creating 32 58 59 number of 32 Zany formats 32 Zany sections 32 Zany tm 58 Zanylcons 58 59 ZanyTextSection 32
51. ine spacing Chapter numbers and titles AvantGarde DemiBold 36 and 24 pt Section headings AvantGarde DemiBold 20 pt Subsection and subsubsection headings Helvetica Bold 12 and 10 pt Captions Helvetica 9 pt Listings Courier Bold 9 pt Use of any trademark in this document is not intended in any way to infringe on the rights of the trademark holder Why these templates If you wanted to write user documentation where would you begin from What should the document contain How should the information be organized How should it be presented How do you make sure that the document you produce will be usable These templates provide a sorely needed starting point and framework to begin addressing the above issues They offer an environment in which you can plan organize and develop your user documentation such that it is coherent both in content and in presentation About user documentation vi The problem addressed by these templates vii About this manual vio wr viii About the templates package ix Acknowledgements 39 eno Sere aes x FrameMaker User Guide Templates v Why these templates About user doc umentation Documentation is a vital but often overlooked part of any technical project Even when a considerable amount of effort is put into producing and maintaining documentation it may still fail to be useful if the style and layout are inappropriate to the audience and int
52. ing page layouts in 51 files 4 51 52 adding and deleting in book 12 chapter fm 6 49 58 cover fm 34 49 52 deleting in book 13 FrameMaker hypertext 39 51 frontmatter fm 52 locking and unlocking 52 MasterPages210x210Cover fm 49 50 51 52 MasterPages210x210Index MasterPages210x254Cover MasterPages210x254Index MasterPages210x279Cover MasterPages210x279Index m 49 m 49 m 49 m 49 m 49 normal tar 4 NormalMasterPages210x210 fm 49 51 52 NormalMasterPages210x254 fm 49 NormalMasterPages210x279 fm 49 organization of 4 size increase per Zany format 32 STOPMasterPages210x210 fm 49 STOPMasterPages210x254 fm 49 STOPMasterPages210x279 fm 49 usersguideIX fm 49 51 52 usersguideTOC fm bl Zany fm 58 formats character see character formats cross reference see cross reference formats graphics files 14 naming new 6 page layouts see page layouts paragraph see paragraph formats reference pages see reference pages table see table formats updating in document files 56 variable see variable formats FrameMaker viii book template 1 5 documentation viii hypertext files 39 51 locking and unlocking 52 Frank Stearns Associates 38 front matter 34 frontmatter fm 52 function calls 30 G generated web 45 getting started 1 graphics generating list of imported 14 hiding 14 imported file formats 14 importing by copy 14 importing by reference 1
53. ing table format as explained above Instead just use a ListingCaption paragraph followed by sequences of ListingLine paragraphs The Listing table format is there to enclose the listing in a box improving readability and to control spacing of the entire unit However single table cells cannot be larger than one FrameMaker page and a box spanning multiple pages cannot be really called a box anymore can it 24 FrameMaker User Guide Templates Dima Ides 1 1 Woking principles of the two programs l Demni ned B Oa BCG form bded wwe ete inso Eeki rules con wiring rrari Er Bach ROR ir comes bo ha Lares 2 vri Tha Ku of fa Loo Por D riri buic ino ceci vm Pod requis med daeigicnr drors tha Cep ipo scd ran rar dacincm p io a FOE ani pepe in cn yr Cia PE E TIL HL IJ HN INE I I dui af stemmed cated En mbna Du Pur nib in dni he i A in i dr oo EN hi MICI Vw Sed Gu Fa ER ARR ERR af BDR Errcabulen Deve keniat ek a inl si i k a 5 ITE BESES Ae Fila mare hda ran a strocture named s for B dees rect use Ha T stap rand a pelnier se the funtion ko bee elled urat pker dirsi Un Velo rigen An amay of REBOUR CEs Hg defined of hee beginning ofboth progres iles Loa g ard rob ch Tz addi nar raucaurca liam tothe program girngly edd a narr mambar bahis army ered wie Len turre maiia ke be called Ad trdtiaiizaHon tena cal Ga Function entrl initi euitialioar Ha rpa and defines the gerer made
54. ize of each FrameMaker file increases by about 1K per zany paragraph format Thus it is recommended that you simply copy the ones that you need rather than import all the predefined formats Importing zany formats or creating new ones Adding these formats to your document should be managed as any other template customization as discussed in Section 1 3 The exact procedures to create and add are described in Section A 5 Copying and creating Zany paragraphs Using zany formats Zany paragraph formats are applied just like any other pre defined format in the paragraph catalog The icon the paragraph title and the lines above and below are part of the format and defined as FrameMaker Reference Page Frames Zany sections In the less common case of emphasizing a sequence of several paragraphs a different technique is used First insert a table of the pre defined ZanyTextSection table format just as you would insert any other table see Section 2 3 Then Re tag the single Zany paragraph in the left cell to the desired one Type in the heading and text for the section can into the right cell Using Table Custom Ruling and Shading assign a Very Thin line to Top and Bottom of right cell The word zany derives from the Italian word zanni for a traditional masked clown As an adjective it now means something fantastically or absurdly ludicrous Also since it starts with the letter Z FrameMaker lists all Zany formats at the bottom of th
55. k Ag TEE apa itihe Ern weet of ROB Emulstee men eptien the conection dare OK thie florira WCE ia L smelbed La Ld 2 nmas 7 y4iiaDart IE reei en eror messa Ls printed end ithe ROS Exendator shops ma mad comer ba dd 1 mamme ee Ewbarm eel E Cmm mah eed Ma l The zia Li sorter diret SC checking options ane mlali E Iun ew ji IH Body BodyPlaceHolder BodyTabular BodyVerbatim ChapterNumber ChapterSection ChapterSectionList ChapterSubSection ChapterSubSubSection ChapterTitle ConceptDescription ConceptTerm DL1Description DL1Description gt DLiTenn DL1TermRIH FigureCaption Footnote KeepRestOfPageClear L1Alpha LlAlphaist _ _ L1Continuation L1ContinuationVerbatim LiNumberist L2Alpha L2Alphaist L2Number L2Number1st ListingCaption ListingLine ListingLineFirst ListingVerbatim QuoteBullet BoldEmphasize Emphasis Equation Variables Error FirstLetter Italic Keyword Roman Subscript Superscript Teletype ZapfDingbats zNegativeSpread2 SideHeadBody SideHeadSection SideHeadStep SideHeadStep1st SideHeadSubSection Ficus Predefined paragraph and character tags for formatting running text Editing the content 2 3 Tables A few simple table formats are provided as convenient starting points Properties like straddling and irregular ruling may not be stored as part of a FrameMaker table format in the catalog There may be a certain amount of table
56. ker Release 5 Automatic conversion to WWW is preconfigured for WebMaker 3 0 We d like to hear from you Send us your comments and suggestions about both this document and the templates themselves If you notice any errors or encounter a problem when using the templates please inform us To communicate with us send mail to docsys ptsun00 cern ch FrameMaker User Guide Templates ix Why these templates Acknowledgements I gratefully acknowledge all who have helped with this project in particular e Alberto Aimar and Paolo Palazzi colleagues in IPT for originating the idea for convincing many of the importance of such templates and for their continued support throughout the project e All members of the IPT group from the ECP Division at CERN for support and infrastructure Dante Borillo Erwin D nes and Fred Wickens courageous users of early versions of the templates Their feedback resulted in innumerable improvements x FrameMaker User Guide Templates Contents Why these templates Asb Uas th taaa Uh arte o xh deu ade OV About user documentation bods th dt 2 Soo Be Be A a NA Part of the software t 4 Boh Be Wu Advantages of good documentation p Mohs Awe e ie y i a Vi Importance of presentation lo eur E uv cue ur eL The problem addressed by these templates oue Lue een sb The problem currently vii Templates for better results Vii Abou
57. l printed on standard paper be it A4 or US Letter Thus documents with a page height different than that of the paper used will need to be cut after printing or photocopying This section describes how you can benefit from these preset options However if you desire a page layout not achievable directly with these options nothing is to stop you from customizing the template page layouts Different page sizes to choose from The default page size is that of the standard paper used in this case A4 297mm x 210mm One may choose to change the height to 254mm for a less tall document shape or to 210mm for a square shaped document The width does not change in all these cases i e 210mm Another option is to have the page size as the common denominator between US Letter and A4 The complete list of predefined page sizes is provided in Appendix A 2 Changing the page layouts for different page sizes The different page sizes allow you to produce a more handily sized document without investing extra work into the preparation of the layout Changing the page size Page sizes may be changed by importing page layout formats from the format files in the 1ib subdirectory of the distribution The exact step by step procedure to execute this is provided in Appendix A 2 Changing the page layouts for different page sizes Select the page height as early as possible Since changing the page height changes also the document styles the sam
58. logical character tags that are more appropriate for your documentation As an example you may add highlights to denote Inputor Output Feel free to add useful character tags as necessary Adding character is a customization and thus the procedure indicated in Section 1 3 Managing template customizations should be followed 20 FrameMaker User Guide Templates i oe Spree eet EEEREN apu with gett seek uses MAC 7 Irxrafur mode Thap ace for checking end miting SC interfaca cuplrieri Walt aed egal migs Selecting thas optar the ROB Emaleter progam polls rhe Inpatt V ME Tieg Ehre for ROIC cuore broads ered discards them The polling Hopi be billing Gor ater a epecified Hine Then be progeum prints oul the Tumben of mean ges pecelved ard thee time it eun polling This end opiion con be med for checking the Local Ria D sipiruker and the VE chanrsl Bri Une this manu cgtion to quil tha progres Batam tuzrniradtirig tha program will moa into shared mamory tha rabus of tha ewes buffer Sterting tha program again ji erill relencd rue saved erent cegmenis Differences in case of shared memory transfer mode rob SB 1 Illustration 2 2 There ia no limi c ECT end PCT rept ter tte a inimalizatizrri tima orba short rama gu dizglnpud if arracyihira ia OK ECE dpsued with wade dd i Arhont error mamaga will ba dep leped ii 51 ia not initialized correctly ru wat spes Bri matura vale raceme cane TO PE REN POATE Ji ae
59. m adiens FR es it H pet ent EU UFU a a EH Cab o D4eeE TARTE abo HP fe LL JII n ia oe rans si pee I 5 pim oom Jia GE RO Ds LAE e cud da mall i pln nnn i pon Ee TF niim pir teen igi ie Foe 8 TRU iac ege HLE ied CHI res SB PL ud ea lrlmra lu Esi ea gente br br pong pap linm The isir e Thes Lil D Bin Hh mr Ten e E uL dein p on ie n TIT SEL AGER aenn VE MEA ER a nmm agn ae sr W Tasse cried Lipi SO pl 1 eii AT ELT ETAT wd Nes e A 7 pari ipg enar quiam Tar lal rico en nib ler bon irr Li acre P BESTEN beUi i ALEUT PAF Tar imi Einer oea empor pl ri nn Tri eimai apara Hn i reri emma ri Uem prac io dt existed nnn Thon TH nnnm rnm ai cmemac i am mace a command en Las un mni rr nim nota vi bun se FAT aed ioa Ph T prp coran Illustration 1 4 Changing the page height from 297mm height of A4 upper half of the illustration to a height of 210mm to give the square shaped pages shown in the lower half of the illustration An intermediate height of 254mm is also a predefined option Getting started 1 5 Planning your user guide There are various ways by which you can organise your document one of which is the task oriented approach Other breakdown schemes are possible but it is of fundamental importance that you pick one and sketch out a plan for the book The task oriented approach The task oriented approach considers the different tasks that users may want the software to perform and how they might g
60. ng a new Zany frame In your chapter template file go to the Zanylcons reference page Create a new frame with the graphics tool and give it an name of the form Zanylcon where Icon is the name of the associated icon Using Graphics Properties set the width to 17 0 cm the height to 1 0 cm and offset from left to 4 0 cm Place it vertically on the page such that it does not overlap any other frame Make sure that fill and pen are set to None Copy from any other frame the line and label grouped graphic object Select the new frame and paste position of pasted object should be Top 0 3 cm Left 3 4 cm Select the frame and import your prepared icon by saying File Import File Make sure you use Copy into Document and click on Import In the Import Graphic Scaling dialog specify an initial scaling of 100 dpi scaling and click on Set Scale the icon further as necessary and move it using Control arrow keys or equivalent just to the left of the guiding vertical line Replace the label text with something more appropriate Creating a new Zany paragraph Go to the Body Pagesand create an instance of any of the previously defined zany paragraphs With the insertion point in this new paragraph bring up the Paragraph Designer FormatParagraphs Designer Create the new paragraph by a Change the paragraph tag name to the name you want to call your new zany paragraph and click on Apply In the New Format dialog make sure tha
61. ng and deleting chapters The table of contents You can get a global view of the content breakdown of the book by updating the table of contents as detailed in Section 3 1 Routine book procedures If you are not happy with the hierarchy or the order of the contents you can iterate on this procedure using the convenient hypertext feature of the table of contents To go toa section just click on the corresponding heading entry in the table of contents Then add delete cut paste etc the section headings in the document files before regenerating the table of contents 10 FrameMaker User Guide Templates Chapter 3 Managing the FrameMaker book M File Edit Format View Special Grap Editing the octet 27 Function calls Why these templates 7 I About user documentation e Presentation features of the templates File Edit Format View Shecial Graphics Aboutthismanval s es y Chapter 1 Getting started Insta th bion setup and nadstenasoe 14 Two document styles to choose from 3 12 Organisation and process H 13 Pageheightoptions Al Instalkatio 14 Planningyouruserguide 15 Addingand deletingchapters 14 Managingimported files aqte Domare nau m Chapter 2 Editingthe content 24 Thechapter first page 22 Text 23 Tables 24 Figures listings and snip ys Normal 25 Illustrations STOP metyfod 26 Controlling indentatiofand spacing in source listings 27 Functioncalls
62. nitoring program makes a request for a new event and implicitly releases the last event processed if needed ie if there is one event still being processed by the monitoring program and if a call to sh refeme event has not been explicitly made before Upon sumessful completion the function shall return a value of zero Otherwise the following value will be returned SEND FAILED Sending the request message to the stage through the request pipe failed sh wait dirclude mp h int sh wit int signal Description The monitoring program waits for an aynchronous signal The routine suspends the caller until a signal is delivered to inform the process of the ccurence of an event The signa parameter returns the signal number which wokeup the monitoring program Two esses need to be distinguished when signal is event_signal sc returned by sh mcannect the monitoring program ean find in the reply pipe the address of an event descriptor for an event of the type it requested the monitoring program should thus call sh get data to actually get this event when signal is one of the user signals declared in sb declare sienaf the foonitoring program should act axordingly Upon sumessful completion the function shall return a value of zero sh_get_data irelude mp h irt sh get data int size irnt hsize int tize int typ int ev int Lev int Atte Description The monitoring program gets an event from th
63. o about to find out how to do it This approach helps produce a document that is usable by all types of users regardless of level of expertise or background Organizing documents by other criteria for example by the type of user may require duplication of a considerable amount of information such as how to start the system Each identified task should be documented in a section that makes complete sense when read separately from the surrounding material In this way the user does not have to flip pages to complete a basic procedure Furthermore basic procedures will not need to be repeated but may be referred to as stand alone units Organize the tasks into chapters Once you have identified the list of tasks that you would like to document you should analyze how to best group these tasks into logical chapters and sections FrameMaker itself may be used for this If you do use FrameMaker before adding chapter files and inserting chapter titles and section headings it will be more efficient if you first decide on the set up of your reference template Section 1 3 This means you would need to also decide which document style to use Section 1 1 your file organisation Section 1 2 and the page heights of your document Section 1 4 If you further customize your reference template you will need to update the formats of any files already added to your FrameMaker book Adding files to your FrameMaker book is explained in Section 1 6 Addi
64. o fm L imported usersguidelX fm template gt usersguide book frontmatter les cover fm i frontmatter fm LA imported a a usersguideOUTLINE fm 3 usersguideTOC fm chapter N m chapter fm Anf imported appendix m appendix fm gt bibliography fm L imported E usersguidelX fm The default file organization of the FrameMaker book template is indicated by the template subdirectory The file structure for the actual document is derived from this and is indicated in the document subdirectory Getting started 13 Managing template customizations You may want to add to or modify the pre defined formats in the template Managing such customizations while still maintaining integrity of the document logic and presentation may be tricky in a multi file and multi author document preparation scenario To help we have laid out the following simple process What is a template customization A customization is anything which changes the definition of any of the pre defined formats or the addition of new ones This guide itself suggests a few standard customizations which you may choose to adopt such as variable page heights Section 1 4 Page size options iconed paragraphs for impact Section 2 8 The zany paragraph formats the cover page Section 2 9 The front matter setting the user variable for the running footer to
65. oc files but as these are locked hypertext files they need to be first unlocked and then relocked This is done by pointing in the document window and typing the keyboard shortcut Esc F1k both for unlocking and for re locking Regenerate and update the reference template book a Select Hle Generate Update from the book File menu b Make sure that all the automatically updated files are under Generate c Click on Generate Save all files in the book Ese fs by holding down Shift key clicking on the book File menu to select Save All Files in Book Close without saving the files a lib MasterPages210x210Cover fm b lib MasterPages210x210Index fm c lib NormalMasterPages210x210 fm FrameMaker User Guide Templates Changing the page layouts for different page sizes 15 Close all files in the book Esc C by holding down Shift key clicking on the book File menu to select Close All Files in Book The page layouts of your reference template are now ready and you can proceed as suggested in Chapter 1 Getting started FrameMaker User Guide Templates 53 Set up and maintenance procedures A 3 Deleting and re adding automatically 54 updated fies Deleting an automatically updated file is easy The problem is to re add them when necessary as this requires the specification of things like the source paragraphs or other objects filename suffixes etc Deleting an automatically updated file From the book
66. r Footer 2 instead FrameMaker User Guide Templates 10 Bibliogra phy The Art of Indexing Larry S Bonura John Wiley amp Sons 1994 Writing Better Computer User Documentation From Paper to Hypertext R John Brockmann John Wiley amp Sons 1990 Everything You Ever Wanted to Know about Documentation and should have asked C Fidge and D Heagerty Telecom Australia Research Laboratories July 1986 Adobe FrameMaker 5 5 User Guide Adobe Systems Incorporated 1997 IXgen Power Indexing amp Marker Management Tool for FrameMaker Frank Stearns Associates October 1996 The Icon Book Visual Symbols for Computer Systems and Documentation William Horton John Wiley amp Sons 1994 LaTeX A Document Preparation System L Lamport Addison Wesley 2nd edition Reading 1994 Writing User Documentation A Practical Guide for those who want to be read Roderick Low with Harriet Ford John Pallot amp James Hall Prentice Hall 1994 Typography how to make it most legible Rolf F Rehe Design Research International Fifth Revised Edition 1984 The TypEncyclopedia A User s Guide to Better Typography Frank J Romano R R Bowker Company New York and London 1984 FrameMaker User Guide Templates 61 Bibliography 62 FrameMaker User Guide Templates Numerics 2Col 22 2 page spreads 3 26 3Col 22 4Col 22 5Col 22 A A4 paper size 8 49 acknowledgements x adding automatically updated files 12 5
67. r and sequential logic such as text the right cerebral hemisphere deals with spatial and visual concepts such as pictures One of the best ways of imparting information to the reader is through a combination of both words and pictures thus enabling the reader to use both sides of the brain 3 Choose the style early You should decide whichever of these two styles you adopt for your document as early on as possible as shifting the material from one style to another may require some rewriting and other adjusting The STOP Sequential Thematic Organization of Proposals method was invented by Hughes Aircraft Company in the late 1960s 2 t The STOP template assumes text on the left and illustration on the right If you would prefer to reverse this see Section 2 5 Illustrations STOP template 2 FrameMaker User Guide Templates 1 1 Woking principias of the hwo programs Tesseract i ink Ra Kdiviri s firirimioi niens n ind eco mg ae iiia ase Roth ped ee ieee Mi seb ellen Les Ed DUST et I pe HER BH einn od DRL Del Ted Apn e en e H pL Tea LU ROS nd apti He pte rama Boda iE ei oan Bad lips 11 ios Us ren mid LORI Dee i Tia Pah Eres im aci lal Arenas hare ia iuda ia m rep ims ma Mh Bedside Tisi g erage maha a or ei Bod Pirie Ud Ecl Dala iH Eoo a Lie qui b PE n e mm am bte M ca lad eg emma Hii erg leur ied Dire Dembmirpruirmrzpacp ea acs aed mrs Pacers Bal mima iae sakalais FCR ada sand ll Rampant Me eH Tasai i iia she
68. r numbers and titles AvantGarde DemiBold 36 and 24 pt Section headings AvantGarde DemiBold 20 pt Subsection and subsubsection headings Helvetica Bold 12 and 10 pt Captions Helvetica 9 pt Listings Courier Bold 9 pt Use of any trademark in this document is not intended in any way to infringe on the rights of the trademark holder Copyright CERN Geneva 1997 Copyright and any other appropriate legal protection of this documentation and associated computer program reserved in all countries of the world Organisations collaborating with CERN may receive this program and documentation freely and without charge CERN undertakes no obligation for the maintenance of this program nor responsibility for its correctness and accepts no liability whatsoever resulting from its use Program and documentation are provided solely for the use of the organisation to which they are distributed This program may not be copied or otherwise distributed without permission This message must be retained on this and any other authorised copies The material cannot be sold CERN should be given credit in all references This document has been prepared with Release 5 5 of the Adobe FrameMaker Technical Publishing System using the User s Guide template prepared by Mario Ruggier of the Information and Programming Techniques Group at CERN Only widely available fonts have been used with the principal ones being Running text Palatino 10 5 pt on 13 5 pt l
69. r you may wish to change the date the name of the webmaster and the URL this is linked to if any The initial setting is address 2 July 1998 a href http consult cern ch xwho people XXXXX gt WebMaster lt a gt address After saving as HTML After each time you save as HTML you are required to in the same directory as the generated HTML files Over write the generated cascading style sheet file to be found in the same directory as all the HTML files with the one provided with the template shared ug master css E g UNIX cp p template shared ug master css ug css FrameMaker User Guide Templates L_CLaSS0EF ADDRESS 10 L_CLASSNAME 18 L_DATE 16 L DIA GEAPAIBAME D L FLEHAME 14 L_HPLEWAME 18 L_PROJECT 14 L_VERSIOM 14 bis cycle 2 igi conser camm 32 giri conet cap 2a EET dhaptar i Overesnw of LIGHT OO 131 Cuanagsa at fe c The LIGHT 0H 2 MT Q0 coig Pee E LKIHT CO r LEET Pa Dpi E The configuration file 2 1 What ie he paniy Faima of Hy i t fie c 22 LIGHT variatias C riguar y Vanablksi Lid Guginr 3 p LIGHT CIO page tempia A1 Types of web p phat i a Se niqse pajaci Object pagan a erable var TS Illustration 3 3 e navigation mde d fa 3 5 LIGHT object pages eer osjeripmges zz h piter Ca gory W gerard pagas are Bro Ces Popes ong Kr each Clas Or dapan TT T iter ban fie g
70. raph zany section encapsulated in a ZanyTextSection table as indicated by the visible borders Shown also is the bottom part of the paragraph catalog showing a selection of predefined zany paragraph formats Editing the content 2 9 The front matter The front matter consists of the cover page as well as the introductory material such as the preface prior to the first chapter This also includes any automatically updated files such as the table of contents but these are never manually edited so are not discussed here The cover and inside cover The cover is not only the first impression of your document that users get but is also the thing that makes your document be recognizable and stand out from a pile of other documents Thus the way the cover looks is quite important There are pre defined formats to make a simple cover page quickly but you may need to play around and change formats to achieve a look that best fits your document Probably you will only need to modify paragraph formats and the Right master page of the file cover fm Managing template customizations is discussed in Section 1 3 The inside cover contains the colophon and a generic trademark disclaimer You may choose to add other statements such as a copyright statement or change what is provided as long as the reference to the template source remains Editing the frontmatter file Editing the frontmatter file is identical to editing chapter files except
71. re defined paragraph formats are available in case you have the need to include such documentation units into your user guide Formatting separate units such as functions Two special paragraph formats have been added to allow the notion of having a separate block of text with its own subsections These can be used in conjunction with all other running text formats for separate units such as function calls The two formats are SideHeadSection For the title of such sections such as the actual function call A line is created above the title to separate from previous content SideHeadSubSection For the subsections of these separate units such as specification for input and output error messages etc The short headings appear right aligned in the sidehead column space of the document Note The SideHeadSec tion paragraph format does not appear in the automatically updated table of contents Customizing for more specific paragraph tags You may derive new logical paragraph styles to tag special sections such as functions calls Thus similar to SideHeadSection you could add a FenCall tag and similar to SideHeadSubSection you could add FenSynopsis FcnParameters Fcninput and FenOutput tags Any customizations should be managed as recommended in Section 1 3 Managing template customizations 30 FrameMaker User Guide Templates ur A Ik eat frat vew sem mes Tae C Evteface UNIX and OS yioma Description The mo
72. reference template and your actual document 2 Open all files in the book of your reference template Esc 0 or Shift key click on the book File menu to select Open All Files in Book 3 For each component file in the reference template i e for each file type update the document file of the same type doing From the File menu of your document book window select ImportFormats b Under Import from Document select a component file from the reference template e g chapter fm c Make sure that all formats under Importand Update are selected d Remove overrides by selecting both items under While Updating Remove e Make sure that under Update there are only the component files in your document of the same file type as that selected under Import from Document e g all the chapter files of your document f Click on Import Due to a FrameMaker bug each automatically updated file must be open during updating Thus before updating the outline the toc and the index make sure that they are open Do not close them until the very end 56 FrameMaker User Guide Templates Updating the formats of your document files impari unmet is impari from Document caapi Mi pari ard U D Paragraph Fomes Math brii T variabie Gaina D Domir premo D Dorumeni Prgerlies D Cross Hriernce Foarmalx D Pepe Loryaasts D inor Desnilians FO Comitiena Erxl Selir 7 Taiti armati 7 Before Pagid Wein hating Renae
73. resentation already taken care of will help you formulate your ideas easier and better Using these templates helps you to not only produce your user guide more quickly thus for less money but may also make your final results better than they might have been otherwise FrameMaker User Guide Templates vii Why these templates Aboutthis manual This manual is produced with the STOP 2 variant of the user guide templates documented here Key issues are thus presented as double page sections which include a full page illustration Who and what is it for This manual is for all authors and editors of documentation prepared using the FrameMaker User Guide Templates It is the only available document describing these templates Although it contains many tips on the use of FrameMaker this manual does not substitute the FrameMaker documentation 4 A basic understanding and familiarity with FrameMaker is assumed There is also much to be said about writing user documentation Different styles and techniques exist for different purposes Again although many sensible suggestions are offered this manual is not a description of how best to write user documentation to learn more on this subject please refer to more dedicated publications some of which are listed in the bibliography e g 2 and 8 The chapters Before starting to edit a user guide with these templates you should first read Chapter 1 Getting started This p
74. resents the major options and decisions that you should make early on How to organise your document is also explained here Chapter 2 Editing the content deals only with how to edit text figures tables and content in general Routine procedures for managing FrameMaker books are presented in Chapter 3 Delivering the document Other non routine maintenance procedures are collected in Appendix A Set up and maintenance procedures The main concepts of the templates explained in Chapter 1 and Chapter 2 are conveyed using the STOP method described in Section 1 1 The remaining more procedural material of the document is written in a more conventional structured report style Conventions used in this manual In general the names of files and UNIX utilities are printed in italic Courier The sequence of FrameMaker menu selections or the names of FrameMaker dialog windows are printed in AvantGarde DemiBold Oblique FrameMaker keyboard shortcuts are printed in bold Courier Simple emphasis uses italics Steps in step through procedures are numbered with the number outdented from the text viii FrameMaker User Guide Templates About the templates package Aboutthe templates package Availability of the templates The distribution kit is available on WWW from http www cern ch FrameMaker It is available only for users at CERN or at collaborating institutes Required software The templates are prepared in Adobe FrameMa
75. rom There are two user guide templates to choose from each supporting a different style of writing user documentation One template supports the structured report style with which we are all familiar and the other the STOP method is a hybrid of structured writing and preparation of transparencies for presentations The structured report or normal style All the commonly available user documentation basically follows this ubiquitous style of technical writing in which documents are organized as hierarchies of chapters sections and subsections with each section containing running text intermixed as necessary with figures tables and listings It can be quite suitable for almost all types of user documentation The STOP method The STOP method 2 breaks up each chapter into independent double page spreads Each double page spread should convey a single complete concept and is made up of a textual page and an illustration page You can think of each 2 page section as a transparency accompanied with comprehensive textual explanation The STOP method can be used whenever a concept can be more clearly expressed by both diagrams and text You may suspect that it would be impossible to squeeze all of your complex information onto separate double page spreads However making the effort to do so is one of the best ways of breaking your information into manageable chunks 3 Why use it The left side of the brain works with linea
76. s ba ds Wiss otn d dro aa rasta c uer pia ig id io kE baisan Ean ee ena Ma waa u bien Pal Papa i po cad ams be t ha Pal Dabans Fea asiar LA MAA i LAARS LLL EDI myd Paanan eneowmals Tasi iua cond d Pe Boma el Sin Deans Hed Fm Leno al arbor acd i la ae TIEN sd BLRC biebel E Bibi ie prim AZ Converling source Bes rami inim s dimid ihr m ph ii rmn Td wt chacurmuseaa prera nia Cin semen bas ge omia c oua bn iLa HTAR pla mi pen teas m ped rg a ia uoa Ha nad rut nga m apania bp iia ama Preparing Cus hare ce Three m Ai a prp ee rg iae E e rien pepa Bins bt TERTLDD peek id i3 feeb pcb ad be Fn ced Se ZEN CO gera mi perenne of precerosy oe islas Sel e chers es Ti am fn dor maet d om am a h be Fi mb ee Te maa a ind DE su 1 omg ee Lj paaa aa ia ge yy ETE mbeal Dei pomp ee min bp aghi eiat opp rap en t Bip mee DR tap Ent i il H Lei TEL ee ee omni Res min Corser be sores eode ae Mpeg hed en T4 pH IL Ten LIGHT L SSeS E Pep tg Th mpl Herm ad bond nnam brani Dor me poma arem Balls mre agri F Thir nmm onere Eon RETIA Kem ieg B r ndn n imma Le rp lico ud ien laa lag comb m sas ira imas uon ruri Trara bem lenia cs rmi ammonia Pergo d Pages Tia lad dagar iia cuis mmm s ma ar mna i Proper Pa gun OTOR THU PEE ee PS ndn EE TT NS Sag Pie pa Ted ra P badie a et mr gun PE pna Loi dn 1o Tar EIH Deda fev kre in ed i remi ogee Tha ad Ui infecit rea ie kelmay bai rt ee bem or Bel BOE mt lur via reir al
77. t as suggested in Section 1 5 Planning your user guide Re adding automatically updated files Deleting and re adding the automatically updated files in the book is done in a different way than content files This is because each of these files has a very specific set up which needs to be specified at the time when they are added For detailed procedure how to re add each of the automatically updated files see Appendix Close all files in the book Esc fC by holding down Shift key clicking on the book File menu to select Close All Files in Book 12 FrameMaker User Guide Templates 10 Q D oe m cw Adding new content files to the book Frontmatter and appendix files are added in the same way If the chapter is in its own subdirectory then create one at the same location as the FrameMaker book file for your user guide using an appropriate name for the chapter to be added Copy the template chapter file from your customized reference template to where you want the new chapter file to be assigning it a name of your choice If the chapter is in its own subdirectory create an imported sub subdirectory to hold any imported files for the chapter With FrameMaker open the book file for your user guide Select File Add File and browse to the newly copied chapter file Select the file and set the position in the book where it is to be added Click on Add Repeat 1 through 7 as many times as necessary to add all the
78. t Store in Catalog and Apply to Selection are both selected and click on Create b Under Properties select Advanced Change Frame Abovef to use your newly created zany frame and click on Update All FrameMaker User Guide Templates 59 Set up and maintenance procedures A 6 Splitting a chapter into several fies 60 If a chapter gets so big that working on it as a single file becomes too unwieldy or if different parts of a chapter are being authored by different people then it is useful to split up the chapter file into two or more files Doing so however breaks the automatically set running header in all files following the first This is because there is no occurrence of the source chapter title paragraph in these files Splitting the content Make one or more copies of the chapter file that you want to split Add the new copies to the book using File Add File Open each file in turn and select and cut away all the pieces of material that should be contained in the other files Setting the running header in subsequent files At the beginning of the second file and each one thereafter insert a marker of type Header Footer 1 with the exact text of the chapter title This sets the running header on all left pages If a part file of a chapter contains no ChapterSection paragraphs then you will also need to set the running header of all right pages This is done in a similar way except that you would use a marker of type Heade
79. that there is no paragraph numbering Thus everything else discussed for chapter files such as the chapter first page running text figures and tables is applicable also to frontmatter files Roman page numbering Page numbering of the frontmatter files should have roman page numbering while the rest of the document should have arabic numerals If for some reason page numbering in a frontmatter file is not roman it can be reset by FormatDocumentNumbering The numbering should be restarted at arabic 1 with the first chapter 34 FrameMaker User Guide Templates ChapterNumberOutline ChapterTi ChapterTitlelndex ChapterTitleOutline DocumentDate DocumentEditor Documentinstitution Mario Ruggier DocumentSubTitle DocumentTitle DocumentType Document ersion SoftwareVersion User s Guide Decument Verson October 31 1997 Erin Denes Fred Wickens Versinn 22 Editors Illustration 2 9 Local Rol Distributor and ROB Emulator Programs for ATLAS LVL2 Demonstrators Salen Version 1 3 The formats provided by the template for the cover page may need to be modified to achieve the appropriate look for your document as shown by the difference in the paragraph formats of the default template cover and the sample document cover above Also shown is the paragraph catalog for the cover file listing the available styles for the cover page Editing the content 2 10 The appendix and the bibliography The appendi
80. tial 2 M maintenance procedures 47 manageable chunks 2 managing imported files 14 inter author cross references 48 template customizations 6 markers for the index 38 MasterPages210x210Cover fm 49 50 51 52 MasterPages210x210Index fm 49 52 MasterPages210x254Cover fm 49 MasterPages210x254Index fm 49 MasterPages210x279Cover fm 49 MasterPages210x279Index fm 49 multi author editing 6 48 N naming new formats 6 navigation aid in generated web 45 normal 49 normal style 2 normal template 24 figures 24 listings 24 snippets 24 normal tar 4 NormalMasterPages210x210 fm 49 51 52 NormalMasterPages210x254 fm 49 NormalMasterPages210x279 fm 49 O opening all files in book 43 56 organization of document files 4 of tasks into chapters 10 of the template 4 orientation aids in generated web 45 Output 6 20 overview 1 P package templates ix page layouts 210mm x 210mm 8 254mm x 210mm 8 changing 49 cover index other files 49 format filesets 49 FrameMaker User Guide Templates MustrationRight 26 pre defined 49 Right 26 34 selecting 8 updating different file types 51 page numbering roman 34 page sizes see page layouts paper copies cutting 42 paper size A4 8 49 A4 width x US Letter height 49 US Letter 8 paragraph formats 20 32 BiblioBody 36 Bibliography 61 Biblioltem 36 BiblioSection 36 Body 18 20 BodyPlaceHolder 20 22 24 25 Bo
81. ting effort In addition to file organization and ownership there are the issues of version control submitting of material by authors to the editor and the handling of cross references between files owned by different people Version control of the entire document Any configuration management tool may be used for version control However if this implies too much overhead then at least a simple scheme should be put in place to archive a complete copy of each versioned release of the document Author submissions of material in progress to editor The problem with material in progress that is passed between author and editor is to keep clear track of which copy is the current master and who owns it The editor should clarify how chapters i e subdirectories of files are to be submitted for compiling a new version of the book and for possible format updates Ideally this is done by a check in and check out mechanism implying that after a chapter has been checked in the author of that chapter must not continue to work on his copy but should wait for the editor to release the updated version of the chapter He can then check that out and continue working Managing inter author cross references For an author to be able to insert a cross reference in his document pointing into a document file being authored by somebody else an appropriate destination point needs to exist in the destination file The problems posed by this situation are
82. tory can be a symbolic link to another During editing it can be made to point to a subdirectory containing lower quality versions of the graphics Before final printing it can be switched to point to another subdirectory containing the higher quality versions of the same graphics A graphic 2 high resolution graphics A graphic 1 A graphic 2 Illustration 1 7 One advantage of importing graphics by reference is that the document can be switched to use either low quality versionns of the same graphic files for quicker editing or higher quality versions of the same graphics for quality printing Getting started 16 FrameMaker User Guide Templates Chapter 2 Editing the content This chapter shows you how to format text and images that you either create in FrameMaker itself or you import from other sources There is a comprehensive set of pre defined formats to handle chapter and section headings running text lists tables figures and listings 2 1 2 2 2 3 24 25 2 6 2 7 2 8 2 9 2 10 2 11 The chapter title page and section headings 18 Running textis uto uic deme ROS GRON RI US 20 Tables 2e we aoro edem dr e qtd 22 Figures listings and snippets Normal template 24 Illustrations STOP template 26 Controlling indentation and spacing in listings 28 Function calls sy RACE ke ae ae a 30 The zany paragraph formats 32 The front matter oce gets ey e e
83. tthis manual pO Ee ele ee dl wx og de s o VE Who and what is it for Gin ot Vi iP ue uie dU uo Ny qe wo ds evil Thechapters Ce NOn eke uoce cen VE Conventions used in this manual LE About the templates package ix Availability of the duas pu eun Soins D ams deese t ES Required software wy pea c Be g oux We dliketohearfrom you ix Acknowledgements X Chapter 1 Getting started o 1 1 Two document styles to choose fon The structured report or normal style The STOP method Why use it Choose the style early 12 File organization and set up Organisation of the template and doaie A Setting up your user guide document 1 3 Managing template customizations What is a template customization Managing customizations Naming convention for new formats Customization checklist 1 4 Page size options Different page sizes to choose from Changing the page size Select the page height as early as possible Qo QooQgoQgoQco OO Oo Oo dH uu MPMPMMPNMAO FrameMaker User Guide Templates xi Contents Centralize template customizations 15 Planning your user guide The task oriented approach Organize the tasks into chapters The table of contents 1 6 Adding and deleting chapters Use your customized template Adding content files Re adding automatically updated files Adding new content files to the book Deleting files from the
84. type Record length in bytes Spare Event Id Global Processor Tag Supervisor Tag No of Rol data sets Rol eta phi index Rol type Rol Threshold Id of this Rol Spare Subdetector mask Rol FEXtag Record postamble The current version of Supervisor program signals tecord with pre and postambles As the C40 version preamble the Rol Distributor program sends preamb postarbles Record preamble Record type 32 bits 16bits 16bits 8bits 24bits 16bits Sbits libits 12bits 4bits 3bits Sbits 8bits l6bits 16bits 132 bits 32 bits 16bits Insert Table Table Format Columns Body Rows Heading Rows Footing Rows LEN H sync word to recognize start of record f 0fa5aa 00201 not counting pre and postambles Its last bit is the Endian flag it is 0 for Bigand 1 for Little Endian record ie of Rol sub detector combinations 1 electron 22muon 32jet from 0 tos of RoI sub detector combina tions 1 for data ro syncword fo recognize end of record start and the end of the ROEs needs a record but does not use syne wor 100fa5Sa 0x0203 Rol D bveebe and ROB low A Body PlaceHolder Illustration 2 3 Basic paragraph formats for formatting tables Also shown is the table catalog with a list of pre defined table formats Editing the content 2 4 Figures listings and snippets Normal template Documents prepared using th
85. ult is more often than not user documentation that has not only taken much too long to produce but is also not as usable as we wished and expected it to be The program to which the documentation belongs is therefore much less usable than it could have been had the user documentation been better conceived Templates for better results These templates address the above problematic scenario by offering a framework that takes care of the presentation aspects for your user documentation and helps you organise it Several authors can work on the same document in a controlled manner Practical guidelines for multiple author editing are provided in this manual You do not need to spend time fiddling with the formatting of your material and to wrestle with the tool to do it as you want it to be Aspects of the document layout such as the numbering pagination of figures running headers and footers tables of content the index references etc have all been carefully thought out to maximise the usability of your information within Accepted type setting standards and results from research studies on readability of typographic material have been adhered to as much as possible to maximize the readability of documents produced with these user guide templates 9 10 You can just concentrate on the actual content The template itself will not change the fact that you have to write your user documentation yourself but it is hoped that having a functional p
86. w page while the sub section tags start anywhere 18 FrameMaker User Guide Templates Chapter 1 Getting started Esch user guide template comes in the form of a FrameMaker book that is preconfigured with automatiolly updated lists such as tables of content and index To get going you simply need to create a document instance and then chapter and section headings amording to your document plan A few template options are required to be set at this beginning stage thus you need to know what they consist of and how to select them f 7 14 12 13 Ex Two document styles to choose from 29 Organisation and process sss AG Page height options sss sss OF Plannin ur u MASS se eves eee oe Adding and deleting chapters 109 Managing imported files 0 ee 129 t Each local toc entry is a cross reference to a ChapterSection paragraph in the same chapter Illustration 2 1 The different paragraph tags that make up the chapter title page Editing the content 2 2 Running text Running text consists of simple paragraphs bulleted and numbered lists and hanging indents or definition lists Running text is formatted using the pre defined paragraph character and cross reference formats These formats are named such that their use is as self explanatory as possible Paragraph formats Body The basic paragraph BodyPlaceHolder A container paragraph for tables and anchored frames
87. your document title Section 3 2 The running footer and background text Possibilities of other useful customizations could be changing few key formats to obtain a distinguishable look and feel for specific document addition of logical character tags as appropriate for your project e g you may add highlights to denote Inputor Output addition of logical paragraph tags for formatting special sections such as function calls see Section 2 7 Function calls Thus you may add a FenCalltag similar to SideHeadSection or FcnSynopsis Fc nParameters Fcnlnput and FenOutput tags all similar to SideHeadSubSection Managing customizations All customizations should be centralized into the component file of your reference template set up in Section 1 2 This file is then used to update the formats of all similar document files using File ImportFormats as suggested by the illustration All changes should be logged The file chapter fm could be used as log file Naming convention for new formats It is a good idea to have a special naming convention for any custom formats that you create such as postfixing XX to new format names where XX indicates the project being documented This make locating them later on easier Customization checklist Does this customization 1 Preserve the visual integrity of the document presentation 2 Effect any of the generated lists e g the TOC 3 Necessitate changes to the configuration for

FrameMaker User Guide Templates

Contents

Download Pdf Manuals

Related Search

Related Contents