Re: Can no longer make a pdf of a large book
On 18 May 2009 at 17:03, Madeleine r Dimond wrote: I received a complaint from a writer who said that FrameMaker 9 took up so much processing power that she could not make a pdf of her 700-page book, even though she could do so in FrameMaker 8. We're using Windows XP SP2, and she has 3.25 GB of RAM. Madeleine, With the same 'processing power' at my workstation I observe the following: - IMHO the effect is idependent of FM8 or FM9 - the intermediate file (tps) of my 400 pages FM handout is about 250MB due to many screen shots and imbedded PDFs - the final PDF is about 5.5 MB - processing time and intermed. file size heavily depend on number of images, their resolution etc. Scaled down images in the FM document must be processed! - 'Save as PDF' creates the intermediate files in the same directories as the FM file is. If that is a network drive, significant time consumption must be envisioned! Even an USB disk might hamper your expectations. Klaus Daube ~~ Docu + Design Daube; Schäracher 11; CH-8053 Zürich Technical documentation consultancy; On-line and paper F: +41-44-422 86 25 E: d...@daube.ch W: www.daube.ch ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Motivating end users to read the training manual
Hi Gariner, I produce training manuals for a company in Cambridge. I suggest that you try and organise some training sessions for the engineers themselves, based around your documentation (or perhaps create a special 'engineer-friendly' version which doesn't make them feel they're being talked down to). That way, they will have a really good idea of what's in the documentation, and where to find things, and will also be more inclined to pass this information onto the customer. The company I work for actually makes every employee go on at least the level 1 training course - a sort of induction session. I think that's a really good idea. It might be that you can use the documentation as the basis for in- house training courses for the customer, which you can sell at a premium price. Hope this helps, Martin martin at em-dash dot com Message: 3 Date: Tue, 12 May 2009 16:43:25 +0530 (IST) From: Garnier Garnier garnier_framescr...@yahoo.co.in Subject: Motivating end users to read the user manual To: framers@lists.frameusers.com Message-ID: 533624.30265...@web94602.mail.in2.yahoo.com Content-Type: text/plain; charset=utf-8 Hi listers, I would like some feedback on this issue which I am sure most of us face. Please write to me directly as most of the time the mails form forums bounces and I do not receive them. Not sure about the reason. I put in a lot of effort to create an exhaustive training material. It includes all information in detail and all the steps too are documentented in simple English. The training material is very technical and includes all the required details and instructions. Still none of the engineers bother to read the contents and when they are at the customer site for training they start complaining that nothing is working. The engineers are familiar with the product no doubt about it but there are certain do's that they ought to know and which is documented in the training material which none bother to read. I welcome suggestions for improvement in the document or otherwise that will prompt the end user to read the training material contents instead simply complaining nothing is working. B/R Garnier ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Changing a whole lot of anchoring positions in FM 7.2
Hi Gerrit, You could use FrameScript to do this (http://www.framescript.com). If you need help with a script, please contact me offlist. Thank you very much. Rick Quatro Carmen Publishing Inc. r...@frameexpert.com 585-659-8267 Subject: Changing a whole lot of anchoring positions in FM 7.2 Hello all, I'm currently converting three large books to a new template in Framemaker 7.2 to make them consistent with our parent company's documentation set. The biggest problem that I've run into is the anchoring position of the anchored frames used for screenshots and illustrations. Our old template required an anchoring position of At the Insertion Point with an alignment of Center, but the new template requires the anchoring position to be Below the Current Line with an alignment of Left. After converting the files to the new template using a FM plugin provided by our parent company, the old anchoring position remains and the graphics are overlapping with the text -- and these books are screenshot-heavy. Does anyone have any tips or know of any plugins that would allow me to update the anchoring positions en masse, or at least do it in a way that's easier than updating each anchored frame individually? Google hasn't been much help. BTW, all of this is being done in unstructured Framemaker using version 7.2. Thanks, Gerrit Thompson ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Frame vs InDesign vs. alternatives??
Hello Framers, I am going to chime in here regarding InDesign scripting. InDesign offers several scripting options: AppleScript for the Mac version, Visual Basic for the PC version, and JavaScript for both. Since these languages have other applications, there are plenty of resources for learning them. In my experience, however, performance can be a major issue. Well-written JavaScript scripts can be painfully slow in InDesign, especially on long documents. For most scripting tasks that I have tackled, a FrameMaker/FrameScript workflow runs circles around a similar InDesign/JavaScript workflow. If your documentation process can benefit from automation, and you can do without InDesign's unique features, you are usually better off staying with FrameMaker and FrameScript. Rick Quatro Carmen Publishing Inc. r...@frameexpert.com 585-659-8267 ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Procedure How to Write a Manual!
Sure do Rick. It's actually a slide presentation on good manual design and development, including how to estimate the time it takes to develop several types of docs. I'm writing you directly so that the attachment will go through. Diane Gaskill Hitachi Data Systems == -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com]on Behalf Of Richard Melanson Sent: Thursday, May 14, 2009 10:58 AM To: Avraham Makeler; framers@lists.frameusers.com Subject: Procedure How to Write a Manual! First, thank you Everyone, you guys always have the answers to questions, even when I don't post questions :-) I just want to share this with the list and absorb the response. My boss today told me to write a procedure on how to write a manual and he also stated to me that anyone could be a writer, he did not understand what all the fuss was about tech writing, anyone could do it. Needless to say, I am still sitting at my desk trying to sort through the myriad of reactions I am having! I cant wait to hear everyone's thoughts. Rick PS: Does anyone have a procedure how to write a manual ;-) ___ You are currently subscribed to Framers as dgcal...@earthlink.net. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/dgcaller%40earthlink.net Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Procedure How to Write a Manual
If anyone can write a manual, why do you need to write a procedure for doing it? Let your boss do it if he thinks it's so easy. ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Procedure How to Write a Manual!
-Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Sharon Burton This is easy. 14 steps: 1. Identify the audience 2. Identify the information needs of that audience (job aids, user guides, and so on) 3. Identify the tasks the audience needs to do 4. Identify the supporting info the audience needs to do those tasks 5. Identify the best way to deliver the information (PDF, help, others) 6. Create a plan that layout all this information 7. Assign time estimates to the plan 8. Decide what can be cut due to time limitations 9. Start creating the information, adapting to the changing product 10. Review by others 11. Make the review changes 12. Build gold candidates 13. Deliver the finals 14. Archive the finals, including all planning information Of course, these steps include a lot of embedded steps and domain knowledge in our field. But these are the steps. I think you skipped something important: 1. Hire a tech writer. Bob Let what comes, come, Let what goes, go, Find out what remains. Sri Ramana Maharshi ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Procedure How to Write a Manual!
-Original Message- From: Avraham Makeler; framers@lists.frameusers.com Subject: Procedure How to Write a Manual! I just want to share this with the list and absorb the response. My boss today told me to write a procedure on how to write a manual and he also stated to me that anyone could be a writer, he did not understand what all the fuss was about tech writing, anyone could do it. Needless to say, I am still sitting at my desk trying to sort through the myriad of reactions I am having! I cant wait to hear everyone's thoughts. PS: Does anyone have a procedure how to write a manual ;-) ___ Now, if you are primarily a tech writer by vocation, you really are joking, right? You do know the procedure for writing a manual. You also understand that to eat an elephant, you have to know how to make it into hamburgers. Someone (you? your boss? his boss?...n?) is authorised *and therefore obliged by job description* to enforce a company policy regarding creation and maintenance of written procedures at all levels. If it's your job in the department to ensure that procedures have proper and sufficient documentation then your How to Write Procedures procedure should be in circulation already. Is it? At 02:50 AM 19/05/2009, Flato, Gillian wrote: Your boss is a Jackass with poor people skills. If How to Write Procedures is already in circulation, why does the boss have to ask for it? Is it good enough? (Does it work?) Does he know it exists? Can he read? If not - isn't he just doing his Boss job? Shouldn't you be grateful that he's only insulting you, when he'd really like to have your guts for garters? Gillian wrote: He just told you that he doesn't appreciate or value you or your job. If layoff time comes, you're the first to go since anyone can be a writer and what's the fuss. It could have quite a different readingif he really believed that it were so easy, he would have written the How to Write a Manual procedure himself, handed it to you and told you to go get. Maybe he did...and you didn't. Your boss is not *totally* out of his tree if he means that anyone could be a provider of essential content for procedure documentation. To arrive at the state where there is a company manual encompassing every procedure in the organisation *requires* the responsible experts in each domain to abstract and articulate the right way to do every task. In this sense, even a dyslexic paint-blender must be able to perform as a content informant for the written paint-blending procedure -- even if you have to provide how-to videos of the questions each informant has to answer and voice recorders to capture the answers. It's time to transfer to another dept in your company or polish your resume and look for another job. On the other hand, if it's Avram's job to make the company manual happen, and it's not happening, then keeping the resume as-is could be safer... ;-) Helen ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Re: Motivating end users to read the user manual
I still say you have to figure out a way to make it easier for them to find the information that has changed, without rereading the entire manual. Perhaps you could list a version history with what's new in each version. Then you could ask the engineer to check the version history and read the related sections of the manual before complaining that it doesn't work. -- Regards, Shmuel Wolfson Technical Writer 052-763-7133 Garnier Garnier wrote: Hello Nancy/Shmuel/Sharon, others, Thanks for the response. I handle documentation for the EDA (Electronic Design Automation) industry. All user/reference/training manuals are very technical so am not sure if having a separate dos and don’t's page(s) would help because it will vary with each design and with simulator/synthesizer that the user selects for the simulation or synthesis. Still thanks for the suggestion I will try to explore the same. I agree with Nancy as the management support is definitely important. I am not defending myself. Whenver a new recruit has to go through the training as part of induction they are able to simulate each of the design convered in the training material. Since the new recruits are not aware of the product they end up reading each page of the training material and able to perform each step as required- like changing the block parameters before simulation or compiling the imported blocks before adding to the design for simulation etc. Whereas the existing field engineers are aware of the product so never bother to read the contents. For example one of the engineers attempted to perform C simulation for a design with imported blocks. This is because any design with imported blocks needs to be compiled separately before adding it to the design and then one needs to run Co-simulation or RTL Simulation. In this case C simulation will fail. This concept is clearly documented but the engineer kept sending nasty mails complaining that the design is faulty. I then sent him the page number of the material wherein the instructions are clearly mentioned. After that he did not bother to respond because he could then run the simulations successfully. Or the Engineer attempting to run the tool on a RHEL version that we do not support. The S/W and H/W requirements are clearly documented still whatever is available at the client end they attempt to run the designs on that OS. There are many such similar cases. During my appraisal this issue was brought up and I have been asked to find methods as to how I can compel the engineers to read the contents. How can I when the engineer is overconfident about his knowledge about the product? It is for the managers to bring this up. As already mentioned the new recruits have never complained and used the same training material to understand the product/module whereas the existing engineers are constantly complaining. The saddest part is whenever there is a feature addition/modification the contents are immediately updated and mails sent to all engineers with a request to exercise the new/modified features and also provide feedback. Nobody responds. When they go for customer training they start using the new feature without reading the modified contents. Assuming the working of a feature and actual working of a feature are different. When a feature does not yeild the required results because of the modifications then I start receiving harsh mails that the designs are not working as expected. Since I handle the training material all the barbs are directed to me even if the design is faulty for which the RD is responsible. Though a writer over a period of time I have gained sufficient knowledge about the product so always test each feature myself before making it available to Engineers. Now I am definitely at a loss as to how the situation can be improved. As Nancy suggested the head of the Engineers should pressurize them to do their homework before visiting the customers for training or use the material during their free time to understand the module and also provide feedback for further improvement. Looks like I am asking for the impossible as this never happens. Thanks once again to each one of you. Warm Regards, Garnier -Original Message- From: Nancy Allison [mailto:ma...@verizon.net] Sent: Monday, May 18, 2009 7:11 PM To: garnier_framescr...@yahoo.co.in Subject: Re: Motivating end users to read the user manual And, again, this time with Plain Text selected. Hi, Garnier. I'm replying to you individually and copying to the forum, because I'm really interested in other people's responses, as well. I'm working at a company where the head of engineering says, Nobody reads the manual. Basically, they've written off the value of what I do and therefore don't support it. Sounds a bit like your place. I believe the most important element to changing your situatkion
Re: Procedure How to Write a Manual
On Facebook this would be tagged Like! by many. :-) Bodvar Bjorgvinsson 2009/5/18 stre...@rcn.com: If anyone can write a manual, why do you need to write a procedure for doing it? Let your boss do it if he thinks it's so easy. ___ You are currently subscribed to Framers as bod...@gmail.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/bodvar%40gmail.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info. -- Life is not only a game--it is also a dance on roses. --Fleksnes (Rolv Wesenlund) ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
ANN: Converted Imported By Copy to Imported By Reference
On behalf of Rick Quatro: Hello Framers, There have been some recent requests for a solution to convert graphics imported by copy to graphics imported by reference. I have developed a set of FrameScript scripts to help with this. The first is an interactive script that works like this: 1) Select the graphic that is imported by copy. 2) Run the script by pressing a shortcut key. 3) The script will prompt you with a dialog box where you enter the graphic type, dpi, filename, etc. The settings are sticky so that they will be remembered the next time you run the script. 4) The script exports the graphic according to the specified settings, then re-imports it by reference. 5) The original by copy graphic is deleted. Since this script is interactive, you have to touch each graphic that you want to process, but this gives you maximum control over the settings and filename. For a more automated approach, there is a companion script where you set the graphic type and dpi once in an INI file. You also specify a folder for the graphics and a prefix for the graphic filenames. The script then goes through the entire document or book and processes all of the by copy graphics according to the INI file settings. Both of these scripts require FrameScript. If you are interested, please contact me offlist. Thank you very much. Rick Quatro Carmen Publishing Inc. r...@frameexpert.com 585-659-8267 ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Re: Can no longer make a pdf of a large book
On Mon, May 18, 2009 at 7:24 PM, Combs, Richard richard.co...@polycom.com wrote: Processing power? Not likely (I'm tempted to say nonsense). How was she creating the PDF? When and how did it fail? The log file for the job (which should be in the directory in which the PDF was being created) shows which pages were successfully processed, when the process failed, and what error occurred. That information is necessary for the list to provide any meaningful suggestions. Thank you, Richard and others. I was quoting the writer. Her words were exactly as much as I knew at the time. I'll be seeing the file today and will go through all the usual processes. Best, Madeleine ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Re: Motivating end users to read the user manual
On Tue, 19 May 2009 13:34:31 +, Bodvar Bjorgvinsson bod...@gmail.com wrote: Agree with Shmuel. This is common in higher technical documentation, called Revision Highlights or Highlights of Changes or similar. Sometimes sent as a transmittal letter accompanying the distributed manual, and sometimes more like a part of the manual front matter pages. +1 If you want to see an example of it, look at the Mif2Go User's Guide, in the opening About this guide section, under New information. All the brief descriptions of changes are linked to the affected content elsewhere in the manual. The User's Guide is free, available in a dozen formats (including Frame 7) at: http://www.omsys.com/dcl/download.htm#Mif2Go_UG -- Jeremy H. Griffith, at Omni Systems Inc. jer...@omsys.com http://www.omsys.com/ ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Screen captures and sizing
Hi all, [from a lurker on daily digest, sorry if this is late] Here is the current comment from a client: Generally, I would like to keep high quality of screen captures. The comment that I have from the client is what I have - nothing specific about fuzziness, or anything else. Tammy, if that is the only comment you have about graphics from the customer, when taken literally, it is a compliment. You don't say whether you're new to this customer's documentation, so I can't tell if it's a reflection of your past work or a veiled request on your future work. Either way, you have what I would consider a solid process for getting sharp screen shots into the docs. As others have pointed out, there are probably some things that can happen after that, but it's just a matter of a few settings. For reference, my screen-shot process is generally similar, but I have a few refinements I haven't seen mentioned here. I'm running FM 8 on Vista. I use the MS Snipping Tool that comes with Vista, and save directly to PNG. I always draw and clip a rectangle box and give myself about 10 pixels around the actual GUI item I want. From there, I open the image in Gimp, a free photo editor that has some handy features for working with PNGs. For example, I mostly work at 150 dpi in Frame, so I have that set up as my default save option. Once the dpi is in the PNG, FM automatically takes that as the default (I learned that on this list a few months ago). I like to zoom to 400% and see every pixel in my screenshot, so I can crop it just right. Cropping is easy because you can draw the box and then move each border independently to get what you want. In my docs, I generally try to have screenshots at only 3 different DPIs: - 96 for small icons and such that usually go inline (this makes easy to see because they are about the same size as in the GUI when viewed at 100% in PDF) - 150 for most dialogs and screens, which keeps all text easily readable. - 200 or 300 if I have to present a full screen layout. (Although I've been basing that on the 600 dpi of most laser printers; I like Ian's suggestion to optimize for PDF viewing in Acrobat.) 90% of my screenshots are at the 150 dpi setting, which I like to think keeps the perspective consistent for the reader. However, when editing the capture, I take some liberties with the actual screen contents. I always make my window as small as possible before the screenshot, but the GUI is still often too large. For example, if a dialog box has a lot of white-space somewhere, especially vertically, I copy-paste the border to cover up some of the extra space, then recrop the box. Or if the screen is too wide, I move some of the fields and elements closer together. The idea is that the reader needs to see something that looks like the product, not the exact pixels. With the image editor, I can also fix bugs in the GUI, even typos in the labels, so I don't have to wait for engineering to generate the fix and I dont' have to set up the screenshot again. It's a bit of an art, and sometimes a bit complicated to move the dialog elements, especially if they're on a gradient background, but as long as the end result keeps the general relative dimensions of the actual GUI, the reader gets the needed info in a clearer way. Anyways, thanks to all who contribute regularly here, I've learned a lot reading this list. Andy ak...@jaspersoft.com ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Exporting the paths of graphics used
You must have used the List of menu item instead of the Index of one that Jeremy suggested. The index one should generate an alphabetical list. Jeff -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Susan Curtzwiler Sent: Tuesday, May 19, 2009 5:09 PM To: Jeremy H. Griffith; framers@lists.frameusers.com Cc: Susan Curtzwiler; Chinell, David F (GE EntSol,Security) Subject: RE: Exporting the paths of graphics used Hi, I'd like to join this email about making a list of figures in alpha order. I followed the directions below and all I got was a blank FMKR page. Then I went to just make a list of figures as a stand alone file, not part of the book file. That worked great, I got the list. 1. Now, how do I alphabatize them. 2. Isn't there a simple sort feature like Word? Seems like then I could make the sorted list as a template and work thru the entire book. 3. Is their an easier way to work within the complete book file to get a full list of figures at one time? 4. Also, make a list of tables. I want to use this same technique to make a list of the titles from my TOC, and arrange them either by WI number or alpha to create a quick hyperlink file for users easy reference. Using FM7.0, Adobe Distiller 5.0, Vista Enterprise. Thnaks, Sue From: framers-boun...@lists.frameusers.com on behalf of Jeremy H. Griffith Sent: Sun 5/17/2009 6:20 PM To: framers@lists.frameusers.com Cc: Chinell, David F (GE EntSol, Security) Subject: Re: Exporting the paths of graphics used On Tue, 12 May 2009 12:23:20 -0400, Chinell, David F (GE EntSol, Security) david.chin...@ge.com wrote: Is there any way to create a list of the graphics used in a FM file, including the path name of the file? Sure. From the Special menu, generate a List of - References (or an Index of - References, if you prefer them alphabetical), and select Imported Graphics as what to include. HTH! -- Jeremy H. Griffith, at Omni Systems Inc. jer...@omsys.com http://www.omsys.com/ ___ You are currently subscribed to Framers as susa...@vmc.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/susancu%40vmc.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as jeff.coatswo...@jonassoftware.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/jeff.coatsworth%40jo nassoftware.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Exporting the paths of graphics used
Susan Curtzwiler wrote: I followed the directions below and all I got was a blank FMKR page. Then the FM file or book for which you generated the list or index doesn't contain any graphics imported by reference. FM doesn't know the file path and name of graphics copied into the document (there's no point). Then I went to just make a list of figures as a stand alone file, not part of the book file. Do you mean that within a single FM file, not a book, you selected Special List of Figures? OK, then in the Set Up List of Figures dialog, you had to select the paragraphs to include (your figure captions). But now you've changed the subject completely. Lists of figures, tables, etc., are lists of paragraphs in FM. That's very different from a list of imported graphics, fonts, text insets, or other references. That worked great, I got the list. 1. Now, how do I alphabatize them. Select Special List of Paragraphs (Alphabetical) -- or for a book, Add List of Paragraphs (Alphabetical) -- and select the paragraphs to include. 2. Isn't there a simple sort feature like Word? Seems like then I could make the sorted list as a template and work thru the entire book. I don't understand. 3. Is their an easier way to work within the complete book file to get a full list of figures at one time? What is it that you can't do with (from the book window) Add List of Figures or Add List of Paragraphs (Alphabetical)? 4. Also, make a list of tables. What is it that you can't do with (from the book window) Add List of Tables or Add List of Paragraphs (Alphabetical)? I want to use this same technique to make a list of the titles from my TOC, and arrange them either by WI number or alpha to create a quick hyperlink file for users easy reference. I don't understand. But again, List of Paragraphs (Alphabetical) will give you alpha lists of whatever paragraph format(s) you want (like Head1, Head2, ...). I don't know what a WI number is, but maybe if you spend some quality time with the generated lists topics in the help or user manual, you can figure out how to do something with that, too. FM's generated lists functionality is pretty robust and versatile. HTH! Richard Richard G. Combs Senior Technical Writer Polycom, Inc. richardDOTcombs AT polycomDOTcom 303-223-5111 -- rgcombs AT gmailDOTcom 303-777-0436 -- ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Lists of figures and tables in alpha order (was FW: Exporting the paths of graphics used)
You'd think that after gently chiding Susan for having changed the subject completely, I'd remember to change the subject line of my reply, wouldn't you? Sorry! Here it is for the archives. -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Combs, Richard Sent: Tuesday, May 19, 2009 4:10 PM To: Susan Curtzwiler; framers@lists.frameusers.com Subject: RE: Exporting the paths of graphics used Susan Curtzwiler wrote: I followed the directions below and all I got was a blank FMKR page. Then the FM file or book for which you generated the list or index doesn't contain any graphics imported by reference. FM doesn't know the file path and name of graphics copied into the document (there's no point). Then I went to just make a list of figures as a stand alone file, not part of the book file. Do you mean that within a single FM file, not a book, you selected Special List of Figures? OK, then in the Set Up List of Figures dialog, you had to select the paragraphs to include (your figure captions). But now you've changed the subject completely. Lists of figures, tables, etc., are lists of paragraphs in FM. That's very different from a list of imported graphics, fonts, text insets, or other references. That worked great, I got the list. 1. Now, how do I alphabatize them. Select Special List of Paragraphs (Alphabetical) -- or for a book, Add List of Paragraphs (Alphabetical) -- and select the paragraphs to include. 2. Isn't there a simple sort feature like Word? Seems like then I could make the sorted list as a template and work thru the entire book. I don't understand. 3. Is their an easier way to work within the complete book file to get a full list of figures at one time? What is it that you can't do with (from the book window) Add List of Figures or Add List of Paragraphs (Alphabetical)? 4. Also, make a list of tables. What is it that you can't do with (from the book window) Add List of Tables or Add List of Paragraphs (Alphabetical)? I want to use this same technique to make a list of the titles from my TOC, and arrange them either by WI number or alpha to create a quick hyperlink file for users easy reference. I don't understand. But again, List of Paragraphs (Alphabetical) will give you alpha lists of whatever paragraph format(s) you want (like Head1, Head2, ...). I don't know what a WI number is, but maybe if you spend some quality time with the generated lists topics in the help or user manual, you can figure out how to do something with that, too. FM's generated lists functionality is pretty robust and versatile. HTH! Richard Richard G. Combs Senior Technical Writer Polycom, Inc. richardDOTcombs AT polycomDOTcom 303-223-5111 -- rgcombs AT gmailDOTcom 303-777-0436 -- ___ You are currently subscribed to Framers as richard.co...@polycom.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/richard.combs%40poly com.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Exporting the paths of graphics used
Richard, Thank you for the detailed information. I will work with them this afternoon. Cheers, Sue From: Combs, Richard [mailto:richard.co...@polycom.com] Sent: Tue 5/19/2009 3:09 PM To: Susan Curtzwiler; framers@lists.frameusers.com Subject: RE: Exporting the paths of graphics used Susan Curtzwiler wrote: I followed the directions below and all I got was a blank FMKR page. Then the FM file or book for which you generated the list or index doesn't contain any graphics imported by reference. FM doesn't know the file path and name of graphics copied into the document (there's no point). Then I went to just make a list of figures as a stand alone file, not part of the book file. Do you mean that within a single FM file, not a book, you selected Special List of Figures? OK, then in the Set Up List of Figures dialog, you had to select the paragraphs to include (your figure captions). But now you've changed the subject completely. Lists of figures, tables, etc., are lists of paragraphs in FM. That's very different from a list of imported graphics, fonts, text insets, or other references. That worked great, I got the list. 1. Now, how do I alphabatize them. Select Special List of Paragraphs (Alphabetical) -- or for a book, Add List of Paragraphs (Alphabetical) -- and select the paragraphs to include. 2. Isn't there a simple sort feature like Word? Seems like then I could make the sorted list as a template and work thru the entire book. I don't understand. 3. Is their an easier way to work within the complete book file to get a full list of figures at one time? What is it that you can't do with (from the book window) Add List of Figures or Add List of Paragraphs (Alphabetical)? 4. Also, make a list of tables. What is it that you can't do with (from the book window) Add List of Tables or Add List of Paragraphs (Alphabetical)? I want to use this same technique to make a list of the titles from my TOC, and arrange them either by WI number or alpha to create a quick hyperlink file for users easy reference. I don't understand. But again, List of Paragraphs (Alphabetical) will give you alpha lists of whatever paragraph format(s) you want (like Head1, Head2, ...). I don't know what a WI number is, but maybe if you spend some quality time with the generated lists topics in the help or user manual, you can figure out how to do something with that, too. FM's generated lists functionality is pretty robust and versatile. HTH! Richard Richard G. Combs Senior Technical Writer Polycom, Inc. richardDOTcombs AT polycomDOTcom 303-223-5111 -- rgcombs AT gmailDOTcom 303-777-0436 -- ___ You are currently subscribed to Framers as arch...@mail-archive.com. Send list messages to fram...@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Can no longer make a pdf of a large book
On 18 May 2009 at 17:03, Madeleine r Dimond wrote: > I received a complaint from a writer who said that FrameMaker 9 took up so > much processing power that she could not make a pdf of her 700-page book, > even though she could do so in FrameMaker 8. We're using Windows XP SP2, > and she has 3.25 GB of RAM. Madeleine, With the same 'processing power' at my workstation I observe the following: - IMHO the effect is idependent of FM8 or FM9 - the intermediate file (tps) of my 400 pages FM handout is about 250MB due to many screen shots and imbedded PDFs - the final PDF is about 5.5 MB - processing time and intermed. file size heavily depend on number of images, their resolution etc. Scaled down images in the FM document must be processed! - 'Save as PDF' creates the intermediate files in the same directories as the FM file is. If that is a network drive, significant time consumption must be envisioned! Even an USB disk might hamper your expectations. Klaus Daube ~~ Docu + Design Daube; Sch?racher 11; CH-8053 Z?rich Technical documentation & consultancy; On-line and paper F: +41-44-422 86 25 E: ddd at daube.ch W: www.daube.ch
Procedure How to Write a Manual!
>-Original Message- >From: Avraham Makeler; framers at lists.frameusers.com >Subject: Procedure How to Write a Manual! > >I just want to share this with the list and absorb the response. My boss >today told me to "write a procedure on how to write a manual" and he >also stated to me that anyone could be a writer, he did not understand >what all the fuss was about tech writing, anyone could do it. Needless >to say, I am still sitting at my desk trying to sort through the myriad >of reactions I am having! I cant wait to hear everyone's thoughts. > >PS: Does anyone have a procedure how to write a manual ;-) >___ Now, if you are primarily a tech writer by vocation, you really are joking, right? You do know the procedure for writing a manual. You also understand that to eat an elephant, you have to know how to make it into hamburgers. Someone (you? your boss? his boss?...n?) is authorised *and therefore obliged by job description* to enforce a company policy regarding creation and maintenance of written procedures at all levels. If it's your job in the department to ensure that procedures have proper and sufficient documentation then your "How to Write Procedures" procedure should be in circulation already. Is it? At 02:50 AM 19/05/2009, Flato, Gillian wrote: >Your boss is a Jackass with poor people skills. If "How to Write Procedures" is already in circulation, why does the boss have to ask for it? Is it good enough? (Does it work?) Does he know it exists? Can he read? If not - isn't he just doing his Boss job? Shouldn't you be grateful that he's only insulting you, when he'd really like to have your guts for garters? Gillian wrote: >He just told you that he doesn't appreciate or value you or your job. If >layoff time comes, you're the first to go since "anyone can be a writer and >what's the >fuss." It could have quite a different readingif he really believed that it were so easy, he would have written the "How to Write a Manual" procedure himself, handed it to you and told you to "go get". Maybe he did...and you didn't. Your boss is not *totally* out of his tree if he means that "anyone" could be a provider of essential content for procedure documentation. To arrive at the state where there is a company manual encompassing every procedure in the organisation *requires* the responsible experts in each domain to abstract and articulate the right way to do every task. In this sense, even a dyslexic paint-blender must be able to perform as a content informant for the written paint-blending procedure -- even if you have to provide how-to videos of the "questions" each informant has to answer and voice recorders to capture the answers. >It's time to transfer to another dept in your company or polish your resume >and look for another job. On the other hand, if it's Avram's job to make the company manual happen, and it's not happening, then keeping the resume as-is could be safer... ;-) Helen
Motivating end users to read the user manual
I still say you have to figure out a way to make it easier for them to find the information that has changed, without rereading the entire manual. Perhaps you could list a version history with what's new in each version. Then you could ask the engineer to check the version history and read the related sections of the manual before complaining that it doesn't work. -- Regards, Shmuel Wolfson Technical Writer 052-763-7133 Garnier Garnier wrote: > Hello Nancy/Shmuel/Sharon,& others, > > Thanks for the response. I handle documentation for the EDA (Electronic > Design Automation) industry. All user/reference/training manuals are very > technical so am not sure if having a separate dos and don?t's page(s) would > help because it will vary with each design and with simulator/synthesizer > that the user selects for the simulation or synthesis. Still thanks for the > suggestion I will try to explore the same. > > I agree with Nancy as the management support is definitely important. I am > not defending myself. Whenver a new recruit has to go through the training as > part of induction they are able to simulate each of the design convered in > the training material. Since the new recruits are not aware of the product > they end up reading each page of the training material and able to perform > each step as required- like changing the block parameters before simulation > or compiling the imported blocks before adding to the design for simulation > etc. Whereas the existing field engineers are aware of the product so never > bother to read the contents. For example one of the engineers attempted to > perform C simulation for a design with imported blocks. This is because any > design with imported blocks needs to be compiled separately before adding it > to the design and then one needs to run Co-simulation or RTL Simulation. In > this case C simulation will fail. This concept is clearly > documented but the engineer kept sending nasty mails complaining that the > design is faulty. I then sent him the page number of the material wherein the > instructions are clearly mentioned. After that he did not bother to respond > because he could then run the simulations successfully. Or the Engineer > attempting to run the tool on a RHEL version that we do not support. The S/W > and H/W requirements are clearly documented still whatever is available at > the client end they attempt to run the designs on that OS. There are many > such similar cases. During my appraisal this issue was brought up and I have > been asked to find methods as to how I can compel the engineers to read the > contents. How can I when the engineer is overconfident about his knowledge > about the product? It is for the managers to bring this up. As already > mentioned the new recruits have never complained and used the same training > material to understand the product/module whereas the existing > engineers are constantly complaining. The saddest part is whenever there is > a feature addition/modification the contents are immediately updated and > mails sent to all engineers with a request to exercise the new/modified > features and also provide feedback. Nobody responds. When they go for > customer training they start using the new feature without reading the > modified contents. Assuming the working of a feature and actual working of a > feature are different. When a feature does not yeild the required results > because of the modifications then I start receiving harsh mails that the > designs are not working as expected. Since I handle the training material all > the barbs are directed to me even if the design is faulty for which the R > is responsible. Though a writer over a period of time I have gained > sufficient knowledge about the product so always test each feature myself > before making it available to Engineers. Now I am definitely at a loss as to > how the > situation can be improved. As Nancy suggested the head of the Engineers > should pressurize them to do their homework before visiting the customers for > training or use the material during their free time to understand the module > and also provide feedback for further improvement. Looks like I am asking for > the impossible as this never happens. > > Thanks once again to each one of you. > > Warm Regards, > > Garnier > > > -Original Message- > From: Nancy Allison [mailto:maker at verizon.net] > Sent: Monday, May 18, 2009 7:11 PM > To: garnier_framescript at yahoo.co.in > Subject: Re: Motivating end users to read the user manual > > And, again, this time with "Plain Text" selected. > > > Hi, Garnier. I'm replying to you individually and copying to the forum, > because I'm really interested in other people's responses, as well. > > I'm working at a company where the head of engineering says, "Nobody reads > the manual." Basically, they've written off the value of what I do and > therefore don't support it. Sounds a
Motivating end users to read the user manual
Agree with Shmuel. This is common in "higher" technical documentation, called Revision Highlights or Highlights of Changes or similar. Sometimes sent as a transmittal letter accompanying the distributed manual, and sometimes more like a part of the manual front matter pages. Bodvar 2009/5/19 Shmuel Wolfson : > I still say you have to figure out a way to make it easier for them to > find the information that has changed, without rereading the entire > manual. Perhaps you could list a version history with what's new in each > version. Then you could ask the engineer to check the version history > and read the related sections of the manual before complaining that it > doesn't work. > > -- > Regards, > Shmuel Wolfson > Technical Writer > 052-763-7133 > > Garnier Garnier wrote: >> Hello Nancy/Shmuel/Sharon,& others, >> >> Thanks for the response. I handle documentation for the EDA (Electronic >> Design Automation) industry. All user/reference/training manuals are very >> technical so am not sure if having a separate dos and don?t's page(s) would >> help because it will vary with each design and with simulator/synthesizer >> that the user selects for the simulation or synthesis. Still thanks for the >> suggestion I will try to explore the same. >> >> I agree with Nancy as the management support is definitely important. I am >> not defending myself. Whenver a new recruit has to go through the training >> as part of induction they are able to simulate each of the design convered >> in the training material. Since the new recruits are not aware of the >> product they end up reading each page of the training material and able to >> perform each step as required- like changing the block parameters before >> simulation or compiling the imported blocks before adding to the design for >> simulation etc. Whereas the existing field engineers are aware of the >> product so never bother to read the contents. For example one of the >> engineers attempted to perform C simulation for a design with imported >> blocks. This is because any design with imported blocks needs to be compiled >> separately before adding it to the design and then one needs to run >> Co-simulation or RTL Simulation. In this case C simulation will fail. This >> concept is clearly >> ?documented but the engineer kept sending nasty mails complaining that the >> design is faulty. I then sent him the page number of the material wherein >> the instructions are clearly mentioned. After that he did not bother to >> respond because he could then run the simulations successfully. Or the >> Engineer attempting to run the tool on a RHEL version that we do not >> support. The S/W and H/W requirements are clearly documented still whatever >> is available at the client end they attempt to run the designs on that OS. >> There are many such similar cases. During my appraisal this issue was >> brought up and I have been asked to find methods as to how I can compel the >> engineers to read the contents. How can I when the engineer is overconfident >> about his knowledge about the product? It is for the managers to bring this >> up. ?As already mentioned the new recruits have never complained and used >> the same training material to understand the product/module whereas the >> existing >> ?engineers are constantly complaining. The saddest part is whenever there is >> a feature addition/modification the contents are immediately updated and >> mails sent to all engineers with a request to exercise the new/modified >> features and also provide feedback. Nobody responds. When they go for >> customer training they start using the new feature without reading the >> modified contents. Assuming the working of a feature and actual working of a >> feature are different. When a feature does not yeild the required results >> because of the modifications then I start receiving harsh mails that the >> designs are not working as expected. Since I handle the training material >> all the barbs are directed to me even if the design is faulty for which the >> R is responsible. Though a writer over a period of time I have gained >> sufficient knowledge about the product so always test each feature myself >> before making it available to Engineers. Now I am definitely at a loss as to >> how the >> ?situation can be improved. As Nancy suggested the head of the Engineers >> should pressurize them to do their homework before visiting the customers >> for training or use the material during their free time to understand the >> module and also provide feedback for further improvement. Looks like I am >> asking for the impossible as this never happens. >> >> Thanks once again to each one of you. >> >> Warm Regards, >> >> Garnier >> >> >> -Original Message- >> From: Nancy Allison [mailto:maker at verizon.net] >> Sent: Monday, May 18, 2009 7:11 PM >> To: garnier_framescript at yahoo.co.in >> Subject: Re: Motivating end users to read the user
Procedure How to Write a Manual
On Facebook this would be tagged "Like!" by many. :-) Bodvar Bjorgvinsson 2009/5/18 : > If anyone can write a manual, why do you need to write a procedure for doing > it? > > Let your boss do it if he thinks it's so easy. > ___ > > > You are currently subscribed to Framers as bodvar at gmail.com. > > Send list messages to framers at lists.frameusers.com. > > To unsubscribe send a blank email to > framers-unsubscribe at lists.frameusers.com > or visit > http://lists.frameusers.com/mailman/options/framers/bodvar%40gmail.com > > Send administrative questions to listadmin at frameusers.com. Visit > http://www.frameusers.com/ for more resources and info. > -- "Life is not only a game--it is also a dance on roses." --Fleksnes (Rolv Wesenlund)
ANN: Converted Imported By Copy to Imported By Reference
On behalf of Rick Quatro: Hello Framers, There have been some recent requests for a solution to convert graphics imported by copy to graphics imported by reference. I have developed a set of FrameScript scripts to help with this. The first is an interactive script that works like this: 1) Select the graphic that is imported by copy. 2) Run the script by pressing a shortcut key. 3) The script will prompt you with a dialog box where you enter the graphic type, dpi, filename, etc. The settings are "sticky" so that they will be remembered the next time you run the script. 4) The script exports the graphic according to the specified settings, then re-imports it by reference. 5) The original "by copy" graphic is deleted. Since this script is interactive, you have to touch each graphic that you want to process, but this gives you maximum control over the settings and filename. For a more automated approach, there is a companion script where you set the graphic type and dpi once in an INI file. You also specify a folder for the graphics and a prefix for the graphic filenames. The script then goes through the entire document or book and processes all of the "by copy" graphics according to the INI file settings. Both of these scripts require FrameScript. If you are interested, please contact me offlist. Thank you very much. Rick Quatro Carmen Publishing Inc. rick at frameexpert.com 585-659-8267
Can no longer make a pdf of a large book
> On Mon, May 18, 2009 at 7:24 PM, Combs, Richard > wrote: > > > > "Processing power"? Not likely (I'm tempted to say "nonsense"). How was > > she creating the PDF? When and how did it fail? > > > > The log file for the job (which should be in the directory in which the > > PDF was being created) shows which pages were successfully processed, > > when the process failed, and what error occurred. That information is > > necessary for the list to provide any meaningful suggestions. Thank you, Richard and others. I was quoting the writer. Her words were exactly as much as I knew at the time. I'll be seeing the file today and will go through all the usual processes. Best, Madeleine
Motivating end users to read the user manual
On Tue, 19 May 2009 13:34:31 +, Bodvar Bjorgvinsson wrote: >Agree with Shmuel. This is common in "higher" technical documentation, >called Revision Highlights or Highlights of Changes or similar. >Sometimes sent as a transmittal letter accompanying the distributed >manual, and sometimes more like a part of the manual front matter >pages. +1 If you want to see an example of it, look at the Mif2Go User's Guide, in the opening "About this guide" section, under "New information". All the brief descriptions of changes are linked to the affected content elsewhere in the manual. The User's Guide is free, available in a dozen formats (including Frame 7) at: http://www.omsys.com/dcl/download.htm#Mif2Go_UG -- Jeremy H. Griffith, at Omni Systems Inc. http://www.omsys.com/
Exporting the paths of graphics used
Hi, I'd like to join this email about making a list of figures in alpha order. I followed the directions below and all I got was a blank FMKR page. Then I went to just make a list of figures as a stand alone file, not part of the book file. That worked great, I got the list. 1. Now, how do I alphabatize them. 2. Isn't there a simple sort feature like Word? Seems like then I could make the sorted list as a template and work thru the entire book. 3. Is their an easier way to work within the complete book file to get a full list of figures at one time? 4. Also, make a list of tables. I want to use this same technique to make a list of the titles from my TOC, and arrange them either by WI number or alpha to create a quick hyperlink file for users easy reference. Using FM7.0, Adobe Distiller 5.0, Vista Enterprise. Thnaks, Sue From: framers-boun...@lists.frameusers.com on behalf of Jeremy H. Griffith Sent: Sun 5/17/2009 6:20 PM To: framers at lists.frameusers.com Cc: Chinell, David F (GE EntSol, Security) Subject: Re: Exporting the paths of graphics used On Tue, 12 May 2009 12:23:20 -0400, "Chinell, David F (GE EntSol, Security)" wrote: >Is there any way to create a list of the graphics used in a FM file, >including the path name of the file? Sure. From the Special menu, generate a List of -> References (or an Index of -> References, if you prefer them alphabetical), and select Imported Graphics as what to include. HTH! -- Jeremy H. Griffith, at Omni Systems Inc. http://www.omsys.com/ ___ You are currently subscribed to Framers as susancu at vmc.com. Send list messages to framers at lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscribe at lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/susancu%40vmc.com Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Procedure How to Write a Manual!
OUCH ! ;-) -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Robert Shelton Sent: Monday, May 18, 2009 2:32 PM To: Avraham Makeler; framers at lists.frameusers.com Subject: RE: Procedure How to Write a Manual! > -Original Message- > From: framers-bounces at lists.frameusers.com > [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Sharon > Burton > > This is easy. 14 steps: > > 1. Identify the audience > 2. Identify the information needs of that audience (job aids, user > guides, and so on) 3. Identify the tasks the audience needs to do 4. > Identify the supporting info the audience needs to do those tasks 5. > Identify the best way to deliver the information (PDF, help, others) > 6. Create a plan that layout all this information 7. Assign time > estimates to the plan 8. Decide what can be cut due to time > limitations 9. > Start creating the information, adapting to the changing product 10. > Review by others 11. Make the review changes 12. > Build "gold" candidates 13. Deliver the finals 14. Archive the finals, > including all planning information > > Of course, these steps include a lot of embedded steps and domain > knowledge in our field. But these are the steps. I think you skipped something important: 1. Hire a tech writer. Bob "Let what comes, come, Let what goes, go, Find out what remains." Sri Ramana Maharshi ___ You are currently subscribed to Framers as rmelanson at spirecorp.com. Send list messages to framers at lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscribe at lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/rmelanson%40spirecor p.com Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Screen captures and sizing
Hi all, [from a lurker on daily digest, sorry if this is late] > Here is the current comment from a client: Generally, I would like > to keep high quality of screen captures. > The comment that I have from the client is what I have - nothing > specific about fuzziness, or anything else. Tammy, if that is the only comment you have about graphics from the customer, when taken literally, it is a compliment. You don't say whether you're new to this customer's documentation, so I can't tell if it's a reflection of your past work or a veiled request on your future work. Either way, you have what I would consider a solid process for getting sharp screen shots into the docs. As others have pointed out, there are probably some things that can happen after that, but it's just a matter of a few settings. For reference, my screen-shot process is generally similar, but I have a few refinements I haven't seen mentioned here. I'm running FM 8 on Vista. I use the MS Snipping Tool that comes with Vista, and save directly to PNG. I always draw and clip a rectangle box and give myself about 10 pixels around the actual GUI item I want. From there, I open the image in Gimp, a free photo editor that has some handy features for working with PNGs. For example, I mostly work at 150 dpi in Frame, so I have that set up as my default save option. Once the dpi is in the PNG, FM automatically takes that as the default (I learned that on this list a few months ago). I like to zoom to 400% and see every pixel in my screenshot, so I can crop it just right. Cropping is easy because you can draw the box and then move each border independently to get what you want. In my docs, I generally try to have screenshots at only 3 different DPIs: - 96 for small icons and such that usually go inline (this makes easy to see because they are about the same size as in the GUI when viewed at 100% in PDF) - 150 for most dialogs and screens, which keeps all text easily readable. - 200 or 300 if I have to present a full screen layout. (Although I've been basing that on the 600 dpi of most laser printers; I like Ian's suggestion to optimize for PDF viewing in Acrobat.) 90% of my screenshots are at the 150 dpi setting, which I like to think keeps the perspective consistent for the reader. However, when editing the capture, I take some liberties with the actual screen contents. I always make my window as small as possible before the screenshot, but the GUI is still often too large. For example, if a dialog box has a lot of white-space somewhere, especially vertically, I copy-paste the border to cover up some of the extra space, then recrop the box. Or if the screen is too wide, I move some of the fields and elements closer together. The idea is that the reader needs to see something that looks like the product, not the exact pixels. With the image editor, I can also fix bugs in the GUI, even typos in the labels, so I don't have to wait for engineering to generate the fix and I dont' have to set up the screenshot again. It's a bit of an art, and sometimes a bit complicated to move the dialog elements, especially if they're on a gradient background, but as long as the end result keeps the general relative dimensions of the actual GUI, the reader gets the needed info in a clearer way. Anyways, thanks to all who contribute regularly here, I've learned a lot reading this list. Andy akass at jaspersoft.com
Exporting the paths of graphics used
You must have used the "List of" menu item instead of the "Index of" one that Jeremy suggested. The index one should generate an alphabetical list. Jeff -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Susan Curtzwiler Sent: Tuesday, May 19, 2009 5:09 PM To: Jeremy H. Griffith; framers at lists.frameusers.com Cc: Susan Curtzwiler; Chinell, David F (GE EntSol,Security) Subject: RE: Exporting the paths of graphics used Hi, I'd like to join this email about making a list of figures in alpha order. I followed the directions below and all I got was a blank FMKR page. Then I went to just make a list of figures as a stand alone file, not part of the book file. That worked great, I got the list. 1. Now, how do I alphabatize them. 2. Isn't there a simple sort feature like Word? Seems like then I could make the sorted list as a template and work thru the entire book. 3. Is their an easier way to work within the complete book file to get a full list of figures at one time? 4. Also, make a list of tables. I want to use this same technique to make a list of the titles from my TOC, and arrange them either by WI number or alpha to create a quick hyperlink file for users easy reference. Using FM7.0, Adobe Distiller 5.0, Vista Enterprise. Thnaks, Sue From: framers-boun...@lists.frameusers.com on behalf of Jeremy H. Griffith Sent: Sun 5/17/2009 6:20 PM To: framers at lists.frameusers.com Cc: Chinell, David F (GE EntSol, Security) Subject: Re: Exporting the paths of graphics used On Tue, 12 May 2009 12:23:20 -0400, "Chinell, David F (GE EntSol, Security)" wrote: >Is there any way to create a list of the graphics used in a FM file, >including the path name of the file? Sure. From the Special menu, generate a List of -> References (or an Index of -> References, if you prefer them alphabetical), and select Imported Graphics as what to include. HTH! -- Jeremy H. Griffith, at Omni Systems Inc. http://www.omsys.com/ ___ You are currently subscribed to Framers as susancu at vmc.com. Send list messages to framers at lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscribe at lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/susancu%40vmc.com Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as jeff.coatsworth at jonassoftware.com. Send list messages to framers at lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscribe at lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/jeff.coatsworth%40jo nassoftware.com Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Exporting the paths of graphics used
Susan Curtzwiler wrote: > I followed the directions below and all I got was a blank FMKR page. Then the FM file or book for which you generated the list or index doesn't contain any graphics imported by reference. FM doesn't know the file path and name of graphics copied into the document (there's no point). > Then I went to just make a list of figures as a stand alone file, not part > of the book file. Do you mean that within a single FM file, not a book, you selected Special > List of > Figures? OK, then in the Set Up List of Figures dialog, you had to select the paragraphs to include (your figure captions). But now you've changed the subject completely. Lists of figures, tables, etc., are lists of paragraphs in FM. That's very different from a list of imported graphics, fonts, text insets, or other references. > That worked great, I got the list. > 1. Now, how do I alphabatize them. Select Special > List of > Paragraphs (Alphabetical) -- or for a book, Add > List of > Paragraphs (Alphabetical) -- and select the paragraphs to include. > 2. Isn't there a simple sort feature like Word? Seems like then I could > make the sorted list as a template and work thru the entire book. I don't understand. > 3. Is their an easier way to work within the complete book file to get a > full list of figures at one time? What is it that you can't do with (from the book window) Add > List of > Figures or Add > List of > Paragraphs (Alphabetical)? > 4. Also, make a list of tables. What is it that you can't do with (from the book window) Add > List of > Tables or Add > List of > Paragraphs (Alphabetical)? > I want to use this same technique to make a list of the titles from my TOC, > and arrange them either by WI number or alpha to create a quick hyperlink > file for users easy reference. I don't understand. But again, List of > Paragraphs (Alphabetical) will give you alpha lists of whatever paragraph format(s) you want (like Head1, Head2, ...). I don't know what a WI number is, but maybe if you spend some quality time with the generated lists topics in the help or user manual, you can figure out how to do something with that, too. FM's generated lists functionality is pretty robust and versatile. HTH! Richard Richard G. Combs Senior Technical Writer Polycom, Inc. richardDOTcombs AT polycomDOTcom 303-223-5111 -- rgcombs AT gmailDOTcom 303-777-0436 --
Lists of figures and tables in alpha order (was FW: Exporting the paths of graphics used)
You'd think that after gently chiding Susan for having "changed the subject completely," I'd remember to change the subject line of my reply, wouldn't you? Sorry! Here it is for the archives. -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Combs, Richard Sent: Tuesday, May 19, 2009 4:10 PM To: Susan Curtzwiler; framers at lists.frameusers.com Subject: RE: Exporting the paths of graphics used Susan Curtzwiler wrote: > I followed the directions below and all I got was a blank FMKR page. Then the FM file or book for which you generated the list or index doesn't contain any graphics imported by reference. FM doesn't know the file path and name of graphics copied into the document (there's no point). > Then I went to just make a list of figures as a stand alone file, not part > of the book file. Do you mean that within a single FM file, not a book, you selected Special > List of > Figures? OK, then in the Set Up List of Figures dialog, you had to select the paragraphs to include (your figure captions). But now you've changed the subject completely. Lists of figures, tables, etc., are lists of paragraphs in FM. That's very different from a list of imported graphics, fonts, text insets, or other references. > That worked great, I got the list. > 1. Now, how do I alphabatize them. Select Special > List of > Paragraphs (Alphabetical) -- or for a book, Add > List of > Paragraphs (Alphabetical) -- and select the paragraphs to include. > 2. Isn't there a simple sort feature like Word? Seems like then I could > make the sorted list as a template and work thru the entire book. I don't understand. > 3. Is their an easier way to work within the complete book file to get a > full list of figures at one time? What is it that you can't do with (from the book window) Add > List of > Figures or Add > List of > Paragraphs (Alphabetical)? > 4. Also, make a list of tables. What is it that you can't do with (from the book window) Add > List of > Tables or Add > List of > Paragraphs (Alphabetical)? > I want to use this same technique to make a list of the titles from my TOC, > and arrange them either by WI number or alpha to create a quick hyperlink > file for users easy reference. I don't understand. But again, List of > Paragraphs (Alphabetical) will give you alpha lists of whatever paragraph format(s) you want (like Head1, Head2, ...). I don't know what a WI number is, but maybe if you spend some quality time with the generated lists topics in the help or user manual, you can figure out how to do something with that, too. FM's generated lists functionality is pretty robust and versatile. HTH! Richard Richard G. Combs Senior Technical Writer Polycom, Inc. richardDOTcombs AT polycomDOTcom 303-223-5111 -- rgcombs AT gmailDOTcom 303-777-0436 -- ___ You are currently subscribed to Framers as richard.combs at polycom.com. Send list messages to framers at lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscribe at lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/richard.combs%40poly com.com Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Exporting the paths of graphics used
Richard, Thank you for the detailed information. I will work with them this afternoon. Cheers, Sue From: Combs, Richard [mailto:richard.co...@polycom.com] Sent: Tue 5/19/2009 3:09 PM To: Susan Curtzwiler; framers at lists.frameusers.com Subject: RE: Exporting the paths of graphics used Susan Curtzwiler wrote: > I followed the directions below and all I got was a blank FMKR page. Then the FM file or book for which you generated the list or index doesn't contain any graphics imported by reference. FM doesn't know the file path and name of graphics copied into the document (there's no point). > Then I went to just make a list of figures as a stand alone file, not part > of the book file. Do you mean that within a single FM file, not a book, you selected Special > List of > Figures? OK, then in the Set Up List of Figures dialog, you had to select the paragraphs to include (your figure captions). But now you've changed the subject completely. Lists of figures, tables, etc., are lists of paragraphs in FM. That's very different from a list of imported graphics, fonts, text insets, or other references. > That worked great, I got the list. > 1. Now, how do I alphabatize them. Select Special > List of > Paragraphs (Alphabetical) -- or for a book, Add > List of > Paragraphs (Alphabetical) -- and select the paragraphs to include. > 2. Isn't there a simple sort feature like Word? Seems like then I could > make the sorted list as a template and work thru the entire book. I don't understand. > 3. Is their an easier way to work within the complete book file to get a > full list of figures at one time? What is it that you can't do with (from the book window) Add > List of > Figures or Add > List of > Paragraphs (Alphabetical)? > 4. Also, make a list of tables. What is it that you can't do with (from the book window) Add > List of > Tables or Add > List of > Paragraphs (Alphabetical)? > I want to use this same technique to make a list of the titles from my TOC, > and arrange them either by WI number or alpha to create a quick hyperlink > file for users easy reference. I don't understand. But again, List of > Paragraphs (Alphabetical) will give you alpha lists of whatever paragraph format(s) you want (like Head1, Head2, ...). I don't know what a WI number is, but maybe if you spend some quality time with the generated lists topics in the help or user manual, you can figure out how to do something with that, too. FM's generated lists functionality is pretty robust and versatile. HTH! Richard Richard G. Combs Senior Technical Writer Polycom, Inc. richardDOTcombs AT polycomDOTcom 303-223-5111 -- rgcombs AT gmailDOTcom 303-777-0436 --
