Home

Production Guide - Pawlan Communications

1. I NETGEAR Tools Netgearuti1s Standard Netgear Custom Tools netgeartools netgearutils d11 maker Netgear Remapper standard Netgear Template Remap Client NetgearTools remapper dll maker ode optional file extension for filter Nel ientwame c Ti ent rype facet Format_ id endar id duds ih deserdprton pati n ne g d ve disp m e ed it determines for which MONS to load This client Mode can be one of maker Structured all for example RTF Text Import RTF RTF FAPI RTF Rich Text Format RTF Import filters rtfimprt dll all rtf ClickPrint standard Print online Manuals fminit clickprt dll all FrameMaker PDFAssistant Standard change default printer for Acrobat Distiller fminit framepdf dil all Y m r e Save and close the maker ini file 5 Open a book in FrameMaker Select the book and look at the menu items You should see the NetgearUtils menu between the View and Window menus FM file Edit Add Format Vif Graphics Variables Set PDF Metadata For Book Update Current Book to New Templates See Chapter 8 Custom Tools Reference for a detailed description of these tools and how they work Install Custom Tools 141 Templates Reference tor Manuals Variables front matter master pages reference pages This appendix supplements the tagging and formatting information provided in the chapter fm file of our templates for manuals Refer to
2. Add Before Page v2 Number of Pages To Add 1 Use Master Page al Add Cancel 3 Click Add Document Preparation 53 Production Guide Links to Internet Resources For links to support within a document use hftp support netgear com This automatically takes the user to the kbserver website Note Itis okay to put links in our documents to Internet resources that are not owned by NETGEAR but this should be done with discretion It is fine to link to technical standards or organizations such as IEEE In general do not link to commercial documents owned by competitors or other private companies Tolink to an Internet resource mmus 9 Note See also URL Tools on page 115 for a faster and more accurate tools based approach to linking Type the destination URL or text such as click here into the FrameMaker file Select and tag the URL or text with the Jump character format Select the URL and then select Special gt Hypertext In the Command pull down select Go to URL In the text box after message URL type the URL into the text field Command Go to URL z Syntax message URL http www adobe com message URL http netgear com v Validate Command upon Insertion Make View Only Select New Hypertext Marker Select Format gt Document PDF Setup and check that the Create Named Destinations for all Paragraphs check box is selected Save the Frame file and make a PDF
3. IR OGo s This is the 70 16 12 arrowhead size tk ga e O This is the 90 16 12 arrowhead size Figure 9 Pointing to objects on a figure e Line width 1 0 preferred but use 5 to 2 0 as needed e Arrowhead 90 16 12 or 70 16 12 e Text color Black but red yellow or white can be used to make it show up on the page Numbering Issues Sometimes chapters pages figures footnotes or tables stop numbering sequentially When this happens make sure the document numbering settings are correct Table numbering is a little less obvious so the following procedure explains how to make your table numbers sequential See Finalize the Book File Set in FrameMaker on page 127 for more information on the numbering properties To make tables number sequentially 1 Open the book file 2 Select but do not open the chapter that has the numbering problem 3 Right click the mouse and choose Numbering to open the Numbering Properties dialog box Select the Paragraph tab Select the Continue Numbering from Previous Para in Book radio button Click Set Repeat for all subsequent chapters in the book Save and regenerate the book file moi mem Note If this does not fix it repeat the steps above on all of the chapters prior to the chapter with the problem Document Preparation 58 Production Guide Spelling Grammar and Style Checks Use the FrameMaker Edit gt Spelling Checker command to check your document for
4. QIGs are two sided print documents that fold and ship in the package with the product If there is a CD a PDF of the document also goes onto the CD These documents cover the basics of how to connect the product and get it working Setup manual The setup manual echoes the CD wizard installation instructions for products that have a CD wizard It is for customers who cannot use the wizard either because their computer does not have a CD drive or they use an operating system such as Linux that the wizard does not support A PDF of the Setup Manual goes onto the CD Note Setup manuals are being phased out on routers and gateway products that are configured with preset security User manual Documents the product GUI If the product has a simple and a complex installation flow the more complex method goes into the User Manual so that the QIG is not too crowded The User Manual also provides background technical information for product features to assist sophisticated users who want to customize their installation Hardware installation guide HIG for managed switches This shows how to install the switch hardware and also covers compatible optional adapters and modules Software administration manual for managed switches This is a lengthy task based book It covers examples of how to complete tasks with either the GUI or by CLI commands CLI manual for managed switches Documents CLI commands for the switch Document Sets 17 Prod
5. If you have any write ups that are reviewed and stable and can be used by other writers post them to the Base docs folder at ftp geardog netgear com ngreng 4 TechPubs BaseDoc include a readme txt file to explain what it is and notify the writing team FrameMaker FrameMaker Check Change bars removed 1 Select all the files in the book 2 Format Document Change Bars 3 Choose Clear Change Bars 4 Click OK Pagination Sequential where the cover is page 1 but the number is invisible on this page Blank pages removed Header footer Running header on right with model name model number Running left right footers with chapter appendix number and title Links Check links Check cross references and verify that they don t go to a chapter in another book Check TOC Check index Metadata Add metadata with variables and the Set PDF Metadata for Book command described in Set PDF Metadata for Book on page 114 Finalize Documents 67 Production Guide FrameMaker Check Language code Add the text box with the language pdf mark as described in Set the Language on page 94 Corrected phone Other Countries in Tech Support Section page 2 of frontmatter fm Make sure Phone Other Countries reads as shown and points to the link It should not refer users to the tech support card Phone US amp Canada only 1 888 NETGEAR Phone Other Co
6. Eos Wa 32 pesos prs os pss pss q 55 9 Figure 6 Bar code sizes used on boxes Add a Bar Code Directly to the PDF It s always best to put the bar code in the source file however there could be a rare case when you need to put a bar code directly on the PDF so it can be loaded into Agile but you do not have the source file gt To put the bar code directly on the PDF 1 Convert the bar code image to a PDF by copying it into Word Frame or Illustrator and saving it as a PDF 2 Open the PDF document into which you want the bar code image inserted 3 Create a button the approximate size of your bar code You can resize later a Select Forms Add or Edit Fields and select Yes if a dialog box displays b In the upper left corner of Acrobat Pro select Add New Field gt Button c Position the button where you want the bar code to go and use the bar code number to name it Right click the button and choose Properties Click the Options tab In the Layout drop down select Icon Only Click the Choose Icon button and select the bar code PDF Click OK In the Button Properties dialog box select the Appearance tab to set the background and border color as needed Usually No Color is the preferred setting Click Close k To position the bar code right click the button and select Align Distribute and Center l Select Forms Close Form Editing 4 Save the PDF and voila 207912 Document Prepar
7. Production Guide Anchored Frames Always place artwork and screen captures inside anchored frames gt To add an anchored frame 1 When you use the Below Current Line setting it is best to right align the frame and then size it to the paragraph text above it as in the following example It might also be useful to use the anchor tag as a spacer after the text ANCHORED FRAME Anchoring Position Below Current Line Alignment Right _ Cropped Roating Size Hoge 3917 Abest practice for an anchored frame is to set it to Below Current Line Right For the width 6 25 aligns with p1 body and 6 0 aligns with the step e Use figure captions except within procedures When you use them do not use periods at the end 2 There might be times when centering the graphic might look better like when it s a complicated illustration Adding a figure caption mostly like will not work in these situations i Internet NZ go o I3 amp 00 ll Document Preparation 56 Production Guide Graphics Although FrameMaker can import many graphic formats the graphic formats typically used in NETGEAR documentation are e JPEG Good overall e PNG Good for screen shots and text e EPS Good for printing but are not visible in thumbnail view on Windows Al Good for ill
8. e Right width 6 25 or 6 to align with the paragraph above e height can stay as it is Change step 1 From this headers to To log in to the wireless router i h4_head and align Figure captions see Changing the Built In Password on page 3 28 ANCHORED FRAME To log in to the product family Anchoring Position Below Current Line 1 Type http www routerlogin net or http w IP address default is 192 168 1 1 in the addreg Enter A login window displays 4 L Crpped Roating Alignment Right Size Width eo Height 3917 Isewceaer me pazza Figure 1 i Enter admin for the router user name and your password or the default password For information about how to change the password see Changing the Built in Password on page 3 2 Modify tables if needed Old Style to New Conversion Tutorial 134 Production Guide CUSTOM RULING AND SHADING Custom Cell Ruling Apply Ruling Style To Selection Thick Outside Edge Thick White Top Bottom v Left v Right Two Single Very Thin Inside Borders Edit Ruling Style Row Column Custom Cell Shading Fill 30 Color Yelow v The conversion tool should do most of this but on occasion you may need to a Add the yellow header 30 yellow Select Table Custom Ruling amp Shading and set definitions as shown b Add or remove Table titles as needed Additional cle
9. netgearutils dll Contains the executable tools code for all tools except the template tools remapper dll Contains the executable template tools code RemapConfigFile fm Specifies the mapping of the old catalog tags to the new template catalog tags The conversion tool uses this file to remap tags and clean up catalogs See Template Conversion Tools on page 119 Custom Tools Reference 101 Production Guide NetgearUtils Menu This section covers tool behavior and contains a description the custom tools available on the NetgearUtils menu These tools help you manage FrameMaker books convert older docs to the new format and keep already converted docs up to date with the latest NETGEAR style Once installed as explained in Appendix A Install Custom Tools each tool has a specific function and is explained in detail in this document Em File Edit Add Format View NetgearUtils Window Help Ci Hd Cross References Graphics Variables Set PDF Metadata For Book Update Current Book to New Templates Figure 13 The NetgearUtils menu within FrameMaker The following topics are covered within this section Commands and Book Files on page 103 e Cross References Tool on page 104 e Graphics Tool on page 107 e Variables Tool on page 110 URL Tools on page 115 e Set PDF Metadata for Book on page 114 e Template Conversion Tools on page 119 Custom Tools Reference 102 Production Guid
10. 1 In Frame select File Launch RoboScreenCapture 2 Open the file you want to prepare and select File Open 3 Select Capture Capture Settings Crop amp Scale to adjust the image as needed 4 Select Capture Capture Settings View amp Edit to combine images or portions of a GUI screen into a single image See also Combine Screen Captures with Photoshop on page 47 Save the image 6 Import the image into FrameMaker See mport Screen Captures into FrameMaker on page 46 7 Within FrameMaker put a 1 pt black border around the image within FrameMaker Use Pen Pattern 0 and check that the borders are consistent clear and crisp throughout the PDF o Document Preparation 45 Production Guide Borders Set borders around graphics such as screenshots from within FrameMaker Apply a 1 point solid black pen pattern No shadow is needed We do not usually put a border around illustrations To set borders within FrameMaker 1 Set the line width to 1 0 Set the selected color to black 2 3 Select the screen capture 4 Select Pattern 0 from the Pen Pattern drop down Set Line Width Set color to to 1 0 black Select pen pattern 0 from drop down When the border is added within FrameMaker it is not resized with the graphic but maintains a consistent size throughout the document Also applying the borders within FrameMaker makes it easy for someone else to change or remove the border if needed
11. 179 color modes CMYK 39 RGB 39 color printing 87 combining PDFs 90 comments 65 compliance 30 Compressed Object Streams warning 89 concept elements DITA 173 content reuse and DITA 166 contract writer document hand off 77 lead writer duties 10 contract writer role 11 convert old docs 125 crop marks 90 cross reference tool 104 107 cross references 30 D Darwin Information Typing Architecture DITA content reuse 166 defined 166 described 166 elements 170 figures and callouts 181 linking 177 localization 166 187 metadata 181 metadata inheritance 184 printed documents 166 taxonomy 185 tools 168 training for 169 transitioning to 167 variables 179 designer role 12 desk phones 163 developmental reviews 63 disconnected pages 53 distribution lists email 163 distribution review 64 DITA maps 177 doc reviews 63 docs server 31 158 document preparation 28 document types 17 Beta 25 certification 24 documentation request 23 24 documentation set determining 23 documents approving 65 archiving 76 beta 25 in Agile 25 localized 21 due dates doc 24 E editing guidelines 73 editor role 12 electronic documents archiving 76 elements concept 173 reference 175 task 171 topic 170 elements DITA 170 email distribution lists 163 engineering teams 14 exporting graphics 40 external PDFs linking to 90 F fast track review 63 64 Figures DITA 181 fiile purposes 101 Production Gu
12. Color or Digital Printing BW Click Analyze and Fix Print spec is current and matches your doc PDF with crop marks Online manuals Save as PDF with the Convert CMYK colors to RGB box selected Content Routers DG Only Check Check the Adding Both WPS and Non WPS Clients section and make sure it does not tell the reader to reset to factory default as the first step This is incorrect information and should be removed Remove cross references to online docs Remove cross references to related documents in Supplemental Information appendix Remove list of related documents in Supplemental Information appendix Remove Wall Mounting a Router in the Supplemental Information appendix Add to the first page of the first chapter in the book a statement something like this For more information about the topics covered in this manual visit the Support website at htto support netgear com If the router can be wall mounted add another sentence that reads If you want instructions about how to wall mount your router see Wall Mount Your Router at http support netgear com app answers detail a_id 18725 One appendix called Supplemental Information that contains Tech Specs and Factory Defaults Make sure that the two paragraphs with links to DoC and GPL are the last items on the bottom of the third panel of the second page of IGs Finalize Documents 69 Production
13. Export Graphics from ai Files Normally we import Adobe Illustrator files directly into the documents However there might be times when you need to export graphics from ai files gt To export graphics 1 Open an illustrator file in Adobe Illustrator 2 For backup purposes save the file under a new name To save the file so that it is compatible with older versions of Illustrator select the version from the drop down list from the Illustrator Options screen 3 Delete any extraneous images from the file or place them outside of the art board area This is necessary because this method exports content from the entire art board it does not allow the option to select individual images to export 4 To reduce the size of the art board so that it wraps around the image a Select File gt Document Setup gt Edit Artboards Document Preparation 40 b c Production Guide Drag the corners until the border fits nicely around the image Go back to the main screen and save the file Edit Artboards POE 2 Opt t Ope 2 Ope Resize Art board Bleed and View Options ws ELGEM Top 2 Opt Show Images h Outline Mode Highlight Substituted Fonts Hilig Substituteg Gyors Breed File Edt Object Type Select Effect View Window Hep a au Ea CG 3000K Bacia 9 400 OtGI Preview X Transparency Guser Meum v Custom GidCoor Clit Simulate Colored Paper Preset Medium
14. Export Graphics from ai Piles oncacceve sm meii 40 Save to an Older Version of Illustrator llle 43 Scale str SHOES cesso kac RR CARRERA RORCCAUR KERRERRRRAR CA 43 Produce PRES i ow dE Er ea du X ba bod dock dod Rue Ree Kasse 44 Gereon SHOS iu ea a uh ad tse CANANEA ENARE RANEES OR OE e C eda 45 BOIUBIS daa Qaae dAdo io eae RE ae RU dcl oe p AC Roe doe de de el 46 Import Screen Captures into FrameMaker 2 20000 46 Use a Dedicated Laptop for Screen Captures 004 46 Combine Screen Captures with Photoshop lsllsusus 47 Use WinTV to Get Screen Shots from a TV Display 48 Update Screen Shots When Product Name Changed 49 IP AdUtesede oi cerot LRP E ERS RO Xa IRURE E REUS ERE Gees RN 49 ERSITIERTEKE E a cur ed odd a ey do ow dodo a OE Ros dica awe icd et oe ae ro 50 tubi rcm 50 Visi C21 Tats DOES ous ee te ae ee eee eae eee ee d i ee 50 Stop the Font Substitution 2c ccc dae eens dance en ee de ad diis ORR ED ES 50 Wares Fle issued uai mir Qo dod dads awed d wo Qao kasd ee 51 Set Up a FrameMaker Book without Blank Pages 52 Aud a Child BODL isis Reed baxpEREKP DAS UE AA edesiavgancds 52 Make a PDF of Parent and Child Books 005 53 Disconnoctlod Pages clsieuei su ede RR REXER SER RXE X Gees x 53 Links to Internet Resources 000 0c eee eee eee 54 Turn Off Annoying Warnings secas Ee e RR Rte ke Enn 54 Import Text Files int
15. Make sure page 2 inside front cover of frontmatter fm is corrected to Phone Other Countries Check the list of phone numbers at htto support netgear com app answers detail a_id 984 Remove the Related Docs appendix remove the cross references to the related docs and add the following sentence to the first paragraph in the first chapter For more information about the topics covered in this manual visit the Support website at http support netgear com If the router can be wall mounted add another sentence that reads If you want instructions about how to wall mount your router see Wall Mount Your Router at htto support netgear com app answers detail a_id 18725 Start a Project 28 7 10 11 Production Guide Run the List of Variable Definitions in Book command described in List of Variable Definitions in Book on page 111 to generate a report of your variables a This report is saved to the Reports directory under the document directory b Rename this report and save it as a record of the old variable settings for the book in case you ever need to refer back to it Note Installation guides are single documents You can make a temporary book for the single file to use for running the tools on installation guides However it s best to set the metadata directly on the file rather than with the Set PDF Metadata on Book command because the book file is not archived with the install guide Run the Edi
16. Numbering and Update Book to set the pagination page numbers and chapter appendix numbering Ignore any book generation errors for the time being If a color description error occurs see Step 8 Note If the chapter and page numbering is still wrong Run the command again If that does not fix it check your numbering properties for each file as explained in Add Setup GenFiles Numbering and Update Book on page 123 8 Sometimes this command introduces a Color Description inconsistency message To remedy this error use the File gt Import gt Format command to import ONLY the color Old Style to New Conversion Tutorial 130 Production Guide definitions from either the front matter index or TOC file These are the new files that were added in step 3 on page 126 and contain the newest color definitions Import from Document Frontmat fm Import and Update Paragraph Formats _ Reference Pages Character Formats Variable Definitions Page Layouts Cross Reference Formats Table Formats _ Conditional Text Settings Z Color Definitions Math Definitions _ Document Properties Combined Fonts Deselect All While Updating Remove Manual Page Breaks Other Format Layout Overides impor Cancel No Undo Figure 24 Fix the Color Description error Clean up the Files You work with each of the individual files to resolve formatting issues and clean up the Master and Reference
17. Product photos are available in V Marketing Product Files ModelNumber in the Product Images or GUI Banners directory However technical publications typically has an illustrator take unit photos that are turned into the front page cover and front and back panel art for the manuals Sometimes you might need to update the product name in an illustration Look in the GUI Banners directory and if you find what you need you can cut and paste the name onto your artwork Mediabin is another repository for art and other media related items Access it here with your LDAP user name and password httos mediabin netgear com Look under Corporate Assets for logos product art videos and more Usability A small usability engineering team is within the Home business unit Technical publications works with the usability team on user interface design terminology color schemes usability study results and more for product improvement and to inform new directions in documentation Localization The localization team is based in Taiwan and handles document translation When the lead writer archives a document set in Agile he or she also notifies the localization team so they can pick up the docs for translation Sometimes we work with the localization team on The Landscape 14 Production Guide requests for smaller printed documents to fit inside smaller boxes or to figure out ways to save printing and translation costs Packaging The pac
18. Writer s Checklists vu ud eee ace CAO X RACER RACIO RACE dem C s 67 ITAL Sasa atacand pa eee EC PIS eee ae eU pude 67 Base POCO E s vato cred d ed ebd d b ques d ahaa hOo ceeded 67 PIAA ccs es cher des iranat nA Eae dede d Rc d qu AA 67 DeCUME raean tts e C ea Dee ee Reb ae ah be oe dod Gas 68 Content Houterg DG OW o crror rn de eudeeu vane e t ean aa ae 69 Preset Security Router DG Only 000000 e eee eee 70 Preset Security Manuals Router DG Only 0005 70 Compliance GNU License WEEE Notice Warnings 70 Prepare and Name Files for Agile Release 0 71 Aocessibiliy CHECKS cess deve deed x esee eee ea dee RE d ds 72 Editing EMITS Sesto ead dx ac asiak dodo dede d Re apu todos 73 EGUNO FPN erants nss ESEE NARESE SERIAS Heenan 73 Lead Writers Checklist iier cdi ei e npa re dae E Rr RC rn 74 Pile NNN e rici ti NURSE ORA pd e obeunt dob gend dre 75 Sample File Names for QIGS 2 2 6006se0 aceeedeceidecates es 75 Sample File Names for Manuals a na aaua aaaea 75 Sample File Names for Booklets naana 76 Archive DOCUMBNIS 5c added ao que tdid do ree aes abf EEREN 76 Final Hand Off from Offsite Writers 0 0 0 cee ee Fx Completed Projects That Do Not Go into Agile 77 Production Guide PO dapes mem D TP 77 Agile Drop Folda orere poe ae Chew CP Cr xpo bar POS CR tob cu grape xus Ff Guirent Projets ones cakes pps RE Re tarni ne
19. or get the image from an engineer and then preparing the image You can use a screen capture program such as SnagIt Print Screen or RoboScreenCapture which is in FrameMaker 9 under the File menu when you have a file open Both Snaglt and RoboScreenCapture have a scrolling feature which can be more convenient than Print Screen which does not See also Use WinTV to Get Screen Shots from a TV Display on page 48 gt To use PrintScreen 1 Press Ctrl Print Screen Alt PrintScreen or Fn Print Screen depending on your PC and operating system This way you capture only the active window instead of the entire desktop if you use only PrintScreen 2 Open Microsoft Paint or Adobe Photoshop 3 Select Edit gt Paste or use Ctrl V to paste the image 4 Save the file in the FmSrc Img ImgScr folder for the document with a unique file name in the default file format You can create a subfolder for screen shots if it helps you stay organized Touse RoboScreenCapture 1 In Frame select File Launch RoboScreenCapture 2 In RoboScreenCapture select the Capture menu and the most appropriate option for capturing the image 3 Save the capture as a JPG Note If engineering provided screen shots and they are low resolution you might have better luck with the png format than a jpg To prepare and Combine Screen Captures Prepare a screen capture for a document within FrameMaker using RoboScreenCapture and the Graphics toolbar
20. s language specified See Set the Language on page 94 for information on how to do set the language specification This document is not tagged Run the Set PDF Metadata for Book command described in Set PDF Metadata for Book on page 114 Tab order may be inconsistent with the structure order This pertains to PDF forms Check that the Tab order is consistent with structure of the book as described in Run Full Check on page 96 The tab order refers to when the person reading the PDF uses the Tab key to navigate elements such as buttons and links on the page or on a PDF form It is desirable for the person to reach the elements in a specified order which might or might not follow the structure of the document This error shows up in our documents on pages that have links Accessibility readers follow the structure of the document by default xxx element s that are not contained within the structure tree When this error comes up for a generated table of contents or index it usually happens on the first entry on the second and later pages If the error comes from the index you can investigate the following causes but if they are not the source of the problem and the Read Out Loud feature reads through the problem area you have met the minimum accessibility requirements PDF Procedures 97 Production Guide An index marker does not have a space after the colon in a hierarchical index entry Single index markers containing man
21. which works well with thin documents or perfect bound glued which works well with thick documents Finished size Specify in inches and in metric centimeters or millimeters Make sure the finished size fits in the box You can get the box dimensions from the NETGEAR packaging team Folding instructions If the document will be folded explain whether the document will fold accordion style in half horizontally in half vertically or whatever You can send a folded sample to the printer if the document has a complex fold e Layout Double sided or single sided Printer Contact Information Kin Shine Shanghai Area Contact Ryan Tel 886 2 2222 4656 331 Fax 886 2 8221 5067 Email ryan 2todaysart com tw or vivianc todaysart com tw Fudy Dongguan and Suzhou Contact Milan Suzhou Phone 86 512 62716091 ext 202 Fax 86 512 62716089 90 Email milan mail fuyangpacking com or ben mail fudy com tw Yuto Shenzhen and Suzhou Address 155 Songshan Rod GaoXin Area Suzhou City Contact Kelly 4 Tel 86 512 66627837 Fax 86 512 68836873 Email xueyan szyuto com Contact Mr Wu Manager located in Suzhou wuyc szuto com Document Preparation 38 Production Guide Illustrations If new illustrations are needed for a project they are typically created by a contract illustrator in Adobe Illustrator format When possible illustrations should not include callouts Callouts are added in FrameMaker to m
22. 3 Efficiency If you need to change the art you can double click it from inside Frame It opens in Adobe Illustrator where you can edit it When you save the AI file your Frame file updates 4 Efficiency Making a screen capture of an ai file not only defeats all of the above but adds an extra step to your job The extra step gets repeated every time you change the art 5 PDFs Using the source art ai file displays more clearly in a PDF too You can t tell from Frame because Frame handles some types of art at a lower resolution to save memory That s why it doesn t necessarily look that good to you in Frame It renders more clearly in a PDF and in printed documents Compliance Check with the compliance engineer on all compliance issues This includes when engineers ask you to change a compliance appendix that the compliance engineer provided to us 1 Required Some compliance paragraphs links and text are required to be in the docs The links to DoC and GPL are two examples There is also now safety text and some other things 2 Costs If someone asks you to remove compliance sections don t do it without checking with Mark first We can be fined and have been fined a lot of money by European countries when they find out that we have not complied with their rules Document Preparation 60 Production Guide Printing To get the best end result in the printed doc 1 Submit High Resolution PDFs with printer marks 2 I
23. 3 Select the correct font tag Add Alternate Text to Figures FrameMaker 9 help explains how to add alternate text to figures To add alternate text to figures All figures have to be inside an anchored frame Select the anchored frame Select Graphics gt Object Properties In the Object Properties dialog box select Object Attributes In the Object Attributes dialog box provide the alternate text in the Alternate field Click Set TOM SP eS PDF Procedures 98 Production Guide Send PDFs Out for Review Use Adobe Acrobat 9 0 Professional or later to create a PDF email review Markup tools are automatically sent with the PDF to the reviewers If the reviewers email PDF markups back to you Acrobat offers you the option to put all comments into a single markup PDF file For very large books use the Send for Shared Review feature to specify the reviewers upload the file to the Adobe web site http acrobat com and notify reviewers by email Note It can be helpful to turn off your email until after you have edited the boilerplate email message created by Acrobat gt To prepare and send a PDF out for review 1 Create the PDF 2 Open the PDF in Acrobat For PDFs less than 5 MB in size select Comment gt Attach for Email Review For larger PDFs select Comment gt Send for Shared Review or Comments gt Enable for commenting and Analysis in Adobe Reader For larger PDFs see the next section 3 Follow the wiz
24. Apple Archive sit File 4 164 La DIOE C ERSUUVORG Y hed os Qa Deed a d ad Da a qa ed 164 Appendix D DITA Reference DITA InHOHBCHON es oed Adu deca EUR e ODORE XU AU V GIC RO cR 166 Printed Documents 0 0 ccc ee eee ees 166 GC ANPING sax aad Eno e eek be Rr eG d dO hee eae x 166 Content FBUEG Llidesuaaaci diedcaca C de Ca RC caa RECORD c C 166 WARGO e vassa ER eee A SEX X DP WORST cake ee X Ead 167 SORES spd Aine these d dde uot acid nin dr Gs E oae rem dd 168 Mr n m PCT 169 Tope EIBIBOBES a iu oco do re Co FRI CR RA Ie RC od 170 Task EIBIDSIS s s pay REP RARERERRRESQUEQS RIO RGEGGOCGODEXYAGqO 171 Concepil Elamenis cer TTE 173 Reference Elements 0 000 cece eee eee eee ees 175 DETTA SIDES od ate 3 dod CROCI a ON AeA REN e EORR ded ish de Pr ed 177 PUDUTBDS Less eade ved qQEieqe quoda dan ded d eq iq unda 177 TODE LION uses d x DECIR OPE SA A PE OE GU UAM e S NA E RA REA 177 EEL e sc cg neta a apna and Ska Se RERTE OS DAREAS qud dde Rx qd 179 Deis V BH o ues aos V dee ane eed Deca n darn LeeEt ad qe da 179 Reference a Variable llle 180 Figures and Callous iocscsecoiinesxxebesdeeu ees cam xe ad 181 Metadata icc cee kee Ra pk ea Ex CR RCR EORR ak ER oa a 181 Index EIE acis paa RPG RR RAXSXqGc REA X GgASTAXATSEAEXqG 183 Conditional Processing Attributes llis elei 183 Tepe BIB og dob d are pes pd dob ed RP PE RUPEE 183 DITA Map Metadata scp odes AR ex REX eke OE
25. Approved products advance through the PCM checkpoints as they reach major milestones Technical publications creates installation guides at the request of marketing Marketing has the final say on costs paper color or not color printing and the PLM should be included in installation guide reviews The Landscape 13 Production Guide Engineering The engineering teams are within the business units and coordinate new product releases maintenance releases and certification processes for gaining new business Individual engineers are assigned to products and are called product engineers PEs When documentation is needed for a product the product engineer approaches technical publications and works with the assigned writer to complete the needed documents The PE reviews all documents Tech Support The technical support team is a separate organization with support engineers dedicated to the various business units Include the technical support person for your business unit in reviews for all documents Product Design The product design team is part of Engineering Services They are responsible for compliance labels and unit photos Technical publications puts compliance information in user reference manuals as described in Compliance Information on page 30 The PE works with product design to get the label that goes on the bottom of the unit Technical publications puts the label in the setup manual or install guide as needed
26. Check the link by positioning the mouse pointer over the link to view it 10 In the PDF select the link to make sure it is active and goes to the correct web page Turn Off Annoying Warnings gt To turn off those annoying warnings in FrameMaker 1 2 3 Select File gt Preferences gt General Clear the Show warnings while clearing history check box or Select the Show warnings while clearing history and Once for every history clearing command check boxes Document Preparation 54 Production Guide Import Text Files into FrameMaker Sometimes a text file that you want to import into Frame was edited in such a way that the edits create lines that are not formatted correctly gt To fix the spacing Change the spaces in the bad lines to Esc space 1 to replace with a figure space This corrects the spacing Note The Global x20 gt x10 changes the space character to a numeric space in hex Change Bars You can turn change bars on and off through the FrameMaker menu system or by using key commands as follows gt To use the Format Menu 1 Select all chapters in the book 1 Select Format gt Document gt Change Bars to display the Change Bar Properties dialog box 2 Select either Automatic Change Bars or Clear All Change Bars as applicable gt To use Key Commands 1 Select all chapters in the book 1 Hold the Esc key 2 Press c and then h Esc c h Document Preparation 55
27. Each table lists from left to right the File Name the Variable Definition used in that file and the pages where the definitions occur Click on the file name in the left column to open the file in FrameMaker so you can use the Edit gt Find Change command to locate the variable Variable Name Product F amily in line Frontmat fm Areless modem router lt No Occurrences gt FullManualTOC fm wireless modem router lt No Occurrences gt Connect fm wireless modem router 6 6 12 14 14 7 7 8 8 8 8 8 9 9 11 11 11 14 14 14 15 15 15 15 15 15 16 16 16 16 16 Wireless fm wireless modem router 17 18 19 20 20 20 21 21 21 21 23 23 23 23 23 23 23 23 23 23 24 24 23 23 24 27 27 24 24 24 25 25 25 25 25 25 27 28 29 27 27 28 28 28 28 28 28 28 29 29 30 30 30 30 30 30 30 30 30 23 23 27 Figure 18 List of Variable Definitions in Book report gt To identify variables not used in the book 1 2 3 Run the Variables Definitions report Look at the third column Occurs In Pages for each variable definition If all rows in that table show No Occurrences that means the variable is not used anywhere in the book Note Most of the variables not used in the book can be deleted but you should not delete any of the standard variables even if
28. For a list of reserved IP addresses see http en wikipedia org wiki Reserved IP addresses Document Preparation 49 Production Guide FrameMaker This section describes guidelines for creating FrameMaker documents See also the Templates Tools amp Processes User Guide for detailed information on chapter paragraph and variable definitions Templates The templates are available on the FTP site in the 4TechPubs folder and also at V engineering TechnicalPublications We often use existing books as the basis for a new book If the existing book uses an older template please convert to the new template before proceeding See Chapter 8 Custom Tools Reference and Chapter 9 Old Style to New Conversion Tutorial for information about how to handle variables when you convert Installing Fonts gt To install Futura fonts 1 Close FrameMaker 2 Copy the 4TechPubs Fonts FuturaNewTemplateFonts folder from geardog to your desktop 3 On your PC open the Control Panel and select Fonts 4 Move the fonts into the Fonts directory a Windows XP Open each folder within the Futura directory and drag and drop the individual fonts not their folders into your Control Panel Fonts folder b Windows 7 Right click the font and select Install or use the Copy and Paste commands 5 Double click FuturaFonts exe to install the remaining Futura fonts The exe file contains HP Futura fonts but does not let you see which ones The o
29. FrameMaker authoring system to a DITA authoring system would have to be very carefully managed 1 Management needs to provide financial support for tools training and DITA expertise Without this support it is not possible to transition the writing team to DITA authoring and production 2 Authoring illustration conversion and content management tools are required for the writers 3 Writers have to be trained to effectively use their new tools Training 4 Expertise a Project manager to manage the DITA conversion project b XML architect to own the DITA document type definitions DTDs c Information architect to define the information model d System administrator or tools specialist to own the source control system publishing system and tools automation Quality assurance engineer to test style sheets and transforms f A company like Stilo to convert documents from unstructured Frame to DITA p DITA Reference 167 Production Guide Tools Authoring The oXygen tool is a good authoring environment that comes with the features we would need See http www oxygenxml con Structured FrameMaker does not produce true and portable DITA format because of all the Fm Condition processing instructions in the XML output It is not producing correct DITA because it dumps all content into a composite topic type instead of the specific topic type concept task or reference Instead of standard DTD files Fr
30. Guide Preset Security Router DG Only Table 1 Install Guides Check Change the WPA WPA2 PSK passphrase to Network Key Password This applies to product label and references within the documentation SSIL Network Key Password zT 3T Add an Other Features section to the end of installation guides using the CD less installation Other Features H1 For features like Live Parental Controls Traffic Metering ReadyShare and Guest Access please log in to http www routerlogin net for more details Add this to the IG below DoC paragraph For GNU General Public License GPL related information please see http support netgear com app answers detail a_id 2649 Preset Security Manuals Router DG Only Refer to the WA WPA2 PSK passphrase as the network key password Compliance GNU License WEEE Notice Warnings Check Noise table Applies to wireless products only Goes in UM or RM when there is no UM If set has both a UM and an RM put the noise table in the UM Put it right after the compliance information which is inside the front cover old template or in the last appendix new template Compliance Info IGs All IGs have this text either in Tech Support section or near the copyright For complete DoC please visit the NETGEAR EU Declarations of Conformity website at http support netgear com app answers detail a_id 11621 Finalize Document
31. Next Available In the Before Saving amp Printing field select Delete Empty Pages Click the Set button Save the book to retain the changes Add a Child Book You can add books within books The books can be unstructured book files or DITA maps A child book is treated as a placeholder within the parent book You cannot edit a child book from within the parent book view All maintenance tasks must be performed in the child book separately For example any book wide operation on the parent book such as spell check or find replace works only on parent book files and not on the child book files You should search and update child books separately Similarly when updating a parent book for pagination and cross references ensure that you first update the child books and then update the parent book This is because numbering and pagination information is stored at a book level A book update on the parent book does not affect the page numbering within the files in a child book if the files in the child book are closed However if the files from the child book are already open they are updated but not saved You should always explicitly save all open files after a book update command or after applying a book wide command Toinclude multiple child books at multiple levels in a book 1 2 Open the parent book into which you want to add a child book In the book window select Add gt Files Document Preparation 52 Produ
32. Note If you have a book with a lot of screen captures done in the old style it is okay to leave them as is until a later time when there are more resources to handle converting the borders Import Screen Captures into FrameMaker e Import by reference Do not embed graphic files e Use an image file format compatible with FrameMaker like jpg eps or png In Photoshop use the Save for Web feature to create jpg files For documents with a large number of images use only jpg files because eps and png files use more memory e Import the image file into the Anchored Frame in FrameMaker accepting the default custom dpi settings usually 96 e n FrameMaker reduce the graphic using Graphics gt Scale Typically 50 works well for screen shots Use a Dedicated Laptop for Screen Captures To get screen captures from a NETGEAR product user interface you need to connect the product to a laptop that is connected to the Internet Do not connect the NETGEAR product to Document Preparation 46 Production Guide your work laptop so you can keep it free for working and also to prevent anything unexpected happening if the NETGEAR product is not production ready Ask the technical publications manager to get you a NETGEAR laptop that you can dedicate to hooking up to NETGEAR products for screen captures This laptop does not have applications software on it but might have Gadwin PrintScreen If not you can put a screen capture program
33. PrintScreen to capture images past them into Microsoft Paint and then save them Adjusting Screen Capture Proportions The screen captures looked a bit squeezed taller and skinnier than the EVA TV display gt To adjust properties in Photoshop 1 First deal with cropping resolution and size Crop the image if needed to remove the WinTV border 2 In Photoshop select Image gt Image Size and click Auto to improve the resolution Change the width to 3 inches 3 Select Image gt Image Size to fix the tall skinny problem Clear the Constrain Proportions checkbox Reduce the height enter a lower value in the Height field and press Enter Now you can prepare the screen shot image file as described in To prepare and Combine Screen Captures on page 45 Update Screen Shots When Product Name Changed If you need to update screenshots when updating manuals for a new product name there are new GUI banner files for most products in this type of directory V Marketing Product Files DGN1000 GUI Banners Just look under the appropriate product Then cut and paste the new top of the screen so that it shows the new product name Sometimes you can crop off the product name entirely It depends on the GUI IP Addresses When you provide an example IP address in a document do not inadvertently use a live IP address This is to prevent the unintentional use by customers of valid IP addresses that are either in use or reserved
34. Resoltion T Type Options V Use Typographer s Quotes Lagaye Engish USA Dane Quotes Singh Quotes Ste 58 3 Position Superscrpt x n3 x Rk np 3 T NG 4 g a 3 9 ji 9 w as Ph s 8 mE 2a Sumo 583 33 x Sm llCaps 70 x Export Preserve Text Edtab ty Ge B W 5 Select File gt Export a b c Select the folder in which to save the image Name the image Select the format type for the image from the drop down list There are many format options from which to choose The recommended format is EPS or TIF because the resolution is better in printed documents arom ER iad GRR gt amt type net tet Ver NE mn F om om i rm saon Open o EELNE I fi B Format options sess 1 y Note The only format not available from this method is EPS To save a file in EPS format select File gt Save As and select the Illustrator EPS option from the Save as type drop down list Document Preparation 41 Production Guide 6 Set the JPEG options Image Quality Medium smaller fie borger fia mGal Color Model Format Method Baseline Standard Resolution Depth Custom v Custom poo Options Anti Alias Imagemap Client side html Server side map Save3 Embed ICC Profile SRGB IEC61966 2 1 Quality Set to 7 High Color model Select RGB CMYK or Grayscale Reso
35. SURE SR TU XE d Es 184 Bookmap Melgdala qicssdasssuakAARREATARRRGARGRA KARada GARE YS 184 Metadata Inheritance ics c lt ccanvs na eee ered dado Rea Rad RO RRO 184 THON secure soem se oue eR dies D Rat d aa dcus dub qus arid 185 Index The Landscape Departmental roles and other teams The production guide covers technical publications procedures for creating product documentation in North American English This guide includes information on people and teams document sets document reviews how a project starts and finishes and production guidelines for producing deliverables Some departmental information regarding desktop sharing and maintaining your NETGEAR laptop are included in Appendix C Office and Laptop Tips The guide finishes up with a section on the CD Build process in Appendix D CD Build Process The goal of this guide is to be a complete reference for technical publications procedures This chapter covers the following topics e What We Do e Job Roles e Cross Functional Teamwork Production Guide What We Do Technical publications handles the following documentation related tasks Writes and updates documentation Creates departmental templates and designs Lays out graphics and creates illustrations Edits customer facing materials such as GUI text and help files Manages document scheduling and production for product releases across all BU s Builds the CD with all the product specific information and d
36. Settings Standard Adobe PDF Security None All check boxes should be selected except for the last one Adobe PDF Document Properties Layout Paper Quality Adobe PDF Settings Adobe PDF Conversion Settings Use these settings to create Adobe PDF documents suitable for reliable viewing and printing Q of business documents Created PDF documents can be opened with Acrobat and Adobe Reader 5 0 and later O ouSetros TT Edt Adobe PDF Security None Adobe PDF Output Folder Prompt for Adobe PDF filename Browse Adobe PDF Page Size Letter Add v View Adobe PDF results IV Add Document Information v Do not send fonts to Adobe PDF IV Delete log files for successful jobs Ask to Replace existing PDF file e f you click Edit next Standard the Resolution should be set to 600 dpi Click PDF Setup On the Settings tab set the PDF Job Options to Standard and the Page Size to 8 5 x 11 Check the Tags and Links tabs The check boxes on these tabs should be cleared The check box on the Bookmarks tab should be selected In the Print Book dialog box click Browse and specify the location and file name for the Postscript file In the Print Book dialog box click Print FrameMaker displays Printing Book fullmanual book while creating a Postscript file Exit FrameMaker and click the Postscript file to launch Distiller and create the PDF file PDFs for Quick Install Guides QIGs Qu
37. and illustrator Handles desktop publishing formatting based on guidelines from the production person and or designer Manages review cycles and incorporates review comments Works directly with the review team to develop review and finalize document Notifies the lead writer of schedule changes as applicable Notifies the lead writer when the doc set for a product is complete Hands off the final files to the lead writer for back up to AgileDropFolder Current Projects and posting to docs netgear com The Landscape 11 Production Guide Editor Contract or Permanent The editor reviews all documents before they are released for editorial style grammar punctuation and other things as specified in the Editorial Style Guide e Uses the editor s checklist on the inside front cover of the Editorial Style Guide to enforce editorial styles e Works with writers to establish the style guidelines and rules e Submits word lists with preferred spelling and usage for inclusion in the Editorial Style Guide Designer The designer is responsible for the look and feel of the printed and online documentation e Uses the branding guidelines produced by marketing to establish colors and fonts used in documentation design and illustrations e Determines page layouts for a consistent look across the various document types while customizing the layout for the best presentation of each document s unique content e Works with illus
38. and new ones added use these tools to update your converted files gt To update already converted files 1 Be sure to update the NetgearTools Templates folder with the latest templates See step 3 Copy paste the latest Manual Templates files into the Templates folder on page 140 2 Apply the updated templates to the book a Import Formats and Latest Templates into Book b Remap Old Tags to New Tags c Cleanup Catalogs d Add Setup GenFiles Numbering and Update Book 3 Page through the files and do any needed cleanup Custom Tools Reference 124 Old Style to New Conversion Tutorial Convert old documents to the new templates format This chapter explains the process and best practices for using the NetgearUtils tools described in Chapter A For information about how to use the NetgearUtils tools see Chapter 8 Custom Tools Reference This chapter walks through the 3 phase conversion process Work on the Book Files Folder Finalize the Book File Set in FrameMaker Update the Book Variables Run the Conversion Tools Clean up the Files Use Additional Tools Update to Newest Version of Template Note Although these steps can be done in a different order this order seems to be the most straight forward and least time consuming 125 Production Guide Work on the Book Files Folder These procedures are performed on the files folder for the book Working on the book files folder involves the follo
39. and reference information The variable name lt varname gt element defines a variable that must be supplied to a software application The variable name element is very similar to the variable var element but variable name is used outside of syntax diagrams This element is part of the DITA software domain a special set of DITA elements designed to document software tasks concepts and reference information Reference a Variable Variables are reused by creating a content reference conref to the inline element that contains the variable text A conref or content reference is an attribute of an element within a topic or a map that pulls the content into the element from another element of the same type Any topic and element with an ID can be reused by means of a conref Conref can be displayed two ways either resolved as regular content or as the path to the target element Local conrefs can link to e Local elements e Local topics External conrefs can link to e External elements e External topics To reference a variable 1 Place your cursor where you want the variable to be 2 Insert a varname element at that location 3 Apply a conref attribute to the varname element The conref attribute has a target that is the name of the file and topic ID where the variable is defined and the variable name in the form flie xml topicID variableName The following is DITA Reference 180 Production Guide the XML th
40. and secure way to set up a wireless home network with fast access to the Internet over a high speed digital subscriber line DSL It has a built in DSL modem is compatible with all major DSL Internet servic providers lets you block unsafe Internet content and applications and protects the devices PCs gaming consoles and so on that you connect to your home network lt p gt lt p gt See lt xref href RouterLogin xml gt for information on logging into your lt varname conref variables xml topic 1 modem gt lt p gt lt conbody gt lt concept gt Collection links create links among a group of nested topics They also specify how links between parent child and sibling topics appear in the output The collection type attribute can be applied to topicref elements in a DITA map topic group elements in a relationship table and columns in a relationship table Variables In DITA variables are implemented by containing the section of text to be reused in an inline element and reusing the inline element with a content reference It s best to keep a collection of reusable pieces of information that can be shared across topics in a DITA topic that contains only variables Define a Variable gt To define a variable Create a variables topic with the generic topic type Add a p element to the variables topic Inside the paragraph add an inline element such as ph filepath or varname Set the id attribute of t
41. are available An example of an un typed topic would be a collection of reusable content such as variables See Variables on page 179 Note Most of the topic elements listed here can be used in a task concept or reference topic e lt topic gt is the top level DITA element for a single subject topic or article Content specific top level DITA elements are concept task reference and glossary e title contains a heading or label for the main parts of a topic including the topic as a whole its sections and examples and its labeled content such as figures and tables Beginning with DITA 1 1 this element can also be used to provide a title for a map e titlealts optional occurs after the topic title Two elements can be inserted as sub elements navigation title lt navtitle gt and search title lt searchtitle gt navtitle is a navigation title that can differ from the first level heading that shows in the main browser window Use lt navtitle gt when the title of the topic is not appropriate in navigation panes or online content because it is too long lt searchtitle gt creates a title element at the top of the resulting HTML file This title is normally used in search result summaries by some search engines such as Eclipse http eclipse org When not set the title element defaults to the source topic title content which might not be as well optimized for search summaries e abstract occ
42. be loaded page by page rather than waiting for the entire file to be downloaded before opening Fast View delivers the document to you reader quickly Whilst not a true search engine optimization technique if it loads too slowly and the reader hits the back button too soon it can harm your search rankings Size Along with Fast View size does matter Keep your PDF file to a reasonable size For search engines if the file is too large and takes to long to load they will abandon it and not index it all PDF Procedures 84 Production Guide Content Finally we come to content Treat your content like you would any other page It should be keyword optimized without being keyword spammed PDF s were once very popular however there seems to be an increase in the use of PDF s again particularly through ebooks Your on page processes should treat the PDF like any other link Link to it using relevant anchor text Keep the PDF stored close to the root directory and available for indexing Creating a PDF file takes a lot of work If you want to be able to have it indexed by the search engines then you should take that extra five minutes to ensure the effective search engine optimization strategies should be applied to it Create a PDF Use FrameMaker 9 0 or later and Adobe Acrobat 9 0 Professional or later Acrobat Distiller Remember to open Acrobat Distiller and check the Default Settings field before creating a PDF from a ps file O
43. business products do not have a space between the model number and version but home products do Business product example FVS318v3 Home products example C814WG v3 Note Home products originally had no space before the version but it was added later Document Sets 20 Production Guide Localized Documents The English versions of NETGEAR product documentation are used for all English speaking countries such as North America Australia and the United Kingdom Localized documents are made from the English versions but have their own unique part numbers Marketing decides whether the documentation for a given product is localized and into which languages For localized products installation guides are always translated Sometimes the setup and user manuals are also translated Whether a document is translated or not affects it s due date Adequate time for translation has to be built into the docs delivery schedule so the installation guide is ready to go into the box and the setup manual is ready to be put onto the CD that then goes into the box See Calculate Doc Due Dates on page 24 Sometimes the localization team which is based in Taiwan requests that technical publications make the descriptions for common features consistent across sets to save on localization costs We try to do this as much as possible without sacrificing quality and user experience Document Sets 21 Start a Project Organized projects are
44. dates are calculated See Calculate Doc Due Dates on page 24 for more information The lead writer requests part numbers for the docs Start a Project 23 Production Guide Calculate Doc Due Dates Documentation due dates are calculated with the 50 percent xfactory date CD Does the product ship with a CD Yes Subtract 5 weeks from the 50 percent xfactory date to calculate the doc deliverable date No Use the published 50 percent xfactory date to figure out the doc deliverable dates Localized and Goes in Box Is the document localized Usually install guides and setup manuals are localized Yes Due date is xfactory 7weeks No Due date is xfactory 5 weeks UM RM for Web Based Delivery Due date is xfactory 2 weeks Estimate Doc Creation Time Use these very generous guidelines to estimate how long it might take to create a document You might need to calculate this when bringing in a contractor to help on a specific project Writing new content 2 hours per page Editing 30 minutes per page Incorporating reviewer comments 30 minutes per page Certification Documents The project engineer might need an installation guide or user manual for product certification In most cases product content is not so important but content relevant to the certification is very important Not all products that go for and pass certification turn into real projects so the goal is to minimize the time and effort inve
45. definition was changed in the session or not gt To add a new variable Some product lines have special considerations For example a hardware installation guide HIW could cover up to three switches You could add and use three variables such as Produce Model 1 Produce Model 2 and Product Model 3 instead of Product Model in this situation 1 Add the variable to any file 2 Select NetgearUtils gt Variables gt Edit Variable Definitions in Book 3 Select the variable definition you just added in the Name in Book column 4 Click Set Definition 5 Click Commit Changes into Book Todelete a variable 1 Select the variable you want to delete in the Name in Book column 2 Click Delete Selected 3 If needed select another variable and click Delete Selected 4 When you have selected all of the variables to delete click Commit Changes to Book Note When you select Commit Changes to Book the command deletes the variables you have specified even if one or more of the variables is used in the book somewhere A deleted variable that is used in the book turns to text which makes it hard to spot and fix The command does not warn you before you delete a variable that is used in the book See To identify variables not used in the book on page 111 for information on how to verify whether a variable is used in the book or not Custom Tools Reference 113 Production Guide Set PDF Metadata for Book gt The Set PD
46. document for editing 1 Get a similar document set on which to base the new document set The engineer or lead writer can help you Check the ftp geardog netgear com ngreng 4TechPubs BaseDocs directory for any stable and reusable write ups that might apply to your project Upgrade to the latest doc templates See Templates on page 50 Make sure you get the correct compliance appendix for your product The compliance information goes in the user or reference manual See Compliance Information on page 30 Installation guides f a Make sure the install guide has a section called Other Features at the end See Other Features Section on page 31 Make sure the link to DoC is included in the install guide See Compliance Information on page 30 for more information Add the GNU GPL statement below DoC paragraph For GNU General Public License GPL related information please visit http support netgear com app answers detail a_id 2649 Make sure the Waste Electrical and Electronic Equipment WEEE text and logo are in the install guide See WEEE Notice and Logo on page 31 Make sure the language is set You should see a white rectangle at the top of the first panel above NETGEAR See Set the Language on page 94 for more information User manuals a b Make sure the language is set You should see a white rectangle at the top of the first page of frontmatter fm See Set the Language on page 94 for more information
47. double click the distribution list you want to edit Use the Select Members Add New and Remove buttons to edit the distributions list Select Save and Close mmi Office and Laptop Tips 163 Production Guide Extract Files from an Apple Archive sit File Download this handy tool Free Stuffit Expander Lab Space We have two benches in the SPBU lab They are the 2nd and 3rd benches in the 3rd row which is the row closest to the door Currently people have some PCs and units on them The rule is that these benches are ours and we can take them whenever we need them These two benches are not officially occupied by engineers Office and Laptop Tips 164 DITA Reference Understanding DITA Use the information here to understand DITA and as a quick reference to DITA elements for tagging DITA content A complete list of DITA elements can be found on the web The default DITA standard has more than 400 elements and those elements contain attributes which can be overwhelming at first A good place to start is with the elements described in this appendix DITA Introduction Topic Elements e Task Elements e Concept Elements Reference Elements e DITA Maps e Bookmaps e Topic Linking e Variables e Topic Linking e Figures and Callouts e Metadata Metadata Inheritance e Taxonomy 165 Production Guide DITA Introduction Darwin Information Typing Architecture DITA is a topic based and tas
48. easier to track Documentation projects start near the beginning of the product life cycle when the lead writer or manager is notified The project could be a new project needing documentation or a maintenance release that requires documentation updates The business units have slightly different methods for requesting and tracking project deliverables including documentation but technical publications processes for starting a project are similar for projects from any business unit This following topics are covered in this chapter Project Kickoff Calculate Doc Due Dates Certification Documents Beta Documents Documents in Agile Document Preparation Compliance Information WEEE Notice and Logo Manuals on Docs Server 22 Production Guide Project Kickoff The project engineer requests product documents from technical publications The project engineer the product line manager and the technical publications department work together to determine the documentation set See Document Types on page 17 for a descriptions and a table of the standard doc sets by product The project engineer recommends a similar doc set on which to base the new set If the project is new without any similar doc set you have the following options Find out if the product has a standard wizard or genie on a CD and get a list of features Sometimes presentations are available with this information Geta unit as soon as possible so you can check the u
49. flyers See the following for information about D TA capable page layout At the present time the workflow from DITA to printed documents is complex and expensive Localization DITA can reduce localization costs because the DITA approach to writing results in fewer words and reusable topics Currently NETGEAR localizes mostly printed installation guides so the cost savings to localization is not immediately obvious In the future NETGEAR could localize more longer manuals that are not printed If and when this happens the cost savings to localization by authoring in DITA could be more evident Content Reuse The most immediate value of DITA to NETGEAR is in content reuse Many products share identical features in different combinations DITA would let technical publications combine the applicable topics from a topic database into a product manual This model would work best for concept and reference topics To a lesser degree DITA would also work for task topics There is more variation in tasks across our products for the same feature due to inconsistent product specification DITA Reference 166 Production Guide implementations by ODMs The implementation variation means that many task topics for the same feature would need to be maintained and carefully tagged with metadata to prevent a task topic from going into the wrong manual As the NETGEAR usability team establishes more standards for consistency across all product lines
50. following variables because they are need by the templates and the tools e Book Title This variable is not used in the book but is needed for the Set PDF Metadata in Book command This command puts the metadata onto the PDF when you generate a PDF e Keywords This variable is not used in the book but is needed for the Set PDF Metadata in Book command This command puts the metadata onto the PDF when you generate a PDF Document part Populates the part number on the cover and history table on page 2 Copy paste the part number from the old variable definitions and delete all other variations of part number variable definitions Document Title Populates the book title on the front cover Do not use the book type in the definition For example make it ReadyNAS for Business and not ReadyNAS user manual for Business Type of Manual Populates the subtitle area below the book title on the front cover with the type of manual For example User Manual or CLI Manual e Publish Date Populates the date on the front cover Product Name Long Populates various areas of the compliance chapter that require the product name It also populates the title as it appears in the front matter and the chapter and appendix headers 4 Select Commit to commit the variable definition changes you have made so far The commit propagates all of the changes you have made to all of the files in the book To pare down the book variables If
51. for Book NetgearUltils tool Company Name in line NETGEAR In line as needed Copyright NETGEAR Generates the Copyright meta data file info with the Set PDF Meta data for Book NetgearUltils tool Document Part Part Number TBD Format XXX XXXX XX Document Title Production Guide Front cover Apply the td document title paragraph tag Do not include the type of manual i e user manual See Type of Manual variable Document Title NETGEARQO Product User Manual In line as reference within the doc Installation Guide Title Product Installation Guide In line as reference within the doc Publications Production Guide IP Address 192 168 1 1 Check also for subnet changes etc Keywords NETGEAR Technical Generates the Keywords meta data file info with the Set PDF Meta data for Book NetgearUtils tool Templates Reference for Manuals 143 Production Guide Table 5 Variable definitions and descriptions VARIABLE NAME VARIABLE DEFINITION USAGE Product Family n a Check with engineering PLM for correct family Product Family in line n a Check with engineering PLM for correct family Product Model Model Number Example MS2110 When used on front cover apply the td_document_title paragraph tag Product Name long Production Guide Production Guide Example Stora MS2110 Wh
52. is actually white in the template so that it does not show up in the document Subtitle tag Use after the chapter title as needed but before the body Associated TOC tag ChapNumTOC e tc chapter titleTOC ChapNum hidden Chap App White character tag paragraph tag d tc chapter title paragraph tag Subtitle if needed Subtitle paragraph tag 3 E e Cross Reference 2 with Heading cross Cross Reference 1 b1 bullet paragraph tag Cross Reference 3 reference tag Figure 26 First Page with hidden Chap App White character tag showing Templates Reference for Manuals 147 Production Guide Appendix Tags Appendix Number The large A on the right is the AppNum tag It will auto generate for each appendix Appendix Title tag is called ta_appendix_title This tag contains a hidden character tag called Chap_App_ White so that it generates the A B etc for the TOC in the pdf file It is white in the template so it does not show up in the document This is why the appendix title section in the template looks indented but it will align correctly in the doc Subtitle tag use after the Appendix title but before the body Associated TOC tag e AppNumTOC ta appendix titleTOC AppNum hidden Chap App White character tag paragraph tag ta appendix title paragraph tag Appendix Title EER E E E tee EM Subtitle if needed subtitle paragraph tag Cr
53. numerous errors and you have been asked to get screen shots you might wonder what to do It s possible you are starting too early before the GUI is frozen Also find out if it s a certification document before investing a lot of time in getting screen shots See Certification Documents on page 24 for guidelines on preparing certification documents Finalize Documents 73 Production Guide Lead Writer s Checklist Lead writers use this checklist to ensure that a document is ready for Agile What Part numbers Requested from Agile analyst at beginning of project Added to docs Final files copied to Agile Drop Folder V Operations Document Control AgileDropFolder lt lt Model gt gt Notification email sent that files are in the Agile drop folder Agile analyst Hsiang Lin localization Alice Ko localization Project engineer Tech support engineer s Suresh Venkatesan Web Naveen Swaroop Polavarum Web Technical publications manager Final files copied to Current Projects VACurrent Projects lt lt Model gt gt Link and Web page on docs netgear com in this format http docs netgear com modelnumber language partnumber index html http docs netgear com modelnumber language partnumber index htm e Get page template from http docs netgear com 1sample page See Project Kickoff on page 23 for more details Example http docs netgear com cwge 111 enu 202 10634 01 in
54. on it if you like or you can use the Print Screen method described in Screen Shots on page 45 for getting screen captures Combine Screen Captures with Photoshop You can use RoboScreenCapture to combine screen captured images from portions of a GUI display such as the top half and the bottom half as described in To prepare and Combine Screen Captures on page 45 You can also do it in Photoshop 7 or later as described here gt To combine screen captures 1 First flatten the layers Layer menu gt Flatten Image option Double click on the background layer to create a new layer If the Layers window is not open select Window gt Layer and then double click Background 2 Add the borders a Crop the top screen shot just inside the borders b Select Photoshop Image gt Canvas Size Canvas Size Current Size 829 0K Width 5 458 inches Height 10 inches New Size 829 0K Width 5 458 inches Relative Anchor Canvas extension color Background v c Set the anchor to the direction you want to enlarge the canvas For example clicking the top arrow positions the anchor so that the increase will add to the bottom when you increase the height d Increase the height If both source images are about the same size you can double the height e Paste a copy of the second cropped image and drag it to the newly enlarged canvas by holding down the lt Ctrl gt key while using the mouse to drag the image into ali
55. or company requirements e Improve content retrieval e Customize information for different audiences versions models and so on Metadata can help you customize delivery features such as dynamic publishing and faceted browsing For example you can set up a dynamic publishing mechanism so that users can DITA Reference 181 Production Guide select the types of content that they need based on categories operating system server type etc model number or size Faceted browsing helps to narrow the number of topics that are relevant to a specific user by listing only the information that is relevant to their search Types of metadata Index entries Conditional processing attributes Topic metadata DITA map metadata Bookmap metadata Note You can also create custom metadata for DITA maps and topics with the othermeta element DITA Reference 182 Production Guide Index Entries In additional to the normal use of an index which is to locate information within a document index entries can also be used as search terms for external web crawlers Even if no one ever sees your index the index entries can help users find your information You can place an index entry almost anywhere within a topic but you should insert most of them in the keywords element of the prolog element This ensures that the index entries for a topic are in the same location and that the terms can be best optimized for search engines Use the inde
56. regular admin login Retail Products These docs are fairly typical for home products and are customer facing as opposed to written for engineers Document Sets 19 Production Guide Product Names Marketing develops product names which appear on the gift box in marketing collateral and in the documentation The gift box is the product package that is sold to the customer and is usually created before the product documentation Product name consistency across these media is very important and for this reason it is up to the writer to find out the marketing approved product long name and short name to use in the documentation Marketing sometimes changes the product names so technical publications uses FrameMaker variables for these names The variables are easily edited and managed with the Edit Variable Definitions in Book command described in Variables Tool on page 110 An example of a marketing approved product long name is N150 Wireless ADSL2 Modem Router It s marketing approved short name is N150 Modem Router The long name is typically used in the book title compliance appendix and in the first paragraph of the first chapter in the book The short name or a generic name such as wireless modem router is used everywhere else Model Numbers and Versions Model numbers and versions vary not only from product to product but also from product line to product line with some inconsistencies across product lines For example
57. schedule the scan for the next reboot The scan begins the next time you turn on the computer and can take 1 2 hours to complete Check Disk Local Disk C Check disk options Automatically fix file system errors Torun virus scans on the C drive 1 Select Start gt All Programs gt ThinkVantage gt Maintenance Manager 2 Select Scan for virus using Symantec Antivirus 3 Clear the other check boxes It s generally better to perform one maintenance function at a time You can come back and run the others one by one as needed Office and Laptop Tips 160 Production Guide 4 Click OK Order Software We order software from CDW http www cdw com Locate what you want on their site and get the technical publications manager approval for the purchase The technical publications manager will then contact Brian Murphy who is the NETGEAR account manager at CDW We get a discount through them so it s worthwhile to either login to the NETGEAR account to order or call him IT can tell you what the NETGEAR log in is Phone 1 877 571 7059 Email giaandbrian cdw com If you purchase with a PO the technical publications manager will ask Brian for a quote including shipping and tax Open the PO and then phone or email him and ask him to place the order under the PO number Office and Laptop Tips 161 Production Guide Remote Access to the V Drive You can have read only access to the V drive through the Citrix
58. spelling errors before reviews and when finalizing it Although FrameMaker does not have a grammar or style checker you can use Microsoft Word to check grammar and basic style FrameMaker to Word through PDF Word cannot read FrameMaker files but you can easily convert a PDF to Word format For large FrameMaker books it might work better to make a PDF for each chapter in the book and check them individually rather than one large PDF for the entire book If the PDF is too large it makes a large Word file that Word can have trouble handling gt To save the PDF to a Word Document 1 Select File gt Save As 2 Select Microsoft Word Document doc in the Save as Type 3 Click Save To configure Word to check for Grammar and Style 1 Click the Review tab 2 Select Spelling amp Grammar in the far left 3 In the Spelling amp Grammar dialog box select the Readability check box to get readability statistics at the end of the check Passive Flesch Reading Ease and Flesh Kincaid grade level See http simple wikipedia org wiki Flesch Heading Ease for more information 4 In the same dialog box click Options in the bottom left Under When correcting spelling and grammar in Word in the Writing Style list select Grammar amp Style 6 Click Settings 7 Select the style settings you want 8 Click OK 9 Click OK again 10 Use the Spelling and Grammar checker e Readability Check Caveats The readability rating
59. technical review before they are submitted for testing First review Developmental review The writer produces a first draft and sends it out as a PDF file for a first review The major review focus is the purpose scope fit for customer profile and structure of the content e Second review Technical review The writer turns on change bars in FrameMaker and incorporates any changes from the developmental review cycle The revised PDF is sent for a review The focus of the review is the accuracy and completeness of the content Final review Release approval The writer incorporates any changes and sends out the final draft for approval to release The structure completeness and accuracy should be final with no changes required When an existing document is updated or modified usually the developmental review can be omitted If major substantive changes are made to an existing document then the developmental review should be included At the discretion of the writer interim updated drafts can be circulated Even if it is a limited distribution the writer should still use the same review cycle names and include the date of the draft in the file name Review Schedule The standard time given to reviewers for each review cycle depends on the length of the document e Less than 50 pages two days per review e 50 or more pages four days per review Some projects are fast track or rush Fast track projects have aggressi
60. that the reader sees the original fonts If you get this error do one or more of the following as needed gt To troubleshoot font errors 1 Check that you ran Preflight on the press quality PDF 2 Start Distiller go to Settings Edit Adobe PDF Settings choose Fonts in the left column and make sure Embed all fonts at the top is selected for the Press Quality job option If it is not selected you might be prompted to create another job option such as Press Quality 1 Press Quality Adobe PDF Settings Gf Press Quality C3 General C3 Images Fonts Color C3 Advanced C3 Standards Show All Settings Embed all fonts R Subset embedded fonts when percent of characters used is less than o Only fonts with appropriate permission bits will be embedded When embedding fails Cancel job v Embedding Font Source Always Embed CAWINDOWSYFonts 0 ACaslonPro Bold 0 ACaslonPro Boldltalic ada 0 ACaslonPro Italic 0 ACaslonPro Regular 0 ACaslonPro Semibold 0 ACaslonPro Semiboldltalic 9 AGaramondPro Bold 0 AGaramondPro Bolditalic 9 AGaramondPro talic O AGaramondPro Regular T AgencyFB Bold T AgencyFB Reg ada T Algerian lAnatsieck T Arial BolditalicMT T Arial BoldMT S Never Embed Add Name Save As OK Cancel 3 In the Embedding section make sure the fonts causing the error are not listed in the Never Embed list PDF Pro
61. the chapter fm file for tag specs and usage guidelines This appendix covers the following topics e Variable Definitions Front Matter Page 1 Front Matter Page 2 e Chapter Tags e Appendix Tags e TOC Tags Index Tags e Master Pages e Reference Pages 142 Production Guide Variable Definitions There is a set list of standard variables that are used in the manual templates and accessed with the commands on the NetgearUtils gt Variables menu within FrameMaker Older documents have a FrameMaker variable definition file called vardef fm which defines project specific terms used throughout the book This file was not always accurate and often contained invalid legacy variable definitions left over from other documents With the custom Variables menu the vardef fm file is no longer needed See Update the Book Variables on page 127 for information about the best way to migrate away from the vardefs fm file approach and to edit update and delete variables You can find this information in step and step 7 Table 5 Variable definitions and descriptions VARIABLE NAME Book Title VARIABLE DEFINITION Production Guide USAGE Add Setup GenFiles Numbering and Update Book on page 123Generates the Title hone file info with the Set PDF Meta data for Book NetgearUtils tool Company Name NETGEAR Inc Frontmat fm page 2 Generates the Author meta data file info with the Set PDF Meta data
62. the file you lose the metadata To prevent this add the metadata directly to the one file with the FrameMaker File File Info command Custom Tools Reference 103 Production Guide Cross References Tool The following commands are available under NetgearUtils gt Cross References These commands maintain consistently defined cross references across all files of the book and update cross references to point to the local files e List of Cross Ref Formats in Book e Edit Cross Ref Formats in Book e Collect Outside Cross References List of Cross Ref Formats in Book This command generates a three column table for each cross reference defined in the book The following figure shows the cross reference formats for the Appendix definition Each table within the report lists from left to right the File Name the Cross Reference Definition used in that file and the pages where that definitions occurs Occurs in Pages gt To list cross reference formats 1 Select Cross References gt List of Cross Ref Formats in Book 2 Inthe report select the file name in the left column to open the file 3 Use FrameMaker s Edit gt Find Change command to locate the cross reference ded M Format Name Appendix Link to File Frontmat fm p Appendix lt chapnum gt lt No Occurrences gt FullManualTOC lt Jump gt Appendix lt chapnum gt lt No Occurrences gt Document Sets fm lt Jump gt Appendix lt chapnum gt lt No Occur
63. the http docs netgear com site where we publish early user manual releases It also provides information about maintaining your NETGEAR laptop Desktop Sharing for a Meeting Geardog docs netgear com Laptop Maintenance Laptop Maintenance Order Software Hemote Access to the V Drive Desk Phones Make an Email Distribution List in Outlook Extract Files from an Apple Archive sit File Lab Space 156 Production Guide Desktop Sharing for a Meeting gt To share a desktop 1 Go to the Adobe site htto netgear acrobat com 2 Login using michael caldwell netgear com for the user name and Welcomet for the password Open the meeting Start the meeting Select sharing of desktop screen Select monitor first or second screen Click Share Allow guests Guests log in at http netgear na6 acrobat com r1285596 1 OMONAA DS w Geardog gt To access geardog with WS_FTP Pro 1 Install lpSwitch WS_FTP Pro if you do not already have it 2 Get the user name and password from IT or the technical publications manager 3 Go to VAEngineering TechnicalPublications Tools WS FTP Pro 9 0 English and double click on setup exe to install the software Start IpSwitch Select the Connection Wizard menu Enter geardog for the site name Type geardog netgear com for the server address Enter the user name Enter the password 10 Accept FTP as the connection type O om S gt oS gt To access geardog with your
64. the old look to the new templates 5 Select Cleanup Catalogs to remove old paragraph catalog table and cross reference tags left over from the old templates It also removes old master pages and references pages 6 This command also generates a Cleanup Catalogs Report that shows any unresolved tag issues Ignore this report for the time being Some issues should be resolved during Phase Il when you clean up the files You will reapply this command later Cleanup Catalogs Report For F21 NETGEAR Conversion Projects Convert for Bets WPNS24N FullManual book Deleting invalid and unused tags from F rontmat fm The Table format Formet A b used in the document and cannot be deleted The Table format No RuleMeta is used in the document and cannot be deleted Deleting invalid and unused tags from F ullManualT OC tm The Pgf format hpl_headTOC is used in cbe document and cannot be deleted Deleting invalid and unused tags from Basic fm Deleting invalid and unused tags from Secerity fm The Char format pdt is ased in the document and cammet be deleted The XR format Table and Page b used in the document and cannot be deleted Deleting invalid and unused tags from Content fas Deleting invalid and unused tags from Customize fm gt Mlio Note Please do not modify the RemapConfigFile yourself any changes you make are lost when a new RemapConfigFile file is released 7 Select Add Setup GenFiles
65. to refer to later rename this report Run the Collect Outside Graphics command described in Collect Outside Graphics on page 109 to make sure all image files for the new book are in the local directory and that FrameMaker is pointing to them in the local directory a This is especially important if you are basing the new book on files that were already on your computer or reachable network Start a Project 29 Production Guide b The reason is that even after you copy the files to a new directory Frame continues to point to the files at the old location When you archive the new file set there are broken links to graphics at the old location on your computer or reachable network 12 Run the List of Cross Ref Formats in Book command described in List of Cross Ref Formats in Book on page 104 to generate a report of the cross reference settings for the book a Review the report for cross reference consistency b Rename this report and save it as record of the old cross reference settings for the book 13 Run the Edit Cross Ref Formats in Book described in Edit Cross Ref Formats in Book on page 105 to set and edit your cross reference definitions for the new book Note Do not delete cross references that are in use The List of X Ref Definitions in Book report shows which cross references are in use 14 Before you submit the book for archiving in Agile run the Collect Outside Graphics command described in Collect Out
66. up You see only the outline of the text box above NETGEAR Copy the text box from the fontmatter fm template file into the same location in your bookfrontmatter fm file and you are all set This will work whether your book is using the new template or the old one To add the text box with the pdfmark manually 1 Open the first file in the book 2 Inthe first body page of the file add a text frame outside the main flow of the document 3 Put the following text in the text frame Catalog lt lt Lang en US gt gt PUT pdfmark Note Here the language is specified to be en US US English It can be any ISO string such as es MX Mexican Spanish fr CN French Canadian and so on Select the text frame and bring up Object Properties Turn on Postscript Code Make the text white so it does not show in your document Save and close the file Export the book to PDF In the PDF select File gt Properties and click the Advanced Tab Check the reading options where it should say Language English To put the text book with the pdfmark directly in the PDF O 0 N enp This has to be done every time you generate the PDF 1 Open the PDF 2 Select File gt Properties 3 On the Advanced tab under Reading Options set the language to English 4 Click OK Test a Tagged PDF Acrobat provides three ways to test a PDF for accessibility compliance and they are described here in their recommended order Read Out Lou
67. urn oasis names tc dita xsd task xsd 1 1 lt title gt Log In to the N150 Modem Router lt title gt shortdesc Log in to the wireless modem router to view or change settings or to set up the wireless modem router lt shortdesc gt taskbody steps step conref Images login jpg DITA Reference 172 Production Guide lt cmd gt Type lt b gt http 192 168 0 1 lt b gt in the address field of your browser and press lt b gt Enter lt b gt to display the login window You can also enter either of these addresses to access the wireless modem router lt b gt http www routerlogin lt b gt net or lt b gt http www routerlogin com lt b gt lt cmd gt lt stepxmp gt image href Images login jpg stepxmp step step cmd When prompted enter admin for the router user name and password for the router password both in lowercase letters cmd info note The router user name and password are probably different from the user name and password for logging in to your Internet connection lt note gt info stepresult The router menus display where you can do things like change settings or add other devices to your network lt stepresult gt lt step gt lt steps gt lt taskbody gt lt task gt Concept Elements DITA concept topics answer What is questions Use the concept topic to introduce background or overview information for t
68. wireless modem router using the Resource CD as described in the N360 Wireless Dual Band ADSL2 Modem Router Installation Guide these Old Style to New Conversion Tutorial 137 Install Custom Tools Add the NetgearUtils menu to FrameMaker NETGEAR contracted with an outside vendor Tassos Anastasiou tassos123 aol com to create a set of custom add on tools for FrameMaker The tools automate time consuming tasks commonly done when converting documents from the old format to the new format and starting and finalizing documents The following topics are covered e About the Tools e Basic Installation Steps Tools Installation Note These tools are for the sole use of NETGEAR employees and contractors and cannot be given to anyone else or to any other company 138 Production Guide About the Tools This custom menu called NetgearUtils appears on the FrameMaker book menu bar but has to be installed before it shows up on the menu bar The NetgearUtils menu only shows up when a FrameMaker book file is open and selected FM File Edit Add Format View NetgearUtils Window Help CE mz v Cross References Graphics Variables Set PDF Metadata For Book Update Current Book to New Templates Figure 25 NetgearUtils menu options These tools are extremely important when converting older docs into the new format and for keeping already converted docs up to date with the latest NETGEAR style Basic Installati
69. you are not using all of them The Book Title and Keywords standard variables are not used in the book but the Set PDF Metadata on Book command uses them to generate metadata See Variable Definitions on page 143 for a complete list of the standard variables Custom Tools Reference 111 Production Guide Edit Variable Definitions in Book This command lets you edit and delete variables and update the entire book with your new variable definitions The figure shows that the BookTitle variable is used in every book file with the same definition except in the compliance appendix Edit Update Definitions For Book Modem Router DGN1000 User Manual yter DGN1000 User Manual DGN100 M Doc nt Tithe TM Installation Guide Title c fm SL2 I GN1000 User Manual IP Address n SL2 N1000 User Manual IP Subnet pliance Wireless fm App e Product Family FuliManualIX fm 50 W er DGN1000 User Manual Set definition use selected or type new definition New Template User Manual Set Definition Delete Selected Un Delete Selected Commit Changes into Book Cancel Figure 19 Variable editor columns text box and buttons Name in Book This column lists the variable definition names for the entire book in alphabetical order Book Filename This column lists all of the book files where the selected variable exists in alphabetical order Ideally this would be all files in the book but is not necessarily the case You might have a
70. you have variables in the book that are used in the book but are not on the standard variables list you can either leave them as is or consolidate the variables to the standard list 1 Select NetgearUtils Variables Edit Variable Definitions in Book 2 Copy the definition from a non standard variable into the standard variable Old Style to New Conversion Tutorial 128 Production Guide 3 Search the book for the non standard variable and replace it with the standard one 4 Do this for each non standard variable that you want to consolidate 5 Run the report again and delete the non standard variables that are now no longer used in the book Run the Conversion Tools The commands for converting an older book to the new templates or updating an already converted book to the latest templates are on the NetgearUtils gt Update Current Book to New Template menu When you execute any of the commands all of the book files open in tabs NetgearUtils Window Help M Cross References Apply this command first Graphics Variables Set PDF Metadata for Book Update Current Book to New Templates Import Formats from Latest Templates into Current Book D Convert Figures Notices Tables To Paragraphs Remap Old Tags to New Tags Cleanup Catalogs Add Setup GenFiles Numbering and Update Book Figure 23 List of template update commands The following procedures walk you through the co
71. 0 ProSafe CD template Finalize Documents 80 Production Guide i PROSECURE SECURITY ARCHITECTURE BY NETGEAR Instructions If the CD does not start automatically browse to the CD drive and double click on Figure 11 ProSecure CD template NETGEAR Connect with Innovation Instructions If the CD does not start automatically browse to the CD drive and double click on Version 1 0 N600 Wireless Dual Band Router WNDR3300v2 e pd NETGEAR Inc rights reserved 240 10681 01 Figure 12 NETGEAR CD template Finalize Documents 81 PDF Procedures Make PDFs web friendly and accessible This chapter provides detailed information about preparing PDFs for release Where applicable troubleshooting information is included to resolve errors that might be raised during accessibility or preflight checks within Acrobat Pro The following topics are covered in this chapter Optimize PDFs for Search Engines Create a PDF Prepare for Color or BW Printing Preflight Crop Marks on PDFs Combine PDFs Link from within a PDF to External PDFs Add A Watermark Tagged PDFs Send PDFs Out for Review See also Add a Bar Code Directly to the PDF on page 36 82 Production Guide Optimize PDFs for Search Engines It is important to provide metadata for your PDF documents so search engines can find them and display intelligible results You can provide the metadata either in Fra
72. 0 xxxxx 0x CD label ai and pdf file LBL CD 7000 V8 0 3 Labels A Word version of this information the STD CD and DVD Manufacturing document DOC 00140 and CD label templates are available in VACurrent Projects CD Labels The CD label art is created in Adobe Illustrator ai The small medium business line uses several CD label templates e ProSafe e ProSecure e NETGEAR standard and wireless Tocreate a CD label 1 Open a label template file NETGEAR ProSafe or ProSecure using Adobe Illustrator 2 Make changes to the label specified by the engineer 3 Save and zip the edited ai file using model CDlabel date zip as the file name Include the standard label font file set in the zip Example 7000 CDlabel 28Jul09 zip 4 Create a PDF file for engineering review Use the same file name format as above 5 Include your name as the author in the Properties list of the PDF Finalize Documents 79 Production Guide 6 When approved submit the pdf and zip files to Agile as the 270 xxxxx xx files 8 SECURITY ARCHITECTURE BY NETGEAR 270 xxxxx OX y Resource CD t Version 1 0 If the CD does not start autom 240 xxxxx 0x Templates NETGEAR Resource CD SN Contents z yu jed Ph Verion 1 2 ae 2 FS116E installation guide 3 Customer support information ProSafe Fast Ethernet Unmanaged Plus Switch FS116E 2010 NETGEAR Inc Al reserved 10617 03 Figure 1
73. 8 Appendix B Appendix Next Appendix C Notification of Compliance Appendix D Notification of Compliance Appendix E Notification of Compliance Index Templates Reference for Manuals 150 Production Guide Index Tags ti_index_titleTOC Generates the listing for the index in the TOC It is not used in the indes fm file 11 pt Arial regular First and left indents 1 Above paragraph 14 pt Below paragraph 8 pt Line space 14 pt Hi index titlef Generates the index title 24 pt Futura Md regular black No indents Above 7 pt Below 7 pt Line Space 13 pt fixed GroupTitlesIX Generates the alphabetic index markers in the index fm file 14 pt Arial blue bold No indents Above 15 pt Below 3 pt Line Space 17 pt General Styes 6 7 9 Templates Reference for Manuals 151 Production Guide Master Pages Each template contains only three 3 master pages All other master pages should be deleted Note Not all OLD master pages may be listed in the tables below When converting files from the old format please DELETE all master pages except for the 3 used in the new templates Extra master pages may show up in the CleanUpCatalog report when the conversion tool is applied Frontmat fm New master page names Old master page names Book Cover Title Page Left Left Right Right Logo Note Other old master pages may not be listed here FullManau
74. A standard has more than 400 elements and those elements contain attributes We would start by mapping FrameMaker tags to DITA elements Other DITA elements would be needed but it would be best to define a core set of elements and attributes to be used Figure call outs There are two types of call outs text and keyed In text call outs the labels are superimposed on the image In keyed call outs language independent key numbers or letters are superimposed on the image with a legend providing the explanations for the call out keys displayed outside the image The keyed method is preferred The legend is stored in a definition list dl within the figure fig element Legends are more easily maintained and more easily localized as the text explanations are stored as text rather than embedded within the image file Component content management system CCMS Documented new processes for reference Editor needs to know what to look for during an edit Correct content tagging Topic based writing and one subject per topic The difference between task concept and reference topics Whata good task concept and reference topic looks like DITA Reference 169 Production Guide Topic Elements Use the generic topic structure for un typed topics While much of the DITA architecture is built on generic topics it is generally better to use more specific information types such as concept task or reference when they
75. After a template conversion use this command to update the numbering and to regenerate the contents and index files When it completes it updates and saves the book This command requires that your numbering settings for Chapter Page and Paragraph be set correctly It relies on that information to update the chapter page and paragraph figures and tables numbering These properties should be set correctly in the templates so that when you perform the template update they are applied to your book files However if after running this command the numbering is off check that the files have the following settings make corrections manually as needed and run the command again e Pagination Next Available Delete Empty Pages Page numbers As specified by your Numbering properties Page Numbers should start with 1 in the front matter and continue numbering from previous page in all subsequent files Tables As specified by your Numbering properties for paragraphs The first table is 1 and number sequentially through the rest of the book Figures As specified by your Numbering properties for figures The first figure is 1 and number sequentially through the rest of the book Footnotes As specified by your Numbering properties for figure or table footnotes The first figure or table footnote is 1 and they number sequentially through the rest of the book e Chapter Appendix numbers as appropriate As specified by your Numbering pr
76. Author NETGEAR Book Title As it appears on the front cover Subject Use the book title and or write something appropriate Keywords Use the title and or add in appropriate keywords Copyright Put in the copyright year 3 Execute NetgearUtils gt Set PDF Metadata for Book Custom Tools Reference 114 Production Guide Creating Useful Metadata Optional When adding data for document properties consider the following Use a good descriptive title in the Book Title field The filename of the document should appear in the Search Results dialog box e Always use the same field for similar information For example do not add an important term to the Subject option for some documents and to the Keywords option for others e Useasingle consistent term for the same information For example don t use biology for some documents and life sciences for others e Use the Author option to identify the group responsible for the document For example the author of a hiring policy document might be the Human Resources department e f you use document part numbers add them as keywords For example adding doc m234 in Keywords could indicate a specific document in a series of several hundred documents on a particular subject URL Tools The URL tool helps to ensure that URLs are active when you make a PDF from a FrameMaker book There are two sets of URL tools as follows When the book is active the NetgearUtils menu displays the UR
77. Default Font Appendix Number amp Title FullManualTOC fm Emphasis Jump paratext td document title Default Font Document Sets fm Emphasis Jump paratext td document title Default Font Cell and Page Production Guidelines fm Emphasis Jump paratext td document title Default Font Chapter pdfprocedures fm Emphasis Jump paratext td document title Default Font Chapter Number amp Title FrameTools fm Emphasis Jump paratext td document title Default Font Figure Reviews fm Emphasis Jump paratext td document title Default Font Figure amp page startproject fm Emphasis Jump paratext td document title Default Font Figure and Page finalprep fm Emphasis Jump paratext td document t tle Default Font Footnote departmental fm Emphasis Jump paratext td document title Default Font Heading TemplateStyleGuide fm Emphasis Jump paratext td document title Default Font Heading amp Appendix FullManualIX fm Emphasis Jump paratext td document title Default Font Heading amp Chapter Heading amp Page Heading amp page Heading and Appendix Heading and Chapter a Set definition use selected or type new definition lt Emphasis gt lt Jump gt lt paratext td_document_title gt lt Default Font Set Definition Delete
78. F Metadata for Book command does two things and then saves the book Reads the bookmark and tagged PDF settings from pdfsettings fm in your NetgearTools directory and applies them to the book so that all books use consistent settings Reads the variable information for the variables listed below from the first file in the book It then populates the File gt File Info box in FrameMaker with the data in the variables When you make a PDF the File Info data populates the File gt Properties fields of the PDF The Properties data is called metadata and is used by search engines to find and display PDF information in search results To set up variables for the metadata 1 Put the variables listed below in the first file in the book if they are not already there Spell the variable names exactly as shown using one or two words as indicated Variable PDF Metadata Behavior Company Name Author NETGEAR Inc Empty if the variable not defined Book Title Title Empty if the variable not defined Product Name long Subject Empty if the variable not defined Keywords Keywords Empty if the variable not defined Copyright Copyright Empty if the variable not defined Define the variables to contain the metadata that you want to be exported to the PDF file You can use the example settings shown here or supply your own data See Creating Useful Metadata Optional on page 115 below for hints on creating good metadata
79. Fs Out for Review 22 4 6 00s usen m ERR Rc XR es 99 Make Large PDFs Available for Review 00 05 99 Chapter 8 Custom Tools Reference NetgearTools Folder and Files 2000 e eee eens 101 NetgesrUtls MENU cues rete wane ee RkRe hxc RR E dx ne 102 Commands and Book Files l e 103 One File DoSURBIS adus xps dh Ex XE daiXeREX keke Eu EE GE 103 Cross References Tool 1 0 0 0 0c cee ee eens 104 List of Cross Ref Formats in Book 0 000 e nea 104 Edit Cross Ref Formats in Book 0 000 cece eee eee 105 Collect Outside Cross References 0 00 cece 106 DU SDHIOS TODO tho tetd dae SER RU deb uer eka eee woe Rha tees x 107 List ar Graphics In BOBK ciis dave xaX Aa XA Ats aedea denne s 107 Move Unused Graphics 0 000s 108 Collect Outside GISDI DB asies tore rx RR Cer Rad eX RE AKE 109 Valabibs TOU 2c cc08 hee REL aie Eque ps REO DROP Sd Pa 110 List of Variable Definitions in Book 0 00 c eens 111 Production Guide Edit Variable Definitions in Book 0220000 0c eee 112 Set PDF Metadata for Book 0 0c eee e eee eee 114 Creating Useful Metadata Optional 00 00 ea eee 115 Bi Mero c D c Ee vlr PRETI 115 Background Information 2s sies e me onm ehem ones 116 URLA O cou a dooce eae ad ab RO tk ee ded ded eee a aestus acd 116 Apply Character Tag to URL Markers 00020000 ee 118 IER HL oi ua bh
80. IE es e acide ded dite chic dedi ador che a qi iid e cue a A dica 12 PROCUCHON PRISON iouuscuxs tineta X EAE OUR Cees RU RR X bh we 12 iG I steers ide ITA LIT DTI 0 E DUET TM 13 Cross Functional Teamwork 000 0 eee eere 13 ICI c soda oR h eed Rx RMS SRG PRR eA CC d Ce Rede 13 EGO BEC sxeccynucne cgedy peSanEcyak yer Ped d Aaa ee 14 Tech sup they tin biodata dd ec db Er dic ESOS ogee Y T onde 14 Frooud Oo as sue ENA NEER r REFERS EXC piEedpsqqa 14 SADIE T E E E CEA Y RA Heo ERG d 4 dk e UR ERG 14 boaz cairn nid ane RM FI EPI ade hag aC 14 Packaging rie rrite xm debut REC XR PEN APER RR RE AR hd 15 Eere Losses as rd ees ET eee i i ute Ii e eared d 15 Chapter 2 Document Sets Document TSBOS adu doti ede ERE RAN LEER eee iwi Eds ads 17 Home and Business Prodlelts iius sue mam ne hose dee 19 Home Producti SBPU GOUD us acea dod do adici ac Rack e deco side di del 19 Product Mami g xaxa a dac ku exp SCR ORORSCRGXORRO RR bed ACA URGE RURCEORGORR CE RON 20 Model Numbers and Versions 0 0 00 cece eee ee ee eee 20 Localized Docet uasa qae a RRR GREK RR KES EERE a 21 Chapter3 Start a Project PROC BIOKEIT cusceadadeadeceddedersdavand ousrdchadseeadacads 23 Calculate Doc Due Dates aana nanana eee eee 24 der MP NR F NIE gt TEEN gen ae eo eeu a EA anes ar oan 24 Localized and Goes in BOX a0 2 2440edisceeer ee deer eesvs 24 Estimate Doc Creation Time 0 0 ee eee 24 Certification Documents uiae ceoka r
81. L Tools menu with two commands for fixing existing URLs in documents Create URL Report tells you which URLs need attention Apply Character Tag to URL Markers These tools are for fixing existing URLs in documents Fixes some of the broken URLs You might have to use the Insert URL command to reinsert the others to get a clean report e When a document file is active the NetgearUtils menu displays an Insert URL command This tool ensures an active URL is inserted into the document Note After incorrect URLs are fixed in older documents and when users start using the Insert URL command to automatically insert and tag URLs the URL report will be clean and there will be no issues that need attention These commands help you have active URLs throughout your book e URL Report e Apply Character Tag to URL Markers Insert URL Note You can put links in our documents to Internet resources that are not owned by NETGEAR but do this with discretion You can link to technical standards or organizations such as IEEE However do not link to commercial documents owned by competitors or other private companies Custom Tools Reference 115 Production Guide Background Information FrameMaker requires that the following two things happen so that a URL is correctly converted to an active PDF link The text of the URL has the Jump character tag applied to it e In front of the URL text there is a hypertext marker that contains the tex
82. Maintenance Dates Revision information Author DITA Reference 183 Production Guide Reason Types of Metadata Information Allowed in the lt prolog gt Element Search Platform Product Permissions Brand Audience Category Index Keywords also useful for search Index terms See index terms See Also index terms DITA Map Metadata You can provide metadata for the topics included in a DITA map There are advantages and disadvantages to applying metdata at the map level Some people feel that applying metadata at the map level provides more reuse potential for the topics Others feel that applying metadata at the topic level keeps the metadata closest to the content and allows writer to set it as they write If metadata is applied at the DITA map level use the topicmeta element inside the topicref element Bookmap Metadata Bookmap metadata is contined in the bookmap element The bookmap element allows additional metadata over what is allowed in the topicmeta element Metadata Inheritance Some metadata is inherited Be aware that standard DITA processing happens from the top down By default DITA map metadata combines with or overrides topic metadata Inheritance can be a quick way to apply metadata to sets of topics in the same hierarchy The disadvantage is that inherited metadata can be misappllied on the topics if it is not done carefully DITA map metadata This metadata is appl
83. NETGEAR Production Guide Technical Publications Production Guide 2010 NETGEAR Inc All rights reserved No part of this publication may be reproduced transmitted transcribed stored in a retrieval system or translated into any language in any form or by any means without the written permission of NETGEAR Inc Trademarks NETGEAR the NETGEAR logo and Connect with Innovation are trademarks and or registered trademarks of NETGEAR Inc and or its subsidiaries in the United States and or other countries Information is subject to change without notice Other brand and product names are registered trademarks or trademarks of their respective holders 2011 NETGEAR Inc All rights reserved Statement of Conditions To improve internal design operational function and or reliability NETGEAR reserves the right to make changes to the products described in this document without notice NETGEAR does not assume any liability that may occur due to the use or application of the product s or circuit layout s described herein Contents Chapter 1 The Landscape Wiel WS DE Sua ces Rade de ORAE Bra seb hae Bing bese da Jo c 10 NOMS ccna qa qaa d pe dp qa dawn wee d Ke dde Ud d d a 10 bea WME eaaa TT TET OTRO 10 TUB Gode ue tb am Reena eee ee eter awe eee 11 Donat Viel ca d ecd de ced d OM CC eee eso ROG SIRE doe dots 11 Editor Contract or Permanent s o 6 ck eco ek c Re eee 12 Bocca P EP 12 MEER S
84. NETGEAR should get to a point where task variation will reduce It is unlikely that sales marketing or training would use the DITA topics produced by technical publications without modifying them The value of content reuse through DITA is lost when the content is modified by the receiving party Technical support is the most likely group to reuse without modification the DITA topics produced by technical publications Storing content in a CCMS would make it easier for technical support to locate topics of interest to publish to the support website Some of the value of content reuse by technical support would be in receiving automatic updates to content posted to the support website However it is important to be aware that content changes are usually made for updates to newer versions of the product Technical publications would use metadata to carefully tag the new content Nevertheless care would have to be taken by technical support to ensure DITA content for an older product is not updated with content meant for the newer product It is likely that two or more versions of the product are in the installed customer base and therefore as many versions of the content needs to be maintained on the website Transition The technical publications department is small and constantly busy Documents are released weekly for new products and product updates The writers have almost zero downtime which means a transition from the current unstructured
85. R WRN 8 9 10 11 12 13 14 15 Production Guide Open the PDF and page through and find an Adobe PDF icon Select Forms gt Add or Edit Fields You don t want Adobe to detect form fields for you At the top left below the PDF menus select Button from the Add New Field drop down list Use your pointer to position the button over the Adobe PDF icon Click Show All Properties Alternately you can double click the button In the General tab of the Show All Properties dialog box type Click me in the Tooltip field This will make the text Click me display when the user hovers over the Adobe PDF icon In the Appearance tab set the fill color to No Color In the Actions tab in the Select Action drop down list select Open a File and click Add In the Select File to Open dialog box select the file you want the button to open In the Specify Open Preference dialog box select New Window and click OK Close the Button Properties dialog To test the button select Forms gt Close Form Editing Click the Adobe PDF icon to open the reference file Find the next Adobe PDF icon and repeat the previous steps Add A Watermark When you add watermarks to a PDF document you want them to be visible and unobtrusive gt To add a watermark 1 2 Inside Acrobat Professional select Document gt Watermark gt Add In the Add Watermark dialog box provide the following settings Font Arial Size Varies For shorter wat
86. Selected f Un Delete Selected Commit Changes into Book Cancel Figure 14 Cross references editor columns text box and buttons Name in Book This column lists the cross reference definition names for the entire book in alphabetical order Book Filename This column lists all of the book files where the selected cross reference exists in alphabetical order Ideally this would be all files in the book but is not always You might have a cross reference that exists in only one or a few chapters Definitions This column lists the cross reference definition in each file where the cross reference exists so you can scan for consistency Set Definition This button lets you set a definition one by one until you have redefined all the cross references you want to for the current session Delete Selected This button lets you delete a cross reference from the book Un Delete Selected This button lets you reverse a deletion You have to reverse the deletion before you click Commit Changes into Book Custom Tools Reference 105 Production Guide Commit Changes into Book This button commits all of the changes you made with Set Definition minus any changes you undid with Un Delete Selected e Cancel This button quits out of the session without making any changes Toedit Cross Reference Definitions 1 In the Name in Book column highlight the cross reference you want to change In the Definitions column hi
87. Web Interface at http citrix netgear com and read write access over VPN The Citrix web interface provides read only access VPN provides read write access gt To use the Citirx web interface 1 Go to http citrix netgear com 2 If this is your first time download the Citrix Presentation Server Client from the login page Do not log in yet 3 If you already downloaded the Citrix Presentation Server Client log in using your LDAP user name and password 4 Click the Atlas V Drive Corporate Share icon follow any prompts that appear and browse the V drive gt To use VPN 1 Download the Citrix VPN client from https pier40 netgear com and install it 2 Start the VPN client and log in with your LDAP user name and password 3 On Windows XP go to Start gt Run and type atlas netgear com 4 If prompted log in with your LADAP user name and password but put netgear in front of your user name like this netgear user name password 5 Click the Corporate Share folder to access the V drive 6 Employees only Click the Departmental Share folder to access the U drive 7 Employees only Click the Home folder to access your home directory Office and Laptop Tips 162 Production Guide Desk Phones gt To initialize a phone 1 Plug in the phone if it is not already plugged in 2 Inthe Ext prompt type the extension number and press OK 3 In the password prompt type the extension number and press OK To make and
88. ae E aed due iac mak Riek a do dansk ance ae d dy en 119 Template Conversion ToBlS 24 23 pne qa REA REG a ER 119 Import Formats from Latest Templates into Current Book 120 Convert Figures Notices Tables to Paragraphs 120 Remap Old Tags to New TagS 00 0c eee eee eee 121 Fix Cross Reference LinkS 0 0 00 cece eee eee eee 121 Ceamp Cals e T C EMT E 122 Add Setup GenFiles Numbering and Update Book 123 Update Converted Files 22 caso sr m e emm nem iks 124 Chapter 9 Old Style to New Conversion Tutorial Work on the Book Files Fold t iis cose soe Rn RR 126 Finalize the Book File Set in FrameMaker 0000005 1287 Update the Book Variables 02 00 000 cee eee 127 Run the Conversion Tools 00 00 cece eee eee ees 129 Lean up the FIGS uico ceti aetna ne onc x ERR on a 131 Use Additional TablS usse rece re CREER XO CREE CR GREECE RD wa 137 Update to Newest Version of Template 2002 00 ee 137 Appendix A Install Custom Tools Absutthe Tools aceozkeseudkbcoasQau HE oRERRESSATORRERISERARGSIe 139 Basic Installation SIBDB avg srada RR CREE ERERIRRXSdu OO ates X dex 139 Toule Tngtellauno co dudaed tquddexu As ede detesasqgeaSx cab da 139 Appendix B Templates Reference for Manuals Variable DEIIOHE uua RR RAS AT KS istis RAERRARE OR RA EE 143 Front Mater Page T iisssoea 6503846 6b dee Rh 4 Ra Reed 145 From Maltar PSOE S Loaded o
89. age and add the crop marks to the PDF To enlarge a PDF to Allow for Crop Marks Open the PDF file in Acrobat 2 Select Document Crop Pages 3 Click Custom 4 Enter custom size at least 1 inch larger width and height than the trim size of the document to allow for crop marks 5 The Center check box should be checked 6 Click OK To add Crop Marks to a PDF 1 Open the PDF in Acrobat 2 Select Advanced Print Production Add Printer Marks 3 Click OK Combine PDFs gt To combine PDFs Open the PDF in Acrobat Select File gt Combine gt Merge Files into a Single PDF A window lists the first PDF Drag and Drop the remaining PDF files into the list Order the PDFs right click a file name and select Move Up or Down Click Combine Files Domen Save the combined file to a new name Link from within a PDF to External PDFs You can link to external PDFs from within a source PDF It is best to do this on a final PDF because you have to redo the links every time you create a new source PDF This can be useful if you have a Word file with embedded PDFs When you make a PDF from the Word file that source PDF has the Adobe PDF icons but those icons are inactive You can use tools within Acrobat Professional to put a transparent button over the icon and define the button to open a specific external PDF file To link to an external PDF 1 Create a PDF from the Word file PDF Procedures 90 NOO
90. ags it The fix is to retag it with Bold 2 The URL text and the marker text do not match Custom Tools Reference 117 Production Guide The text you typed into the document and the text you typed into the hypertext dialog box after message URL do not match This could be intentional like in the example above where NETGEAR website is the URL text and www netgear com is the marker text The tool reports the situation and you have to decide whether or not to fix it Use the Insert URL command to re create the URL if you decide it needs fixing 3 There are URL markers that do not have the Jump tag applied to them As explained above the URL text and the URL marker need the Jump tag applied If the error message tells you that you have untagged URL markers run the Apply Character Tag to URL Markers command to fix this problem throughout the book Note This is the only situation that the Apply Character Tag to URL Markers command fixes 4 There is a URL marker with the Jump tag applied but the character that follows it does not have the URL text This could happen if you forgot to insert the URL text or apply the character tag to the URL text You have to review the URL and determine how to fix it Use the Insert URL command to re create the URL Apply Character Tag to URL Markers Book level command The Apply Character Tag to URL Markers does not apply the Jump character tag to the actual URL text It applies the Jump charac
91. ake translation easier In FrameMaker use 9 point Arial for the text and make the callout lines either 0 5 or 1 point thickness Note If you experience font problems with legacy illustrations the Illustrator file might have layers that previously contained text with those fonts even if the text has been deleted These layers should be removed to solve the problem Adobe Illustrator Files Import Adobe Illustrator source files directly into your documents Do not convert illustrator art to JPG or PNG or to any other format for your doc There are 2 reasons for this e Localization Anything being translated whether it s a print document or a PDF should use Illustrator art so the translators do not have to redraw the illustrations Printing Anything going to print needs to be crisp JPGs and PNGs made from Illustrator art do not render nearly as well as simply using the illustrator art Screen captures seem to be fine At least we haven t had any complaints about them so far gt To use an Al file in your document 1 Put the Adobe Illustrator file into the FmSrc Img folder for the document 2 Import the file into FrameMaker by reference Do not embed the image except bar codes Accept the FrameMaker default setting of 96 dpi Scale the graphic in Frame as needed Al Production Files Adobe Illustrator art files imported directly into FrameMaker as ai files have a color mode which is either CMYK less bright colors for d
92. alization engineering support and web but not Help Desk The email message has the following information 1 2 3 Statement that the lead placed documentation for a project product in an Agile drop folder including the path Reason for the documentation as follows 01 part number docs The new product or products that the doc supports 02and higher part number docs The product or products that the doc supports and the reason for the revision Explicit request to the PLM to create a Help Desk ticket to update Agile When the Agile team finalizes the upcoming procedure change the lead is required to approve the resulting ECO The lead approval indicates that the correct files were included in the ECO Finalize Documents 78 Production Guide CD Document Delivery Some products ship with a CD In those cases the CD contains installation and setup software and documentation The information provided here is for informational purposes only The writing team no longer manages the CD build process All matters related to CDs are handled by the CD Build engineer that is based in Taiwan The position reports into the localization team Part Numbers There are 4 P Ns for a CD Format Example 103 xxxxx 0x CD assembly 103 10405 02 CD ASSY SW 7000 V8 0 3 1240 xxxxx 0x CD and label subassembly 240 10596 02 SW CD ASSY 70000 V8 0 3 230 xxxxx 0Ox Bits ISO file SW CD 7000 V8 0 3 27
93. ameMaker introduced EDD files which were similar to DTDs but not quite the same lt xml version 1 0 encoding UTF 8 lt DOCTYPE dita PUBLIC OASIS DTD DITA Composite EN ditabase dtd Begin Document Specific Declarations End Document Specific Declarations J gt lt Fm Condition DITA Prolog AsIs NO_OVERRIDE hide gt lt Fm Condition DITA Comment AsIs NO OVERRIDE hide Fm Condition FM8 SYSTEM HIDEELEMENT AsIs NO OVERRIDE hide FrameMaker has a View in Notepad option that displays the XML code However you cannot edit the XML code or see changes you have not yet saved The information displayed in FrameMaker is a rendered version of the underlying XML file What authors want is the ability to edit the XML files directly and then continue working in FrameMaker To make the View in Notepad option semi usable 1 Go to APPDATA Adobe FrameMaker 10 to change the default text editor 2 Open the TextEditorPlugin ini file in a text editor and you see this TextEditor TextEditorName C WINDOWS system32 Notepad exe SaveFileBeforeOpening No 3 Edit the file to reference TextPad instead of Notepad and to save before opening TextEditor TextEditorNamezC Program Files TextPad TextPad exe SaveFileBeforeOpening Yes 4 Close and restart FrameMaker If you attempt to edit the text file that s displayed you get an erro
94. and online deliverables on schedule e ls responsible for documentation quality and quality improvements e Studies the competition documentation to make sure NETGEAR documentation is at least on par e Establishes efficient processes to streamline the work e Collaborates across all business units and functional teams e Manages and works with geographically dispersed teams e Runs the weekly technical publications departmental meeting e Owns the Production Guide and the Editorial Style Guide Cross Functional Teamwork Technical publications is within the Engineering Services organization because it is a shared service The department provides printed and online documentation for the following NETGEAR business units Home Small Medium Business Service Provider and Storage This section describes how the technical publications department interacts with other teams Marketing The marketing team is a separate organization with product line managers PLM s dedicated to the various business units The PLM for a business unit develops new product ideas researches these ideas and performs a competitive analysis to see if they are worthwhile for NETGEAR to pursue The PLM is also responsible for determining the formal product name and the short name to be used in the documentation on the packaging and in marketing documents The PLM presents new product ideas to upper management for approval at Product Change Management PCM meetings
95. anup tasks Apply H4 head to step headers e Realign graphics as needed e Realign figures as needed Remove extra carriage returns throughout each file Other cleanup tasks as you see necessary in the document Clean up the Master Pages To keep the files as clean as possible check the master pages of each file Cleaning these will resolve many Cleanup Catalog issues you may have gotten earlier Each template contains only three 3 master pages Delete all other master pages Frontmat Book Cover Left e Right TOC e TOC First Left e Right Chapters and Appendices Old Style to New Conversion Tutorial 135 Production Guide e chap_cover Left e Right IX ndex First Left e Right 8 Clean up the Reference Pages The reference pages on all the templates are exactly the same All other reference pages should be deleted e TOC e IX Reference 9 Reapply NetgearUtils gt Remap Old Tags to New Tags and NetgearUtils gt Cleanup Catalogs to get a new list of tag issues which should be shorter at this point 10 Resolve issues that show up in the Cleanup Catalogs Report if any Note The following Tables might show up in this report but they need to be resolved manually by going to the Table Designer and deleting them from the catalog e Warning e Imgt Img2 Img3 e Note Note 2 They cannot be resolved through he RemapConfigFile because it causes the Notes Warnings et
96. ard prompts Acrobat creates an email message in your outbox with boilerplate content and the PDF attached 4 Add text to the boilerplate email message to specify the type of review developmental technical or release approval and the due date for replies 5 Send the email to the reviewers Make Large PDFs Available for Review For very large books use the Send for Shared Review feature to specify the reviewers upload the file to the Adobe web site http acrobat com and notify reviewers by email To reduce large PDFs there are two optional steps in Adobe Pro e Advanced gt PDF Optimizer Document Reduce File Size PDF Procedures 99 Custom Tools Reference Learn our custom FrameMaker tools The custom NETGEAR tools for FrameMaker automate time consuming tasks commonly done when converting documents from the old format to the new format and when starting and finalizing documents The custom menu called NetgearUtils appears on the FrameMaker book menu bar after you install the tools as described in Appendix A Install Custom Tools This chapter explains the files tools and reports associated with the NetgearUtils menu NetgearTools Folder and Files NetgearUtils Menu Commands and Book Files One File Documents e Cross References Tool e Graphics Tool e Variables Tool e Set PDF Metadata for Book e Creating Useful Metadata Optional URL Tools e Template Conversion Tools e Update Conv
97. asks choosing produce dita gt lt relcell gt lt relcell gt lt topicref href reference produce dita gt lt relcell gt lt relrow gt lt relrow gt relcell topicref href concepts about cannedgoods dita lt relcell gt lt relcell gt lt topicref href tasks buying cannedgoods dita gt relcell lt relcell gt lt topicref href reference cannedgoods dita gt lt relcell gt lt relrow gt lt reltable gt Parent topic DITA core vocabulary Hierarchical Link Related concepts Relationship Table Linking attribute Linking content Cross reference element lt xref gt Related links element lt related links gt Figure 32 Hierarchical and related links Inline links are inserted in the topic text to connect users to related information These links are handled with the xref element It is best to limit cross referencing because if you reuse a topic you have to include all other topics that are within the cross referencing scheme to avoid broken cross references The following is the XML for an example inline link concept xmlns xsi http www w3 org 2001 XMLSchema instance id concept 1 DITA Reference 178 Production Guide xsi noNamespaceSchemaLocation urn oasis names tc dita xsd concept xsd 1 1 lt title gt DGN1000 At A Glance lt title gt lt conbody gt lt p gt The varname conref variables xml topic 1 modem gt provides you with an easy
98. asks or reference topics In a concept topic where other sections or examples are used only other sections or examples are permitted as e lt title gt provides the topic or section title e shortdesc introduces the topic e conbody contains more description of the concept where you can add sections paragraphs and other elements e section contains a subsection that you can use to organize the conceptual information e Sl displays a list of short or simple items e lt ul gt displays content as an unordered bulleted list e lt dl gt displays a list of terms or short concepts and their definitions e lt image gt provides a figure so that you can insert graphics e fig provides a caption for an image e term highlights new terms DITA Reference 173 Production Guide Box Contents Make sure you have everything you need to cable your router N150 Wireless ADSL2 Modem Router DGN1000 AC power adapter plug varies by region Category 5 Cat 5 Ethernet cable Telephone cable with RJ 11 connector Microfilters and splitters quantity and type vary by region Resource CD with NETGEAR Genie setup Installation guide with cabling and router setup instructions If any of the parts are incorrect missing or damaged contact your NETGEAR dealer Keep the carton including the original packing materials in case you need to return the product for repair NETGEAR Y Figure Bo
99. at shows how to reuse the variables defined in Define a Variable on page 179 Blue highlighting calls your attention to values used when you defined the variables lt varname conref variables xml topic 1 productname gt varname conref variables xml topic 1 modem gt Figures and Callouts The fig element can contain an image an ordered list a paragraph and a table This provides the tools for building a set of labels a legend or multiple captions An example of a definition list within a figure structure is lt fig gt lt title gt Example of keyed callouts on an illustration lt title gt image href images callout_key_ej25_turbo jpg width 393px height 322px lt alt gt Example of keyed callouts on an illustration lt alt gt lt image gt lt dl gt lt dlentry gt dt A dt lt dd gt intercooler lt dd gt lt dlentry gt lt dlentry gt dt B dt lt dd gt expansion tank lt dd gt lt dlentry gt lt dl gt lt fig gt Metadata Metadata is information about the content in your DITA topics and maps When properly implemented metadata can help writers create content that is targeted to specific audiences products versions and so on to help users find the right information In DITA there are many topics that have to be tagged with metadata so they can be correctly located and used You can use DITA metadata elements to do the following e Include information to meet legal
100. ation 36 Production Guide Quick Response QR Codes Some of our documents are starting to use Quick Response QR codes to take the reader directly to a download page or somewhere else of interest The user scans the QR code with a device such as a smart phone that has a bar code scanning application installed on it AQR code can be a URL text phone number or SMS The following link lets anyone make a QR code for free http grcode kaywa com This article mentions several options http gadgetwise blogs nytimes com 2011 03 0 1 qa make a quick qr code This QR code takes you to www netgear com Figure 7 A QR code that when scanned goes to the corporate website Print Specs All documents destined to be printed and put in the box have a print specification also known as a print spec A print spec is a Word or text document that tells the printer how to print the document The print spec is archived with the document NETGEAR uses printers based in Taiwan to save money The employees read and speak English but are sometimes not very proficient It is very important that the print spec be clear and contain enough details so the printer can interpret the print spec and print the document correctly If you have a new type of document for print it is a good idea to come up with a preliminary print spec and work with the printers to get samples This can save you unwelcome and expensive surprises when you find out that the print
101. ble or variables that apply such as Model Product Name etc and apply the Use the variable td_document_title Type of Manual paragraph tag and apply the Subtitle_Cover paragraph tag Embedded anchored frameto add a product photo Adjust size as necessary 260 East Plumeria D rive Esn Joss DA Pee TETI Lives on the master page Juns 2610 EEEIEI Uses the variables as Pari Mmm ber T ED Publish date uE TP Part Version Number Templates Reference for Manuals 145 Production Guide Front Matter Page 2 Uses the variables Paragraph tags Copyright Headings hf1_head hf2_head or hf3_head Company Name Body text legalese or legalese_indent Bullets legal_bullet or legal_bullet2 Notes legal_note BOUIU NETGEAR TG AN fights RSV TI mmm No part of this publication may be reproduced transmitted transcribed stored in a retrieval system or translated into any language in any form or by any means without the written permission of NETGEAR Inc Technical Support Thank you for choosing NETGEAR Toregister your product getthe latest product updates or get support online visit us at http support netgear com Phone US amp Canada only 1 888 NETGEAR Phone Other Countries See Support information card Trademarks NETGEAR the NETGEAR logo ReadyNAS ProSafe Smart Wizard and Auto Uplink are trademarks or registered trademarks of NETGEAR Inc Micros
102. browser 1 In Internet Explorer type ftp geardog netgear com in the URL box 2 Enter the user name 3 Enter the password 4 When you get the Internet Explorer cannot display the web page message Select Page gt Open FTP Site in WIndows Explorer o Enter the user name and password again Note f you don t see the Page menu in IE use the View menu to add it Office and Laptop Tips 157 Production Guide docs netgear com gt To access docs netgear com 1 Install lpSwitch WS_FTP Pro if you do not already have it 2 Get the user name and password from IT or the technical publications manager 3 Go to V Engineering TechnicalPublications Tools WS FTP Pro 9 0 English and double click setup exe to install the software 4 Start IpSwitch 5 Choose the Connection Wizard menu 6 Enter docserver for the site name 7 Type docs netgear com for the server address 8 Enter the user name 9 Enter the password 10 Accept FTP as the connection type Note To FTP to the docs server from outside NETGEAR VPN must be running But sometimes docs netgear com is not accessible and it usually means the log file is full Contact Kent Robinson so he knows he needs to clear out the log file krobinson netgear com gt To access docs netgear com with your browser 1 In Internet Explorer type fip docs netgear com in the URL box 2 Enter the user name 3 Enter the password 4 When you get the Interne
103. c to stay in tables rather than being converted to text Note If there are still tags that show up in the CleanupCatalogReport have someone else look at it to see if the tags can be mapped in RemapConfigFile fm 11 Save and close each file Old Style to New Conversion Tutorial 136 Production Guide Use Additional Tools Use the other tools available on the NetgearUtils menu to finish the conversion process They are straightforward and easy to use For more information see Chapter 8 Custom Tools Reference These commands require that all book files be closed e Variables Tool on page 110 e Cross References Tool on page 104 e Graphics Tool on page 107 e Set PDF Metadata for Book on page 114 Update to Newest Version of Template After a book is converted from the old look to the new templates you can easily update it to newer revisions of the new templates gt To update to a newer template version Step through all the commands on the NetgearUtils menu Note You can skip the Convert Figure Notices Tables to Paragraphs and the Fix Cross References Links commands There is no harm in running them again it s just unnecessary gt To check the big Chap App numbers on first page of each file Delete the extra Big Num that might show up on the front page Manually delete this extra one This chapter describes how to configure vour N300 Wireless Modem Router Internet zonnection When you install your N 300
104. can have multiple schemes for the same subjects For instance different audiences might be interested in a different subset of the taxonomy Note fyou do not organize subjects into a hierarchical taxonomy or otherwise express relationships between subjects you do not have to create a scheme You can still classify content topics without a scheme The following is an example of a subject scheme that identifies Installing and Configuring as Task subjects and Resource utilization and Security as Concerns subjectScheme title Sampletaxonomy id taxonomyScheme subjectdef href task dita navtitle Task gt lt subjectdef href installing dita navtitle Installing gt lt subjectdef href configuring dita navtitle Configuring gt subjectdef href concern dita navtitle Concern gt lt subjectdef href utilization dita navtitle Resource utilization gt subjectdef href security dita navtitle Security Toclassify content Inside the topicref element for a topic or map that refers to the classified content nest a topicsubject element that identifies the subjects of the content The subjectref element identifies a subject with an href or a keyref attribute See Subject classification with DITA and SKOS for more information See also XML Topic Maps XTM 1 0 topicref href websecure dita gt lt topicsubject gt lt subjectref href webserver dita gt lt subjectref h
105. ce page names Old reference page names TOC No equivalent IX No equivalent Reference Reference note lof lot Note Other old reference pages may not be listed here FullManaulTOC fm New reference page names Old reference page names TOC TOC IX Index Reference Reference note lof lot Note Other old reference pages may not be listed here Templates Reference for Manuals 154 Chapter Template fm Production Guide New reference page names Old reference page names TOC No equivalent IX No equivalent Reference Reference note lof lot Note Other old reference pages may not be listed here Appendix Template fm New reference page names Old reference page names TOC No equivalent IX No equivalent Reference Reference note lof lot Note Other old reference pages may not be listed here FullManaullX fm Reference page names are Old reference page names TOC No equivalent IX Index Reference Reference Note Other old reference pages may not be listed here Templates Reference for Manuals 155 Office and Laptop Tips Writer resources This appendix provides departmental information pertaining to staff meetings and accessing the ftp geardog netgear com FTP site and
106. cedures 88 Production Guide With Embed all fonts selected all fonts listed in the left window under Embedding are embedded except fonts listed in Never Embed If a font has been moved from the left list to Never Embed you have to then move it to Always Embed if you want it embedded 4 Select Program Files gt Adobe gt Acrobat 9 0 gt Acrobat Settings and use a text editor to add the following PostScript setting to the Press Quality job options file EmbedAllFonts true Note Ideally you should embed fonts for all job options you use to generate PDFs to prevent font substitution in all PDFs A font can be embedded only if it has a setting provided by the font vendor that permits it to be embedded When a font cannot be embedded because of the font vendor s settings and someone who opens or prints the PDF does not have access to the original font a Multiple Master typeface is temporarily substituted AdobeSerifMM for a missing serif font and AdobeSansMM for a missing sans serif font The Multiple Master typeface can stretch or condense to fit to ensure that line and page breaks in the original document are maintained The substitution cannot always match the shape of the original characters however especially if the characters are unconventional ones such as script typefaces PDF X is an umbrella term for several ISO standards that define a subset of the PDF standard PDF X facilitates graphics exchange and so has a series of p
107. chap_cover Master Page Usage Use Master Page Right Left Q Custom None eov J No Undo 2 Clean up the first Page Remove the extra line above the Chapter or Appendix title Atthe end of the title press return and add a subtitle if needed e Change the first paragraph from p1 body to pO bogy Old Style to New Conversion Tutorial 132 Production Guide Before cleanup Remove extra line After cleanup This chapter desg bes how 0 configure your WNORG3COVZ row ter internet commecton Ahen you instal your wireless router using he Resource CD ss de scribed in te NETGEAR Router Setup Manus these semings are configur ed sutomatics ly for you This capter provides Smszuctions on how 3 log in to She wire ess router for further configuration This chamer Includes Using the Setup Manual Logging in to Your Wreless Routeron page 2 3 Remove extra spaces above and below the notes graphics tips warnings etc These spaces are generated with the Convert Figures Notices Tables to Paragraph command and have to be manually removed Remove extra spaces tags and so on 7 TBeec tie Turn Access Control On deck ba 8 34 fess filtering alone to secure your network Old Style to New Conversion Tutorial 133 Production Guide Modify the anchored frames that were not automatically aligned correctly The command converted most anchored frames to e Below Current Line
108. checks at this time Finalize Documents 72 Production Guide Editing Guidelines This section provides guidelines for which documents to edit and when to have them edited All installation guides for Home and Service Provider SP retail products should receive an edit every time they are updated Other documents can be edited or not depending on whether they have been edited before how much they have changed how long they are schedule constraints and editing priority see Editing Priority on page 73 Also some books might be important to develop as a base for future products These could get more developmental editing usually from peers but our editor should have a look at it as well Take into consideration the time involved to edit a long document that has not changed much since the last edit and the time it will take you to update the document with the edits These are guidelines and you should use your judgment to determine whether or not a document that is not an installation guide needs editing Under no circumstances should the editing cycle cause a release to slip Note In general do not have certification docs edited Editing Priority 1 IGs Home and SP Retail 2 IGs for other products 3 User reference CLI and setup manuals Note GUI text and online help are edited as a high priority on the request of the product engineer Writers if you notice errors in the GUI please inform the engineer If there are
109. ction Guide 3 Navigate to and select the book file you want to add as a child book 4 Click the Add button 5 Double click the child book to open it in a separate Resource Manager panel Note You can click the Browse URL button in the Add File dialog box to select a book residing on a WebDAV server Make a PDF of Parent and Child Books When you save a parent book file as a PDF FrameMaker updates information for only those files that belong to the parent book gt To ensure that the information is correctly represented in the PDF for child books as well do one of the following e First update all child books and then their parent books before saving a book file as a PDF e Open all files including the files in the child books before saving the parent book file as a PDF After creating the PDF ensure that you save all the open files to preserve any updates Disconnected Pages The visual install guide also called a place mat is used for routers It has two pages The first page is an Adobe Illustrator drawing showing how to connect the router and the second page is three columns of text that walk the user through installation The first page of the place mat uses a disconnected page for the Adobe Illustrator art A disconnected page means that page s content does not flow to the next page gt To add a disconnected page 1 Select Special gt Add Disconnected Pages 2 Complete the dialog box Add Disconnected Pages
110. d The Read Out Loud feature reads aloud the text in a PDF including the text in comments and alternate text descriptions for images and writable fields In tagged PDFs content is read in the order in which it appears in the document s logical structure tree In untagged documents the reading order is inferred unless a reading order has been specified in the Reading preferences This is the minimum test a PDF must pass to meet accessibility requirements PDF Procedures 95 Production Guide gt To use the Read Out Loud feature 1 Open your tagged PDF in Acrobat 2 Select View gt Read Out Loud gt Activate Read Out Loud 3 Select View gt Read Out Loud gt Read To End of Document You can leave the document running and come back and check it in a few hours If the reading makes it to the end of the document the PDF has met the minimum requirement for accessibility compliance If the file stops there is probably a font tagging issue See Clean up Font Problems on page 98 for ways to locate and fix the problem You might want to spot check pages for the following things a Listen for figure numbers figure captions if used and alt text if used If these are not read the most likely cause is a problem with the anchored frame It might contain more than one object for example b If you hear headers and footers being read the most likely cause is that the structure is wrong due to a tagging problem Run Full Chec
111. d or write something appropriate Keywords Use the title and or add the appropriate keywords 4 Click Additional Metadata and provide the following information Copyright Status Copyrighted Copyright Notice Put in the year 5 Click Ok to save the additional metadata and click OK again to save properties PDF Procedures 83 Production Guide Other Search Engine Optimization Tips Search Engine Optimization Tips For PDF s by Nick Stamoulis http www searchengineoptimizationjournal con 2008 07 26 optimization tips 2 Many website owners release PDF versions of their content or ebooks in PDF format For many commercial and professional websites articles such as operating instructions are also written in PDF format Your website may benefit if your PDF files are indexed and returned in search results for certain queries However search engine optimization for PDF format files can be slightly different to that of a normal web page say slightly different because the general optimization concepts are still the same it s how you achieve those concepts that can make a big difference The following tips may help to get your PDF indexed by the search engines Format PDF s can be produced in either a text or graphic format Search engines cannot read the content of a graphic file so for SEO benefits publish your PDF in text format META Tags PDF s don t come with meta tag information PDF s do have a specific section where y
112. d set plus any additional variables that are unique to your book Tolist and edit the book variables 1 Select NetgearUtils gt Variables Window Hep O lij imi NetgearUtils Cross References Graphics Variables Set PDF Metadata for Book List of Variable Definitions in Book Edit Variable Definitions in Book Update Current Book to New Templates 2 Select NetgearUtils gt Variables gt List of Variables to get a report of the variables in the original book Rename this file so that it is not overwritten the next time you run the command Old Style to New Conversion Tutorial 127 Production Guide 3 Select NetgearUtils gt Variables gt Edit Variable Definitions in Book You can delete variables that the report shows are not used in the book except the Book Title and Keywords variables The Book Title and Keywords variables are not used in the book but are accessed by the Set PDF Metadata for Book command to populate the metadata dialog box within FrameMaker File gt File Info When you make a PDF from FrameMaker the metadata is then transferred to the PDF to make the PDF more accessible to search engines on the web Edit and modify the remaining variables See Variable Definitions on page 143 for a list of the standard variables Note You can add variables that are not listed in the template but do not delete any of the standard ones Make sure you set the
113. dex htm Finalize Documents 74 Production Guide File Naming Reference manuals and other online documents are provided to the customer in a standard PDF format For print documents except booklets you have to make two PDF files One standard PDF is for online viewing and the second PDF is for the printing company For booklets you have to make three PDF files A separate cover and interior PDF for the printer and a combined PDF cover first followed by the interior for online viewing and for localization For custom layouts new printing instructions must be written and approved See Send PDFs Out for Review on page 99 for additional information about PDF preparations Sample File Names for QIGs Follow these conventions to name the final PDFs e WGXB102 IG 20Mar10 for the standard format PDF e WGXB102 lIGptr 20Mar10 for the press quality PDF that has registration marks Usually translation services handle foreign language versions but occasionally Tech Pubs will format a document and create the PDFs For foreign language versions such as German e WGXB102 IG GR 20Mar10 e WGXB102 IGptr GR 20Mar10 for the print quality PDF For the Zip file archive name use WGXB102 IGsrc GR 20Mar10 zip Sample File Names for Manuals Follow these conventions to name the final PDF WGXB102 RM 20Mar10 for reference manuals WGXB102 UM 20Mar10 for user manuals e WGXB102 SM 20Mar10 for setup manuals e Use
114. e Commands and Book Files Each NetgearUtils tool has a specific function and handles the book files differently depending on which command you are running Some of the tools require that the book files be open and other tools require that the book files be closed Commands that run if the files are open or closed Reports list Move and Collect commands and URL tools It is not necessary to close the documents before executing report move and collect commands because these commands do not change anything in the documents Commands that require all files to be closed Edit and Set PDF Metadata on Book commands When running edit commands or the Set PDF Metadata on Book command the tools require that all files be closed This is because edit commands are programmed to save and close only changes made by the commands If you have open files the edit commands prompt you to close the files before proceeding Commands that open all files in the book Update Current Book to New Templates commands All of these commands open all the files in the book One File Documents If you have a one file document such as an installation guide and you want to use the tools make a book for that file and make the final PDF from the book When you archive the document do not include the book file Note When you run the Set PDF Metadata on Book command the metadata is added to the book With one file documents where the book is not saved with
115. e Agile drop folder and in current projects following the guidelines in Lead Writer s Checklist on page 74 Agile Drop Folder V Operations Document Control AgileDropFolder lt Model Number gt Documentation lt document type gt For example V Operations Document Control AgileDropFolder DGN2200 Documentation UM Current Projects V Current Projects lt Model Number gt Documentation lt document type gt For example V Current Projects DGN2200 Documentation UM Finalize Documents 77 Production Guide Notification All products Except Storage The lead writer for the business unit logs in to Tracklt HelpDesk and creates a ticket To create a help ticket 1 2 3 Open a browser and go to the Tracklt page http trackit netgear com TIWEB8 scripts T WebPortal TrackltUser asp Click Manage your Work Order Requests Click Add a new Work Order Fill in the fields Priority Normal Type Document Control Subtype File Archive Category Select the Agile analyst for the product line Notes Indicate which files are to be picked up and where they are Click Submit Send follow up email to the Agile analyst localization Hsiang Lin and Alice Ko project engineer web master Suresh Venkatesan and the technical publications manager Notification Storage Products Write an email message addressed to the PLM and cc the analyst Also include in the cc list anyone else who needs notification such as loc
116. e Graphics report The top entry shows one image was collected from another directory and moved to the local directory for the FrameTools fm file The bottom entry shows no images were collected for the Reviews fm file Click the filename path to open the file and click image path to go the page in the file where the image is used Custom Tools Reference 109 Production Guide Link to File Link to Image t 1 Departm ental P rodu ction Guides P roduction Guid e Fram eSrc F ram eTools fm X Copied t 1Projects DGN1000 SM Shortened FrmSre Images AddWPSClient 1 jpg to T 1Departm ental ProductionGuides ProductionGuide F rameSre Images Add WPS Client 1 jpg 1 images have been collected T 1Depar tm en tal Prod uctionGuides Prod uctionGuide Fram eSrci Review s fm 0 images have been collected Figure 17 Collect Outside Graphics report Variables Tool The following commands are available under NetgearUtils gt Variables These commands eliminate the need to maintain a separate vardefs fm file for every book These commands help you have consistently defined variables across all files of the book List of Variable Definitions in Book Edit Variable Definitions in Book Custom Tools Reference 110 Production Guide List of Variable Definitions in Book This command generates a three column report for each variable defined in the book following report shows the definitions for the Product Family in line variable
117. efine the topics to build for a particular output e Define online navigation or table of contents for the topics in the map e Define what topics to combine and nest for printing e Define relationships among the topics in the DITA map In the output the relationships become related links for the topics See Topic Linking on page 177 for more information Bookmaps A bookmap is a type of DITA map that provides elements and attributes for creating PDF output in a book style format The format includes book title front matter chapters appendices back matter and book metadata author copyright book number A bookmap is nearly the same as a DITA map So if you need multiple output formats such as HTML PDF and eBook it is better to use a DITA map A DITA map is also lower maintenance for writers compared to a bookmap Note To set up a low maintenance book structure with a DITA map put the necessary book metadata in the topicmeta element Then add standard information such as copyright and year to the output by putting this information in your XSL transform See Metadata on page 181 for more information Topic Linking In DITA linking helps people navigate from one topic to another A well designed linking strategy creates a web of information that is easier to navigate and find information There are the following types of links DITA Reference 177 Production Guide Hierarchical links show the navigation of your informa
118. eliverables that are needed Job Roles Technical publications has the following job roles Lead Writer The lead writer not only writes product documentation but also represents the technical publications department to one or more business units in a leadership capacity This position is usually an employee position but a contractor can assume this role also Permission from HR and the second level manager are needed for the contractor to get access to the internal drives The lead writer also does the following Represents technical publications in cross functional team meetings Is on the email list for cross functional team communications to monitor project changes and answer questions Receives writing assignments from the business unit Requests documentation part numbers from document control Does the writing assignments or asks a writer or contract writer to do them Establishes the review team and initial schedule Notifies the writer of schedule changes as applicable Creates the product page on docs netgear com and posts files http docs netgear com modelnumber enu partnumber Receives the final files from the writer Posts the final files to V Current Projects and V Operations Document Control AgileDropFolder Notifies the Agile analyst that documents are ready for pickup via Tracklt http trackit netgear com TIWEB8 scripts TIWebPortal TrackltUser asp Notifies the Agile analyst localization product en
119. en used on front cover apply the td_document_title paragraph tag Generates the Title meta data file info with the Set PDF Meta data for Book NetgearUtils tool Product Name short Example Stora When used on front cover apply the td_document_title paragraph tag Product Name Product Name amp Model Mandatory field use in Compliance sections Use as required by product Example NETGEAR Stora MS2100 Publish Date February 2012 Front cover amp page 2 of Frontmat fm Release Number Release 1 0 Front cover Frontmat fm Resource CD Resource CD In line as reference to product resource CD SAR Level W kg lt insert value get from engineer gt Mandatory for Wireless Adapter Compliance Check with engineer for numbers SSID NETGEAR Production Guide Used mostly for routers Check with engineer Hardware Software Reference Inst Type of Manual all Guide etc Use on the Front cover apply the Subtitle_Cover paragraph tag Version v1 0 Front cover Frontmat fm Templates Reference for Manuals 144 Production Guide Front Matter Page 1 Hidden text automatically sets Reading Language Option for 508 ADA compliance in a PDF file Uses the Chap_App_ White character tag DO NOT DELETE iCamiog e Bang ees ee UIT pina For doc title ogee soe eee bees E E eee ed use any varia
120. er message URL https mediabin net gear com URL click to go to web site https mediabin netgear com am eSrc FullMan Messages Hypertext marker is untagged or not available https mediabin netgear co message URL ftp geardog net gear com ngreng 4TechPubs B aseD ocs message URL http support net gear com app answers detail a_id ftp geardog netgear com ngreng 4TechPubs B aseDocs http support netgear com app answers detail a_id 2649 2649 message URL http support net gear com app answers detail a_id 984 http supp ort netgear com app answers detail a_id 984 Figure 20 Report on URLs in a book Some of the situations that are reported 1 There is text that has the Jump tag applied to it but there is no marker associated with the text This could be because the Jump tag is applied to text that is not supposed to be an active URL It could also be that the marker was never inserted accidentally deleted or something else The tool reports the situation and you decide what the issue is and correct it For example you can retag the text if it is not an active URL or use the Insert URL command to re create the URL Note n our manuals routerloginl net is bolded because we tell the user to type it into the URL box of their browser If you applied the Jump tag instead of the Bold tag and did not make it a hypertext marker which it should not be the report fl
121. erence topic in WYSIWYG mode partial The XML markup for the sample reference topic partial lt title gt Technical Specifications lt title gt lt shortdesc gt Your router is manufactured to the following specifications This information can help you correctly set up and maintain your router lt shortdesc gt lt refbody gt lt section gt lt title gt Network Protocol and Standards Compatibility lt title gt lt simpletable gt lt sthead gt lt stentry gt Protocols lt stentry gt lt stentry gt Description lt stentry gt lt sthead gt lt strow gt lt stentry gt Data lt stentry gt lt stentry gt TCP IP RIP 1 RIP 2 DHCP PPPoE or PPPoA stentry lt strow gt lt strow gt lt stentry gt Routing lt stentry gt lt stentry gt RFC 1483 Bridged or Routed Ethernet and RFC 1577 Classical IP over ATM lt stentry gt lt strow gt DITA Reference 176 Production Guide lt simpletable gt lt section gt lt refbody gt lt reference gt DITA Maps DITA maps have many of the same common attributes as DITA content but also have attributes to control the way relationships are interpreted for different output Storing output information in the DITA map makes the topics completely reusable across multiple media DITA maps let you do the following e Define an information architecture before after or during topic creation e Provide an authoring interface for new and existing topics e D
122. ermarks like the word Draft 72 pt works well Color Pure red R 255 G 0 B 0 Rotation 45 Opacity One notch above zero on the slider 12 Location Appear on top of page Optional To apply the water mark to a specific range of pages click select Page range options in the upper right corner of the Add Watermark window PDF Procedures 91 Production Guide NETGEAR Editorial Style Guide Technical Publications PDF Procedures 92 Production Guide Tagged PDFs One function of tagged PDFs is to make a document accessible to the visually impaired Visually impaired individuals can surf the Web and read PDFs using screen reading software that offers audio cues to help them navigate The main barrier to accessibility is that PDF documents are not always designed by their authors to be compatible with screen readers Adobe has developed a number of tools and resources to make it easier for authors to create accessible PDF documents these are available at htto www adobe com accessibility Characteristics of a correctly tagged PDF A logical structure and reading order Alternate text descriptions for page elements displayed not as text but visually such as figures and form fields Note We introduce figures in the text right before the figure rather than include alternate text for each figure e Navigational aids such as links bookmarks table of contents and index e Security that do
123. erted Files Note These tools were made for the sole use of NETGEAR employees and contractors The tools cannot be given to anyone else or to any other company 100 Production Guide NetgearTools Folder and Files Appendix A Install Custom Tools explains how to create a NetgearTools folder in the FrameMaker 9 installation folder and add the tools files listed in Table 4 NetgearUtils Files Usage into that folder These tools files are used by the NetgearUtils menu commands to automate conversion tasks When a new release of these tools come out copy the new files into the NetgearTools directory and restart FrameMaker The table below explains the purpose of each file Table 4 NetgearUtils Files Usage File Description report tpl Provides the output formats for the reports generated by the various report commands These reports are saved to the book directory under a reports directory pdfsettings fm Contains the bookmarks and tagged PDF settings that are applied to the current book when the Set PDF Metadata for Book command runs To view the settings open pdfsettings fm in Frame select Format Document PDF Setup and view the settings under Bookmarks and Tags This tool also reads certain book variables and references a pdfcode in the front matter file to set the PDF metadata for improved search and the language option to English for accessibility compliance See Set PDF Metadata for Book on page 114
124. esc gt introduces the topic lt refbody gt contains the body of the topic lt section gt organizes content in a topic into sections lt table gt contains table content lt ul gt displays content as an unordered bulleted list lt dl gt displays a list of terms or short concepts and their definitions lt example gt contains example content that explains or supports the topic lt parml gt displays parameters in a format similar to a definition list lt properties gt lists properties in a table by type value and description lt simpletable gt provides a table that does not require a title lt refsyn gt Contains syntax or signature content such as command line utility calling syntax an API signature or a syntax or high level structure diagram lt properties gt element for tables that describe types values and descriptions for each item DITA Reference 175 Production Guide Technical Specifications Your router is manufactured to the following specifications This information can help you correctly set up and maintain your router Network Protocol and Standards Compatibility pata cI RIP 1 RIP 2 DHCP PPPOE or PPPoA Routing RFC 1483 Bridged or Routed Ethernet and RFC 1577 Classical IP over ATM Power Adapter Description Europe S230 50 Hz input Physical Characteristics 6 80 in x 5 03 in x 1 28 in 172 7 mm x 127 7 mm x 32 5 mm Weight 0 61 Ibs 0 275 kg Figure 31 Sample ref
125. esn t interfere with assistive technology Restrictions that interfere with printing copying extracting commenting or editing text can interfere with a screen reader s ability to convert the on screen text to speech e Fonts that allow characters to be extracted to text If a font s underlying information is sufficient each character can be extracted for the screen reader printing copying pasting or saving to a text file If the information is not sufficient characters and words might be omitted or you might see question marks black rectangles or other marks when you print copy paste or save the PDF to text Section 508 of the Americans with Disabilities Act Firms that do business with the government or potentially work for clients who have government contracts are required to create documents that are accessible to the visually impaired Section 508 is the law that applies The NETGEAR service provider product line does business with third party service providers It is likely all or some of those third parties do business with the government In 1998 Congress amended the Rehabilitation Act to require federal agencies to make their electronic and information technology accessible to people with disabilities Inaccessible technology interferes with an individual s ability to obtain and use information quickly and easily Section 508 was enacted to eliminate barriers in information technology to make available new opportunities fo
126. estination of a cross references in other words where the cross reference points to For example if you insert a cross reference to Figure 3 FrameMaker inserts a cross reference marker in the paragraph for Figure 3 and the marker contains the following text in the old template style The Paragraph Object Unique Id lt The paragraph tag The paragraph text gt Example 34567 fg figure Figure 2 2 In the new template style there is no fg figure instead it is now called fg1 figure and the figure text has changed to Figure 2 The conversion from the old style templates to the new style changes the tag but it does not update the marker text to the new tag and new text After the conversion the marker should have looked like this but it does not 34567 fg1 figure Figure 2 Custom Tools Reference 121 Production Guide The cross reference link still works in FrameMaker because FrameMaker uses only the Paragraph Object Unique Id which stays the same before and after the conversion The cross reference link does not work when you make the PDF because the entire and correct marker text is needed in PDF destinations Cleanup Catalogs The Cleanup Catalogs command uses the RemapConfigFile fm file to delete old paragraph character and table tags from the paragraph character and table catalogs To use this command Select the book and then select Cleanup Catalogs When this command completes a report display
127. f time in the Cleanup stage gt To clean up the book files folder Delete these old files from the book folder Preface fm TOC fm Index fm Vardefs fm Old Style to New Conversion Tutorial 126 Production Guide Finalize the Book File Set in FrameMaker These procedures are performed with files open in FrameMaker The goal is to have a finalized set of book files before starting the conversion gt To finalize the front matter Open both the Frontmat_old fm and new Frontmat fm files 1 Copy paste the cover image from the old to the new file 2 Import the old variable definitions in the vardefs fm file into only the new Frontmat fm file This creates a combination of old and new variable definitions in one file to help you in step 3 Select NetgearUtils gt Variables gt Edit Variable Definitions in Book on page 128 Note Do not import old definitions into the other files 3 Close both of the files gt To finalize the contents index and compliance files Open the book file in FrameMaker 1 Delete the Preface from the book 2 Make sure the book has the following files that you copied into the file folder e FullManualTOC fm FullManuallX fm e Correct compliance appendix for the product Update the Book Variables The templates provide a standard set of variables to be used across all NETGEAR manuals In these procedures you will use the custom variable tools to reduce your book variables to the standar
128. ferent types of information to help you determine whether or not there is an error and what if anything might be done to correct it 1 The left column lists the URL markers Select an entry to open the document and go to the marker If it starts with something other than Message URL there is a problem with the marker Column 3 provides a message to help you determine the fix 2 The middle column shows the URL as it appears in the marker You might spot errors in the URL such as a misspelling Also you can quickly check that all of the URLs in your document work by selecting the links in the middle column Note The tool does not do any link checking to ensure the URL target is live Custom Tools Reference 116 Production Guide 3 The right column provides messages to help you determine what the situation is For example in Figure 20 the left column in the third row says that the Hypertext marker is untagged or not available The middle column shows that the m is missing from com There is no additional information provided in the Message column on the far right Fix the typo and check the tagging If all looks correct rerun the report to see if the error disappears If you still get errors check the URL again or use the Insert URL command to reinsert the URL Opens the Opens the Looks like a document website URL REPORT REPORT FOR T 1 Departmentbl Style Guides Production Guide ualbook MarkerText click to go to mark
129. ghlight the definition you want to change In the Set definition box make the change to the definition you want Click Set Definition All files now show the new definition Repeat Steps 1 4 for every definition you want to change Click Commit Changes into Book All files are updated with the current definition regardless of whether the definition was changed in the session or not oo0P O0NM Todelete a Cross Reference 1 Select NetgearUtils Cross References List of Cross Ref Formats in Book command to identify which formats are not being used and can be deleted Select the cross reference you want to delete in the Name in Book column Click Delete Selected The format moves to the top of the list and is marked with Del If needed select another cross reference and click Delete Selected When you are done review the formats selected for deletion and a lf you want to remove one from the list select it and click Un Delete Selected b When everything looks fine click Commit Changes to Book ms m Note When you select Commit Changes to Book the command deletes the cross references you have specified even if one or more of the cross references is used in the book somewhere A deleted cross reference that is used in the book turns to text which makes it hard to spot and fix The command does not warn you before you delete a cross reference that is used in the book See To identify Cross references Not Used in the Book
130. gineer Web engineer and technical publications manager by email that files are ready for Agile pickup The Landscape 10 Production Guide Writer An employee writer writes product documentation He or she might be assigned to a specific business unit or work across two or more business units Duties are the same as those of a contract writer with the addition of the following Attends cross functional team meetings as needed or as time permits Is on the email list for cross functional team communications to monitor project changes and answer questions Receives writing assignments from the lead writer Either hands off the final files to the lead writer for backup to AgileDropFolder and Current Projects or puts the files there and notifies the lead writer when they are there Upon agreement by the lead writer might notify the Agile analyst localization product engineer web engineer technical publications manager and lead writer that the files are ready for Agile pickup by email Upon agreement by the lead writer might post files to docs netgear com Contract Writer A contract writer writes product documentation He or she might be assigned to one business unit or work across two or more business units Receives writing assignments from the lead writer Determines where illustrations are needed contacts the illustrator and if needed recommends a meeting with the engineer or product line manager plus the writer
131. gnment with the upper portion f If necessary crop the new composite image Document Preparation 47 Production Guide 3 Save the image as a psd in the FmSrc Img ImgeSrc folder 4 Prepare the image and save it as described in To prepare and Combine Screen Captures on page 45 Use WinTV to Get Screen Shots from a TV Display This method is used primarily to get screen shots of EVA or NeoTV menus that are displayed on the TV screen To avoid copyright infringement do not take screen captures of scenes from videos or movies You need a Windows based PC Win TV software the Win TV USB device and the AV cable from the Win TV package To connect the EVA unit you need either a composite video cable or an S PDIF cable The quality will be better with S PDIF but composite generates an image acceptable for a user manual WinTV is not compatible with HDMI which yields the best image quality HDMI screen captures require a card installed inside a computer as opposed to the USB connection that WinTV provides If a higher resolution image is required Michael Ellis has an HDMI set up in the lab and can provide screen shots Setup e Ifyou need media files to populate your screen shots you can use content located on the V drive in Current Projects EVA Media Files Copy the files onto a shared folder on the PC that is on the same network as EVA an Ethernet connection to a router is easiest See the EVA documentation about setting u
132. have the manual ready to post rename it usermanual pdf and put it in the directory Start a Project 32 Document Preparation How to create a printed or web based document This chapter provides procedures and guidelines for preparing FrameMaker printed and online documents The following topics are covered in this chapter Part Numbers and Bar Codes Quick Response QR Codes Print Specs Illustrations Product Photos Screen Shots IP Addresses FrameMaker Process Summary 33 Production Guide Part Numbers and Bar Codes Everything requires a part number but only printed documents have a bar code There is one exception to this and that is certification documents Certification documents get Part TBD until we know the project is going ahead Requesting Part Numbers gt To create a help ticket 1 The lead writer opens a browser and goes to the Tracklt page http trackit netgear com TIWEB8 scripts T WebPortal TrackltUser asp 2 Click Manage your Work Order Requests 3 Click Add a new Work Order 4 Fill in the fields Priority Normal Type Document Control Subtype Part Number Request Category Select the Agile analyst for the product line Notes Indicate which files are to be picked up and where they are 5 Click Submit Part Number Anatomy Part numbers use this format xxx yyyyy zz for example 202 10045 05 Prefix xxx The prefix indicates the type of material or assembly t
133. he inline element to the variable name Set the value of the element to the variable value SP Pp For example the following are the definitions for the productname and modem variables Blue highlighting calls your attention to values you need to reference when you reuse the variables See Reference a Variable on page 180 topic xmlns xsi http www w3 org 2001 XMLSchema instance id topic 1 xsi noNamespaceSchemaLocation urn oasis names tc dita xsd topic xsd 1 1 gt lt title gt Variables lt title gt lt body gt DITA Reference 179 Production Guide p varname idz productname 2N150 Wireless ADSL2 Modem Router DGN1000 lt varname gt lt p gt lt p gt lt varname id modem gt modem router lt varname gt lt p gt lt body gt lt topic gt The phrase lt ph gt element is used to organize content for reuse or conditional processing for example when part of a paragraph applies to a particular audience It can be used by specializations of DITA to create semantic markup for content at the phrase level which then allows but does not require specific processing or formatting The lt filepath gt element indicates the name and optionally the location of a referenced file by specifying the directory containing the file and other directories that may precede it in the system hierarchy This element is part of the DITA software domain a special set of DITA elements designed to document software tasks concepts
134. heck test shows no elements outside the structure tree see Error Messages and Fixes on page 97 the reflowed document PDF Procedures 96 Production Guide should be in good shape You do not need to perform this test to meet minimum accessibility requirements To reflow a document 1 2 3 Open your tagged PDF in Acrobat Select View gt Zoom gt Reflow Resize the PDF and watch the text flow Spot check that all page elements are within the flow by looking for any odd presentations that seem incorrect Note that you do not see graphics in reflow mode To fix problems run the Full Check test and correct the errors that come up Pay particular attention to structural errors Error Messages and Fixes These are common error messages generated by the Acrobat Full Check It s best to fix these in the Frame source if possible Some fix suggestions are provided here None of the images on this page that need alternate text have it This one means the figure has no alternate text You can add the alternate text in Frame or in the PDF For now we are not adding alternate text to figures so you will routinely see these errors when you run the Full Check unless you clear the Alternative descriptions are provided check box before running the Full Check See Add Alternate Text to Figures on page 98 for easy instructions for adding alternate text All of the text on this page lacks a language specification The PDF needs it
135. hoices gt and lt choice gt displays choices in a bulleted list instead of ordered steps lt choices gt and lt choice gt display choices in a bulleted list instead of ordered steps lt choicetable gt displays choices in a two column table where you describe steps for each choice Use the lt choicetable gt element for two part items such as the name of an operating system and a corresponding file name or a bicycle model and its frame size lt postreq gt provides information about tasks that has to be done after the current task is done lt example gt provides an example that illustrates or supports the task lt result gt provides the expected outcome when the task is done lt example gt shows examples of what the procedure might accomplish Log In to the N150 Modem Router Log in to the wireless modem router to view or change settings or to set up the wireless modem router hos http 192 168 0 1 in the address field of your browser and press Enter to display the login window You can also enter either of these addresses to access the wireless modem router http Www routerlogin net or http WwWw routerlogin com izhttp Jj182 168 0 1 User name admin Password 9 eee 2 When prompted enter admin for the router user name and password for the router password both in lowercase letters Note The router user name and password are probably different from the user name and password for logging in to your Interne
136. ick install guides are printed documents For review PDFs make a standard quality PDF that is the finished trim size of 17 x 7 25 without registration marks For final PDFs you have to make two PDF files and include the print spec with the file set The print spec is located in same folder as the template within the 4TechPubs folder on the FTP site Make a standard quality PDF with a finished size of 17 x 7 25 without registration marks Create a press quality PDF that is oversize by one inch 18 5 x 8 5 with Western registration marks PDF Procedures 86 Production Guide Prepare for Color or BW Printing Preflight Adobe Acrobat Professional has the Preflight command so you can verify that your PDF contains only the features fonts and formatting that you ve specified When you use this command Acrobat inspects and corrects the document s contents whenever possible and issues errors and warnings for conditions that can be addressed only by the author Note Run Preflight on all documents that will be professionally printed and placed inside the box Toanalyze a PDF for color printing 1 Open the press quality PDF with the Western registration marks 2 Select Advanced gt Print Production gt Preflight 3 Select Digital Printing color to optimize the current PDF document for digital printing in color Acrobat converts all colors including spot colors to CMYK The wrench icon indicates that this option includes f
137. ide file naming 75 final doc review 63 first doc review 63 fonts 50 clean up 98 Preflight error 88 FrameMaker blank pages 52 disconnected pages 53 fonts 50 links 54 metadata 83 PDF generation 94 Save as PDF command 85 screen shots 46 templates 50 vardefs file 51 warnings turning off 54 frontmat 145 full accessibility check 96 G geardog 4Backup 77 FTP site 77 geardog accessing 157 general styles 143 giftbox 20 graphics 29 57 graphics tools 107 H hardware installation guide 17 Hierarchical links DITA 178 Home business unit 19 illustrations 39 illustrator role 12 importing screen captures 46 incorporating review comments 65 index tags 151 install guide PDFs 86 place mat 17 print spec 37 install guides 103 editing 73 file naming 75 L language options setting on PDF 94 laptop memory clearing 159 large PDFs sending for review 99 lead writer checklist 74 part numbers 34 lead writer role 10 legal team 15 linking to external PDFs 90 links 54 links to Internet resources 54 localition DITA 166 localization about 21 calculating doc due dates 24 localization team 14 localization and DITA 166 manager role 13 marketing collateral 20 marketing team 13 master pages 152 meetings desktop sharing for 157 memory laptop clearing 159 menu tools 102 metadata DITA 181 metadata inheritance DITA 184 metadata PDFs 83 model numbers 20 N naming files 75 NetgearTo
138. ied to all topics inside the DITA map Parent topicref element This metadata is applied to all child topics nested under the parent Topic metadata child topicref element or prolog element This metadata is applied to only that topic DITA Reference 184 Production Guide Taxonomy A taxonomy is a hierarchical structure that organizes subjects and controls the vocabulary that can be used to describe those subjects Taxonomies let organizations create and centrally manage important terms that can be applied to topics and maps as metadata When metadata and taxonomy information are applied to topics and maps search applications can access the metadata to retrieve content Search engines can also use the taxonomy to organize search results in meaningful ways and to suggest related searches A taxonomy is a DITA map specialization Specialization is the process by which new designs are created based off of existing designs Specialization allows new kinds of content to be processed with existing processing rules See DITA Specialization for more information The taxonomy is created in a specialized DITA map by adding topicref elements to the map in a hierarchy Each topicref element points to a topic that describes the subject of that node of the taxonomy The description declares the content s subject matter in a way that a semantic processor can understand Simple Knowledge Organization System SKOS is a standard for describing
139. igital printing or RGB brighter colors for online viewing It is easy to change the color mode in Al Acrobat Pro also has features to handle color modes in case your Al file is in the wrong mode and you cannot or do not want to change the mode in Illustrator The PDF Setup dialog box that displays when you select Save as PDF has a Convert CMYK Colors to RGB check box at the bottom that should always be selected See 7o use the Save as PDF Command on page 85 The Preflight command covered in Prepare for Color or BW Printing Preflight on page 87 converts RGB colors to CMYK for PDFs that go to the printer for digital printing Document Preparation 39 Production Guide As long as you 1 have the Convert CMYK Colors to RGB check box checked for the online version and 2 remember to run the Preflight command on the printed version it does not matter which color mode the ai file uses However for documents that will be printed CMYK color mode is preferred Also the color specifications used should follow the CMYK color specifications in the NETGEAR Branding Guidelines Note Writers using a 64 bit laptop might have to leave the Convert CMYK Colors to RGB check box deselected There is a FrameMaker bug that prevents the PDF from generating when this check box is selected on some 64 bit laptops gt To set or change the color mode in Adobe Illustrator 1 Select File gt Document Color Mode 2 Select either CMYK or RGB
140. image Options Use with the non uniform option to set the stroke on an object proportional when you size it up or size it down f Select the Scale tool The dialog box displays but you can size the image up or down by dragging the image from corner Product Photos User manuals and reference manuals include a product photo on the front cover Product photos are located on Mediabin https mediabin netgear com and on the V drive If they are very recent they can sometimes also be found at ftp geardog netgear com If you cannot get the product photo you need but you have the unit you can have an illustrator take photos and make an illustration from the photo Sometimes you need a product illustration early for a Beta document before there are any units to photograph and before any photos are available on Mediabin or geardog In that case look for early artwork that will be used to make the units in either of the following two places This artwork can be used to figure out where the ports and cables ultimately go when the unit is made Label artwork indicates the location of DSL and Ethernet ports for example V Current Projects DGND3700 DGND3700 V1H1 ENCLOSURE ARTWORK VAMarketing Product Files lt product model gt Document Preparation 44 Production Guide Screen Shots Always create screen shot images used in any Frame project by first getting the image do a screen capture take a digital photo
141. iness environment Wireless routers managed switches and fire walls are examples Users in this group are technically knowledgable Home Product SBPU Group This group has several types of products It is important to know which kind of product your document is for Platform Products These are developed as demonstration models Typically engineering needs only a rough draft of the user manual for certification The user manual should show the right hardware and include the right feature set but the GUI does not have to be documented precisely because it might change Sometimes they also need a QIG Often these documents do not have part numbers and their schedules are different from those for other NETGEAR products Files are delivered into 4Backup on the FTP site Sometimes months later the demo model becomes an actual product Then these files can be used as a base for the documentation Carrier Products These products are sold through carriers such as Comcast or Times Warner They do not sell retail with a gift box There might or might not be an IG depending on how the carrier handles installation There is a user manual which might be customized and used only by the engineering group of the carrier Sometimes they have special security needs For example there was a gateway that a post office group bought in which each modem router had a unique security key based on its MAC address Many have a super user login in addition to the
142. inks are usually displayed at the end of the topic although some Web based help systems might display them in a separate navigation frame DITA Reference 170 Production Guide Task Elements Task topics answer How do I questions and have a well defined structure that describes how to complete a procedure to accomplish a specific goal Use the task topic to describe the steps of a particular task or to provide an overview of a higher level task The task topic includes sections for describing the context prerequisites actual steps expected results example and expected next steps for a task lt title gt provides the topic or section title lt shortdesc gt introduces the task lt steps gt lt step gt lt cmd gt contain ordered steps for a task lt steps unordered gt contains unordered steps for the entire procedure lt context gt Provides background information that users need to understand to do the task lt substeps lt substep gt lt cmd gt contain the substeps for a step One level of nesting only lt info gt provides additional information that users might need when they complete a step lt stepresult gt provides what happens when a step is completed Use the lt stepresult gt Note For software documentation you do not need to add The XY window displays because users can see what windows open when they do the step lt stepxmp gt provides an example of what happens when a step is completed lt c
143. irectory structure FmSrc Image ImgSrc If the document is going to the printer add the printer ptr PDF and print spec to the Zip file Rename the Zip file based on the archive file naming guidelines Keep a copy of the regular PDF outside the zip file Submit the Zip file and regular PDF for archiving Note For the SMB business unit the printer ptr PDF is kept outside the zip file and the regular PDF is put inside the zip file Finalize Documents 76 Production Guide Final Hand Off from Offsite Writers gt To hand off the file archive and final PDF 1 The offsite writer delivers the file archive and final PDF to the lead writer or the technical publications manager using the geardog FTP site in the 4AgileRelease folder for final documents or 4Backup for WIP documents 2 The offsite writer notifies the lead writer or the Tech Pubs Manager that the files are ready and tells where they are 3 The lead writer or the technical publications manager places the file archive on the NETGEAR V drive and notifies the applicable stakeholders as described in Agile Pickup on page 77 Completed Projects That Do Not Go into Agile Sometimes a platform is developed before there are customers or a project goes on hold In this case the documentation is not released into Agile It would be stored in 4Backup on geardog and or in Current Projects on the V drive instead Agile Pickup The lead writer places the Zip and PDF files in th
144. ix up 4 Click Analyze and fix Save the file if prompted Note Run this command a second time if you get the Unable to save file after post processing error 5 Results appear in the Preflight dialog box Errors that Preflight was unable to fix are flagged with a red 3 Cautions are flagged by a black exclamation point within a yellow triangle gt To analyze a PDF for black and white printing 1 Open the press quality PDF with the Western registration marks 2 Select Advanced gt Print Production gt Preflight 3 Select Digital Printing B W to optimize the current PDF document for digital printing in black and white Acrobat converts all colors including spot colors to black and white The wrench icon indicates that this option includes fix up 4 Click Analyze and fix Save the file if prompted Note Run this command a second time if you get the Unable to save file after post processing error PDF Procedures 87 Production Guide 5 Results appear in the Preflight dialog box Errors that Preflight was unable to fix are flagged with a red Cautions are flagged by a black exclamation point within a yellow triangle Font Error Font not embedded Fonts should always be embedded for prepress files Fonts must be embedded for PDF X 1 and PDF X 3 files This means the listed fonts are not embedded in the PDF file Embedding prevents font substitution when readers view or print the file and ensures
145. k Use Full Check to check a PDF for many of the characteristics of accessible PDFs While this is not required to meet minimum accessibility requirements it is a good idea to run this test and fix as many errors as possible to make your PDF more accessible to different types of accessibility equipment gt Torun a full accessibility check 1 Open your tagged PDF in Acrobat 2 Select Advanced gt Accessibility gt Full Check 3 Clear the Alternative descriptions are provided All form fields have descriptions and Tab order is consistent with the structure order check boxes We are not including alternate text on figures at this time and the other two options pertain to PDF forms and are not relevant to our documents 4 Accept the rest of the defaults If you want problem areas flagged with comments within the document select the Create comments in document check box which is cleared by default 5 Click Start Checking A report appears in the left column of reader with instructions on how to fix problems on the PDF It s best to fix the problems in the Frame source if possible Reflow Document You can reflow a PDF to temporarily present it as a single column that is the width of the document pane This reflow view can make the document easier to read on a mobile device or magnified on a standard monitor without the need to scroll horizontally to read the text If your PDF reads out loud all the way through and the Full C
146. k e e Raa one RR dade CRY He 24 Beta Do6ufnienls iiu sias ce aces kao boh RO ee m CREE CE ig 25 Documents n Agile seed ep Reges beoe Ve e RERO A d 25 Document PIORSESIOD A secus x3 eked e ieee ke ee aos 28 Production Guide Compliance Informallotis i4 2502810 2444 eede ada pais suededvs 30 User Manuals sco c dene ened ake eared GRACE ROSE SAAS RE OR UR 30 Stason GUIS 15 uaa acc dot on dese erro x X EORR baba ca Res as 30 WEEE Nome and LOU Li ues DERE RUE nena RR rb oe dirai i tede 21 Other Features Section lille 31 Manuals on Docs Server 0 0 0 cc ee 31 Chapter 4 Document Preparation Part Numbers and Bar Codes 0 000 ccc eee eee een eee 34 Requesting Part N mbeor amp isse seem gm mE eae 34 Pan Number PRONE Gauss d bod ra edic a De ahaa Sag b 34 When a Document Changes xxieecsnese crx ERR ERR dO wea 85 Document Bar COUBSEL cappa nei bss X e X OE o KOC 3 35 Bar Gode GIZSS cse uas X ALAWRGG REA QA AREA PEAK LO RARS RRA Ka x 36 Add a Bar Code Directly to the PDF 020 00 cereus 36 Quick Response QR Codes 0 0 0 0 0c cee a a7 PUNE SRE d i bbe ea QST CER VPE teat se E V EC ER CES 37 V OY 1 14 iter de po ade SE LA ah a cid otha 38 Printer Contact Information lisse s s xod xe e ek RR Rx Re ae 38 EP P sg tack dca andere oA are a dh T LO DL TET 39 Adobe Illustrator Files 00000 cece eee 39 Al Produc on FNS cect dde Ree ean A de t ea d Ro Ana ras ele aR a 39
147. k oriented approach to producing content DITA effectively takes task oriented and task based writing a step further by organizing information into modular topics that can be reused In DITA there are three types of topics task concept and reference Each topic covers one subject and a DITA map organizes a set of topics into an information flow for publication in different formats such as PDF or HTML files There is also a generic topic for content that has no type Writers tag and store individual topics in a component content management system CCMS Anyone with access to the CCMS can retrieve and use the topics Anyone with a DITA authoring environment can create topics and DITA maps DITA authoring is about editing XML text files that conform to the DITA Document Type Definition DTD The DITA DTD declares precisely which elements and references can appear where in the document of the particular type topic task reference or concept and what the element contents and attributes are The OASIS DITA document types are implemented with a set of DTD modules Some of these modules are used by every DITA document type others are only used by topics or by maps and some are only used in specific specializations For more information see DTD Organization Printed Documents DITA is independent of style and layout and therefore does not currently work well for printed documents NETGEAR technical publications prints installation guides and
148. kaging team coordinates the design and creation of our product packaging They can provide NETGEAR and competitor box samples Sometimes we ask to see the NETGEAR packaging for a particular product when we are designing a smaller printed document to go inside This can help us determine whether or not the document will fit inside the box as intended Legal The legal team advises us on copyright and trademarking questions and provides the applicable text as needed The Landscape 15 Document Sets Documents vary across business units Technical publications delivers documentation sets appropriate for the business unit and geared to the product line This means there are many different types of documents and even the same type of document as it is used across product lines can have different information or additional sections This chapter provides a high level explanation of the document types as they pertain to the business units Localization is also covered The following topics are covered in this chapter e Document Types Home and Business Products e Home Product SBPU Group Product Names Model Numbers and Versions e Localized Documents 16 Production Guide Document Types The most common documents are Quick install guide QIG or place mat A product can have either a QIG or a place mat A place mat is used for routers and gateway products and shows detailed package and cabling information on the first page
149. lTOC fm New master page names Old master page names TOC First chap cover Left Left Right Right Title Page LOGO Blank Note Other old master pages may not be listed here Templates Reference for Manuals 152 Chapter Template fm Production Guide New master page names Old master page names chap_cover chap_cover Left Left Right Right Title Page LOGO Blank Note Other old master pages may not be listed here Appendix Template fm New master page names Old master page names chap_cover chap_cover Left Left Right Right Title Page LOGO Blank Note Other old master pages may not be listed here FullManaullX fm New master page names Old master page names Index_ First Left Right Note Other old master pages may not be listed here Templates Reference for Manuals 153 Production Guide Reference Pages Each template contains only three 3 reference pages They are the same three pages for all templates All other reference pages should be deleted from the files The reference page also shows the template revision date Note Not all OLD reference pages may be listed in the table When converting files from the old format please DELETE all reference pages except for the 3 used in the new templates Frontmat fm New referen
150. lution Set to at least 300 dpi Options Keep defaults Click OK paoo8 Note For all graphic formats set the resolution to at least 300 dpi The graphic is now ready to use in documents Document Preparation 42 gt gt Production Guide Save to an Older Version of Illustrator To save to an older version of illustrator 1 Open the illustrator file and select File gt Save As Cancel a Subset Illustrator C53 is less Illustrator CS2 Illustrator CS Illustrator 9 INC Ilustrator 8 Eem Illustrator 3 Japanese Illustrator 3 Use Compression Transparency Pre Pre Warnings 49 The Document Raster Effects resolution is 72 ppi or less 4 Only fonts with appropriate permission bits will be embedded 2 From the Illustrator Options screen select the version from the drop down list 3 Set the other parameters as needed 4 Click Ok Scale Illustrations To scale illustrations 1 Open an Illustrator file Son Scale 100 Non Uniform Horizontal 100 i Preview Vertical 100 m Options Scale Strokes amp Effects Objects Patterns 2 Select the entire image that you want to scale 3 You can do either of the following Select Object Transform Scale Uniform Use this option to proportionally scale the image Document Preparation 43 Production Guide Non Uniform Use this option to individually change the width and height of the
151. mages unused directory This includes graphics that are copied into the book If you do not want these images moved put them in a subdirectory called Embeddedlmages When this command completes a dialog box displays to tell you how many unused graphics it found and where they are FrameMaker 1 NetgearUtils There are 16 unused graphics that have been moved successfully JJ There are 0 unused graphics that have not been moved because of errors Figure 15 Number of unused graphics moved Note Embedded template images are in the Images and Icons directories of the template There is no need to do anything with embedded template images The Move Unused Graphics command also generates the Move Unused Graphics report to tell you which graphics were moved from the images directory The entries in the report are links to the image Custom Tools Reference 108 Production Guide Move Unused Graphics Report For T 1Departm ental Production Guides Produ ction Guide FrameSrc FullManual book Images Directory T 1Departm en tal Prod uctionGuides ProductionGuide Fram eSrc Images Unused Directory T 1Departm ental P roductionGuides P roduction Guide Fram eSrc Images_unused Moved T 1Departmental ProductionGuides ProductionGuide Fram eSrc Images A ddDiscon nectedPage eps Code 0 Moved T 1Departmental ProductionGuides ProductionGuide Fram eSrc Images cross refsfor matsreport jpg Code 0 Moved T 1Departmental ProductionG
152. mats If you get an error that the command cannot open Unknown Template fm make sure the first paragraph has the correct tag so the command can identify it and use the correct template 1 Look at the first paragraph in the main flow 2 If the tag is a ta_appendix_title the command uses the Appendix Template fm template tc_chapter_title the command uses the Chapter Template fm template ti_index_title the command uses the Appendix Template fm template td_document_title the command uses the Frontmat fm template Otherwise the document is of unknown type and the command uses the Unknown template fm This file does not exist and is therefore an error papp Convert Figures Notices Tables to Paragraphs This command converts images figures notes warnings and cautions out of the table formatting used in the old templates and applies the new tags Anchored frames that house the images and the figure caption may need to be adjusted to align with the paragraph To use this command Select the book and then select Convert Figures Notices Tables to Paragraphs If a dialog box with the message Select Text to Convert displays it means the document has conditional text that will not be converted The warning is coming from FrameMaker and not the tool itself In these cases wait for the command to finish and manually unhide the conditional text and run the command again assuming you want the hidden text converted Custom Tools Refe
153. mbol without the notice please add the notice The new template has the symbol and text which are reproduced below so you know what you are looking for Equipment the WEEE Directive If disposed of within the European Union this product should be treated and recycled in This symbol was placed in accordance with the European Union Directive 2002 96 on the Waste Electrical and Electronic accordance with the laws of your jurisdiction implementing the WEEE Directive a Figure 5 WEEE symbol and text Other Features Section For routers and DG products using the CD less installation the installation guide needs an Other Features section at the end The reason is we learned from user studies and Beta feedback that users want to have quick pointers on where to find information about how to use these features The text should read For features like Live Parental Controls Traffic Metering ReadyShare and Guest Access please log in to http www routerlogin net for more details Manuals on Docs Server Many products have a link to the user or reference manual from their user interface or on the CD Currently this link is to the http docs netgear com server gt The writer creates the link as follows 1 Start VPN if you are working offsite VPN is not necessary if you are working onsite and using an employee NETGEAR laptop 2 Access the docs server with the user name and password supplied by the technical publications manager
154. me or directly on the PDF It is better to add it in Frame so that it is applied to the PDF every time you generate the PDF from Frame However if you have a PDF and no Frame or other source files you have to add the metadata to the PDF Set Metadata within Frame The best place to get metadata into your PDF is in the Frame file at the book level This way every time you generate the PDF the metadata ports to the PDF Read about it here http help adobe com en_US FrameMaker 9 0 Using WSA CD8CFOD 726F 4bfd 8839 20E5 8074D5B1 html To add metadata within Frame use the Set PDF Metadata for Book command described in Set PDF Metadata for Book on page 114 Add Metadata to the PDF While it is better to add metadata to the source files if you are in a situation where you have a PDF going on the Web and no source files you can add the metadata to the PDF itself using Acrobat Professional gt To add metadata to the PDF 1 Open the PDF in Acrobat Professional Windows only You can also enter and read the data properties information from the desktop Right click the document in Windows Explorer select Properties and click the PDF tab Any information you type or edit in this dialog box also appears in the Document Properties description when you open the file 2 Select File gt Properties 3 On the Description tab provide the following information Title As it appears on the front cover Author NETGEAR Subject Use the title an
155. nation artifacts including all content that comes from master pages such as page numbers and running headers and any graphic objects outside anchored frames Layout and typographic artifacts such as colored bars between columns of text horizontal lines separating footnotes from text and table borders e Printing artifacts such as crop marks registration marks and page information printed outside the crop marks Generate a Tagged PDF Generating a tagged PDF from FrameMaker involves specifying bookmarks the default book structure and setting the language Acrobat Professional provides accessibility checks to verify that the tagged PDF has no errors The checks and errors are described in Test a Tagged PDF on page 95 Specify PDF Settings The PDF settings are for bookmarks and the default book structure The easiest way to set these is to run the Set PDF Metadata for Book command described in Set PDF Metadata for Book on page 114 This command also sets the book metadata for search optimization Set the Language You can set the language in FrameMaker or directly on the PDF Within FrameMaker This is done once per book You place a text box with a pdfmark a PostScript extension on the first page of the first chapter in a FrameMaker book file PDF Procedures 94 Production Guide The new templates have this text box in place on the first page of the frontmatter fm file The pdfmark is white so the text does not show
156. nclude an accurate print spec 3 Use Al files for all illustrations 4 Runthe PDF through preflight using the correct B amp W or Color settings depending on the file Editing Get all of your documents edited Editing saves money and ensures a better user experience 1 Priority IGs and other printed documents have the highest priority with editing 2 Cost savings Get it right the first time rather than fix a typo roll the dash and resubmit to Agile Printed docs that are localized do not have to be retranslated when they are done right the first time Localization All of these policies help keep localization costs lower 1 Art Import Al files directly into FrameMaker for illustrations 2 Callouts Do not embed text in illustrations It s more expensive to translate text that is embedded in illustrations 3 Terms Use consistent terminology throughout a document as much as possible For example all of these mean the same thing but require extra translation time and increase costs if they are used interchangeably throughout a doc a Type routerlogin net b Enter routerlogin net c Browse to routerlogin net Overall doc quality When someone wants you to add or change text you do not have to do it exactly as they tell you to As a writer and a lead you own the final words and the final presentation Your docs go directly to a lot of non technical consumers You are their advocate for docs usability Don t let the doc
157. nging features and adjust the content accordingly Sometimes content is pulled from different books and combined to get the feature set needed In particular check and update the following as needed a Does the product include automatic firmware updates or not b Are there variations on superuser MSO admin access guest networks multiple SSID capability WDS vs no WDS c Does WDS reside on the same screen as advanced WPS settings d Check the Firewall rules Block Sites and Services screens e Look for miscellaneous variations in LED behavior Sometimes there are requests from the engineers for changes in the compliance content that need to be run by the NETGEAR compliance engineer Beta Documents The project engineer might need only a partial document set for Beta This could be a completed installation guide only or include a partially completed user manual Beta documents typically have a note on the cover to indicate that these are Beta documents Documents in Agile Agile is the database where items associated with a project are stored when the project releases The items include the bill of materials BOM product label CD label engineering Start a Project 25 Production Guide documents engineering change orders ECOs product documentation for all required languages and more Sometimes lead writers need to locate documents in Agile to verify something or to get a copy to use as the basis for a new d
158. nly way to get them is to execute this file Stop the Font Substitution If FrameMaker is substituting a font and you want it to remember the substituted font there is a way to do that For example if FrameMaker is substituting Times New Roman for Times Roman you probably want it to just use Times New Roman all the time gt To stop font substitutions 1 Open the file that gives you the Unavailable Fonts message Make sure you want FrameMaker to use the substituted font Select File gt Preference gt General Clear the Remember Missing Fonts check box Click Set moa Document Preparation 50 Production Guide Save the file and open it again This time FrameMaker does the substitution without remembering the old font Save the file again and you are all set Go back and select the Remember Missing Fonts check box This is so that if another font goes missing that you need and FrameMaker does a substitution the substituted font is not remembered Vardefs File Historically technical publications has used a vardefs fm file for managing document variables It is a Frame file with a two row table Left column lists the names of all the document variables for the book and the right column lists their definitions To update the book using a vardefs file instead of the preferred Edit Variable Definitions in Book command To update variables with a vardefs file 1 2 3 Open the vardefs file Edit the definitio
159. ns as needed To add a variable make a new row in the table and add the name and definition and select Special gt Variables to add it to the Variables tool also To delete a variable delete the row in the table and select Special gt Variables to delete it from the Variables tool also Update the book variables by doing the following a Select the book Select Edit gt Select gt All Select File gt Import gt Formats In the drop down list select vardefs fm Deselect everything except Variable Definitions in the Import and Update box Click Import 92095 Frame takes the variable definitions in vardefs fm and applies them to the book Note With the Edit Variable Definitions in Book command it is no longer necessary to use a vardefs file However writers are welcome to continue using it if they prefer The procedure descriptions in this guide other than in this immediate section provide instructions for using the tools and not the vardefs fm file Document Preparation 51 Production Guide Set Up a FrameMaker Book without Blank Pages gt To eliminate blank pages 1 2 3 4 5 6 Open the book in FrameMaker You might need to change the settings for each file in the book Right click the file and select Pagination Pagination Pagination O Single Sided 1st Page Side Next Available v Before Saving amp Ping Delete Empty Pages v No Undo In the 1st Page Side field select
160. nversion commands to accomplish the following steps Update to new templates e Convert notice tables to paragraphs Remap tags from old look to new tags e Fix cross reference links so they are active in the PDF e Cleanup catalogs so you only have the new set of tags Set up numbering generated files and update book gt Torun the conversion tools 1 Select the Import Formats from Latest Templates into Current Book command to read the templates stored in the NetgearTools gt Templates folder and applies them to the files in the book 2 Select Convert Figures Notices Tables to Paragraphs to convert tables formerly used for graphics notes warnings cautions and the like to text Ignore book errors at this point The older style used tables to format figures and notices This command only needs to be run when a book is first converted from the old look to the new templates Old Style to New Conversion Tutorial 129 Production Guide e Although this command removes the table formatting and applies the new tags some cleanup needs to be done as explained in Clean up the Files on page 131 3 Select Remap Old Tags to New Tags to read the RemapConfigFile that resides in the NetgearTools folder 4 Select Fix Cross Reference Links so that all cross references work when you generate the PDF See Fix Cross Reference Links on page 121 for more information This command only needs to be run when a book is first converted from
161. o FrameMaker 002200 eee eee 55 Change Bale zuceseersk ci eresesFuuwbbeseiudpereXTRcku d aga dde 55 Production Guide Arnehored FPESITIBBL S odor xopPILAVRQGG aed eed a Cease PARR ERASE TS 56 EII a PEER AAL ENE acd Coban qq URGE Rd RUP RO ns deus 57 e lp P ETECEETOE 57 Lines Arrows Colo sua oe kg eee eae aoe RON E ACER CR e a 58 Numbering ISSUES us scs e tre m kot Ire exeo k ede e eate ce 58 Spelling Grammar and Style Checks 00000 e eee eae 59 FrameMaker to Word through PDF Lllluellsususe 5g Readability Check Caveats 0 ccc eens 59 IOSBES SUMMONS 1d esu qqae dq patei ad d qd req edem ed 60 Lite eee Ce Cee beu ee ee v qi XX C d d adc qp ded au dae dio 60 LIOmIDHSHOB sias udidpdes qa Xd Che ganna id dde dpud ua 60 mi PETRITT TIE OT 0 12 REY ARG LORE PRR TTE 61 caer AIL E E e T ET T LET ETN 61 Loos HO uei d e x 4d de sud Xu d e UH Cp d raaa 61 CAA CORI adie Sia i as dia eens 40d dedita ita api dicat E ied 61 Chapter 5 Document Reviews MOVIE GIES Leurs a UE dr RA ER Eo E E eR d Robb ee Ses Aas 63 Review Sohbedule isses eer Re s mp Ru s x Rp e m de 63 Fast Track Review Schedule for Wireless Adapters 64 BsF MEER D ERIT 64 Reviewer PIBSPOUNSE 1a ago dod ec p RIDERE E E oder de dedo ded d das 65 Comment ACGEDIANCE iioecossemes eem nq v cera Rx e wea 65 Document ApDIOVI sao cesa eq C RERO eC REY pEG du CREE OES 65 Chapter 6 Finalize Documents
162. ocument set If you know the part number for a document you can put it into the search engine and the document comes up ORACLE agile 4 gt Rd ing 202 10434 01 Eo Figure 1 Search on part number However if you want to see a list of documents and other items you can search on the product model number with a wild card and select Items like this z O E a E o Figure 2 Search on model number Scroll down to find the documents which will be listed like this 104 10351 01 GFASY DGN1000 V1H1 ACT 107 10145 01 SASY ENCL DGN1000TBEGE BSL 201 11934 01 INSTGD DGN1000EN V1H1 201 11935 01 INSTGD DGN1000IT V1H1 201 11936 01 INSTGD DGN1000FR V1H1 201 11937 01 INSTGD DGN1000BGR V1H1 201 12325 01 INSTGD DGN1000TBEGE V1H1 201 12514 01 INSTGD DGN1000RU V1H1 201 12565 01 INSTGD DGN1000EP V1H1 201 12566 0 INSTGD DGN1000SP V1H1 202 10523 01 GD REF MNL DGN1000 V1 0 202 10523 02 GD REF MNL DGN1000 V1 0 203 10718 01 SHT CHINA ROHS DGN1000 V1H1 203 10723 01 SHT README FW UPGRADE DGN1000 204 10185 01 CE DOC DGN1000 V1H1 208 10462 01 SETUPMNL DGN1000NA V1H1 208 10462 02 SETUPMNL DGN1000NA V1 0 208 10462 03 SETUPMNL DGN1000NA V1 0 208 10498 01 SETUPMNL DGN1000GR V1 0 Figure 3 List of items If you want to find artwork AW you can search on AW to bring up all the artwork in Agile You will have to browse the list to find what you are looking for Note If you want the artwork for a particular product such a
163. oft Windows Windows NT and Vista are registered trademarks of Microsoft Corporation Other brand and product names are registered trademarks or trademarks of their respective holders Statement of Conditions To improve internal design operational function and or reliability NETGEAR reserves the right to make changes tothe products described in this document without notice NETGEAR does not assume any liability that may occur due to the use or application of the product s or circuit layout s described herein Revision History vedsauuseousessaauvaussauawurasusEPesssuswesdessausssnUva E EsessasepuuMuewauESad M nMUMaVE Na RaE EUR UMS i Publication Part Number Version Publish Date i Part Number TBD June 2010 Uses the variables History Table Paragraph tags Document Part CellHeading Version Number CellBody Publish date Templates Reference for Manuals 146 Production Guide Chapter Tags Chapter Number The large 1 on the right is the ChapNum tag It will auto generate for each chapter Chapter Title tag is called tc chapter title This tag contains a hidden character tag called Chap_App_ White so that it generates the 1 2 etc for the TOC in the pdf file This is why the chapter title section in the template looks indented but it will align correctly in the doc Note For the example below the Chap App White tag 1 is shown as magenta but it
164. ols folder create 139 NetgearUtils 138 Numbering and Update Book 123 O online documents color modes 39 ordering software 161 Other Features section 31 P packaging team 15 Production Guide part numbers 34 CDs 79 certification documents 34 Part TBD 34 PDFs archibing 76 see tagged PDFs 82 PDFs link to external 90 phones 163 photos product 44 place mat install guide 17 platform products 19 Preflighr 88 Preflight 87 89 Print Book command 86 print spec about 37 printer contacts 38 printed documents and DITA 166 printed documents archiving 76 printed documents color modes 39 printer contacts 38 printing color and BW 87 product design team 14 product names 20 product photos 44 production person role 12 Q QR codes 37 quick install guide 17 quick install guides 86 R Read Out Loud 95 reconversion 137 reference elements DITA 175 reference pages 154 reflow document 96 Related links DITA 178 release approval 63 RemapConfigFile 121 remote access to V drive 162 reviewers approvals 65 comment acceptance 65 response 65 who reviews what 64 reviews 63 64 65 cycles 63 PDFs 99 reviewsl 63 RGB color mode 39 S Save as PDF command 85 scaling images 43 scheduling doc reviews 63 screen shots about 45 combining 45 47 dedicated laptop 46 importing 46 preparing 45 Print Screen 45 RoboScreenCapture 45 WinTV 48 search tagged PDFs 83 Section 508 93 Service provider b
165. ompliance_Wired_Powerline e AppCompliance_Wireless e Appendix Template fm e Chapter Template fm Frontmat fm e FullManuallX fm FullManualTOC fm NewTemplates book file e Production Guide 4 Modify the maker ini file a Open the maker ini file in a text editor C Program Files Adobe FrameMaker9 maker ini b Search for APIClients and find the second instance of the API Clients area It looks like this APIClients jueces API Clients ClientName ClientType facet format id vendor id display name description path mode optional file extension for filter c Copy the following 3 lines into the maker ini file You can copy the lines from here or from the Edit maker Dot ini File txt file in the NetgearTools directory Install Custom Tools 140 Production Guide Note Make sure the directory name within your FrameMaker9 installation NetgearTools is spelled exactly the same as the reference to NetgearTools in the following lines Case does not matter A mismatch causes the NetgearUtils menu to not display when to start FrameMaker and select a book Netgear Tools NetgearUtils Standard Netgear Custom Tools netgeartools netgearutils dll maker NetgearRemapper Standard Netgear Template Remap Client NetgearTools remapper dll maker d Paste these 3 lines before the line that starts with ClientNamez they can wrap maker Note Ei TemplateBrowser 0 20 ECatalog 500 50 130 350 EH ients
166. on Steps Create a NetgearTools folder in your FrameMaker 9 installation folder Copy paste the Tool files into the NetgearTools folder Copy paste the Template files into the Templates folder Modify the maker ini file Launch FrameMaker m RM Tools Installation gt To install the tools 1 Create a NetgearTools folder in the FrameMaker 9 installation folder Windows XP C Program Files Adobe FrameMaker9 NetgearTools Windows 7 C Program Files x86 Adobe FrameMaker9 NetgearTools 2 Copy paste the most recent Tool files into the NetgearTools folder you just created a You will find them on either geardog external or the V drive internal Geardog 4TechPubs NetgearTools V drive Engineering TechnicalPublications Tools NetgearTools b Copy paste the following files You do not need to copy the two Zip files in there e Templates folder has a ReadMe txt Edit maker Dot ini File txt e netgearutils dll Install Custom Tools 139 Production Guide e pd settings fm e RemapConfigFile fm e remapper dll e remaptoolinstructions txt e report tpl 3 Copy paste the latest Manual Templates files into the Templates folder a You can find them on either geardog or the V drive Geardog ngreng 4TechPubs Templates Current Manuals V drive VAEngineeringYTechnicalPublications Templates Templates Current Manuals b Copy paste all of the files Images folder e AppCompliance_Adapters e AppCompliance_Wired e AppC
167. on page 104 to learn more Collect Outside Cross References This command traverses the list of cross references in the book and determines whether the cross reference is to a file in the local directory or not For each cross reference if the cross reference is somewhere outside of the book s local files directory it does the following 1 Ifa file exists with the same name in the book s local files directory the tool resolves the cross reference to the file in the local directory by breaking the link to the outside file 2 If there is no file with the same name in the book s local files directory it copies the remote file into the local files directory and resets its link to point to the local file Custom Tools Reference 106 Production Guide 3 Then it reports that a file was copied from location A to the local directory The message is a link to the cross reference in the document Click the filename path to open the file where the cross reference is if you want to review it Graphics Tool The following commands are available under NetgearUtils gt Variables These commands maintain consistently defined cross references across all of the files in the book e List of Graphics in Book e Move Unused Graphics e Collect Outside Graphics List of Graphics in Book This command generates a report of embedded graphics and graphics imported by reference gt To list graphics 1 Select Variables gt List of Graphics in B
168. ook to generate the report 2 Inthe report select the graphic file name in the left column to jump to the image This also works for embedded images which are listed in the List of Graphics in Book report as Copiedlmage The word Copiedlmage is a link to the actual image in the book The report tells you that page 3 of Production Guidelines fm has a copied image List of graphics imported by copy There are 11 graphics imported by copy Link to image Production Guidelines fm CopiedImage Graphic imported by copy Note If the image exists only on the disk and is not used in the book anywhere the path is not a link In this next report the Production Guidelines fm file has seven graphics imported by reference The table tells you the Graphic Name the Graphic File Path where FrameMaker is getting the graphic and what page it is on in the file On Page Custom Tools Reference 107 Production Guide Wist of graphics imported by reference There are 7 graphics imported by reference Link to image Production Guidelines fm Photoshop_canvas_size jpg T JDefarmental Production Guides Production guide FrameS rc Images Pagination jpg Td Departmental Production Guides Producti on Guide FrameSre Images AddDisconnectedPage jpg T Departmental ProductionGuides Producti on Guide FrameSrc Images Move Unused Graphics The Move Unused Graphics command moves all graphics not used in the book to the I
169. operties which should be set as follows Chapter 1 First page 1 Format Numeric 14 Subsequent chapters continue numbering Appendix A First page 1 Format ALPHABETIC N Subsequent appendices continue numbering gt To use this command Select the book and then select Add Setup GenFiles Numbering and Update Book Sometimes this tool introduces a Color Description inconsistency message To fix this error open either the front matter index or contents file in your Templates directory and select File gt Import gt Format to import only the color definitions from one of these files These files contain the newest color definitions Custom Tools Reference 123 Production Guide Import from Document Frontmat fm Import and Update _ Paragraph Formats _ Reference Pages Character Formats _ Variable Definitions Page Layouts _ Cross Reference Formats Table Formats C Conditional Text Settings V Color Definitions Math Definitions Document Properties Combined Fonts Deselect All While Updating Remove Z Manual Page Breaks Other Format Layout Overrides No Undo Figure 22 Reapply templates to fix color description error Update Converted Files New revisions of the templates come out from time to time and using these tools will ensure that all manuals stay up to date even after they ve been converted If tags styles or formats have been obsoleted
170. or IT See docs netgear com on page 158 for more information about accessing the docs server Note Sometimes docs netgear com is not accessible and it usually means the log file is full Contact Kent Robinson so he knows he needs to clear out the log file at krobinson netgear com 3 Create the directory structure in this format modelnumber language code part number Start a Project 31 Production Guide Note Only Chinese German French Japanese and Korean have their own user reference manual link with a language specific language code The other languages link to English manuals The English language code is enu Sample URL using the English language code http documentation netgear com cwge 111 enu 202 10634 01 index html Give the URL to the product engineer so it can be put into the product user interface or included on the CD Create and put index htm and index html pages in the directory Get the page template from http docs netgear com 1sample page a Provide the model number and product name b Fix the link to the user manual to show the correct path c The manual name is always usermanual pdf d Comment out the section that does not apply For example if you do not have the manual to put out there yet show the text that says The manual for this product will appear here soon Check the links with Firefox if possible and Internet Explorer to be sure the pages display correctly When you
171. organization or cosmetic changes should be accepted or rejected based on NETGEAR style and design guidelines Note Notify the technical publications manager or the lead writer if review comments cause the scope of the document to change dramatically Document Approval Email responses from the reviewers are treated as an electronic signature approving the release If there is no reply from a team member regarding a document within the allowed time frames we take that to mean acceptance and approval of the document Document Reviews 65 Finalize Documents Checklists help you remember all of the details NETGEAR writing projects have a lot of details that need to be attended to before the set is ready for Agile archiving This chapter provides checklists and supporting information to help you remember all of the many details The following topics are covered in this chapter Writer s Checklists Lead Writer s Checklist File Naming Archive Documents Final Hand Off from Offsite Writers Completed Projects That Do Not Go into Agile Agile Pickup CD Document Delivery 66 Production Guide Writer s Checklists Writers use these checklists to ensure that a document is ready for release URLS Change URLs that reference kb such as http kb netgear com to use support instead http kb netgear com Check the link after you change it If it does not work let Carlota Sage in Tech Support know Base Documents
172. oss Reference 2 with Heading cross Cross Reference 1 b1 bullet paragraph tag Cross Reference 3 reference tag Figure 27 First Page with hidden Chap App White character tag NOT showing Templates Reference for Manuals 148 Production Guide TOC Tags The TOC Title tag is called toc and is only used on the Contents title page Associated TOC tags AppNumTOC generates the Appendix A part of TOC ChapNumTOC generates the Chapter 1 part of TOC ta_appendix_titleTOC generates the appendix title tc_chapter_titleTOC generates the chapter title ti_index_titleTOC generates the Index tile hi_headTOC generates level 1 headings using h1 head tag h2 headTOC generates level 2 headings using h2 head tag hp1 head pTOC generates level 1 headings using hp1 head p tag hp2 head pTOC generates level 2 headings using hp2 head p tag h3 headTOC generates level 3 headings using h3 heading tag but level 3 is not generated in the template Note There is no associated TOC tag since the TOC title is not generated for the TOC Also td document title TOC is not generated in the TOC Templates Reference for Manuals 149 Production Guide Chapter1 Chapter First Heading uc cscs sess ccit seve cevec wees eeeces wads oeSeseeeee nies 5 HMB 2 pP crm 5 Chapter2 Chapter Next Appendix A Appendix Title HORE usos Aw ana eee wanes RARO Reni UN ake Sah 8 PC 2 unco ava RUR SH RUE GR RA IE PEU ame some ewe P T pane S
173. ou can include a title author subject and keyword Ensure this is filled in with relevant data As with all web content the title should be keyword optimized This information is accessed through the document properties section Description There is nowhere within a PDF to place a description The description is the text that is returned in the search results Left alone the search engines will find the first paragraph of text and use that This may not be a great selling point to attract the searchers click When you have completed your PDF you can specify the reading order Place suitable text close to the front of the document and specify this to be read first Tags If you use Acrobat to create your PDF then you can also specify tags including alt tags for images This can be accessed in Acrobat through the TouchUp Reader Order panel Links PDF files can and should have links Links should use standard good white hat techniques such as anchor text Since PDF s can change hands several times links within a PDF back to your own pages can help bring extra traffic Version Control By version control am not referring to the PDF s version rather PDF reader versions Don t be too hasty to jump onto the latest version of Acrobat Using an older version will ensure that search engines can read your PDF Search engines can be slow on the uptake when it comes to new versions Fast View Fast View is an Acrobat option that allows the PDF to
174. p network shares so that EVA will locate the media files You can put them on the same PC that you will use to get the screen shots The EVA unit must be connected and working Make sure that the EVA unit is not connected with HDMI cable If it is connected with both composite video cable and HDMI EVA will communicate with HDMI and you will not be able to get screen captures Make sure that the TV is set to the right mode AV mode for composite video so that you will be able to see the TV display Cycle through modes if you need to until you get a display see the EVA IG WinTV Installation To use WinTV 1 Go to the Hauppauge website and download the most recent WinTV software 2 Insert the WinTV USB device into a USB port on your computer and connect the WinTV AV cable to the USB device 3 Go to the TV and disconnect the EVA composite or S PDIF cable from the TV You bypass the TV completely while getting screen captures 4 Connect the composite or S PDIF cable to the Win TV AV cable The composite cable connects to the small port on the side of the WinTV USB device 5 Follow the WinTV instructions to install the WinTV software Document Preparation 48 Production Guide The WinTV installation process installs a WinTV user manual on your local computer Follow the instructions in the WinTV user manual to get screen captures On some laptops Photoshop locks up when WinTV is running In this case you can use Alt
175. pages This is where you will spend the most time because these are primarily manual processes Toclean up the front matter contents and index files 1 Clean up the Frontmat a If you did not do this step previously open the Frontmat Old fm file and the new Frontmat fm file See step 3 on page 126 b Copy paste the product image from the old file into the anchored frame in the new file c Close and delete the Frontmat Old fm file from the book folder it is no longer needed d On the new Frontmat fm file make sure these variables display correctly Document Part Document Title e Type of Manual e Publish Date e Save and close the file 2 Clean up the FullManualTOC fm file Old Style to New Conversion Tutorial 131 Production Guide If you deleted the old TOC and already copy pasted the new TOC into the source folder there is nothing to be modified on the FullManualTOC fm file See step 3 on page 126 Save and close the file 3 Clean up the FullManuallX fm file If you deleted the old IX and already copy pasted the new IX into the source folder there is nothing to be modified on FullManuallX fm file See step 3 on page 126 Save and close the file gt To clean up the chapter and appendix files This is where you ll spend most of your time If the big chapter number does not show up you may need to apply the new master page 1 Select Format gt Page Layout gt Master Page Usage and select
176. r PDF file named in the format WNA3100_IG_24MAY2010 pdf and the zipped file only The zipped file is titled WNA3100_IGsrc_24MAY2010 and contains The correct print specification The Frame file The Images directory The print PDF named in the format WNA3100_IGptr_24MAY2010 pdf A MIF file in case the printer or anyone else encounters the FrameMaker bug that prevents opening the file Note For SMB projects the organization is the opposite The print PDF goes outside the zip file and the regular PDF goes inside Finalize Documents 71 Production Guide Table 3 Manuals Check Post the regular PDF file named in the format WNA3100_UM_24MAY2010 pdf and the zipped file only The example is UM substitute SM if it is a setup manual The zipped file contains one directory called FmSrc This directory contains All the Frame source files The Vardefs fm file The Images directory Accessibility Checks If you are using the new template setting the metadata with the Netgearutils Set Metadata for book command including the language option introducing your figures right before they appear and or using meaningful figure captions your PDF is compliant with Section 508 of the Americans with Disabilities Act Adobe Acrobat provides several ways to check that your PDF is compliant and these are described in Test a Tagged PDF on page 95 You are not required to perform these
177. r people with disabilities and to encourage development of technologies that will help achieve these goals The law applies to all federal agencies when they develop procure maintain or use electronic and information technology Under Section 508 29 U S C 794d agencies must give disabled employees and members of the public access to information that is comparable to the access available to others PDF Procedures 93 Production Guide Structure Tagged PDFs have a logical document structure organization and extensive metadata for repurposing content Tagged Adobe PDF provides the following capabilities Ensures that information is in the correct reading order on a page e Includes paragraph attributes used to correctly reflow the document contents into different sized devices such as eBook reading devices Ensures the reliable translation of text into Unicode This approach recognizes ligatures and hyphens so a Windows screen reader can correctly read all characters and words e Recognizes alternative text descriptions for graphics in anchored frames e Enables the document to be exported more reliably to Rich Text Format RTF and XML from Acrobat 7 0 for reuse in other documents Tagged PDFs have author content pages articles paragraphs tables and graphics in anchored frames but do not have the following information found in standard PDFs e Comments such as online notes graphic markups and text markups e Pagi
178. r when you attempt to save You can close the file in FrameMaker and then make changes in the text editor CCMS Component content management system CCMS to make the DITA content readily searchable and available to others DITA Reference 168 Production Guide SVG Rendering SVG rendering tools The oXygen authoring tools comes with this installed Other authoring tools need to have an SVG rendered installed In DITA binary files images can only be referenced That is you have an image tag with an href attribute This works well for jpgs gifs and png files for screen captures Illustrations need to be in SVG format Adobe Illustrator can output SVG There are also SVG editors available SVG is an XML format for vector graphics Since the SVG is text you can edit the text within a DITA authoring tool because most of them are general XML editors that have the DITA DTDs installed with the editor Companies that localize a lot convert all of their graphics to SVG because it is cheaper to localize strings than binary images Note SVG is XML that conforms to a different schema than DITA All XML documents are governed by a schema that describes the structure of a document message illustration For tools to validate the XML document the document has to declare at the beginning what schema it conforms to Training Learning to use the chosen DITA authoring tool Learning the elements to properly tag the content The default DIT
179. racy structure regulatory compliance for target markets and completeness of content Document Reviews 64 Production Guide Technical support Reviews for technical accuracy appropriateness for the target audience customer profile that the content addresses previous product call histories and that information on how to obtain technical support is present PLM marketing Reviews appropriateness for the target audience product definition product name feature function product requirements Lead writer Depending on the project this can be a courtesy cc or comments can be provided to the writer e Editor Checks for style guide compliance presence of metadata on the PDF correct compliance information in QIGs and UMs and other things e Compliance Reviews regulatory compliance for target markets for user manuals and reference manuals only Reviewer Response Reviewers typically respond by email but in some cases meet with writers to discuss changes Comment Acceptance Comments on technical errors in the documentation are incorporated Comments on technical completeness are accepted or rejected depending on the scope and intent of the documentation or as interpreted by the writer lead writer or manager Comments on the purpose and scope of the manual including the intended audience are accepted or rejected based on the related material in the PRD which is the P1 presentation Comments on editorial style
180. receive calls on another phone from your own extension 1 Note the original extension number on a piece of paper 2 Press the Menu button 3 Press the Up or Down arrow key to locate the Log Out option 4 Press the button under Select and then the button under Log Out 5 Initialize the phone with the original extension as described in 7o initialize a phone on page 163 6 If the phone belongs to someone else follow Steps 3 through 5 to log out when you are done and put the original extension back in Make an Email Distribution List in Outlook A distribution list is a great way to notify people of an event such as when a document is ready for Agile pickup Put the people who are always notified regardless of the project on the distribution list When you make your notification email to the distribution list plus other people who are specific to the project such and the product engineer These lists work best when everyone has a NETGEAR email You can put people without a NETGEAR email on the list but they will not be able to reply to the list To make a distribution list 1 In Outlook select File New Distribution List 2 Type the distribution list name in the Name field 3 Use the Select Members and Add Members buttons to add names to your distribution list 4 Select Save and Close To edit your distribution list 1 In Outlook select Tools Address Book Under Address Book select Contacts Under Contacts
181. ref security dita gt lt topicsubject gt lt topicref href https_protocol dita gt lt topicref gt topicref href loginsetup dita collection type sequence lt topicsubject gt lt subjectref href configuring dita gt lt subjectref href webserver dita gt lt subjectref href security dita gt lt topicsubject gt lt topicref href editinguserdef dita gt lt topicref gt DITA Reference 186 Index Numerics 4Backup folder 77 A accessibility check 95 errors 97 font problems 98 guidelines 72 Acrobat Distiller 85 Add Setup GenFiles 123 Adobe Illustrator color modes 39 Agile 25 77 alternate text 98 Americans with Disabilities Act ADA 93 anchored frames 56 appendix tags 148 approval document 65 archiving docs 76 electronic documents 76 printed documents 76 artwork in Agile 26 bar codes 35 36 bar codes QR codes 37 Beta documents 25 black and white printing 87 blank pages removing 52 book files 103 borders 57 business units 19 C calculate doc due dates 24 calculate docs due dates 24 callout text 57 callouts DITA 181 carrier products 19 CDs 24 79 certification documents 24 25 34 change bars 55 checklists lead writers 74 writers 67 Citrix web interface access to V drive 162 clean up converted files 131 Cleanup Catalogs 122 clearing laptop memory 159 CLI manual 17 CMYK color mode 39 CMYK colors 85 Collection links DITA
182. rence 120 Production Guide Remap Old Tags to New Tags This command uses the RemapConfigFile fm file to map document elements tagged with the old tags to the new tags with the new table paragraph and character settings If you open the file you see the document elements retagged and in the new look You still have to page through the files and do some cleanup See Clean up the Files on page 131 for tips on cleaning up the files To use this command Select the book and then select Remap Old Tags to New Tags If you see any document elements that appear to be using old tags it means RemapConfigFile fm does not have a mapping for that old tag You need to notify the person who owns RemapConfigFile fm so they can add it map it to the correct new tag and notify everyone there has been an update to the file Fix Cross Reference Links The Fix Cross Reference Links command fixes broken cross references in the book by re creating the connection between the source marker and the target cross reference This command makes two passes over the book The first pass fixes the marker text by deleting the current marker and re creating it with new text and the second pass updates all cross references to point to the new markers To use this command Select the book and then select Fix Cross Reference Links No report is generated Background Information In unstructured documents FrameMaker uses cross reference markers to indicate the d
183. rences gt Production Guide lt Jump gt Appendix lt chapnum gt lt No Occurrences gt lines fm pdfprocedures fm lt Jump gt Appendix lt chapnum gt 13 10 Note Legacy content might include numerous versions of the same x ref for example Heading amp Page Heading and Page Heading Page If you are unsure which is correct refer to Chapter B Templates Heference for Manuals Toidentify Cross references Not Used in the Book 1 Run the List of Cross References Formats in Book report 2 Look at the third column Occurs In Pages for each cross reference definition Custom Tools Reference 104 Production Guide 3 If all rows in that table show No Occurrences gt that means the cross reference is not used anywhere in the book and can be deleted Edit Cross Ref Formats in Book This command brings up a dialog box that lets you edit the cross reference formats across the entire book To display the dialog box Select Cross References gt Edit Cross Reference Formats in Book The example shows that the BookTitle cross reference is used in every book file and has a consistent definition across the files The highlighted definition displays in the edit box where you can edit or delete that definition as described in the following procedures Edit Update Definitions For Book Name in Book Book filename Appendix Frontmat fm i lt Emphasis gt lt Jump gt lt paratext td_document_title gt lt
184. rinting related requirements that do not apply to standard PDF files Read more here http en wikipedia org wiki PDF X Compressed Object Streams Warning Compressed object streams used except for tags warning A PDF file consists primarily of objects that contain data such as Boolean values numbers strings names arrays collections streams and empty objects An object can be either embedded in another object direct or indirect Object streams were introduced in PDF 1 5 Acrobat 6 0 as a mechanism where indirect objects can be located in special streams called object streams This technique reduces the size of files that have large numbers of small indirect objects and is especially useful for reducing the size of Tagged PDFs This warning is to alert you that the PDF contains object streams because it was created with Acrobat Professional 6 0 or later and if it is not read with Acrobat Reader 6 0 or later the user might experience performance and or reliability degradation Other than recommending that the reader use the freely available Acrobat Reader 6 0 or later there really is not anything else to do about this warning It s quite possible that if the reader experiences difficulties he or she would upgrade Acrobat Reader on their own PDF Procedures 89 Production Guide Crop Marks on PDFs It s best to add crop marks within Frame but if you have a PDF and no source files follow these instructions to enlarge the p
185. rker text is used for the document text 4 Click OK to insert the URL into the document Note The Jump character tag includes the carriage return if the URL is at the end of a sentence and not followed by a period This is the expected behavior Template Conversion Tools The Update Current Book to New Templates menu provides commands for converting books from the old look to the latest templates See Chapter 9 Old Style to New Conversion Tutorial for detailed instructions on how to use these tools Import Formats from Latest Templates into Current Book Convert Figures Notices Tables to Paragraphs Remap Old Tags to New Tags Fix Cross Reference Links Cleanup Catalogs Add Setup GenFiles Numbering and Update Book Custom Tools Reference 119 Production Guide Import Formats from Latest Templates into Current Book This command uses the templates installed into the NetgearTools Templates folder to import the formats and settings into the current book The settings include the new paragraph tags character tags system variables reference pages and master pages To use this command Select the book and then select Import Formats from Latest Templates into Current Book While the command executes FrameMaker opens all the book files and applies the template settings and formats A dialog box displays when the command completes This command uses the following algorithm to identify which template to use for importing for
186. rra DENA Rd cs 77 Notification All products Except Storage 0 00005 78 Notification Storage Products 00 000 cee eee eens 78 CD Document Delivery 0000 e cee ee 79 Part NUMOS cese mus cm meme eee eee eRe ex e eR Re 79 BR nme M Mc Tc a a ee 79 ToP a crai ep DEI 2 REqP qe qd qood d qe ges qii 80 Chapter 7 PDF Procedures Optimize PDFs for Search Engines 000 ccc eee cece 83 Set Metadata within Frame a assa anaana aeaee 83 Add Metadata to the PDF 0 000 eee 83 Other Search Engine Optimization Tips 2 000000ee 84 Diese FDP seed pte edm aceto ea petunt qp ddp Id RIO 85 Acrobat Distler sissit IEEE EUR XXE Qoo ap er WR RUE obo 85 PDFs for Online Documents iouis cuadra rk RR n OR RR a 85 PDFs for Quick Install Guides QIGs liliis 86 Prepare for Color or BW Printing Preflight 2 87 Drop Marke an PDFS es euacosQe Eu RE Re REO Seve dde ds 90 Lombinae FDF 4 23 9 2 in rh he aw dora ep AC ay capice eu el 90 Link from within a PDF to External PDFs llllslsslselnlsn 90 Add A Welginamk oua sa cando ORD ry RR Ree RR CR deed 91 aed PERS oro pue oae Vesta iy E ad acid tp end at eod 93 Section 508 of the Americans with Disabilities Act 93 EQUO BL ccc ac DAD p RARO AAA E XYGq E ERG REGSRACZ AGREE ESERE 94 Generate a Tagged PDF cena 94 Test pads paca chaos EEG RU qe pae dd div 95 Send PD
187. s 70 Production Guide Check Compliance Info UM RM Goes in the UM or RM when there is no UM If the doc set has both a UM and an RM put the compliance info into the UM only Compliance info is present in the last appendix of the UM Compliance info includes this text right before the EDOC in languages of the European Community table For complete DoC please visit the NETGEAR EU Declarations of Conformity website at http support netgear com app answers detail a_id 11621 Compliance info is correct for the product See Compliance Information on page 30 for details Class variable is set correctly to Class A or Class B Product name is present in the compliance information e It s handled with the Product Name Long variable in the new templates Make sure your compliance information shows the product name and model number Waste Electrical and Electronic Equipment WEEE Notice with WEEE symbol See WEEE Notice and Logo on page 31 Add to IGs below the DoC paragraph For GNU General Public License GPL related information please visit http support netgear com app answers detail a_id 2649 Make sure this text is on the IG Do not stack equipment or place equipment in tight spaces or in drawers Be sure your equipment is surrounded by at least 2 inches of air space Prepare and Name Files for Agile Release Table 2 Installation Guides Check Post the regula
188. s DGN1000 do a search on DGN1000 and it brings up everything that has this product in its description The descriptions might not all have the product ID in them but the artwork AW files will Start a Project 26 Production Guide Search for ai JEA ig AW a Agile PLM displays up to 1000 rows for a search There are additional undisplayed results amp ii d Export v Selected 0 of 1000 j4 4 Page V of4 Name Number Description Status AW 10001 01 1 AW CG814WGTWC V2H1 PLBL ACT REWORK AW 10002 01 18 AW DG834 V3H1 PLBL m AW 10003 01 1 AW DG834B V3H1 PLBL AW 10004 01 AW DG834G V3H1 PLBL AW 10005 01 14 AW DG824GB V3H1 PLBL ACT AW 10006 01 AW DG834PN V1H1 PLBL OBS AW 10007 01 AW GCM9006 V1H1 OVERLAY Preliminary AW 10010 01 AW GCM9024 V1H1 OVERLAY Preliminary AW 10011 02 1A AW GS605 V2H1 OVERLAY ACT pP P p Dy my mp y Ry mp AW 10012 01 14 AW GS605 V2H1 PLBL ACT Figure 4 Search for artwork Start a Project 27 Production Guide Document Preparation These steps provide a high level outline of the procedure for getting a new doc set ready for editing Some of the steps involve using the custom commands available on the custom NetgearUtils menu in your FrameMaker installation These commands are described in Chapter 8 Custom Tools Reference See also Chapter 6 Finalize Documents for information about preparing documents for Agile archiving 2 To prepare a
189. s become cluttered unclear and evolve to an unpleasing visual presentation because people ask you to add things to them 1 You can work with the person to find a good solution 2 You can propose solutions to them and discuss the pros and cons with them 3 If you have a problem bring it to me can either help you figure out a better layout or talk to whoever it is that s insisting you add text and other visuals exactly the way they want it when i s not the best approach for our customer Document Preparation 61 Document Reviews Review strategies vary by project schedules This chapter covers how to conduct document reviews Schedules and cycles can vary depending on the kind of product type of document and business conditions For example sometimes documents have to be created or turned around quickly to meet changing market demands See Send PDFs Out for Review on page 99 for information about the tasks involved in preparing PDFs for review The following topics are covered in this chapter Review Cycles Review Schedule Fast Track Review Schedule for Wireless Adapters Distribution Reviewer Response 62 Production Guide Review Cycles PDFs are emailed to reviewers as described in Send PDFs Out for Review on page 99 Many documents have three review cycles before they are released Sometimes there is not enough time in the schedule for three reviews Note When documents are requested for Beta they get a
190. s that tells you by chapter which obsolete tags could not be deleted because they are in use The file names in the report are links that open the corresponding files when you click on them Cleanup Catalogs Report For F l NETGEAR C onversion Projects Convert for Betsy WPNS24N F ull Manual book Deleting invalid and unused tags from F rontmat fm The Table format Format A i used in the document and cannot be deleted The Table format No RuleMeta is used in the document aad cannot be deleted Deleting invalid and unused tags from FullManualTOC tm The Pf formar hol bed TOC is used in che document and cannot be deleted Deleting invalid and unused tags from Basie fm Deleting invalid and unused tags from Security fm The Char format pdf is med in the document and cannot be deleted The XRef format Table and Page b wed in the decument and cannot be deleted Deleting invalid and unused tags from Content fas Deleting invalid and unused tags from Customize fm Figure 21 Clean Up Catalogs report Use the report to e Go into the files and do any necessary retagging Consider whether RemapConfigFile fm needs additional entries and if so convey them to the file owner After running this command your catalogs should be free of the old tags so that you do not inadvertently tag something with an old tag Custom Tools Reference 122 Production Guide Add Setup GenFiles Numbering and Update Book
191. ser interface for features Ask for a document that describes the LED behaviors Base the new set on multiple doc sets so you can pull the features you need from them Meet with the engineer and include the illustrator Have the engineer demo the unit so you and the illustrator can ask questions The project engineer informs technical publications if there will be a CD and which version of the installation wizard or genie the product uses The project engineer provides a unit for screen captures photos and illustrations or enables remote access if the unit has to be used in the lab The project engineer tells the writer whether the product is Class A or Class B for compliance purposes See Compliance Information on page 30 for more information The project engineer provides xfactory and other due dates Typically there is a 50 percent and a 90 percent xfactory date Technical publications uses the 50 percent date for calculating documentation due dates Certification documents do not use xfactory dates See Certification Documents on page 24 for more information The lead writer calculates documentation due dates using the algorithms described in Calculate Doc Due Dates on page 24 The product line manager approves long and short product names to use in the manuals in the product packaging and in the marketing materials Product line manager determines which documents are localized Localization is taken into account when the document due
192. side Graphics on page 109 one more time and finish up by running Move Unused Graphics to prevent extra graphics from being archived with the book 15 Delete the reports directory Compliance Information Compliance information goes in the last appendix of the user or reference manual and on the second page of the installation guide User Manuals The compliance information varies depending on whether the product is wireless single band non wireless single band wireless dual band or non wireless dual band The product can also be Class A or Class B There are four templates that you choose from based on whether the product is wireless or not and whether it is single or dual band The Class setting is based on a book variable that you set to populate the compliance text with Class A or Class B as applicable Installation Guides Make sure there is a link to the DoC on the second page under technical support or in the third panel right above the copyright information The DoC link looks like this For complete DoC please visit the NETGEAR EU Declarations of Conformity website at http support netgear com app answers detail a_id 11621 Start a Project 30 Production Guide The new templates are set up so that the link to the DoC is there WEEE Notice and Logo The Waste Electrical and Electronic Equipment WEEE notice has to appear with the WEEE symbol We put the notice and symbol on the install guides If you see a WEEE sy
193. spec was not as clear as it needed to be See Printer Contact Information on page 38 or contact the NETGEAR Operations department to get printer names and their email addresses It is a good idea to email two or three printers and request samples You would include an initial print spec and a PDF of the preliminary document You might want to cc someone at NETGEAR preferably in Operations who speaks Chinese because sometimes the printers respond in English and Chinese Operations negotiates prices with the printers and handles the logistics of getting something printed Your goal in contacting the printers is to determine exactly how you want something printed and how the corresponding print spec should read The final choice of the printer and price are determined by Operations after the document and print spec are uploaded to Agile Document Preparation 37 Production Guide What to Specify Cover paper weight 80 100 etc Inside paper weight 80 100 etc The cover can be different from the inside Paper color White yellow or whatever color you want Printing color Specify 4 color or B amp W Router DG install guides use 4 color print All other install guides use B amp W Note that some localized router DG install guides are B amp W instead of 4 color This difference is handled by the localization team e Paper type Glossy wood free uncoated cheaper or whatever you want Binding Saddle stitch stapled
194. sted in creating certification docs There are generally two types of certification docs simple and more involved In both cases technical publications gets a documentation set from a similar project Depending on how different the device to be certified is from the device described in the base doc set follow either the simple or more involved process Start a Project 24 Production Guide gt Create a simple certification document 1 of gt Place a note on the cover saying the document is for certification purposes only and the screen captures and illustrations might not exactly match the unit Place a note near the unit photos saying the document is for certification purposes only and the actual unit might not exactly match the picture Change the product name everywhere Remove sections that do not apply Add short sections that are important for certification Change the part number to Part TBD to avoid confusion caused by leaving in the existing part number from the similar doc Do not change screen captures and illustrations except in a case where an initial screen is so different from the base doc set that it would be very confusing not to Changing out the screens and illustrations is a lot of work and costs money and the product might not get the go ahead gt Create a more involved certification document 3 2 Do all of the above plus the following Go through the GUI and put in screen shots for cha
195. t Document Bar Codes Every printed document has a bar code of the part number Bar codes are usually placed on the master page If you are working with a bar code that is an Illustrator file import the image by reference and then size in FrameMaker Be careful not to crop off the edge of a bar code or the bar code will not work correctly in the finished document Toinstall Bar Code Wizard 1 Go to V Engineering TechnialPublications Tools BarCodeWizard 4 1 2 Double click setup exe 3 Get the name and key to use from the key txt file Tocreate the Bar Code Image File and put it in your document 1 Launch the Barcode Wizard 2 Select Code 39 3 Enter the part number for the document 4 Copy the code to the clipboard 5 n FrameMaker go to the master page and paste the bar code into the anchored frame gt To save the bar code as an Illustrator file not usually necessary 1 From Adobe Illustrator select File gt New 2 Use an art board size of 468 x 60 3 Paste the bar code from the clipboard 4 Save the file to your fmsrc img folder and use the part number for the filename Document Preparation 35 Production Guide Bar Code Sizes A question came up about the minimum size a bar code can be and still be read by the scanner We did not find the precise smallest size but operations provided these bar code specifications that are used on the boxes Size Pt Font Barcode Narrow Adjust i spaces
196. t message URL lt URL gt where URL is the actual URL such as www netgear com The marker itself needs to have the same character tag Jump applied to it For Example if you want the text NETGEAR website to be an active link in a PDF that goes to http www netgear com you would perform the following steps Below is the manual process The Insert URL command does all of these steps for you 1 Type NETGEAR website in the document text 2 Apply the Jump tag to the text so it looks like this NETGEAR website 3 Put the cursor in front of the text and select Special gt Hypertext to insert a hypertext marker in front of the text 4 In the Hypertext dialog select Go to URL for the Command Message URL appears in the Command box 5 After Message URL type www netgear com 6 Select the New Hypertext Marker button to insert the hypertext marker into the text so it looks like this NETGEAR website 7 Check that the marker has the Jump tag applied If not apply the Jump tag to the marker URL Report The URL report tool presents various information about the URLs in the document The information does not necessarily indicate errors but some of the information could be indicating errors that need your attention You need to review the report and decide if any fixes are needed and then make the fixes To generate the URL report At the book level Select NetgearUtils gt URL Report The three columns provide dif
197. t applicable to the custom installation flow if applicable and sends out the UM for a technical review e Day 5 One day review cycle for the UM Writer makes final changes to the QIG and delivers the final PDF file archive e Day 6 Writer corrects the UM and sends it out for release approval Day 7 One day review cycle for the UM Day 8 Writer makes final changes to the UM and delivers the final PDF file archive Very rarely for a super fast track the QIG and UM can be sent out for review on the same day Here is an example of that schedule e Day 1 Writer creates the QIG and UM and sends them out for technical review e Day 2 One day review cycle Day 3 Writer corrects the QIG and UM and sends them out for release approval Day 4 One day review cycle Day 5 Writer makes final changes to the QIG and the UM and delivers final PDFs file archives This makes it possible to deliver both docs in 5 working days instead of 8 In this case if changes are required in the QIG then the writer might need to make parallel changes in the User Manual custom installation flow It requires a bit more work but is the fastest schedule Distribution At the start of the project the lead writer confirms with the project manager that the review distribution is correct for the project It should include at least these team members although some projects include additional reviewers Project engineer Reviews for technical accu
198. t Explorer cannot display the web page message Select Page gt Open FTP Site in WIndows Explorer e Enter the user name and password again Note f you don t see the Page menu in IE use the View menu to add it Office and Laptop Tips 158 Production Guide Laptop Maintenance gt To check laptop memory 1 Right click the My Computer icon on the desktop 2 Select Properties Memory is shown in the lower right For Adobe products Frame about 3 Gb of RAM is adequate Torun scans and defragment the disk 1 On the Start Menu select Computer 2 Right click Local Disk C and select Properties 3 Select the Tools tab 4 Select the Check Now button to run a scan or the Defragment Now button to run a disk defragmentation The disk defragmentation takes place the next time you turn on your computer and takes several hours to complete The best thing to do is to turn shut your computer down and turn it back on right before you leave for the night to start the scan In the morning you can log in as usual Office and Laptop Tips 159 Production Guide Local Disk C Properties Generel Eror checking This option will check the volume for errors Defragmentation amp This option will defragment files on the volume Backup m This option will back up files on the volume Backup Now 5 Inthe dialog box that displays select both CHeck disk options as shown click OK then click Yes to
199. t Variable Definitions in Book command described in Edit Variable Definitions in Book on page 112 to set and edit your variable definitions for the new book Make sure you set the Class variable based on whether your product is Class A or Class B to populate the text in your compliance appendix See Compliance Information on page 30 for more information Note Do not delete variables that are in use The List of Variable Definitions in Book command described in List of Variable Definitions in Book on page 111 shows the variables in use a Make sure you create if necessary and set the metadata variables with the Set PDF Metadata for Book command described in the Templates Tools amp Processes User Guide for all documents including installation guides a Run another List of Variable Definitions in Book report b If you want a record of the new variable settings to refer to later rename this report Run the Set PDF Metadata for Book command described in the Set PDF Metadata for Book on page 114 Run the List of Graphics in Book command described in List of Graphics in Book on page 107 to review which graphics are imported by reference and which ones are copied so you can make sure all graphics that need to be imported are imported a This report also shows where Frame is finding the graphics It s possible that Frame is finding graphics that are not in the local directory b If you want a record of the new variable settings
200. t connection The router menus display where you can do things like change settings or add other devices to your network Figure 28 Sample task topic in WYSIWYG mode DITA Reference 171 Production Guide Log In to the N150 Modem Router T Log in to the wireless modem router to view or change settings or to set up the wireless modem l lemd gt type gt nttp 192 168 0 1 b in the address field of your browser and press b gt Ente to display the login window You can also enter either of these addresses to access the wireless modem router b gt nttp www routerlogin b net or b gt ges secon ome cmd http 192 168 0 1 v User name admin Password rire Remember my password LL JL o9 step gt 2 lemd gt when prompted enter admin for the router user name and password for the router password both in lowercase letters Note The router user name and password are probably different from the user name and for logging in to your Internet connection The router menus display where you can do things like change settings or add other eR network Figure 29 Sample task topic in markup mode The XML markup for the sample task topic follows DITA authoring tools provide a way to view the XML code which can sometimes be an easier way to troubleshoot a syntax error task xmlns xsi http www w3 org 2001 XMLSchema instance id task 1 xsi noNamespaceSchemaLocation
201. ter tag only to URL Hypertext markers Use this command when the URL Report indicates that there are URL markers that do not have the Jump tag applied to them There is no way for the tool to know if specific text is supposed to be a URL and even if some assumptions are made such as any text that starts with http it is too risky and too slow to try to apply the character tag to the actual URL text To apply the character tag to all URL markers At the book level select NetgearUtils gt Apply Character Tag to URL Markers Custom Tools Reference 118 Production Guide Insert URL Use this command to insert a new URL or to re create a URL that has errors gt Toinsert a URL 1 At the document level place your cursor where you want the URL to be 2 Select NetgearUtils gt Insert URL to display the following dialog box Insert URL Insert a complete URL exam http www netgear com Insert text to be displayed in the document Optional leave empty to use the URL Cancel 3 Complete the fields in the dialog box Insert a complete URL Type the complete target URL into this field This is the marker text and is also used for the document text if you leave the next field blank Insert text to be displayed in the document This optional field lets you provide text that the reader clicks on to go to the target URL For example it might read NETGEAR website If this field is left blank the ma
202. the same convention for CLI and hardware installation guides For foreign language versions such as German e WGXB102 RM GR 20Mar10 e For the Zip file archive name use WGXB102 RMsrc GR 20Mar10 zip For managed switch manuals e 7000 series SM 8 0 3 22Jun10 for software setup manuals e 7000 series SWA 8 0 3 22Jun10 for administration guides Finalize Documents 75 Production Guide Sample File Names for Booklets MCA1001v2 IG interior ptr 10Apr12 MCA1001v2 IG cover ptr 10Apr12 MCA1001v2 IG cover interior 10Apr12 Archive Documents The PDF and a zip of the source files are archived Source files use a directory structure of FmSrc Images ImgSrc If additional source documents need to be preserved such as Skype translation guidelines place them in an FmSrc DocSrc folder To archive you need a program such as Winzip Tocreate a Zip archive 1 2 ONAA Pw Remove unneeded image files with the Move Unused Graphics command described in the Move Unused Graphics on page 108 Delete the Reports Images Unused and Images Collected directories under FmSrc if they exist These directories are created when you run FrameMaker tools described in the Chapter 8 Custom Tools Reference Note If you have a one file document and you created a book file so you could run the FrameMaker tools delete that book file Put a copy of the PDF under the FmSrc directory Zip the FrameMaker and image files keeping the d
203. the subject matter of content SKOS lets you define the subjects for a particular subject matter area and classify each piece of content to indicate its subject The basic steps to define subjects and classify content are as follows e Define the subjects e Organize the subjects e Classify the content gt To define the subjects Create a DITA topic that identifies an aspect of the subject matter of the content This topic is typically a concept topic The DITA topic specifies the subjects with a subjectxxx element to specify the following kinds of information default labels that include synonyms and denotative images and notes on the definition and on the scope of coverage for the subject concept id configuring gt lt title gt Configuring lt title gt lt shortdesc gt You configure components to set up or refine a solution lt shortdesc gt lt conbody gt lt p gt You don t have to get the best configuration the first time lt p gt lt subjectDetail gt lt subjectLabels gt lt altLabel gt Setting up lt altLabel gt lt subjectLabels gt lt scopeNote gt Administrative tasks performed after installation lt scopeNote gt lt subjectDetail gt lt conbody gt lt concept gt DITA Reference 185 Production Guide gt To organize the subjects Create a subject scheme A subjectScheme is a specialized DITA map that defines a collection of controlled values rather than a collection of topics You
204. therwise Distiller uses whatever the settings were when you last distilled a project This has a negative effect when you go from creating standard PDF to print quality PDFs If you do not change your Distiller settings then only the ps file is created using print quality the PDF is distilled at standard quality PDFs for Online Documents You can use the Print Book or Save as PDF command to create a PDF from FrameMaker for an online document Remember to run the Set PDF Metadata for Book command described in Set PDF Metadata for Book on page 114to establish your PDF settings gt To use the Save as PDF Command 1 In the book file select the book 2 Go to Format gt Document gt PDF Setup In the PDF Setup dialog box you should see Settings Tab PDF Job Options Standard Open PDF Document on page 1 at Zoom FitPage Registration Marks None Page Size 8 5 x 11 0 Page Range All Convert CMYK Colors to RGB Selected Bookmarks Tab Bookmarks expanded through level None 3 Select File Save as PDF 4 Click Set PDF Procedures 85 Production Guide gt To use the Print Book Command M ope 7 In FrameMaker select File gt Print Book In the Print Book dialog box Printer section click Setup In the Printer Setup dialog box Name drop down list select Adobe PDF and then click OK Click the Properties button and make sure that the settings are correct on the Adobe PDF Settings tab e Default
205. tion Guide variables in book 29 variables tool 110 versions product 20 virus scans 160 VPN access to V drive 162 W warning 89 warnings turning off in FrameMaker 54 Waste Electrical and Electronic Equipment WEEE 31 web search 83 WEE symbol and text 31 WinTV screen shots 48 writer role 11 writers checklist 67 Z zip files 76 191
206. tion through nested topics A list of related topics at the end of the topic gets created automatically when you generate output A parent will always have links to its children and a child will always have a link to its parent Related links can be hard coded with the related links element or soft coded in a relationship table A relationship table is the preferred method because it is more flexible than hard coding links WIth a relationship table you create and maintain links in the DITA map rather than in the topics Each row in the table represents a relationship that is rendered as a link Each cell represents participants in the relationship When the relationship table is created each topic reference in a cell links to the topic references in the other cells in the same row For more information see Linking DITA Topics Through Relationship Tables The following figure shows the code for an example relationship table This is a DITA topic that includes a hierarchical link and a relationship table at the bottom when it is rendered Relationship table gt lt The related concept task and reference files point to each other gt lt reltable gt lt relheader gt lt relcolspec type concept gt lt relcolspec type task gt lt relcolspec type reference gt lt relheader gt lt relrow gt relcell lt topicref href concepts about produce dita reicell lt relcell gt lt topicref href t
207. tools in Word are for general text We write for a variety of audiences from the average to the highly technical We sometimes have requirements for long nouns and long verbs The rating tools are only a guide We can use simple short sentence structure to improve readability and clarity This can be done even when the words themselves are long There is nothing wrong with scoring a high grade level as long as the reader can easily understand the text A manual is a composition of art and text presented so the reader can Document Preparation 59 Production Guide easily understand it Everything plays a part typeface size line measure page layout concept flow and so on have written user and programmer manuals totaling 1400 pages for a very complex software application Similar procedures were written using similar text and so on The manuals used the same conventions and style for text and standardized art Only the nouns and verbs changed Total vocabulary of about 100 words The goal was to have a reader say amp This doesn t seem difficult get it Process Summary This section summarizes the important art compliance editing localization and documentation quality standards Art Import all Al art d by reference into your FrameMaker files 1 Cost savings This saves money for localization They explicitly requested that we do this 2 Printing This makes the art in printed documents crisper
208. trators to determine art guidelines such as colors fonts line widths color format RGB or CMYK and develops an art catalog as needed Implements or works with the production person to implement templates Illustrator The illustrator creates illustrations and other art for all the docs adhering to the art guidelines set forth by the designer in collaboration with the illustrator e Uses Adobe Illustrator and Photoshop e Takes photos of units to make front cover drawings Does line drawings as needed e Does cabling diagrams for place mats as needed Production Person The production person is an expert in FrameMaker who backs up the team as follows e Puts text into an existing or customized template Updates documents with product name changes Implements and or designs templates e Creates documents as needed under the direction of a lead writer The Landscape 12 Production Guide Manager The manager is responsible for a team of employee and consultant technical writers designers illustrators and production personnel who produce all printed and online product documentation in U S English except product online help The CD build release engineer also reports to the manager See Appendix D CD Build Process for more information The manager has the following responsibilities e Sets employee goals hires trains and develops a strong collaborative team e Ensures the team provides all required printed
209. uction Guide The document set varies depending on the product and whether there is a CD Product CD Documentation Accessory antenna or simple No Quick Install Guide QIG switch Application No User Manual UM Smart amp managed switches Yes QIG Hardware Installation Guide HIG Software Guide installation setup etc Software Administration Guide CLI Manual Digital media players EVA Yes QIG User Manual No QIG Powerline Yes QIG UM ReadyNAS Yes QIG Software User Manual Hardware User Manual Router gateway modem Yes Place mat router Setup Manual User Manual No QIG User Manual Wireless adapters or range Yes QIG extenders User Reference Manual Document Sets 18 Production Guide Home and Business Products NETGEAR products can be divided into two broad groups consisting of home products and business products Home retail products These can be either home consumer products sold directly to consumers or service provider products sold to carriers for their customers to use ina home environment Some examples are wireless routers gateways modem routers wireless adapters digital media players and Powerline products Retail customers range from first time users to experienced users Carrier group technicians are technically knowledgeable e Business products The small to medium business and network storage business NSB units make products for use in a bus
210. uides ProductionGuide Fram eSrc Images editxrefs jpg Code 0 Moved T 1Departmental ProductionGuides Production Guide FrameSrc mages icon_danger gif Code 0 Moved T 1Departmental ProductionGuides Production Guide FrameSrc mages icon_pointer gif Code 0 Moved T 1Departmental ProductionGuides Production Guide FrameSrc mages icon_pointer2 gif Code 0 Figure 16 Move Unused Graphics report Collect Outside Graphics This command traverses the list of images that are imported by reference in the book The command can read the images directory regardless of case images Images IMAGES and so on For each referenced image if the image is somewhere outside of the book s Images directory it does the following 1 If there is an image with the same name in the book s local Images directory it copies the image into Images_collected 2 If there is no Image with the same name in the book s Images directory it copies the image into the Images directory 3 It then updates the path in the FrameMaker source file to reference all images in the local Images directory alerts you there are images in images collected to check and generates a report telling you which graphics were collected for what file and from where If you have duplicate images in Images collected check to see if they are the same or different to determine which image you want to use The following report shows a partial section form the Collect Outsid
211. untries Check the list of phone numbers at http support netgear com app answers detail a_id 984 Document Check Editing Document has been edited See Editing Guidelines on page 73 and Editing Priority on page 73 below for details on what and when to edit Cover is correct Date on cover Check model name number and image Check manual type User Manual Setup Manual etc Part number Check cover e Check the dash 0x Revision history can be omitted in home products with the writer s discretion Updated Kept to 4 lines or fewer List of box contents Is correct Does not list a warranty card this is no longer in the box but now on the Web Organization Cover Front matter Table of Contents Chapters Appendices Noise table in second to last appendix wireless products only Compliance info in last appendix must be correct for the product See Compliance Information on page 30 Index Finalize Documents 68 Production Guide Check Art Check that art is being read in from the local directory Check that correct art is in the right place Check that art is properly introduced in the text right before Check for good quality rendering Printed IGs fliers and whatnot PDF optimized for color or black and white as applicable Select Advanced gt Preflight gt Digital Printing gt Digital Printing
212. urs between the topic title and the topic body for the initial topic content It can contain paragraph level content and one or more lt shortdesc gt elements that provide link previews or summaries This element cannot be overridden by maps but the lt shortdesc gt element contained within can be overridden to create link summaries or previews e shortdesc occurs between the topic lt title gt and the topic lt body gt for the initial paragraph like content of a topic It can also be embedded in an abstract element This tag represents the purpose or theme of the topic and is intended to be used as a link preview and for searching When used in a DITA map the lt shortdesc gt of the lt topicref gt element can be used to override the lt shortdesc gt in the topic e lt body gt is the container for the main content of a topic section represents an organizational division in a topic Multiple sections within a single topic do not represent a hierarchy but peer divisions of that topic Sections cannot be nested A section can have an optional title e example is a section that contains examples that illustrate or support the current topic The example element has the same content model as section e related links contain related information links of a topic This information is stored in a special section following the body of the topic After a topic is processed into its final output form the related l
213. usiness unit 19 Set PDF Metadata 114 setup manual 17 about 17 product illustration 44 setup manuals editing 73 SMB business unit 19 software administration manual 17 software ordering CDW for software orders 161 SPBU 19 starting a document 28 storage business unit 19 support links to 54 T table of contents tags 149 tag styles 142 tagged PDFs 93 accessibility check 95 accessibility errors 97 Acrobat Distiller 85 alternate text 98 bar codes 36 combining 90 creating 85 crop marks 90 font problems 98 full accessibility check 96 generating 94 install guides 86 Production Guide language options 94 large 99 metadata 83 Preflight 87 print book command 86 Read Out Loud 95 reflow document 96 reviews 99 Save as PDF command 85 search engines 83 Section 508 of ADA 93 structure 94 tagged 93 task elements DITA 171 taxonomy DITA 185 technical doc review 63 technical publications deliverables 10 job roles 10 technical reviews 63 technical support team 14 telephones 163 template conversion tools 119 templates 50 TOC 149 tools 28 topic elements DITA 170 topics DITA linking 177 trademarks 2 U URLs 54 URLs in docs 54 usability team 14 user manual about 17 product illustration 44 user manuals 73 file naming 75 V V drive AgileDropFolder 77 current projects 77 read only access 162 VPN access 162 vardefs 143 vardefs file 51 variables 51 143 variables DITA 179 190 Produc
214. ustrations Where possible import Al files directly into FrameMaker The resolution is better and it s easier for localization GIF Good for cases where there are solid blocks in images When you add graphics use the Object Properties feature to scale them appropriately Callout Text See Minimalistic Callouts Heighten Visual Appeal at htto idratherbewriting com 2011 01 1 7 minimalistic callouts heighten visual appeal for tips on writing and placing effective callouts For callout text use Arial 10 pt bold There are two ways to add callout text Rod EE This is a Text Frame feature I v0 LO which allows you to add the E CallOut paragraph tag KGeROOA This is the A feature in Frame Figure 8 Add callout text to figure Draw a Text Line feature A on the menu This feature is good for one line callouts and needs to be manually formatted You need to manually change the font to the size color and text option bold italic etc that you want to use Place a Text Frame feature Page icon on the menu This feature allows you to add a paragraph tag Use the CallOut paragraph tag when using this feature This is good when you have more than one line The text frame can easily be sized to fit as needed Document Preparation 57 Production Guide Lines Arrows Color It is preferable to use black straight lines when pointing to an object on a figure but if required use arrows
215. variable that exists in only one or a few chapters Definitions This column lists the variable definition in each file where the variable exists SO you can scan for consistency Set Definition This button lets you set a definition one by one until you have redefined all the variables you want to for the current session Delete Selected This button lets you delete a variable from the book e Un Delete Selected This button lets you reverse a deletion You have to reverse the deletion before you click Commit Changes into Book e Commit Changes into Book This button commits all of the changes you made with Set Definition minus any changes you undid with Un Delete Selected e Cancel This button quits out of the session without making any changes To edit variable definitions 1 In the Name in Book column highlight the variable you want to change In the above example that would be the BookTitle variable 2 Inthe Definitions column highlight the definition you want to change opposite the file in which you want to change it Custom Tools Reference 112 Production Guide 3 In the Set definition box make the change to the definition you want In this example that would be N150 Wireless ADSL2 Modem Router DGN1000 User Manual 4 Click Set Definition 5 Repeat Steps 1 4 for every definition you want to change 6 Click Commit Changes into Book All files update with the current definition regardless of whether the
216. ve schedules with short review cycles and a high priority This can be due to market demands such as compatibility with a new operating system or getting a product to market before a competitor Rush jobs are urgent reactions to unforeseen circumstances They can be unexpected and might be needed to correct a defect that leaves NETGEAR exposed These are rare See Calculate Doc Due Dates on page 24 for algorithms to determine when a document has to be completed to meet localization if applicable and shipment schedules Document Reviews 63 Production Guide Fast Track Review Schedule for Wireless Adapters Wireless adapter products sometimes have fast track schedules Typically this is for an existing product or a new product with the same form factor as an existing product No developmental review is needed The start date is either upon receipt of a working stable GUI frozen product or when the engineer identifies the wizard and provides screen shots The writer also needs the part numbers for the documents the product name and the list of reviewers The fast track documentation schedule goes something like this Day 1 Writer creates the QIG and sends it out for technical review Day 2 One day review cycle for the QIG The writer can set up vardefs etc for the UM e Day 3 Writer corrects the QIG and sends it out for release approval e Day 4 One day review cycle for the QIG Writer creates the UM incorporating conten
217. wing tasks Update the Images directory Update the front matter Update the contents index and compliance appendix Clean up book files folder gt To update the images directory T 2 Open the folder that houses the book source files Rename the Images folder to Images The conversion tool looks for a folder named Images If needed rename the folder to Images and update the book path to read this folder Open the templates Images folder and copy paste SideBanner jpg into your book Images folder If this image does not import during the conversion import it by reference manually gt To update the front matter 1 2 Rename the original Frontmat fm to FrontmatOLD fm This is temporary You will delete the FrontmatOLD fm file after you copy paste the product image from the old cover to the new cover and import the old variable definitions From the templates folder copy and paste the Frontmatter fm file in to the book folder gt To update the contents index and compliance appendix 3 From the templates folder copy paste these files into the book folder a FullManualTOC b FullManuallX c Appropriate compliance appendix Note Adding the front matter contents index and compliance files directly instead of using the tools to convert the originals ensures that the correct content is used that all variables are included from the new templates and that all hidden tags are applied This saves a lot o
218. x Contents Figure 30 Sample concept topic in WYSIWYG mode The XML markup for the sample concept lt title gt Box Contents lt title gt lt shortdesc gt Make sure you have everything you need to cable your router lt shortdesc gt lt conbody gt lt p gt lt ul gt li N150 Wireless ADSL2 Modem Router DGN1000 lt 1i gt li AC power adapter plug varies by region lt li gt li Category 5 Cat 5 Ethernet cable lt 1li gt li Telephone cable with RJ 11 connector li li Microfilters and splitters quantity and type vary by region lt li gt li Resource CD with NETGEAR Genie setup li N A A A A A A li Installation guide with cabling and router setup instructions lt li gt lt ul gt If any of the parts are incorrect missing or damaged contact your NETGEAR dealer Keep the carton including the original packing materials in case you need to return the product for repair lt p gt image href Images DGN1000 contents jpg fig title Box Contents title fig DITA Reference 174 Production Guide lt conbody gt Reference Elements Use the reference elements to describe regular features of sets of things most commonly the commands in a programming language However this format is also suitable for recipes bibliographies catalogues and similar collections of structured descriptive prose lt title gt provides the topic or section title lt shortd
219. xRE EIE Ne ER UE qp PE E Pp e 146 haber TSS buses binge seers Rad ERES I ees eee BRE ER EE Ee 147 FOREN T8598 side dcadeendeniideeencdes aeeeaddde cadence sees 148 TOG MAG PETERE 149 De e adi ipic aca arate Peles od dae Melati Oei t a e iid 151 Master Pages i ccccdeced dew ki d RUE EE EC d sd dade d RAN d ded 152 ida gg I ea E de 8 Ae A tsi tng eke LITT 152 FolManaul TOC IIl aaaecdd ausu eR rRXG M Rud AEAEE 152 Chapter Template fm 000 cee 183 Pppendbe Tamma Il ueque e ab qae S pace a Pe o Ce Ee eg 153 POU ANSUN X UTI cus SX 34 EX RRRUGH CASE ER Gd Y X XP SERRG NE EE 153 Relerence Pagos esse sed d EROR ROS CR DARED RON ACAD ROSA E 154 Production Guide PRON stata come a oped E dae eode eae ddr BACON ed uc 154 Falls s OEC TEN sace cd cee hare Peek ORE CRGA ICRG AURORA e 154 Chapter Template dtl ance suum mmm rmm mh ems 155 Appendiz Template TI uuu ua aca eb actor dele od E ee d 155 Fullana lX WT sis ere bebe sands RU PRU etane 155 Appendix C Office and Laptop Tips Desktop Sharing for a Meeting n anaua nanana 157 Ee ee AEE A T EAE E AAE bota E A A T ET ES a d 157 docs Newa COM PR 158 L piop Mantena asus acdod adco d A A acd ra de ae 159 oar SONG ade doas br ende qu xU grex d pura ai 161 Remote Access to the V Drive 00 eee ee 162 auk PHONES 64 6065 ax de xadxqer RE RESWQSTA GRE NR Sq QAAE REG 163 Make an Email Distribution List in Outlook llle 163 Extract Files from an
220. xterm element to add index entries Nested indexterm elements create primary and secondary index entries Use the index see and index see also elements to create see and see also entries Use the index sort as element to specify a different sorting phrase for an index entry Conditional Processing Attributes Conditional processing attributes let you flag topics and elements to include or exclude content or flag content with a graphical icon to make scanning easier You can also apply values to conditional processing attributes such as audience product platform and revision to sort information along any of those lines Topic Metadata Topic metadata is applied to the entire topic and contains information about the author date created and other internal administrative information e Writers can use the administrative information to maintain content over many years e Writers can use the topic metadata to locate content in a file management system e Users can use the topic metadata to filter content in a dynamic publishing or faceted browsing system Topic metadata goes inside the prolog element for the topic Docs groups should decide which metadata information to use and how to use it Here is a list of topic metadata that is valid inside the prolog element organized by the possible reason you would want to use it Reason Types of Metadata Information Allowed in the lt prolog gt Element Legal Copyright Publisher
221. y multiple level tags can give this error One fix is to create several index markers instead of putting three or four into one marker In non generated files the following situations might be causing the problem If you are unable to find and fix the problem and the Read Out Loud feature can read through where the problem is you have met the minimum accessibility requirements e Two fonts are applied to the same text e Anunknown element is present in the Frame source due to copying and pasting from another document type such as word PDF or HTML Try retagging it Clean up Font Problems Font problems are a common reason the Read Out Loud feature cannot complete reading These are some possible causes for font problems e A font change is not tagged a URL or copyright text has been screen copied and has introduced odd characters or text has been pasted from a legacy Frame or other document __ A string has more than one font tag such as a URL tag and an emphasis tag To fix the problem do a visual inspection and manually select each font change one by one Check the character designer on the Info bar at the bottom of the document window to confirm that the characters are correctly tagged When you find untagged or incorrectly tagged text first remove the invalid tag and then apply the correct tag To delete an invalid tag 1 Select the untagged or correctly tagged text 2 Inthe font catalog select Default Character Font
222. ype All documents have a prefix between 200 229 Install guides use 201 user and reference manuals use 202 and setup manuals use 208 for the prefix Base PN yyyyy The base PN is sequentially assigned starting with 10000 This part of the number changes when there has been a significant change to the document Suffix zz The suffix starts with 01 and rolls for most changes The suffix is also referred to as the dash Document Preparation 34 Production Guide When a Document Changes If you change a document after it has been released to Agile in most cases you just bump the suffix up one which is also referred to as rolling the dash You might need to request a new part number if the document has changed significantly If a document goes on a CD and has a minor change the CD software needs to be changed which means the dash needs to roll on the document However manuals that are placed on the Web can either roll the dash or use versioning instead of rolling the dash This means that instead of changing the part number the document version changes For example Version 1 0 becomes Version 1 1 with the same part number as Version 1 0 If you change the version the document still goes into Agile Notify the Agile analyst that the version changed so he or she can roll the revision in Agile Note All questions regarding part numbers and when to change them are to be directed to the Agile analyst for the business uni

Production Guide - Pawlan Communications

Contents

Download Pdf Manuals

Related Search

Related Contents