Copy link to clipboard
Copied
My team is just getting started with structured FrameMaker, and we're trying to determine whether we should use DITA or define our own EDD (etc.). DITA seems overly restrictive for our needs, so I'm leaning toward defining our own. Is there anything in DITA that we couldn't recreate (for example, tagging or map files)?
Copy link to clipboard
Copied
The base "topic" model in DITA is very loose (from my perspective). It's basically like HTML. If you want a generic container for whatever content you want to toss in, that's a perfectly good model to use. It may have many more elements that you really want to use .. so you can trim out the domains that aren't of interest to you (or you can just subset the model within FrameMaker).
Personally, I think that the benefits you gain from using the existing model far outweigh the complications or working around something that's not *exactly* the way you want it. If you go with DITA, you automatically have a huge array of tools (both authoring and publishing) at your disposal. If you roll your own, you'll have to create and maintain the tools on your own.
What is it about DITA that you see as too restrictive .. perhaps I'm not seeing what you are.
Cheers,
...scott
Copy link to clipboard
Copied
We're looking at moving to structured authoring to facilitate content reuse. We already use many of the concepts fundamental to DITA (for example, every step is a command). However, I noticed that DITA does not allow you to have a section within a section, which seems restrictive. (Maybe it's not, but that's my initial perspective.
I don't have a good understanding of what tools are DITA-specific, and what those tools would bring. For example, I don't know that we would need publishing tools beyond what we have with FrameMaker and RoboHelp. But I could see us potentially using maps. Do you have specific examples of what I would need to recreate if we didn't use DITA?
Thanks,
Melanie
Copy link to clipboard
Copied
Hi Melanie...
First off .. Russ is absolutely correct. I'm a big proponent of DITA, and have seen it used successfully in very small to very large organizations. But it is very important to fully weigh your needs against the pros/cons of any content model. I suppose that's why you started this thread in the first place .. but you should be aware of my bias here.
Yes .. DITA doesn't allow nested sections, and to some purists, use of the section element might not be considered to be a good practice in general. One of the big focuses of DITA is content reuse and modularity. In an ideal world you might consider using a nested topic instead of a section and use a map to define the relationship/hierarchy of how that "section" relates to the parent topic. Doing this allows you to easily reuse that section content in other contexts. If you have a large topic made up of many nested sections, you could create a map that represents that topic .. the "root" topicref in that map would be the main topic, and any "sections" would just be topicrefs that are children of the main topicref. A topicref to this map would then be inserted into the main map (or a "chapter map"). Since DITA allows unlimited nesting of maps you can use maps to define certain types of structures that relate to book-based constructs.
Using this technique, you might create multiple maps, that reuse the same content in different ways. One that's tailored for print output and another that's tailored for online use.
The DITA-specific features that would be a bit of work to implement on your own are the various content and module referencing features .. xrefs (easy to implement in other models), but conrefs (in particular conref ranges), topicrefs, and keyrefs would be some work. I'm also excited about using the new coderef feature, which allows you to reference non-DITA files like you would a text inset (this isn't working properly in FM10, but will be when DITA-FMx has been updated for DITA 1.2).
Mostly the tools you'll see that are DITA-specific are authoring and publishing tools .. but also you'll see file/topic management tools of various types. While most of these tools can also be configured to work with a custom model, they will probably have put more time into refining their DITA support so you'll see features that allow easy browsing and management of references (topicrefs, xrefs, conrefs, keyrefs, etc.) as well as other productivity enhancement features. Also, because DITA has become a very common XML model, you'll find that consultants and vendors will be more familiar and comfortable with that model. If you send your DITA topics out for localization, it's likely that there will be fewer questions and errors than if you send off content in a home-grown model.
If you're happy with your current tools and workflow, then many of these potential benefits may not carry much weight, but the thing that I like the most about DITA is that it frees your content from proprietary tools. That doesn't mean you won't still need to buy proprietary tools, but it's going to be easier to move to another tool when/if that time comes. Granted, just moving to XML starts to give you this benefit, but over the coming years there will be more and more cool tools coming along that support DITA.
One thing that might have been good to clarify up front .. when you say "getting started with structured FrameMaker" .. do you mean that you're looking at using "binary" structured FM files or XML? If you're staying with binary FM files, there's much less reason to worry about using DITA .. in fact, I'd recommend not using DITA as binary FM files. You can gain big consistency and efficiency benefits by using structured FM binary files, but the additional benefits come from moving to XML.
Cheers!
...scott
Copy link to clipboard
Copied
Scott, thank you so much for taking the time to share your experience. DITA maps look like they would open up some very interesting possibilities for content reuse. For example, we provide a report reference for our presales team which has be be updated for every release. Currently, we copy infro from RoboHelp files (in multiple RH projects) and paste into a traditional FrameMaker doc to produce a PDF -- which of course has to be updated with every release. This is one example of a workflow that we want to streamline by single-sourcing.
For the most part, I plan to publish through either FrameMaker or RH. But I think that we'll be publishing some information to an XML file that will be read by the UI (short descriptions will be displayed for certain elements in the UI). Notice all the verbs like "plan" and "think" -- obviously this project is in the planning stage and I've got a lot of learning to do! 😉
One thing that I wish Adobe had is more information about how to specialize the DITA files that ship with Adobe. They provide a nice walk-through of how to define a custom EDD in the PDF "Developing Structured Applications with Adobe FrameMaker 9." But nothing about how to get started modifying the OOTB DITA files to, for example, use your styles. (Maybe it's obvious to most people, but it wasn't to me.) But I found some helpful info online at http://www.kynosarges.de/FrameDita.html. I'm going to do a small test project which I think will help me determine how best to meet our team's needs.
Thanks again!
Melanie
Copy link to clipboard
Copied
Hi Melanie...
I'm glad to help. As you can see, I think DITA is pretty cool (it does have its detractors though, and there are pitfalls to watch for).
Be careful of your terminology. When you say "specialize" in reference to DITA, that means much more than customizing the EDD and templates. One of the features of DITA is it's ability to specialize the data model .. essentially, you can create new element names and structures to more closely match your needs. In addition to modifying the FM structure application files, this also requires some serious work with the DITA DTDs. This is not something that I recommend .. at least not when you're starting off. Try to make your content work with the default elements and structures, and when that fails, you can consider specialization.
What you can do (and I think is probably what you were really talking about) is customize the structure application files so the output looks more like your house style. In a nutshell, you''d start by modifying the template file (paragraph and character styles as well as page layout). If you require more serious work, you'll need to do some work on the EDD (after tweaking the EDD, be sure to import it back into the tempalte). The Structure Application Developer's Guide is the place you'll go for the details, but yes, it might be good if there was some introductory material, and something more specific to DITA. You might check scriptorium.com and publishingsmarter.com for some white papers or other material that would be useful.
You may also want to check out my plugin DITA-FMx, which provides extended DITA authoring and publishing features. In particular DITA-FMx makes it much easier to create consistently formatted PDFs from DITA maps. Creating PDFs from default FM can be a fairly laborious and manual task where it's easy to make mistakes .. DITA-FMx automates the whole process. You can download a trial from here ..
http://leximation.com/dita-fmx/
And there are a number of videos on our blog ..
http://blog.leximation.com/category/framemaker/dita-fmx/
The following documentation is specific to DITA-FMx, but might provide you with some overview info about structure applications in general. In particular, when you do customize your apps, I strongly recommend that you clone the default apps and create your own apps to customize, rather than tweaking the shipping apps. This allows you to keep the default apps available and in pristine condition so that when you break something (and you will), you can test with the default apps to see what's gone wrong.
http://docs.leximation.com/dita-fmx/1.1/?ditafmx_customizingapps.html
Cheers!
...scott
Scott Prentice
Leximation, Inc.
www.leximation.com
Copy link to clipboard
Copied
M_Boyd,
You may not realize it, but you have asked a very contentious question, one which could evoke some strong opinions in the right crowd. I would vigorously encourage you to examine your options carefully and take anything you hear as general advice only. In other words, it would could be a big mistake to choose either way just based on comments received on a forum like this. The wrong decision could be very costly.
In my personal experience, I have found DITA to be very cool and innovative, but I've yet to find a practical use for it as a complete solution. I like the structure definition and have modeled my own after it, but I do not use the mapping concept, the toolkit, the DTDs, or any such DITA-specific gizmo.
Again, look carefully before you leap. Everyone's needs as far as authoring workflow and published output differ. Your solution may fall anywhere in the spectrum of a completely-custom structure definition to the full implementation of DITA. Get to know structure first... then you can make an educated decision about what will best serve your goals.
Russ
Find more inspiration, events, and resources on the new Adobe Community
Explore Now