Contents - Docu + Design Daube
Contents
1. 2 For addition information see Chapter 27 Hypertext and View Only Documents in the Using FrameMaker Manual for Frame Maker 4 Creating Hypertext ina Graphic Creating Hypertext in the Same Place on Several Pages Inserting Hypertext Markers and Commands Mechanics of Creating Hypertext within FrameMaker 4 To use an entire paragraph to indicate an active area make sure there are no Character Format changes in the paragraph and insert a hypertext marker If there are no Character Format changes in the paragraph then when a viewer clicks Frame Viewer searches the paragraph until it finds a hypertext marker highlights the entire paragraph and then per forms the hypertext command A hypertext marker must always be in a text column therefore you must put a text col umn on top of a graphic to create an active area To create hypertext in a graphic per form the following functions 1 Draw a text column over the graphic you want to be active Set the Pen and Fill patterns to None Make sure that the text column is on top of the graphic P 9 N Insert a hypertext marker With a hypertext marker present the entire text column is an active area When a viewer clicks anywhere in the text column Frame Viewer highlights the entire column When you want an active area to appear on several pages of a document create the hypertext marker on a master page When a viewer clicks that area on a Body Page Frame Vi2. lt DViewOnlyWinPopup No gt A document region pop up menu is a menu activated by the right mouse button For example in Unix versions of a Frame product the Maker menu and Viewer menus can be accessed by pressing the right mouse button If this statement has a value of No the background menu does not appear when the right mouse button is pressed This statement has no effect in Macintosh and Windows versions of a Frame prod uct e To make a window behave as a palette window use the following statement lt DViewOnlyWinPalette Yes gt A palette window is a command window that has special behavior such as the Equa tions palette The behavior of palette windows is platform dependent In the Macin tosh version of a Frame product for example a palette window always remains in front of the active window In a Unix version a palette window can only be dis missed and cannot be closed to an icon A locked document automatically has active cross references An active cross reference behaves like a hypertext gotol ink command when the user clicks on a cross refer ence FrameViewer displays the link s destination page By default the destination page is shown in the same document window as the link s source You can use MIF statements to turn off active cross references and to change the type of hypertext link that the cross reference emulates To make cross references emulate the openlink command which displays the desti n
3. Disable cutting or clearing lt DViewOnlyNoOp 0x322 gt Disable copying lt DViewOnlyNoOp 0xF00 gt Disable unlocking the document The fcodes for commands are in the file Commands You can find this file as follows For this Version of a Frame Product Look Here Unix SFMHOME fminit language where language is the language in use such as usenglish In the fminit directory where the Frame product is Windows installed One undocumented hypertext command involving the use of fcodes is as follows fcodes hexnumber The hexnumber is a function code listed in the above mentioned Commands file For example to completely exit Frame Viewer not just the document window type the fol lowing in the hypertext marker window fcodes fff This will exit the entire application For more information about disabling commands see the online manual Changing Setup Files Section 1 7 Moving Hypertext Documents from FrameMaker 3 to 4 Hypertext Changes There have been some modifications in the FrameMaker hypertext from version 3 to version 4 The changes to hypertext have the following effects e Graphics over buttons In version 3 documents if you use a text column on a Master Page as a button and if you have a graphic object that is on top of the text column the button will work In version 4 the button will no longer work To fix the button make sure the text col umn is on top of the graphic Simply
4. GA 30650 706 342 3425 Sony DADC 400 N Woodbury Avenue Pitman NJ 08071 609 589 8000 Distronics 2800 Summit Avenue Plano TX 75074 214 881 8000 Sony DADC 3181 N Fruitridge Street Terre Haute IN 47804 812 462 8160 DMI 1120 Cosby Way Anaheim CA 92806 714 630 6700 Technidisc 2250 Meijer Drive Troy MI 48084 810 435 7439 DMI Huntsville AL 35810 205 859 9042 Evatone 4801 Ulmerton Road Clearwater FL 34622 800 382 8663 4905 Moores Mill Road 3M 2933 Bayview Drive Fremont CA 94538 510 440 8161 3M 1425 Parkway Drive Menomonie WI 54751 715 235 5567 HRM HMG 15 Bilpin Avenue Hauppauge NY 11788 516 234 0200 Uni Distribution Highway 154 East Pinkneyville IL 62274 618 357 2167 JVC 2 JVC Road Tuscaloosa AL 35405 800 677 5518 US Optical Disc 1 Eagle Drive Sanford ME 04073 207 324 1124 Section 1 2 Unix Distribution Issues When you publish documents in FrameViewer format and deliver them along with FrameViewer on CD ROM there are some issues to consider There are some limitations to CD ROM format most notably the 8 3 file naming restriction Frame delivers its Unix installation in tar volumes on an ISO 9660 CD ROM for this reason The tar volumes are 8 3 but the filenames within are not and need to be installed onto long filename systems 4 2 hfs ufs etc The filenames in the FrameMaker Viewer directory tree are fixed and nece
5. Please do not leave files in the ROOT directory If you need the clclient model of connecting to an already running FrameViewer process but also need to access the API functionality of the FDK you may want to develop an application that combines clclient and the FDK API For instance you may want to add menu items to the FrameViewer or perform processing when a notifi cation such as file open or close is received Example Scenario Suppose in an application any time a user selects help from appli cation X you want a Frame Viewer document called main help doc to be displayed In addition suppose that you want to add various menu options to the Frame Viewer help implementation This is how you would achieve this functionality e Use clclient to bring up the initial FrameViewer document main help doc That is application X would contain code to make the call clclient f main help doc The clclient program would check to see if FrameViewer is running if Frame Viewer is not running it will be started if Frame Viewer is run ning the running Frame Viewer will be sent a message telling it to open main help doc e When FrameViewer is brought up the first time set it up so it runs FV help apiclient which adds the various menu options In other words you can take advantage of clclient s ability to accept asynchronous messages to determine if Frame Viewer is already running and to raise open the m
6. Unix Specific Frame Viewer Information To develop context sensitive help in another application using Frame Viewer under Unix the following functionality is available in the source bin SFMHOME bi n there is an fmclient program that can send messages to FrameViewer The fmclient program allows you to open a doc and jump to a specific hypertext marker as well as connect to an already running FrameViewer process To find out more about fmclient type fmclient h The fmclient program is the same as clclient In version 3 the source code for clclient was in the install directory SFMHOME source openmaker clcli ent This code will also work with FrameMaker 4 In version 4 clclient the uncompiled version of fmclient is included as part of the Frame Developer s Kit FDK and is in the SFMHOME fdk apps unix apps frameserver clclient directory If you do not have the FDK and you need the uncompiled version of fmclient it is available to you via ftp Frame FTP ftp frame com or 192 111 118 8 Login as anonymous Type LS to see files and directories Read me files contain directions and file trees in each Directory When you login or CD you will get a message file with directions and usage Files from Frame are in OUTGOING unsecure files for Frame Technical Support are in TECHSUP Secure files for Technical Support go in the PRIVATE directory PUB is a directory for people that are not working with Technical Support
7. media instead of being installed To prepare this type of distribution first install FrameViewer with all the desired options to a hard drive and make the desired changes within the viewer ini file These will be the fixed settings for all users 33 Installed Application Customized MS Windows Distribution Issues Copy the installed Frame Viewer or image along with the distribution documents to the master media If you purchased Frame Viewer Professional viewer exe is shipped with the product viewer exe is not included with Frame Viewer You can download viewer exe from Frame s Bulletin Board at 408 975 6729 or 408 975 6730 This file allows Frame Viewer to be launched by clicking on the filename viewer exe ora file associated with viewer exe in the Windows File Manager With this method there is not a Frame Viewer icon or icons for your documents to start up Frame Viewer You must use Windows File Manager or FILE RUN in Program Manager to start the application It is not necessary to write an installer for this type of installation however you must make the following entries within the win ini file FrameViewer4 FMHome x viewer4 IniFile x viewer4 viewer ini Where x is the drive letter of the distributed media viewer4 is the absolute path to the Frame Viewer directory and viewer4 viewer ini is the absolute path to the viewer ini file This method is suited for end users nee
8. Advanced Features of Hypertext Setting View Only Document Options You can use MIF statements to control the display appearance and behavior of View Only documents and cross references in locked documents 3 See the MIF Reference Manual under online Manuals in the FrameMaker 4 Help for additional information 16 Changing the Document Window Advanced Features of Hypertext The MIF statements for View Only documents are intended for hypertext authors who want more control over hypertext documents They do not have corresponding com mands in the user interface The View Only MIF statements described in this section must appear in a lt Docu ment gt statement These statements have no effect in an unlocked document Make sure that the lt Document gt statement also includes the following substatement lt DViewOnly Yes gt To permanently lock a document perform the following commands 1 Save the document out as MIF 2 Open the MIF text file using whatever editor is available to you in Unix press the shift key while opening the MIF file in FrameMaker and this will open the document as text only 3 Search for DViewOnly 4 In the line directly below the DViewOn1y statement type the following lt DViewOnlyWinNoOp OxF005 5 Save and quit the MIF file 6 In FrameMaker open this document 7 Using the keyboard shortcut Esc F 1 k lock the document You will be presented with an alert telling you that
9. TIFF file format e Use fonts that are available on all end user platforms i e Times and Helvetica Remember that unique symbols i e Zapf Dingbats used within the document may not be the same on all hardware platforms e Use Unix pathname conventions for specifying the pathname of a file if you are planning online documents for Unix and or Macintosh and Windows Resolve Graphics Issues e If possible limit the number of graphics e Line art is more readable on screen but may be harder to maintain Mechanics of Creating Hypertext within FrameMaker 4 e If you use screen shots convert to monochrome if possible e Importing graphics by reference is safer graphics don t get lost but can create addi tional file management issues Storyboard the Process 1 Mockup a paper document that indicates the hypertext areas This will help eliminate unnecessary hypertext as well as point out deficient areas i e where a viewer may want to navigate but cannot 2 Design and test an online document prototype Define and test the online document production process 4 Create a schedule based on production process taking into account hypertext link management 5 Determine how and when the documents will be updated Does the online version need to be paginated in the same way as the paper version 7 Determine how many hypertext markers can be automatically generated Hypertext markers can be automatically generated wh
10. be used with the message system command The command is as follows message system application pathname winstate where winstate is one of the following SW_HIDE SW_MINIMIZE SW_RESTORE SW_SHOW SW_SHOWMAXIMIZED SW_SHOWMINIMIZE SW_SHWOMINNOACTIVE SW_SHOWNA SW_SHOWNOACTIVE SW_SHOWNORMAL Identifies a destination for newlink linkname linkname is a string that uniquely identifies the newlink It is the If the link is in a heading you may want to use the heading name as the linkname to simplify the maintenance of your documents newlink gotolink and openlink target for openlink and gotolink commands commands that use the same linkname Displays the next nextpage page of the current nextpage document Sheet 4 of 8 p 4oyeyowesy ulyyM IX H d H Buyeasy JO sajueyooyy LL Types of Hypertext Markers Available in FrameMaker 4 Continued Hypertext Name Purpose Syntax Example Comments Opens a new document window openlink filename linkname filename identifies the file that contains the matching newlink If Use the openlink command to display related information without losing the source For example clicking on the words Main Index opens the main index menu to FrameMaker s online help openlink and displays the the newlink is in the current file system Openlink can open locked or unlocked documents page that contains a
11. beep as the first page of a document is displayed if the pagenumber for the command is invalid The document that you are jumping to may not have page numbering starting at 1 because it is part of a book where page numbering is continuous or you have set the starting page to something other than 1 Therefore using gotopage filename as your hypertext command is not correct You should either edit your hypertext command to reflect the actual page number of the first page in the document or you should use the got olink filename firstpage command if you just want to go to the first page of that document no matter what the actual page number is Sheet 2 of 8 p 4oyeyowesy UIY IM X H d H Buyjeasy JO sajueyooyy Types of Hypertext Markers Available in FrameMaker 4 Continued Hypertext Name Purpose Syntax Example Comments Divides the text column containing the marker into rows and columns of hypertext matrix rows columns flowname rows specifies how many rows of buttons the text column will contain matrix 2 3 MyCommands divides the text column into two rows and three columns of buttons The hypertext commands are on a reference page in a text column tagged MyCommands Each command is in a separate paragraph the first three paragraphs are for row 1 and the second three paragraphs are for row 2 The example below depicts where to use the matrix hypertext command in a graphic This type
12. for those running both Maker and embedded Viewer licenses The simplest workaround for the system administrator is to wrap the maker and viewer commands in a shell script which first sets the FM FLS variables to the correct value for the product and then starts the appropriate product For example bin sh shell script startup wrapper for Viewer and Maker This should be in the path before SFMHOME bin and SFMHOME must be defined This sample has not been tested and is 37 system administrator usage echo Usage maker viewer arg if S eq 0 then usage exit 1 else myname 1 shift case Smyname in maker imaker builder SFMHOME fminit env sh SFMHOME bin Smyname viewer FM_FLS_HOST localhost export localhost SFMHOME bin viewer x error case usage exit 1 End exampl provided as a point of departure for the interested ibuilder S 6 If a FrameMaker Viewer user runs on the license server e g an X terminal then that user must have a reserved license on another host as only one fm_f 1s process can run on any one machine 38 ISSUE 2 When I automatically generate hypertext links in a TOC Index etc my hypertext markers are not active ANSWER Make sure that your filenames are greater than one character ISSUE 3 When I access a hypertext link to page 2 of a docu
13. of graphic lends itself to the matrix command because each figure is the same size and the figures are divided into rows and columns matrix buttons The columns specifies the number of commands for columns of buttons the text eo these buttons are column will contain specified ina text Howname is the name of the flow column on a tag for the corresponding text reference page column on the reference page O e Co Ce postings message apiclient yourmessage Sends a message to MEET sage apiclient is the registered name of another application bra message 3 the API application that s already running yourmessage is the text passed to the API application Sheet 3 of 8 p 4ayeyowesy UIY IM X H d H Bune IN JO SIIUBYIIY OL Types of Hypertext Markers Available in FrameMaker 4 Continued Hypertext Name Purpose Syntax Example Comments message system Executes a platform specific command message system command Command is the command name as you would type it on any platform You can start other applications from within FrameViewer or a view only FrameMaker document using the message system hypertext command However the message system command is not cross platform compatible i e a Windows hypertext message commands will not work on the Unix platform x FrameMaker 4 for Windows Tip Under FrameMaker4 for Windows the following commands can
14. of topics or an alert box containing a few lines of information Oceans FIGURE 1 Example of Using Hypertext Planning an Online Document Section 1 2 Planning an Online Document What Types of Documenis Should go Online 1 Audience Considerations There are no absolute guidelines to determine what types of documents should go online however consider the following cost and value Will it be more expensive to produce online documents or printed documents Do the documents add inherent value to your business The following documents are good candidates for use online e Urgent Information Documents Material Safety Data Sheets Technical Notices Recall Notices Engineering Change Notices Software Change Notices e Evolving Documents Change Pages Sales Catalogs Price Lists Procedure Manuals Errata Sheets Supplements Replacement Chapters or Sections e Inter related Information Cross Referenced Information i e See Figure 2 on page 9 Repeated Data i e technical data that references the same figure throughout the entire document Related Documents i e See the Windows Reference Manual for additional informa tion Not all documents are good candidates for use online For example documents that con tain lengthy and detailed text i e abstract philosophy may be more easily read in hard copy In addition legal documents and those documents needed away from the computer as well as documen
15. this will now become a permanently locked document and offer to make a backup that is unlockable for future editing WARNING Always create a backup version of your document for future editing Frame Technology takes no responsibility for the safety nor the security of documents protected in the manner described above or like functions nor does it take responsibility for information rendered inaccessible by these means or other like functions You can use MIF statements to change the appearance and behavior of the document window in the following ways e To suppress the document window menu bar use the following statement lt DViewOnlyWinMenubar No This statement has no effect in the Macintosh and Microsoft Windows version of a Frame product because those versions have an application menu bar rather than a document window menu bar e To suppress the display of scroll bars and border buttons in the document window use the following statement lt DViewOnlyWinBorders No To suppress selection in the document window include the following statement lt DViewOnlySelect Nos 17 Using Active Cross References Disabling Commands Advanced Features of Hypertext e You can normally select text and objects in a locked document by Control dragging Specifying lt DViewOnlySelect No gt prevents all selection in a locked docu ment To suppress the appearance of a document region pop up menu use the following statement
16. 5 5 page size works well for most monitors even 13 monitors 2 What type of color capability will be available on the end user systems Choose colors that display well on all systems i e color tints do not display well on lower dpi monitors Use the lowest common denominator computer i e slowest when developing an online system if possible Consider using a color and underline FrameMaker Character Format if the end user system involves both color and monochrome monitors 3 Are the online documents for the help system stand alone or context sensitive Context sensitive help systems require more extensive planning Every location within your application must be identified where FrameViewer will be accessed Once these areas have been identified the Frame Developer s Kit FDK can be used to create context sensitive access See Context Sensitive Help on page 22 What fonts will be available on the end user system Will both paper and view only versions be issued simultaneously If both paper and view only versions will be issued simultaneously consider using FrameMaker s Conditional Text for the various versions Resolve Cross Platform Issues If your online system will be accessed from various hardware platforms consider the following e Use the 8 3 monocase filenaming convention for all files and directories e Use graphic file formats that display across all hardware platforms that the end user will be using i e
17. Automatically Generating Hypertext Section 1 4 Mechanics of Automatically Generating Hypertext Display Commands for Generated Hypertext Documents Hypertext markers can be automatically generated when you generate a Table of Con tents Index List of Figures List of Tables etc In addition all cross references create hypertext markers in Frame Viewer See Advanced Features of Hypertext on page 16 This features can significantly reduce the development process for creating online documents When the viewer clicks an active area in a generated hypertext document Frame Viewer displays the correct page in the source document For best results avoid using a Para graph Tag with the Frame Above or Frame Below on when automatically generat ing hypertext The following table lists some of the hypertext commands you can use for controlling how the source document is displayed The got 00b ject ID command is a special hypertext command used only in generated documents You should type the commands exactly as shown Use the lt relfilename gt building block to have FrameViewer create a relative pathname from the generated document to the other doc ument Otherwise use lt ful1filename gt for a full pathname The examples in the following table show only the lt fullfilename gt building block To display Type The highlighted item goto0bjectId centered in the current lt Sfullfilename gt lt SObjecType g
18. Contents Developing Online Documents with FrameMaker 4 1 Introduction to FrameMaker 4 and Frame Viewer 41 How Hypertext Works aaa 1 Planning an Online Document2 What Types of Documents Should go Online 2 Audience Considerations a an 2 System Planning 5s sexo sw ee ees PB AE ee ake aes Sa ee NPA DP Ee NG 3 Mechanics of Creating Hypertext within FrameMaker 44 Where to Place Hypertext Markers eee eens 4 Indicating an Active Area in Text ene eens 4 Creating Hypertext in a Graphic 2n 5 Creating Hypertext in the Same Place on Several Pages 5 Inserting Hypertext Markers and Commands 5 Types of Hypertext Commands aaa 6 Mechanics of Automatically Generating Hypertext15 Display Commands for Generated Hypertext Documents 15 Activating Hypertext Within FrameMaker 16 Locking a Document aa 16 Unlocking a Document 4n 16 Creating Nonprinting Buttons aan 16 Advanced Features of Hypertext16 Setting View Only Document Options naaa 16 Changing the Document Window 2 0n 17 Using Active Cross References aaa aan 18 Disabling Commands 200c cece eee ene eee 18 Moving Hypertext Documents from FrameMaker 3 to 419 Hypertext Changes 00ce cee n cece e nnn
19. Format in the Save As dialog box To lock a document without saving it press Esc F 1 k for File lock The command is case sensitive so be sure to type the letters as shown here On the Macintosh you can also press Command Option 3 This is a toggle command therefore repeat the proce dure to change the document back to editable format In addition hypertext commands can be activated without changing the document to View Only format by using one of the following commands Windows Alt Control click a hypertext marker Macintosh Control Option click a hypertext marker X Motif Control click right mouse button on a hypertext marker To edit a locked document you must unlock it first When the document is unlocked hypertext commands are inactive To unlock a document press Esc F1 k The command is case sensitive so be sure to type the letters as shown here You can create navigation buttons and other such graphics that won t print if your viewer prints the document To make a graphic nonprinting assign a color to the graphic and then put that color in the Don t Print list in the Set Up Separations dialog box In the same dialog box turn on Skip Blank Separation Pages Make sure Print Sep arations is turned on in the Print dialog box and that you click Save Setting Only For more information on making a color nonprinting and for printing separations see Chap ter 17 in the Using FrameMaker Manual for FrameMaker 4 Section 1 6
20. aa EE Wie aa ae NG 37 Developing Online Documents with FrameMaker 4 Revision 2 July 27 2010 Section 1 1 Introduction to FrameMaker 4 and FrameViewer 4 How Hypertext Works This document is intended to provide FrameMaker 4 user s issues and information related to designing online documents Much of the information contained in this docu ment can be found in following FrameMaker 4 manuals Using FrameMaker MIF Ref erence Changing Setup Files and Release Notes FrameMaker allows you to create sophisticated view only documents perfect for communication in an online environment using FrameViewer FrameMaker writers can both manually and automatically insert hypertext within documents so viewers can instantly review related pieces of information For example a viewer can click on an illustration in an online parts manual and view the inventory status for that particular product Or they can click on a photo in a newsletter and immediately browse through document archives related to the photo image In online documents you create hypertext links active areas between related pieces of information as the document writer Then when a viewer clicks a hypertext link a word phrase or graphic containing a hypertext command in Frame Viewer or a view only FrameMaker document the command is carried out For example the command may display another page in the same document or in a different document a pop up menu
21. ain help doc window When clclient needs to start Frame Viewer it also starts the FV help apiclient TheFV help apiclient adds the menu options keeps track of what help files are open and provides you with a more robust integration 26 Windows Specific Frame Viewer Information Command Line Options for fmclient Use the h or help option SFMHOME bin fmclient h fmclient display host dpy rpcProp propname fpname fmclient options n filename fmclient options p filename fmclient options f filename linkname Y N fpname is to specify the command to start the Frame product e g SFMHOME bin maker deutsch ER n opens a template as a new file p prints a file to SFMPRINTER SFMPRINTER must be defined f opens an existing file linkname specifies a hypertext link to jump to If the file specified is already open Y tells it to open a new window N not to The default is N If the file specified is a brand new file not already open YIN has no affect i e the file will always open in a new window If you wish to open a program other than maker set the environment variable SFM_PROGNAME to be viewer or imaker or builder etc Alternatively the command line flag fpname stands for Frame Product Name and can have the same argu ments as the environment variable To open a FrameViewer file without the Open dialog box appearing set the fol
22. ation page in a new document window use the following statement lt DViewOnlyXRef OpenBehavior gt Use this setting to allow users to see both the source page and the destination page To turn off active cross references use the following statement lt DViewOnlyXRef NotActive gt Use this setting to emulate the behavior in earlier FrameMaker releases You can use the lt DViewOnlySelect gt statement to control whether active cross ref erences highlight the destination text You might use this statement to improve the appearance of hypertext documents When cross references are active and lt DViewOnlySelect Yes gt is specified click ing a cross reference in the document highlights the destination text When cross refer ences are active and lt DViewOnlySelect UserOn1ly gt is specified clicking a cross reference does not highlight the destination text In the Unix and Windows versions of FrameMaker you can disable commands in a View Only document For example a hypertext author might disable cut copy and print commands for sensitive documents 18 Moving Hypertext Documents from FrameMaker 3 to 4 To disable a command you must supply the hex code called an fcode that internally represents that command in a Frame product For example you can disable printing cutting copying and unlocking the document by supplying the following statements lt DViewOnlyNoOp 0x313 gt Disable printing lt DViewOnlyNoOp 0x321 gt
23. cument When the document is opened in FrameViewer or as view only in FrameMaker these markers execute the specified commands The marker text specifies the command To locate these com mands in FrameMaker 4 simply select the Help Main Menu press Syntax Descrip tions then select Hypertext commands Important FrameMaker Frame Viewer remembers the origins of a viewer s last 69 jumps in the document window by storing them on a stack with the most recent jump on top The stack lets a viewer retrace his or her path In the following descriptions each command s effect on the hypertext stack is explained Listed below are the various types of hypertext commands that you can create with FrameMaker 4 Those commands listed with an asterisk affect the stack alert gotolink gotolink firstpage gotolink lastpage gotopage matrix message message system newlink nextpage openlink opennew openpage popup previouslink previouspage quit quitall 1 Commands in the matrix have the same effect on the stack as they would elsewhere 2 Creates a stack for the newly opened window but leaves the stack in the current window unchanged 3 Commands in the matrix have the same effect on the stack as they would elsewhere 4 Displays the last location stored on the stack Types of Hypertext Markers Available in FrameMaker 4 Hypertext Name Purpose Syntax Example Comments alert Displays an alert box a
24. ding to launch Frame Viewer from the distributed media If your distributed media is CD ROM FrameViewer will run slower than if it were installed locally or on a network drive CD ROM is one of the slowest media options and this is true for any MS Windows application This is more complicated to setup but is much more customizable for the end user Like the previous method you will copy an image of the installed Frame Viewer application to the master media along with the documents for distribution You will not need to edit the viewer ini file since this will not be the same for all end users You will need to write an installer to do the following e Ask the end user for a drive to copy a minimal set of files to e Check the destination drive to verify enough space exists approximately 3 2MB e Copy the files in the viewer4 directory to the destination drive including viewer ini and frame exe It is not necessary to copy the subdirectories of viewer4 This may be a little different if you are using Viewer Pro with Book marks and Notes e Edit win ini and add the following information FrameViewer4 FMHome x dirname IniFile x dirname viewer ini Where x is the drive letter for the Frame Viewer installation dirname is the absolute path to destination drive for FrameViewer and dirname viewer ini is the absolute path to the viewer ini file e Edit the copy of viewer ini in the installer destination directory so it s referr
25. e Flow com BR eee pop up mand to assign a tag that matches the name in the popup com menu whose items mand execute hypertext commands Th 4 Inthe Flow type the menu name and press Return menuitemsare In this example the menu name is HypertextCommands specified in a text 5 In each subsequent paragraph type a menu item column on a popup flowname popup reference page Frame Viewer for the Unix platforms will only show you 24 items per pull down There is not a limitation of Frame Viewer for the Macintosh flowname is the name of the flow tag for the corresponding text col umn on the reference page If necessary widen the text column so each item fits on a single line The flow tag cannot contain embedded spaces for example popup HypertextCommands Insert a hypertext marker in each line except the line with the menu name The text column containing the menu items and markers would look something like this Hypertextlommands Alert sotolink message system newlink nextpage operdink popup previcovslink quit p 19YENJWB14 UIY IM IX H d H DUNEB1D JO SIIUBYI9Y el Types of Hypertext Markers Available in FrameMaker 4 Continued Hypertext Name Purpose Syntax Example Comments When a viewer points on an active area containing the popup command and holds down the left mouse but
26. ee ene ene e eens 19 Using FrameViewer on Multiple Platforms 21 Cross Platform Issues21 Pathname Conventions 4 eee eee eee 21 Graphic FOrM ats se aa ck min voce ole be hoe tow oe Pee BS be ee ates 21 Context Sensitive Help22 Unix Specific Frame Viewer Information22 Entering Command Line Options for FrameViewer 4 for Unix 22 Specifying a File to Open on Start Up 0 0 aaa 22 Minimizing the Unix FrameViewer Installation 24 Contents LICENSING tied sot Lee eR Le EE eee 25 Context Sensitive Help for Unix cee eee 26 Windows Specific Frame Viewer Information27 Context Sensitive Help for Windows 2a aaa 27 Macintosh Specific Frame Viewer Information28 Distribution CD ROM Production a 29 CD ROM Technology29 Why Manufacture a CD ROM aan 29 Types of Data Stored on CD ROM cece ences 29 Updating CD ROM DiSCS cece ene 29 How Much Does It Cost eee eee eee 29 CD ROM Development and Production Processes 30 CD ROM Manufacturing Facilities aa 31 Unix Distribution Issues32 MS Windows Distribution Issues33 Uninstalled Application 00 cece cee eee eens 33 Installed Application Uncustomized eee e ene 33 Installed Application Customized 4 aa 34 Troubleshooting fwd Fis he Wie enc bide
27. en you generate a Table of Contents Index List of Figures List of Tables etc In addition all cross references create hypertext markers in Frame Viewer Section 1 3 Mechanics of Creating Hypertext within FrameMaker 4 Where to Place Hypertext Markers2 Indicating an Active Area in Text You can create hypertext in the following areas within FrameMaker 4 documents e Text so viewers can click a word phrase or sentence to see related information or hear related messages e Graphics so viewers can click a portion of a drawing for more information e The same place on several pages so viewers can easily retrace their path through the document s or page through an online document To use a word phrase or paragraph to indicate an active area select the text change its Character Format and insert a hypertext marker Choose a Character Format such as red and underline to visually indicate a hypertext area to the viewer Then when a viewer clicks in a text column in a locked document Frame Viewer highlights the area and per forms the hypertext command Frame Viewer ignores Character Formatting such as change bar spread case and pair kerning If you need to designate a word or phrase as hypertext without changing the character properties use a Character Format that sets all properties to As Is If you insert hypertext markers at the beginning or end of words text editing will be easier in the future
28. ewer looks for a hypertext marker on the Master Page You can override the Master Page hypertext areas on any Body Page of the document For example you may want the last page of every document not to contain a pagedown button since it is the last page To override a Master Page s active area put an active area or an object over it on a Body Page After you indicate hypertext areas in a document you are ready to insert hypertext markers and commands To insert 1 Choose Marker from the Special menu The Marker window will appear 2 Put the insertion point where you want to insert a marker Editing your document will be easier if you put markers at the beginning or end of a word 3 In the Marker Type scroll list select Hypertext pe FrameMaker Marker Marker Type Marker Text New Marker FIGURE 2 Selecting a Hypertext Marker in FrameMaker 4 for X Motif Types of Hypertext Commands Mechanics of Creating Hypertext within FrameMaker 4 4 In the Marker Text box type the hypertext command When inserting hypertext markers in text make sure that the hypertext marker is located with the Character Format change otherwise the hypertext area will be before the active area If you experience difficulty typing in characters into the Marker dialog box use the cross platform method of the forward slash See Pathname Conventions on page 21 Hypertext markers embed links or commands in a do
29. ext Name Purpose Syntax Example Comments gotolink firstpage Displays the first page of the document gotolink filename firstpage filename identifies a file other than the current one To go to the first page of the current file filename is not needed gotolink lastpage Displays the last page of the document gotolink filename lastpage filename identifies a file other than the current one To go to the last page of the current file filename is not needed The linkname in this command must match exactly the linkname in the newlink command For example a linkname with a trailing space differs from a linkname without a trailing space Also the linkname is case sensitive Changing Units differs from changing units The filename in a gotol ink command can contain a pathname When the pathname is relative FrameViewer searches for the relative pathname in the following directories in this order e The directory containing the document you re jumping from e install dir fminit usenglish helpdir where install dir is the directory in which Frame Viewer is installed See ISSUE 3 on page 39 gotopage Displays a specific page in the document got opage filename pagenumber filename identifies a file other than the current one To go toa specific page of the current file filename is not needed pagenumber is the number of the page to be displayed Frame Viewer will
30. file 20 Using FrameViewer on Multiple Platforms Section 1 1 1 Cross Platform Issues Pathname Conventions Graphic Formats The only cross platform hypertext links that are fully supported in FrameMaker 4 are those that use Unix style naming i e and where NO SPACES are allowed in any component of the filename The above rules are fully enforced on the Macintosh version of FrameMaker 4 when you have Unix compatibility chosen in the Preferences dialog If you have the Macin tosh compatibility chosen then slashes are still used but you can have spaces in the file names These types of hypertext links are not cross platform compatible and this is a convenience factor for Macintosh only online documents In addition the Macintosh product does not support colon based filename structures in hypertext links mean ing the paths to documents should not use colons in the path names It conflicts with hypertext markers and other specific commands such as firstpage The DOS style pathnames A mydir mydoc in hypertext links are NOT cross platform compatible and are discouraged TIFF file format is consistent across all hardware platforms and it is the easiest choice for images However color TIFF images may not be a good choice because they display very slowly on some systems i e 386 based systems with no RAM dedicated to the video Convert color images to monochrome if possible to avoid co
31. ges the entire paragraph would be active Even if the paragraph included more than one hypertext marker the entire paragraph would be active and the first marker in the paragraph would take effect In version 4 you can still use Character Formats to specify active areas However when a paragraph has more than one hypertext marker the paragraph is split by those markers into different active areas The markers indicate where each area starts and ends For example in a generated index entries that refer to multiple locations use different hypertext markers for each page number making each page number for the entry a different active area When you convert a FrameMaker version 3 hypertext document to version 4 if there are any paragraphs that include more than one hypertext marker the links might not work or they might not highlight correctly Look for incorrect hypertext markers and delete them For more information about active areas in text see Hypertext and view only docu ments in your Frame user s manual The message system command in a hypertext marker If you use a relative path in this command the path is relative to SFMHOME not to the location of the document that contains the hypertext marker This is not new to hypertext but it was not documented in earlier versions However you can use SFMDOCDIR to specify the absolute path for the current doc ument and FMDOCNAME to specify the name of the current document
32. gt a matching filename is not needed When Frame Viewer jumps to an openl ink command it creates a newline linkname is the name of the stack for the newly opened window but leaves the stack in the corresponding newlink current window unchanged Opens the specified file as an opennew filename penne untitled document filename identifies the file to be in a new document opened window openpage filename pagenumber Opens a new filename identifies a file other document window than the current one To go toa openpage and displays a specific page of the current file specific page in the filename is not needed document pagenumber is the page number of the page to display Sheet 5 of 8 p 19YENJWB14 UIY IM IX H d H Buyeasy JO SIIUBYIIY cl Types of Hypertext Markers Available in FrameMaker 4 Continued Hypertext Name Purpose Syntax Example Comments popup MyCommands displays a popup menu The items in the pop up menu are specified in a text column tagged MyCommands Each item is specified by a separate paragraph The hypertext command for each item is specified by inserting a hypertext marker into its corresponding paragraph For example to create a pop up menu used in the document to access the hypertext commands below 1 Create an active area to be associated with the pop up menu 2 Insert a hypertext marker containing a popup command Disol 3 On a reference page draw a text column and use th
33. icon or fi filename tapi Start API client programs when FrameViewer starts See API clients on page 24 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help api Start Frame Viewer without starting API client programs noapi See API clients on page 24 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help apiclient Start a specially designed API client program in a batch mode See API clients on page 24 of the Changing Setup Files document The Changing Setup Files docu ment is located under online Manuals in the FrameMaker 4 Help 22 Unix Specific Frame Viewer Information Start FrameViewer with this Option To clientBitmapSize n Specify the size in bytes of the memory buffer that holds the screen representation of imported images and font information on the client running Frame Viewer See Memory allocation for images and fonts on page 18 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help geometry wxh xty Specify the size and coordinates of the main Frame Viewer window For more information about specifying coordinates see Window positions and dimensions on page 21 of the Changing Setup Files document The Changing Setup Files d
34. ilesystem so as to avoid the semicolon 1 problem Section 1 3 MS Windows Distribution Issues Uninstalled Application Installed Application Uncustomized The following section outlines some distribution methods that might be used to distrib ute documents under FrameViewer for MS Windows Copy using the DOS command xcopy or something comparable the original FrameViewer diskettes to the master media The contents of each diskette needs to be in its own directory For example create a directory called disk1 for Disk 1 In addi tion make a directory for the documents you are shipping with FrameViewer these are the documents you want the end users to view For the next step you need to write an installer There are software packages available that can assist you with this procedure The installer will need to e verify there is enough disk space to install FrameViewer and the distributed docu ments e invoke the Frame Viewer installer the end user will need to provide a registration number for Frame Viewer e install your help documents The Frame Viewer installer will make the necessary entries in win ini and create the program group and icon in MS Windows This is the preferred method if Frame Viewer and the distributed documents are to be installed on a hard drive or network drive as it allows Frame Viewer to run the fastest With this method Frame Viewer and all of the documents are read directly from the
35. ing to the distributed media This way only the exe and ini files will need to reside on the local hard drive the rest of the files remain on the distributed media which will aid system performance 34 MS Windows Distribution Issues e Add a windows group and icon The icons may point to your documents as follows Name Widget Specification Report Path q dirname FRAME EXE VIEWER x ROOT subdir WID GET RPT Starting directory q dirname Icon z ICONS CUSTOM ICO Where x is the drive letter of the distributed media q is the drive letter where the copy of VIEWER4 is located and z is the drive letter where the icons reside which you made to represent the documents T You can create the icons and the other information ahead of time and have the installer just place them into the group The Installed Application Customized is the best way to setup FrameViewer on a CD ROM The end user can have an icon for each document or book file This technique provides the best performance while providing customized options during installation In addition each end user s setup can be unique Note however an entry must always be made within the win ini file for FrameViewer to launch If you are using Notes and Bookmarks of Frame Viewer Professional your installer may also have to write the correct entries within nts cfg You must purchase the right to distribute Frame Viewer with your doc
36. lert message message is the text that appears in the alert box The message can be up to 249 characters long FrameMaker Alert i Enter whatever text you want within this box There are three types of gotolinks The first type gotolink requires another marker to be placed in the document This additional marker is a hypertext marker called newlink See newlink on page 10 Gotolinks are different from openlinks because they do not open a separate document window gotolink Displays the page that contains a matching newlink gotolink filename linkname filename identifies the file that contains the matching newlink If the newlink is in the current file filename is not needed linkname is the name of the corresponding newlink This hypertext link jumps to the page of the specified document containing a newl ink command with a matching linkname For example the command gotolink Repair doc Brakes causes Frame Viewer to jump to the page in the document Repair doc that contains the newlink Brakes If Frame Viewer can t find the specified document or linkname it leaves the current page displayed If you need to resize the document window use the openlink command The gotolink command does not resize the document window Sheet 1 of 8 p 19YENJWB14 UIY IM X H d H BUNEB19 JO SIIUBYIIY Types of Hypertext Markers Available in FrameMaker 4 Continued Hypert
37. lor display issues Line art maybe a better alternative since it is cleaner and easier to read Line art also avoids all the potential image display issues 1 See the Changing Setup Files document under online Manuals in the FrameMaker 4 Help for additional information 21 Context Sensitive Help Section 1 2 Context Sensitive Help FrameMaker 4 allows you to develop online documents on any FrameMaker 4 sup ported platform however to develop context sensitive help the development methods vary by platform The following platform specific sections will provide additional information for developing context sensitive applications using FrameViewer 4 under Unix Windows and Macintosh Section 1 3 Unix Specific FrameViewer Information Entering Command Line Options for FrameViewer 4 for Unix Specifying a File to Open on Start Up To start FrameViewer with command line options type the command to start the pro gram a space an option name a space and a value if needed Begin each additional option with a space For example the following command starts Frame Viewer and opens a file viewer file filename or f filename Command line options allow you to specify a file to open automatically when FrameViewer starts Start FrameViewer with this Option To file filename or Open the file and display its document window f filename fileIconic filename Open the document and display it as an
38. lowing environment variable to read by fmclient FM_PROGNAME viewer noViewerFile or use the X resource Maker noViewerFile Tru Section 1 4 Windows Specific FrameViewer Information Context Sensitive Help for Windows To develop a context sensitive help system under Windows you will need the Windows version of the Frame Developer s Kit FDK The Windows version of the FDK allows other applications to asynchronously control the Frame product through an FDK client How is Asynchronous Communication Initiated Asynchronous communication is initiated by the application that wants to control the Frame session This application sends a message to the Frame product via the Windows function SendMessage in which it specifies the FDK client and the command an integer it wants the client to carry out For example SendMessage frame_hWnd WM_USER 12 calling_app_hWnd MAKELONG fdk dil instance intCommand 27 Macintosh Specific Frame Viewer Information After the application s call to SendMessage has returned it can continue carrying out its own processing The Frame product must be running in order for your application to send it a message So the application should check to see if Frame is running and if it is not then is can start a Frame session by calling the Windows function WinExec How Does Frame Respond The Frame product posts a deferred message to itself and then re
39. ment Frame Viewer dis plays 2 pages half of page and half of page 2 ANSWER The problem is caused by the hypertext link being too close to the edge of the page By moving the link farther away from the edge of the page the problem is resolved ISSUE 4 When I generate a book or list I get Internal Error 148E08 ANSWER This error occurs when a FrameMaker Character Format has been applied to the openOb ject Id hypertext command on the Reference Page of the generated list document Removing the Character Format on the Reference Page will eliminate the Internal Error ISSUE 5 I need my documents to support relative pathnames not absolute pathnames on the Windows platform How can I do this ANSWER In the viewer ini file located in the viewer home directory add the fol lowing line in the Directories section Directories Drive c In any hypertext link in a FrameMaker document use the following syntax gotolink lt Spath drive gt path path filename firstpage The drive letter c will be picked up in the path so that the command will be evalu ated to gotolink c path path filename firstpage If the documents are stored on any other drive all you have to do is change the drive variable in the viewer ini file 39 40
40. not be changed The data must be in a static form which means that it needs no further changes You can make changes only by updating the data and producing a new disc In today s world information is rarely static Frequent updates make useful information more expensive to acquire and produce on disc Yet some of the most useful and power ful CD ROM applications are those that are updated regularly Update frequency is determined by the nature of the data Information that changes reg ularly however may be suited for CD ROM storage If the information a customer wants to store is prone to change they must evaluate their willingness to update the CD ROM Updating the disc means future costs for a new CD ROM that contains the new information The cost of producing a CD ROM title depends on many factors The actual cost of physically replicating a CD ROM disc by mass production 500 or more copies is about 1 50 per disc 29 CD ROM Development and Production Processes CD ROM Technology Previously a small stamping of discs one to 25 was rather expensive With the intro duction of one off CD ROM writers from companies such as Sony JVC Ricoh and Philips the cost of producing a small quantity of CD ROMs has decreased You can for example purchase your own desktop disc mastering system for around 3 800 If you take the data through the production process you can have a single CD ROM cut by a service bureau for as lit
41. nvolve coding AppleEvent handlers in the api client for the AppleEvents you wish to send receive This method allows you to develop your own class of events that do exactly what you want within the Frame prod uct Using this method you send the AppleEvents to the Frame product and because your api client has registered its handlers with the Frame session it appears as if Frame supports the AppleEvents you need 28 Distribution CD ROM Production Section 1 1 CD ROM Technology Why Manufacture a CD ROM Types of Data Stored on CD ROM Updating CD ROM Discs How Much Does It Cost When CD ROM technology was first introduced many people considered CD ROM production a mysterious expensive and time consuming procedure Today companies can produce a simple CD ROM quickly and at a reasonable cost The vast storage capacity of CD ROM the low cost of CD ROM drives and the stan dards that are in place for the media all combine to make CD ROM the ideal way to distribute large amounts of information at a low cost CD ROM also is a cost effective way to distribute publish or gain access to information that you or your company works with on a regular basis The general rule to keep in mind when considering CD ROM is data is data The only differences between data stored on a hard disk and data stored on a CD ROM disc are the manner in which the data is arranged and the fact that after committed to CD ROM the data can
42. ocument is located under online Manuals in the FrameMaker 4 Help maxClientBitmaps num maxServerBitmaps num Specify the maximum number of images both bitmaps and EPSI files that the client running the Frame Viewer product can keep in memory See Memory allocation for images and fonts on page 18 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help Specify the maximum number of images both bitmaps and EPSI files that the server displaying the Frame Viewer product can keep in memory See Mem ory allocation for images and fonts on page 18 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help noViewerFil Start Frame Viewer without prompting the user to open a file See Resources for controlling Frame Viewer on page 28 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help serverBitmapSize n Specify the size in bytes of the memory buffer that holds the screen representation of imported images and font information on the server displaying the Frame Overproduce See Memory allocation for images and fonts on page 18 of the Changing Setup Files docu ment The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help tsplashscreen Di
43. ogram script that finds the PID under of the session and issues and O S kill signal Which files can be safely removed from a Unix Frame Viewer installation tree so as to make the smallest version needed to run the Frame Viewer product only Request Frame Technical Note 982 from Frame s Technical Support at com ments frame com or M F 6 5 PST at 408 922 2744 If I have limited the fonts used within the online documents to Times Courier Hel vetica and Symbol in bold underline and italic faces Can I reduce the number of supporting fonts in the FrameViewer Unix Directory The fonts in the file SFMHOME fminit fontdir fontlist are the ones available within the product Any font not used in your online document set can be deleted See Managing Frame Products about Installing Fonts and reverse the pro cedure of editing the fontlist for any files not needed The corresponding afm and bfont files can be removed All the dialog boxes fonts are supplied by the Xserver and are not part of the Frame Maker Viewer tree Can the different FrameViewer binaries for Unix use a single font set The entire FrameViewer for Unix product line at equivalent revision numbers e g 3 1a or 4 0 3 are explicitly designed to install into the same directory tree Only the binary programs the viewer executable the print driver filters utilities which are be different for various architectures are redundant however all other file
44. p KAO 6110 Peachtree Street Los Angeles CA 90040 213 725 6900 41474 Christie Street Fremont CA 945875 10 657 8425 Alshire International Inc 1015 Isabel Street Burbank CA 91506 213 849 4671 Americ Disc Inc 2525 Canadien Drummondville Que Canada J2B 8A9 819 474 2119 KAO 1857 Colonial Village Lane Lancaster PA 17601 717 392 7840 Metatec Discovery Systems 7001 Colonial Village Lane Dublin OH 43017 614 761 2000 American Multimedia Inc 2609 Tucker Street Burlington NC 27215 910 229 5554 Nimbus PO Box 7427 Charlottesville VA 22906 804 985 1100 ASR Recording Services of CA 8960 Eton Avenue Canoga Park CA 91304 818 341 1124 Pilz Compact Disc PO Box 220 Concordville PA 19331 215 459 5035 BQC Inc 2101 South 35th Street Council Bluffs A 51501 712 328 8060 Polygram Mfg Dist Centers Inc PO Box 400 Grover NC 28073 704 734 4100 Capitol Records 1 Capitol Way Jacksonville IL 62650 217 243 8661 Print NW Six Sigma 4101 Industry Drive East Suite D Fife WA 98424 206 922 0990 Cinram 2255 Markham Road Scarborough Ont Canada M1B 2W3 416 298 8190 Sanyo Laser Products 1767 Sheridan Street Richmond IN 47374 317 935 7574 Cinram 1600 Rich Road Richmond IN 47374 800 927 7749 Sonopress USA 108 Monticello Road Weaverville NC 28787 704 658 2000 31 Unix Distribution Issues Denon 1380 Monticello Road Madison
45. s are com mon to all platforms See Installation Notes Installing Frame Products on Multi ple Platforms 24 Licensing Unix Specific Frame Viewer Information 4 How can we control Frame Viewer window placement in Unix Window placement is controlled through xresources Resources for dialogs can be found in SFMHOME fminit 1langdir xresources Maker for FrameMaker version 4 If you are delivering Frame Viewer on a variety of platforms use a conser vative number towards the upper left corner of the X root window This prevents users of low resolution and or small screens from having dialog boxes appear off their screens The documents window s coordinates are stored when the document is saved and cannot be specified interactively or by external resources Can Frame Viewer be modified not to display its opening window and only start our opening document See Entering Command Line Options for Frame Viewer 4 for Unix on page 22 Can PATH variables be set to avoid placing specific paths to files within hypertext markers We do not recommend the specific shell variable SPATH the marker windows will use system environment variables in their path descriptions This is not a search path but a specific tree substitution You can use the environment variables SFMDOCDIR and FMDOCNAME with the message system commands When the viewer clicks an active area containing the command SFMDOCDIRis se
46. select the graphic object and move it behind the text column Change the text column s fill and pen patterns to None if necessary 4 Note The fcodes for disabling printing cutting copying and unlocking in a document are incorrectly specified in the MIF Reference Manual 5 See the Release Notes document under online Manuals in FrameMaker 4 Help for additional information 19 Moving Hypertext Documents from FrameMaker 3 to 4 Newlink command highlighting As a by product of allowing selection in view only documents when you jump to a newlink the marker is highlighted This is useful if you use automatically generated links to debug an index However you might want to turn off this feature for docu ments you created in earlier versions To turn off the highlighting of newlink markers import a MIF file that specifies how to handle selection in view only documents The MIF file should read as follows lt MIFFile 4 0 gt lt Document lt DViewOnlySelect UserOnly gt Turns off link selection but lets users select gt Instead of importing a MIF statement you can write your documents out to MIF and then edit the appropriate statements See Setting View Only Document Options on page 16 Active area highlighting In FrameMaker version 3 active areas in text were determined by placing a hyper text marker within the text and changing the Character Format of that text If there were no Character Format chan
47. splay the licensing window when starting a FrameViewer product See Start up messages on page 24 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help 23 Start FrameViewer with this Unix Specific Frame Viewer Information Option To splashscreen Do not display the licensing window when starting a nosplash FrameViewer product See Start up messages on page 24 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help tviewerIsServerl1l Start Frame Viewer without displaying the main window server See Resources for controlling Frame Viewer on page 28 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help viewerIsServer Start Frame Viewer and display the main window See Resources for controlling Frame Viewer on page 28 of the Changing Setup Files document The Changing Setup Files document is located under online Manuals in the FrameMaker 4 Help Minimizing the Unix FrameViewer Installation 1 Note that if you suppress the viewerkit there is no mechanism to exit Frame Viewer This can only be done through the GUI EXIT button or through external RPC client communi cation The only other way to kill the Viewer session is through an external pr
48. ssary for binary operation and cannot in any way be shortened for publishing in compliance with ISO9660 For this reason you need to create a tar or some other image that could be extracted to an end user s filesystem for Frame Viewer operation 32 MS Windows Distribution Issues In addition there are constraints even publishing cross platform capable documentation on CD ROM Hewlett Packard has implemented a version number for files on 9660 filesystem Files that would be read for example as filename doc 8 3 on a Sun mounted CD ROM would be seen by the HP as FILENAME DOC 1 The implica tions of this can be seen in our manual Installing FrameMaker for HP workstations Just for installation we tell the end user to double quote the filename to protect the semicolon against shell interpretation and to enter the file in all caps The same CD ROM mounted on a Sun has no such restrictions This has an impact within a hypertext document published on CD ROM One solution may be to create a separate tree with new links created for each hypertext link created for the HP system All those filenames would be referenced in the links as A_FILE DOC 1 rather than the a_file doc needed for the other systems However there is no mechanism in FrameMaker Viewer to automatically resolve these differ ences Note that if only one document tree is produced the tree needs to be installed onto the end user s hfs HP f
49. t window lt SObjectId gt x f j I The highlighted item ET a ort R lt Sfullfilename gt lt SObjecType gt centered in a new window lt SObjectId gt The page in the current gotopage window with nothing 2 highlighted lt Sfullfilename gt lt Spagenumonly gt The page in a new window openpage with nothing highlighted lt S fullfilename gt lt Spagenumonly gt An alert that displays the filename for the source document alert lt Sfullfilename gt 1 Do not apply Character Formats to the text when typing these commands 2 Avoid using the lt Spagenumon1y gt building block if your page numbers are alphabetic or Roman characters If your page numbers are alphabetic or Roman use the lt SOb ject Id building block instead 15 Activating Hypertext Within FrameMaker Section 1 5 Activating Hypertext Within FrameMaker Locking a Document Unlocking a Document Creating Nonprinting Buttons You can lock a document to test hypertext commands within FrameMaker Because your viewers see the locked document exactly as it appeared when you locked it you may want to turn off the display of the grid ruler text symbols and borders before locking it Also make sure that nothing is selected when you lock a document otherwise the selected object s handles will appear when a viewer opens the locked document To save a document in locked format use the Save As command and turn on View Only
50. t to the directory containing the current document and SFMDOCNAME is set to the name for the current document For example the command message system cp HyperDir Data SFMDOCDIR copies the file named Data from the HyperDir directory to the directory containing the current document The command message system cp HyperDir SFMDOCNAME Data SFMDOCDIR copies the file named the same as the current document with the extension Data from the HyperDir directory to the directory containing the current document Does the floating license scheme for FrameViewer operate in the same fashion as it does for Frame Installations You would need to negotiate an embedded licenses agreement for OEM to end user distribution with Frame Viewer in which case the Floating License Server may or may not be necessary Depending on the agreement you may decide to supply instructions to your end users on how to set up a Floating License Server in con junction with your product What environment variables must be set for each user to access the floating license on FrameViewer Unix There are two licensing variables required for Version 3 1 and two for version 4 0 FRAMEUSERSD_HOST v3 to identify the Floating License FM_FLS_HOST v4 servers host machine FRAMEUSERSD_AUTO v3 to identify the start up script to be FM FLS AUTO v4 executed on the host matching if the client viewer finds it is not running 25 Context Sensitive Help for Unix
51. tle as 99 Mastering facilities also offer special rates near 500 for one to ten prototype discs The demand for affordable CD ROM publishing prompted the CD ROM industry to find better and cheaper ways to make CD ROM available to a wider market Because consumers can farm out parts of the process to service bureaus they no longer need thousands of dollars equipment Today small businesses and individuals can pro duce CD ROMs on their desktops Process Purpose Data acquisition Assembling the information to be placed on the CD ROM Software acquisition Choosing an indexing and retrieval program that is suit able for your data Data Conversion Altering the data to a format that can be handled by the indexing and retrieval software Indexing Using the indexing and authoring software to catalog the data for searching and linking audio and graphics Premastering Putting the data in CD ROM format while it still resides on a hard disk Testing Simulating the CD ROM environment so that the appli cation s operation can be tested and optimized before committing it to a final premastered image to send to a mastering facility Mastering Producing the glass master and steel stamper for replicat ing CD ROM discs 30 CD ROM Technology CD ROM Manufacturing The following is a list of just some of the manufacturing replication facilities in the Facilities United States and Canada Allied Records Cor
52. ton Frame Viewer displays the following pop up menu gotolink matrix message system newlink popup con t neHtpage openlink popup previouslink quit quitall When a viewer chooses an item from the menu Frame Viewer executes the corresponding hypertext command and changes the stack as needed Help index Displays the last previouslink page the viewer previouslink viewed 1 1 he 1 4 4 8 Sheet 7 of 8 p 1 YEW WELIJ UIY IM X H d H Buyeasy JO sojueyooyy vl Types of Hypertext Markers Available in FrameMaker 4 Continued Hypertext Name Purpose Syntax Example Comments previouspage Displays the previous page of the current document previouspage quit Removes the current window from the screen quit The quit command is the same as the Close command in the Window menu If you edited the document and locked it without saving changes FrameMaker prompts you to save it before closing If several locked documents are open quit removes only the current locked document To remove all locked documents use the quitall command quitall Removes all view only windows from the screen including documents that are closed to an icon quitall Sheet 8 of 8 1 See the Power of FrameMaker 4 0 for Windows Chapter 23 by David B Doty for additional information p 4oyeyowesy UIY IM X H d H Buyeasy JO SIIUBYI9Y Mechanics of
53. ts for non computer users may not be good candidates for use online There are four primary areas to consider when planning an online document 1 Types of users Tasks that the users will perform How the users will interact with the online document P 9 N Types of documents the users will navigate 1 See Designing amp Writing Online Documentation by William K Horton for additional information System Planning Planning an Online Document After you have considered all the issues pertinent to your online audience strategize about the system planning For example consider the size of each document The viewer can display each page within a long document quickly however a long docu ment takes more time to open With a series of short documents typically 10 pages or less there is little delay when a viewer clicks an active area to display a page from another document Also consider whether you will open several document windows If so is it important to be able to retrace your jumps Remember each new open window starts its own stack for retracing jumps and the two do not merge See Types of Hypertext Commands on page 6 Determine the Method for Delivering Online Documents When planning an online document consider the following areas 1 What is the smallest screen size available to view these documents Choose a document size that displays best on all monitors For example an 8 5 by
54. turns one of the values listed below 99 if the Frame product is busy and can t process the request if the ID of the FDK client is bad or some other error occurred zero if the Frame product has successfully noted the request The Frame product responds to the deferred message by calling the FDK client s F_ApiCommand command callback function where command is the int Com mand that was specified by the application in the SendMessage function call The FDK client then calls FDK functions to perform document manipulation in the Frame session When the Frame product has carried out all of the FDK functions called by the FDK client it notifies the other application that it and the FDK client have finished processing its request The Frame product notifies the application of this by calling the Windows function PostMessage The application must have executed the Windows function call RegisterWindowMes sage FM ApiNotify in order to receive the message posted by the Frame product Section 1 5 Macintosh Specific FrameViewer Information Frame Viewer on the Macintosh supports the four following required AppleEvents e Open Application e Open Document e Print Document e Quit Application Knowing this you can use a utility such as AppleScript to send AppleEvents from within your application Another method you can use is to develop an api client with the Frame Developer s Kit FDK for the Macintosh This would i
55. uments whether on CD ROM or any media type If you are interested in during so contact any PC software reseller that carries FrameMaker or Frame Sales at 408 975 6000 In Europe please contact your local Frame Reseller or Frame Europe on 44 081 606 4100 35 MS Windows Distribution Issues 36 Troubleshooting ISSUE 1 We have FrameViewer for Unix as a help engine provided by another com pany In addition we also have FrameMaker for Unix internally When we start FrameViewer we get an error that there are no licenses installed Some users also get an error about not being authorized to use the product when starting FrameViewer or FrameMaker while others are able to use both concurrently How can we configure these two products to co exist ANSWER The problem occurs because two license servers are needed one for Frame Maker and one for the embedded Frame Viewer For FrameMaker all licenses can be administered by a central server Identification of the server in the user s environment is controlled by two system variables 1 FM_FLS_HOST hostname 2 FM_FLS_AUTO license server startup script FrameMaker Viewer pings the FM FLS HOST for a live server and if it does not receive a response it executes the script named in FM_FLS_AUTO For FrameViewer embedded licenses the value of the FM FLS HOST should be localhost and the auto start script should be in HOME fminit This conflict presents a problem
Download Pdf Manuals
Related Search