RE: re-use 101
Inset Plus [sic] is free, and looks very interesting, but the site does not indicate whether it is a product one can just inject into one's Structured FrameMaker system, of if one needs to BUY any of the other West Street Consulting products in order to make use of it. Kristy, can you address this or should we ask West Street? --Guy K. Haas Software Exegete in Silicon Valley, and sometime user of LOADS of text insets On Wed, March 11, 2009 9:01 am, Kristy Nolan wrote: Hi, Joel! Are you using structured or unstructured Frame? Have you considered using text insets? I found this useful when I had a similar scenario a few years ago on unstructured Frame. If you are on structured, check out InsetPlus at West Street Consulting. We have found this to be very useful for our docs. Kristy -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Joel Sent: Wednesday, March 11, 2009 7:36 AM To: framers@lists.frameusers.com Subject: re-use 101 I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ You are currently subscribed to Framers as kristy.no...@wnco.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/kristy.nolan%40wnco. 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 g...@hiskeyboard.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/guy%40hiskeyboard.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: re-use 101
I work in this way too. A number of books, with the common chapters the same, some text insets too. What I wanted to add, was not to forget to document what you are doing. Even if you are a lone writer, you may sometimes have time between working on books. I have a text file in each book directory reminding myself how I set it all up, which conditions should be applied when and whatever else is relevant. Caroline Tabach Technical/Marcom Writer Fax: +972 3 6474681 Email: carol...@radcom.com www.radcom.com www.protocols.com -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Susan Modlin Sent: Wednesday, March 11, 2009 7:46 PM To: Flato, Gillian; Joel; framers@lists.frameusers.com Subject: Re: re-use 101 Joel, I'm with Gillian on this one. Using this approach (and variables on title pages and in running headers and footers for book titles) I managed a pretty complex set of deliverables: two versions each of 10 major guides, and three versions of a training guide that contained pared-down chapters from each of the major guides. I also produced context sensitive help from the same set of FrameMaker source files. Because I used Frame 7.2, handling the conditions was tricky, but creative use of color (red + green = brown) enabled me to construct a system of 16 possible combinations that I could keep track of without too much trouble. The trick was to plan the whole thing out in advance, make it logical and easy to remember, and to be absolutely rigorous about not straying from the rules. As a one-woman department, I was tempted at times to do a little ad hoc conditionalizing, but I knew that the whole thing hinged on sticking to the structure I'd created. I'm sure others have done even more complicated schemes and as Gillian points out, it's easier and cheaper than DITA. ...Susan Gillian wrote: The easiest way to do it is the following: 1. Have 7 Frame book files 2. The book files can share chapter files that are mostly similar; likewise, they don't share chapters that are radically different for each manual. 3. Within the chapters, apply conditional text to the minor differences With this method, you simply set the conditions as needed before your build your book. When you build your book or PDF, you generate the manual and only the text conditioned to that manual displays. This is the method that I use. It's much easier, cheaper and manageable then DITA. -Gillian ___ You are currently subscribed to Framers as carol...@radcom.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/caroline%40radcom.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-use 101
I work in this way too. A number of books, with the common chapters the same, some text insets too. What I wanted to add, was not to forget to document what you are doing. Even if you are a lone writer, you may sometimes have time between working on books. I have a text file in each book directory reminding myself how I set it all up, which conditions should be applied when and whatever else is relevant. Caroline?Tabach Technical/Marcom Writer ??? Fax: +972 3 6474681 Email:?? caroline at radcom.com www.radcom.com www.protocols.com -Original Message- From: framers-bounces at lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Susan Modlin Sent: Wednesday, March 11, 2009 7:46 PM To: Flato, Gillian; Joel; framers at lists.frameusers.com Subject: Re: re-use 101 Joel, I'm with Gillian on this one. Using this approach (and variables on title pages and in running headers and footers for book titles) I managed a pretty complex set of deliverables: two versions each of 10 major guides, and three versions of a training guide that contained pared-down chapters from each of the major guides. I also produced context sensitive help from the same set of FrameMaker source files. Because I used Frame 7.2, handling the conditions was tricky, but creative use of color (red + green = brown) enabled me to construct a system of 16 possible combinations that I could keep track of without too much trouble. The trick was to plan the whole thing out in advance, make it logical and easy to remember, and to be absolutely rigorous about not straying from the rules. As a one-woman department, I was tempted at times to do a little ad hoc conditionalizing, but I knew that the whole thing hinged on sticking to the structure I'd created. I'm sure others have done even more complicated schemes and as Gillian points out, it's easier and cheaper than DITA. ...Susan Gillian wrote: The easiest way to do it is the following: 1. Have 7 Frame book files 2. The book files can share chapter files that are mostly similar; likewise, they don't share chapters that are radically different for each manual. 3. Within the chapters, apply conditional text to the minor differences With this method, you simply set the conditions as needed before your build your book. When you build your book or PDF, you generate the manual and only the text conditioned to that manual displays. This is the method that I use. It's much easier, cheaper and manageable then DITA. -Gillian ___ You are currently subscribed to Framers as caroline at radcom.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/caroline%40radcom.com Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
re-use 101
I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I’m puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I’m looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ 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: re-use 101
Hi Joel In my opinion, there are ways you could use several unstructured Frame features to eliminate some of the repetitiveness and cumbersome maintenance. XML is a fabulous choice if there is enough work and other applications to justify doing the development for it. I don't know enough about your environment to speak to that. Depending on what is being reused and where it is found in the content, you could use a combination of: variables conditional text (I personally look very carefully at conditions to keep them from being too cumbersome) book files cross references text insets breaking files up differently to reuse specific portions I would need more information about the actual text to say how I would approach this. Although I believe XML rocks as an approach, there is a lot that can be done with unstructured FrameMaker...that happens to be my specialty since my clients haven't been interested in moving to XML because of the initial learning curve and costs nor have the company business models indicated there were be enough payback on the investment to warrant it. There are, as always, tradeoffs to choosing one approach over the other and each project must be evaluated using a variety of factors. You're welcome to write me offlist if you like so we can look at your situation individually. Blessings Jerilynne On Wed, Mar 11, 2009 at 7:36 AM, Joel eleys...@gmail.com wrote: I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I’m puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I’m looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ 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: re-use 101
Hi Joel: I have an incomplete answer, but I'd like to get the ball rolling. I'm still using FrameMaker 7.2, so that's one of my knowledge limitations. I'm counting on others to fill in the gaps. (a) I wouldn't recommend using conditional text because you'd have seven variations and possibly recombinations of those seven (e.g., something applies to three of the seven, etc.). I know that FM 8 deals with multiple conditions much better than FM 7x, but still, seven variants could make your head hurt just as badly as XML. (b) I use structured FM and I like it a lot, but it'll take a month or two to learn, set up your own definition, and convert the manuals. I'm not sure if you have the time to invest. One advantage to moving to structured is that there is an awesome structured tool called InsetPlus from West Street Consulting that will help you manage and use shared text. Furthermore, you won't run into the problems I've heard about with cross-references and indexing in unstructured text insets. (c) I just read Jerilynne's answer, and it's true that you can do a lot with the list she sent you. If you don't go to structured FM, I would recommend text insets, or splitting up the files so that the common sections can be shared through the book files. In both structured and unstructured, I use variables to take care of the little differences. And Jerilynne is also right that depending on the details, conditional text may also be appropriate...my answer in (a) was based on one master document and trying to generate seven variations on it. Good luck! Fei Min -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Joel Sent: Wednesday, March 11, 2009 8:36 AM To: framers@lists.frameusers.com Subject: re-use 101 I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ You are currently subscribed to Framers as feimin.lore...@onsemi.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/feimin.lorente%40ons emi.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: re-use 101
You make excellent points Fei, especially about the conditional text. Another thing: I didn't mention that I often review the content to see if text can be arranged in a different way, or different order, to achieve the results needed (without, of course, compromising readability or usability). I find that doing these projects take a combination of skills and approaches...and some compromises unless you've got unlimited time or an unlimited budget (and someday I'll get a client with those...maybe...smile!). Blessings Jerilynne On Wed, Mar 11, 2009 at 8:04 AM, Fei Min Lorente feimin.lore...@onsemi.comwrote: Hi Joel: I have an incomplete answer, but I'd like to get the ball rolling. I'm still using FrameMaker 7.2, so that's one of my knowledge limitations. I'm counting on others to fill in the gaps. (a) I wouldn't recommend using conditional text because you'd have seven variations and possibly recombinations of those seven (e.g., something applies to three of the seven, etc.). I know that FM 8 deals with multiple conditions much better than FM 7x, but still, seven variants could make your head hurt just as badly as XML. (b) I use structured FM and I like it a lot, but it'll take a month or two to learn, set up your own definition, and convert the manuals. I'm not sure if you have the time to invest. One advantage to moving to structured is that there is an awesome structured tool called InsetPlus from West Street Consulting that will help you manage and use shared text. Furthermore, you won't run into the problems I've heard about with cross-references and indexing in unstructured text insets. ___ 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: re-use 101
-Original Message- I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel Joel - I'll give you *our* solution, but you need to determine what works for you. We have several product lines. Each product line has its own user guide, maintenance manual, and quick reference guide. Because the products are similar, they share much of the content. On top of the standard product line, we have several custom variations of products for OEMs and high-profile customers. We broke our manuals apart into topical files (much like you'd do with XML). In most cases, a topical file break came at the Heading1 level. Within each topical file, if the content is similar enough, we use conditional text to handle any small differences between procedures. If a particular procedure is completely different between printers, then we create a topical file just for that printer, and name the file accordingly. (Example: topic1_printer1 and topic1_printer2.) Use your book file to bring the topical files together. Our book structure would look like this: Cover_page.fm Book_toc.fm Intro_front_page.fm Intro_topic1.fm Intro_topic2.fm Chapter1_front_page.fm (contains chapter heading and intro paragraph, and a mini-toc indicating what's in the chapter.) topic_1.fm topic_2.fm topic_3.fm topic_4_printer1.fm topic_5.fm Chapter2_front_page.fm topic_6.fm topic_7.fm IX.fm Back_cover.fm This structure allows you to reuse content at the topical level across multiple books. We have hundreds of topical files, and our conditional text matrix has 80+ conditional text formats. When it comes to conditional text, be logical and create your format structure before you start applying it. In our case, we use a naming convention like this: UG_printer1 UG_printer2 UG_printer3 (UG indicates the tagged content is for use in the User Guide of the specific printer) MM_printer1 MM_printer2 MM_printer3 (MM indicates the tagged content is for use in the Maintenance Manual of the specific printer.) We assign a color to a specific product line, and a format to a type of manual. Printer 1 is always purple. Printer 2 is always red, and so forth. User Guide styles are underlined. Maintenance Manual styles are overlined. So... purple text with under- and over-lines is for Printer1 and both the UG and the MM. Red text with underline is for Printer2 user guide only. If you apply multiple printer conditions, you'll get the standard magenta override conditional text format, but FM8 and higher allow you to define custom tag formats for multiple conditional text expressions. (We aren't doing that yet, but I know its there.) For our running headers which reflect the Chapter title, we use markers. The variable for running header/footer 1 references to marker1. You can insert and conditionalize multiple markers in a single file, so a topical file could be used in chapter1 of the UG, but chapter 4 of the Maintenance Manual. There's a lot of info here, but hopefully you can pull out the basics and apply it to your situation if you determine that's the way you want to go. Our plan is to eventually move to DITA XML. The topical structure we're using is a good basis for that. -Carla *** Carla Martinek, Senior Translation Coordinator/Editor Zebra Technologies Corporation 333 Corporate Woods Parkway, Vernon Hills, IL 60061 - CONFIDENTIAL- This email and any files transmitted with it are confidential, and may also be legally privileged. If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email. ___ You are currently subscribed to Framers as
RE: re-use 101
Hi, Joel! Are you using structured or unstructured Frame? Have you considered using text insets? I found this useful when I had a similar scenario a few years ago on unstructured Frame. If you are on structured, check out InsetPlus at West Street Consulting. We have found this to be very useful for our docs. Kristy -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Joel Sent: Wednesday, March 11, 2009 7:36 AM To: framers@lists.frameusers.com Subject: re-use 101 I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ You are currently subscribed to Framers as kristy.no...@wnco.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/kristy.nolan%40wnco. 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: re-use 101
The short answer is no, you do not have to purchase anything else from West Street. And it is pretty quick to get started using. Kristy -Original Message- From: Guy K. Haas [mailto:g...@hiskeyboard.com] Sent: Wednesday, March 11, 2009 11:12 AM To: Kristy Nolan Cc: Joel; framers@lists.frameusers.com Subject: RE: re-use 101 Inset Plus [sic] is free, and looks very interesting, but the site does not indicate whether it is a product one can just inject into one's Structured FrameMaker system, of if one needs to BUY any of the other West Street Consulting products in order to make use of it. Kristy, can you address this or should we ask West Street? --Guy K. Haas Software Exegete in Silicon Valley, and sometime user of LOADS of text insets On Wed, March 11, 2009 9:01 am, Kristy Nolan wrote: Hi, Joel! Are you using structured or unstructured Frame? Have you considered using text insets? I found this useful when I had a similar scenario a few years ago on unstructured Frame. If you are on structured, check out InsetPlus at West Street Consulting. We have found this to be very useful for our docs. Kristy -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Joel Sent: Wednesday, March 11, 2009 7:36 AM To: framers@lists.frameusers.com Subject: re-use 101 I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ You are currently subscribed to Framers as kristy.no...@wnco.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/kristy.nolan%40wnco. 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 g...@hiskeyboard.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/guy%40hiskeyboard. 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: re-use 101
The easiest way to do it is the following: 1. Have 7 Frame book files 2. The book files can share chapter files that are mostly similar; likewise, they don't share chapters that are radically different for each manual. 3. Within the chapters, apply conditional text to the minor differences With this method, you simply set the conditions as needed before your build your book. When you build your book or PDF, you generate the manual and only the text conditioned to that manual displays. This is the method that I use. It's much easier, cheaper and manageable then DITA. -Gillian -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Joel Sent: Wednesday, March 11, 2009 5:36 AM To: framers@lists.frameusers.com Subject: re-use 101 I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ You are currently subscribed to Framers as gfl...@nanometrics.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/gflato%40nanometrics .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: re-use 101
Thank you to everyone who has replied. I am going to game plan a little, and do some version of insets or smaller topics that can be combined in the final book. I am on structured Frame, for those who asked, but I don't use the structure, elements, or XML. I just default to strucure in case I use XML in the future. I appreciate your replies. Joel ___ 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: re-use 101
Joel, I'm with Gillian on this one. Using this approach (and variables on title pages and in running headers and footers for book titles) I managed a pretty complex set of deliverables: two versions each of 10 major guides, and three versions of a training guide that contained pared-down chapters from each of the major guides. I also produced context sensitive help from the same set of FrameMaker source files. Because I used Frame 7.2, handling the conditions was tricky, but creative use of color (red + green = brown) enabled me to construct a system of 16 possible combinations that I could keep track of without too much trouble. The trick was to plan the whole thing out in advance, make it logical and easy to remember, and to be absolutely rigorous about not straying from the rules. As a one-woman department, I was tempted at times to do a little ad hoc conditionalizing, but I knew that the whole thing hinged on sticking to the structure I'd created. I'm sure others have done even more complicated schemes and as Gillian points out, it's easier and cheaper than DITA. ...Susan Gillian wrote: The easiest way to do it is the following: 1. Have 7 Frame book files 2. The book files can share chapter files that are mostly similar; likewise, they don't share chapters that are radically different for each manual. 3. Within the chapters, apply conditional text to the minor differences With this method, you simply set the conditions as needed before your build your book. When you build your book or PDF, you generate the manual and only the text conditioned to that manual displays. This is the method that I use. It's much easier, cheaper and manageable then DITA. -Gillian ___ 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: re-use 101
Joel, There are so many ways to meet your goals using FrameMaker... You asked for unstructured Frame and reuse so here's a take: When using unstructured Frame I've solved this problem using text insets and a simple spreadsheet for tracking where used information. I have a client that wanted to enhance their reuse strategy but were not ready to move their group to structure and XML. They had been using the copy/paste method for years and were unable to maintain books after release. So, I analyzed the usage across 3 product models and 15 books (content was: exactly the same, similar, different or not used). Based on the analysis, I created reusable topics (text insets) and imported them by reference into the specific section containers and then created serial number books. (Note, I handle graphics in the same way and often a text inset may reused with a model specific graphic. So, there's a bit of rewrite/reflow up front for optimal reuse.) Reuse analysis across 15 English books was very high: 70% for text (insets) and 55% for graphics. The books are large (10 sections, about 700 pages) and the client now happily builds at least 3 books (serial number specific) a week using this scheme. They also translate each complete book into at least one other language...sometimes two. So, tracking, managing and publishing those translations is a lot easier now too) The books are saved to PDF right now. The conversion table and EDD are complete so the next step is structure and then XML delivered to knowledge base on the web. Real trick to this is the analysis, a bullet-proof template (section/inset) with no overrides and maintaining the where used information. The rest is the simplest of FrameMaker features. Let me know if I've been clear enough with this! And when you're ready for a content management solution, I'll gladly make some recommendations:) Mollye Barrett, ClearPath, LLC content management solutions 414-331-1378 (cell) -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Joel Sent: Wednesday, March 11, 2009 7:36 AM To: framers@lists.frameusers.com Subject: re-use 101 I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ You are currently subscribed to Framers as mol...@clearpath.cc. 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/mollye%40clearpath.cc 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-use 101
I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I?m puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I?m looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel
re-use 101
Hi Joel In my opinion, there are ways you could use several unstructured Frame features to eliminate some of the repetitiveness and cumbersome maintenance. XML is a fabulous choice if there is enough work and other applications to justify doing the development for it. I don't know enough about your environment to speak to that. Depending on what is being reused and where it is found in the content, you could use a combination of: variables conditional text (I personally look very carefully at conditions to keep them from being too cumbersome) book files cross references text insets breaking files up differently to reuse specific portions I would need more information about the actual text to say how I would approach this. Although I believe XML rocks as an approach, there is a lot that can be done with unstructured FrameMaker...that happens to be my specialty since my clients haven't been interested in moving to XML because of the initial learning curve and costs nor have the company business models indicated there were be enough payback on the investment to warrant it. There are, as always, tradeoffs to choosing one approach over the other and each project must be evaluated using a variety of factors. You're welcome to write me offlist if you like so we can look at your situation individually. Blessings Jerilynne On Wed, Mar 11, 2009 at 7:36 AM, Joel wrote: > I am using Frame 8. I have a set of seven manuals that are close to 100 > pages each. Many sections of these manuals are identical, some sections > differ in detail in minor ways, and fewer sections differ in more > substantial ways. Currently they are all Frame books with each chapter > being > its own file within the book. There is no re-use of anything at the moment. > > This is becoming increasingly burdensome to maintain, as a change to > something that appears in all seven manuals requires me to make that change > manually in all seven files. I would like to get to re-use, or > single-sourcing, but I?m puzzled as to how to get there. Would the best > strategy be: > > (a) To use conditional text and generate several versions; > > (b) To try and convert everything to XML and sew things together based on > individual XML files; > > (c) Something else? > I have zero XML knowledge, and whenever I read about it, my head hurts. I > am > willing to learn, but the benefit needs to be commensurate with the pain > involved in learning. I?m looking for the simplest solution that allows for > some common source material using my existing Frame configuration. Ideas > are > appreciated. > Joel > >
re-use 101
Hi Joel: I have an incomplete answer, but I'd like to get the ball rolling. I'm still using FrameMaker 7.2, so that's one of my knowledge limitations. I'm counting on others to fill in the gaps. (a) I wouldn't recommend using conditional text because you'd have seven variations and possibly recombinations of those seven (e.g., something applies to three of the seven, etc.). I know that FM 8 deals with multiple conditions much better than FM 7x, but still, seven variants could make your head hurt just as badly as XML. (b) I use structured FM and I like it a lot, but it'll take a month or two to learn, set up your own definition, and convert the manuals. I'm not sure if you have the time to invest. One advantage to moving to structured is that there is an awesome structured tool called InsetPlus from West Street Consulting that will help you manage and use shared text. Furthermore, you won't run into the problems I've heard about with cross-references and indexing in unstructured text insets. (c) I just read Jerilynne's answer, and it's true that you can do a lot with the list she sent you. If you don't go to structured FM, I would recommend text insets, or splitting up the files so that the common sections can be shared through the book files. In both structured and unstructured, I use variables to take care of the little differences. And Jerilynne is also right that depending on the details, conditional text may also be appropriate...my answer in (a) was based on one master document and trying to generate seven variations on it. Good luck! Fei Min -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Joel Sent: Wednesday, March 11, 2009 8:36 AM To: framers at lists.frameusers.com Subject: re-use 101 I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ You are currently subscribed to Framers as feimin.lorente at onsemi.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/feimin.lorente%40ons emi.com Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
re-use 101
You make excellent points Fei, especially about the conditional text. Another thing: I didn't mention that I often review the content to see if text can be arranged in a different way, or different order, to achieve the results needed (without, of course, compromising readability or usability). I find that doing these projects take a combination of skills and approaches...and some compromises unless you've got unlimited time or an unlimited budget (and someday I'll get a client with those...maybe...smile!). Blessings Jerilynne On Wed, Mar 11, 2009 at 8:04 AM, Fei Min Lorente wrote: > Hi Joel: > > I have an incomplete answer, but I'd like to get the ball rolling. I'm > still using FrameMaker 7.2, so that's one of my knowledge limitations. > I'm counting on others to fill in the gaps. > > (a) I wouldn't recommend using conditional text because you'd have seven > variations and possibly recombinations of those seven (e.g., something > applies to three of the seven, etc.). I know that FM 8 deals with > multiple conditions much better than FM 7x, but still, seven variants > could make your head hurt just as badly as XML. > > (b) I use structured FM and I like it a lot, but it'll take a month or > two to learn, set up your own definition, and convert the manuals. I'm > not sure if you have the time to invest. One advantage to moving to > structured is that there is an awesome structured tool called InsetPlus > from West Street Consulting that will help you manage and use shared > text. Furthermore, you won't run into the problems I've heard about with > cross-references and indexing in unstructured text insets. > >
re-use 101
-Original Message- I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel Joel - I'll give you *our* solution, but you need to determine what works for you. We have several product lines. Each product line has its own user guide, maintenance manual, and quick reference guide. Because the products are similar, they share much of the content. On top of the standard product line, we have several custom variations of products for OEMs and high-profile customers. We broke our manuals apart into topical files (much like you'd do with XML). In most cases, a topical file break came at the Heading1 level. Within each topical file, if the content is similar enough, we use conditional text to handle any small differences between procedures. If a particular procedure is completely different between printers, then we create a topical file just for that printer, and name the file accordingly. (Example: topic1_printer1 and topic1_printer2.) Use your book file to bring the topical files together. Our book structure would look like this: Cover_page.fm Book_toc.fm Intro_front_page.fm Intro_topic1.fm Intro_topic2.fm Chapter1_front_page.fm (contains chapter heading and intro paragraph, and a mini-toc indicating what's in the chapter.) topic_1.fm topic_2.fm topic_3.fm topic_4_printer1.fm topic_5.fm Chapter2_front_page.fm topic_6.fm topic_7.fm IX.fm Back_cover.fm This structure allows you to reuse content at the topical level across multiple books. We have hundreds of topical files, and our conditional text matrix has 80+ conditional text formats. When it comes to conditional text, be logical and create your format structure before you start applying it. In our case, we use a naming convention like this: UG_printer1 UG_printer2 UG_printer3 (UG indicates the tagged content is for use in the User Guide of the specific printer) MM_printer1 MM_printer2 MM_printer3 (MM indicates the tagged content is for use in the Maintenance Manual of the specific printer.) We assign a color to a specific product line, and a format to a type of manual. Printer 1 is always purple. Printer 2 is always red, and so forth. User Guide styles are underlined. Maintenance Manual styles are overlined. So... purple text with under- and over-lines is for Printer1 and both the UG and the MM. Red text with underline is for Printer2 user guide only. If you apply multiple printer conditions, you'll get the standard magenta override conditional text format, but FM8 and higher allow you to define custom tag formats for multiple conditional text expressions. (We aren't doing that yet, but I know its there.) For our running headers which reflect the Chapter title, we use markers. The variable for running header/footer 1 references to marker1. You can insert and conditionalize multiple markers in a single file, so a topical file could be used in chapter1 of the UG, but chapter 4 of the Maintenance Manual. There's a lot of info here, but hopefully you can pull out the basics and apply it to your situation if you determine that's the way you want to go. Our plan is to eventually move to DITA XML. The topical structure we're using is a good basis for that. -Carla *** Carla Martinek, Senior Translation Coordinator/Editor Zebra Technologies Corporation 333 Corporate Woods Parkway, Vernon Hills, IL 60061 - CONFIDENTIAL- This email and any files transmitted with it are confidential, and may also be legally privileged. If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email.
re-use 101
Hi, Joel! Are you using structured or unstructured Frame? Have you considered using text insets? I found this useful when I had a similar scenario a few years ago on unstructured Frame. If you are on structured, check out InsetPlus at West Street Consulting. We have found this to be very useful for our docs. Kristy -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Joel Sent: Wednesday, March 11, 2009 7:36 AM To: framers at lists.frameusers.com Subject: re-use 101 I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ You are currently subscribed to Framers as kristy.nolan at wnco.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/kristy.nolan%40wnco. com Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
re-use 101
The short answer is no, you do not have to purchase anything else from West Street. And it is pretty quick to get started using. Kristy -Original Message- From: Guy K. Haas [mailto:g...@hiskeyboard.com] Sent: Wednesday, March 11, 2009 11:12 AM To: Kristy Nolan Cc: Joel; framers at lists.frameusers.com Subject: RE: re-use 101 Inset Plus [sic] is free, and looks very interesting, but the site does not indicate whether it is a product one can just inject into one's Structured FrameMaker system, of if one needs to BUY any of the other West Street Consulting products in order to make use of it. Kristy, can you address this or should we ask West Street? --Guy K. Haas Software Exegete in Silicon Valley, and sometime user of LOADS of text insets On Wed, March 11, 2009 9:01 am, Kristy Nolan wrote: > Hi, Joel! > > Are you using structured or unstructured Frame? Have you considered > using text insets? I found this useful when I had a similar scenario a > few years ago on unstructured Frame. If you are on structured, check > out InsetPlus at West Street Consulting. We have found this to be very > useful for our docs. > > Kristy > > -Original Message- > From: framers-bounces at lists.frameusers.com > [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Joel > Sent: Wednesday, March 11, 2009 7:36 AM > To: framers at lists.frameusers.com > Subject: re-use 101 > > I am using Frame 8. I have a set of seven manuals that are close to > 100 pages each. Many sections of these manuals are identical, some > sections differ in detail in minor ways, and fewer sections differ in > more substantial ways. Currently they are all Frame books with each > chapter being its own file within the book. There is no re-use of > anything at the moment. > > This is becoming increasingly burdensome to maintain, as a change to > something that appears in all seven manuals requires me to make that > change manually in all seven files. I would like to get to re-use, or > single-sourcing, but I'm puzzled as to how to get there. Would the > best strategy be: > > (a) To use conditional text and generate several versions; > > (b) To try and convert everything to XML and sew things together based > on individual XML files; > > (c) Something else? > I have zero XML knowledge, and whenever I read about it, my head hurts. > I am willing to learn, but the benefit needs to be commensurate with > the pain involved in learning. I'm looking for the simplest solution > that allows for some common source material using my existing Frame > configuration. Ideas are appreciated. > Joel > ___ > > > You are currently subscribed to Framers as kristy.nolan at wnco.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/kristy.nolan%40wnco. > 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 guy at hiskeyboard.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/guy%40hiskeyboard. > com > > Send administrative questions to listadmin at frameusers.com. Visit > http://www.frameusers.com/ for more resources and info. >
re-use 101
Thank you to everyone who has replied. I am going to game plan a little, and do some version of insets or smaller topics that can be combined in the final book. I am on structured Frame, for those who asked, but I don't use the structure, elements, or XML. I just default to strucure in case I use XML in the future. I appreciate your replies. Joel
re-use 101
Joel, I'm with Gillian on this one. Using this approach (and variables on title pages and in running headers and footers for book titles) I managed a pretty complex set of deliverables: two versions each of 10 major guides, and three versions of a training guide that contained pared-down chapters from each of the major guides. I also produced context sensitive help from the same set of FrameMaker source files. Because I used Frame 7.2, handling the conditions was tricky, but creative use of color (red + green = brown) enabled me to construct a system of 16 possible combinations that I could keep track of without too much trouble. The trick was to plan the whole thing out in advance, make it logical and easy to remember, and to be absolutely rigorous about not straying from the rules. As a one-woman department, I was tempted at times to do a little ad hoc conditionalizing, but I knew that the whole thing hinged on sticking to the structure I'd created. I'm sure others have done even more complicated schemes and as Gillian points out, it's easier and cheaper than DITA. ...Susan Gillian wrote: The easiest way to do it is the following: 1. Have 7 Frame book files 2. The book files can share chapter files that are mostly similar; likewise, they don't share chapters that are radically different for each manual. 3. Within the chapters, apply conditional text to the minor differences With this method, you simply set the conditions as needed before your build your book. When you build your book or PDF, you generate the manual and only the text conditioned to that manual displays. This is the method that I use. It's much easier, cheaper and manageable then DITA. -Gillian
re-use 101
Joel, There are so many ways to meet your goals using FrameMaker... You asked for unstructured Frame and reuse so here's a take: When using unstructured Frame I've solved this problem using text insets and a simple spreadsheet for tracking "where used" information. I have a client that wanted to enhance their reuse strategy but were not ready to move their group to structure and XML. They had been using the copy/paste method for years and were unable to maintain books after release. So, I analyzed the usage across 3 product models and 15 books (content was: exactly the same, similar, different or not used). Based on the analysis, I created reusable topics (text insets) and imported them by reference into the specific section containers and then created serial number books. (Note, I handle graphics in the same way and often a text inset may reused with a model specific graphic. So, there's a bit of rewrite/reflow up front for optimal reuse.) Reuse analysis across 15 English books was very high: 70% for text (insets) and 55% for graphics. The books are large (10 sections, about 700 pages) and the client now happily builds at least 3 books (serial number specific) a week using this scheme. They also translate each complete book into at least one other language...sometimes two. So, tracking, managing and publishing those translations is a lot easier now too) The books are saved to PDF right now. The conversion table and EDD are complete so the next step is structure and then XML delivered to knowledge base on the web. Real trick to this is the analysis, a bullet-proof template (section/inset) with no overrides and maintaining the "where used" information. The rest is the simplest of FrameMaker features. Let me know if I've been clear enough with this! And when you're ready for a content management solution, I'll gladly make some recommendations:) Mollye Barrett, ClearPath, LLC content management solutions 414-331-1378 (cell) -Original Message- From: framers-boun...@lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Joel Sent: Wednesday, March 11, 2009 7:36 AM To: framers at lists.frameusers.com Subject: re-use 101 I am using Frame 8. I have a set of seven manuals that are close to 100 pages each. Many sections of these manuals are identical, some sections differ in detail in minor ways, and fewer sections differ in more substantial ways. Currently they are all Frame books with each chapter being its own file within the book. There is no re-use of anything at the moment. This is becoming increasingly burdensome to maintain, as a change to something that appears in all seven manuals requires me to make that change manually in all seven files. I would like to get to re-use, or single-sourcing, but I'm puzzled as to how to get there. Would the best strategy be: (a) To use conditional text and generate several versions; (b) To try and convert everything to XML and sew things together based on individual XML files; (c) Something else? I have zero XML knowledge, and whenever I read about it, my head hurts. I am willing to learn, but the benefit needs to be commensurate with the pain involved in learning. I'm looking for the simplest solution that allows for some common source material using my existing Frame configuration. Ideas are appreciated. Joel ___ You are currently subscribed to Framers as mollye at clearpath.cc. 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/mollye%40clearpath.cc Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
re-use 101
Inset Plus [sic] is free, and looks very interesting, but the site does not indicate whether it is a product one can just inject into one's Structured FrameMaker system, of if one needs to BUY any of the other West Street Consulting products in order to make use of it. Kristy, can you address this or should we ask West Street? --Guy K. Haas Software Exegete in Silicon Valley, and sometime user of LOADS of text insets On Wed, March 11, 2009 9:01 am, Kristy Nolan wrote: > Hi, Joel! > > Are you using structured or unstructured Frame? Have you considered > using text insets? I found this useful when I had a similar scenario a > few years ago on unstructured Frame. If you are on structured, check out > InsetPlus at West Street Consulting. We have found this to be very > useful for our docs. > > Kristy > > -Original Message- > From: framers-bounces at lists.frameusers.com > [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Joel > Sent: Wednesday, March 11, 2009 7:36 AM > To: framers at lists.frameusers.com > Subject: re-use 101 > > I am using Frame 8. I have a set of seven manuals that are close to 100 > pages each. Many sections of these manuals are identical, some sections > differ in detail in minor ways, and fewer sections differ in more > substantial ways. Currently they are all Frame books with each chapter > being its own file within the book. There is no re-use of anything at > the moment. > > This is becoming increasingly burdensome to maintain, as a change to > something that appears in all seven manuals requires me to make that > change manually in all seven files. I would like to get to re-use, or > single-sourcing, but I'm puzzled as to how to get there. Would the best > strategy be: > > (a) To use conditional text and generate several versions; > > (b) To try and convert everything to XML and sew things together based > on individual XML files; > > (c) Something else? > I have zero XML knowledge, and whenever I read about it, my head hurts. > I am willing to learn, but the benefit needs to be commensurate with the > pain involved in learning. I'm looking for the simplest solution that > allows for some common source material using my existing Frame > configuration. Ideas are appreciated. > Joel > ___ > > > You are currently subscribed to Framers as kristy.nolan at wnco.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/kristy.nolan%40wnco. > 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 guy at hiskeyboard.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/guy%40hiskeyboard.com > > Send administrative questions to listadmin at frameusers.com. Visit > http://www.frameusers.com/ for more resources and info. >
