Author Archive

Tooling around

December 7th, 2009 by Ethan Duty

In a recent post, Alan Pringle picked apart the argument that “the tools we use in our wacky profession are a convenience.” He made the comparison of using a shovel to plant a tree versus a gardening trowel, which is an appropriate metaphor for two similar authoring tools, but perhaps not so fitting when you consider the plethora of tools and options available.

Authoring tools typically do a few things very well and range from mediocre to not supported for all other tasks. Some tools produce better PDF, some are better at structured authoring, some produce better 508 compliant output, some do well with hundreds to thousands of pages of content, some are designed specifically for DITA, etc. Choose a tool that’s not versatile enough to meet your documentation needs and you’re going to lose a lot of time, resources, and patience with work-arounds and post-processing.

The end-user of your content might not care how you create the product or how long it takes to make it, but chances are, your employer does. As authors, our goal is not only to produce accessible content that helps users solve problems, but to do so as efficiently as possible. Choosing the right tool ensures that authors can create the most comprehensive content within their time and budget constraints.



Space battle

November 16th, 2009 by Ethan Duty

I recently had a battle with FrameMaker over how it handles white space in XML output. My space battle didn’t involve any lasers, explosions, or cool looking spaceships, but here’s a couple minutes of space battles that did:

And now that you’re entertained, here’s how you get rid of that rogue white space in XML output from FrameMaker.

Extra white space (which can represent tabs and line breaks in the FrameMaker content) is often not a problem when you’re opening the XML content in FrameMaker. However that white space is not so useful if you’re accessing the XML content with other tools such as ActionScript. Flash holds onto the spacing and displays it as big, nasty gaps in your text fields.

You can eliminate most of the extra white space with an XSL transform:

<xsl:strip-space elements=”*”/>

That transform doesn’t get rid of the line breaks. To get rid of those breaks, you can use the following read/write rule in your structured application:

element “Para” {
writer line break is 9999 characters;
}

This write rule overrides FrameMaker’s default limit of 80 characters per line for the designated element.

You will need to include a write rule for every element that contains text. If you have a robust structure (such as DITA) and do not want to create read/write rules for hundreds of elements with text, consider writing custom XSL transforms to run as a preprocess on your XML.



你好中国 A foodie foray in China

October 1st, 2009 by Ethan Duty

Most of the time, the folks at Scriptorium get to travel for conferences. We fly hither and thither to give presentations and talk to you from our booth. Every so often, we get to travel simply for the joy of it.

For two weeks in September, I toured Beijing, Hangzhou, and Shanghai with my in-laws. The sight-seeing was wonderful, but the food was even better. Here are a few foodie highlights from the trip:

This photo was taken in Huangzhou at a restaurant by the West Lake. The local specialties featured in this meal are: clay roasted duck (top), watershield soup (top right), tea flavored shrimp (center), and braised pork (the little red container on the right).

These buns came from a dimsum restaurant in Shanghai. Here you can see sticky rice with egg custard (top left), red bean buns (top right), vegetable dumplings (bottom left), and some very attractive sticky buns filled with more custard (lower right).

One of the things I love about Beijing is you can eat at about any time. This photo was taken at an outside restaurant around 11pm. The meal featured meat buns, vegetable buns, boiled peanuts, seaweed and tofu, boiled soy beans, and a huge pile of lamb skewers.

While the local cuisine was absolutely superb, Americans dining in China will be hard pressed to find dessert items or dairy products.

If you know of a good place to pick up cheese cake in Beijing, let me know.



The evolution of books

February 17th, 2009 by Ethan Duty

Sarah O’Keefe has brought a lot of attention to how XML and structured authoring are revolutionizing the economy of authoring, but there has not been a lot of discussion about the paradigm shift being experienced by readers.

Some might find this frightening, but mobile technology like iPods and smartphones are replacing printed documentation. My iPod has already replaced my need for printed reference materials. Yes, that’s right, my iPod has replaced just about every printed bit of information I need.

My iPod is my atlas, calendar, cookbook, dictionary, encyclopedia, newspaper, shopping list, translator, and TV guide. I can find all the how-to and instructional media I want online. Better yet, I don’t even have to read most of it. YouTube and similar sites are filled with videos on everything from folding your clothes more efficiently to off-pan VW restorations.

The information is constantly updated and spans an international audience (try finding books in Mandarin at your local Barnes and Noble). It doesn’t take up extra space on my book shelf or coffee table and it reduces the amount of paper I throw away.

There are only a few reasons why I still have to reach for paper:

  • I need to look at or write on a bigger page
  • I want to leave a note somewhere for others to see (I’m not about to tape my iPod to a coworker’s door like a Post-It note)
  • I can’t mark up a document on my iPod (although you can do this on a tablet PC)
  • I can’t compare two documents side by side
  • writing can be faster (typing on an iPod, even with a stylus, is a slow and difficult operation)
  • I can’t find an Internet connection
  • The battery died

As the technology improves, merges with personal computers, and becomes cheaper, mobile reading and mark up devices could become as disposable as flash drives and rival the printed page for presentation and functionality.

A sci-fi dream for the distant future? I don’t know. I’m not too far from living a paperless life already. How about you?



Digital rights management in Web 2.0

July 8th, 2008 by Ethan Duty

The argument for digital rights management (people will steal your stuff) sounds good from a retail perspective. Who would buy the book when they can get a pirated copy for free? But if retail sales aren’t the focus of your company, there is value in the illegal proliferation of your stuff.

This does not mean piracy is good. Pirates take from the producer without investing anything back, leaving that producer with fewer resources to make better stuff, and thus slowing the progress of knowledge, technology, and perhaps civilization as we know it. But piracy is an additional form of marketing. Unprotected content results in additional readers at the expense of lost sales. But “free” content will reach consumers that cannot afford or justify the cost of a book, so your content gains exposure to individuals who otherwise would not have access to the information.

Let’s say you’re a consultant. You attract your clients by being the authority on certain information. One way to prove your authority (see the connection, authority and author) is to create white papers and books that others find useful.

The more people that read and use your stuff, the bigger an authority you become on the topic. If piracy drastically increases the copies of your books being used, you have that many more people that recognize your authority.

The more individuals that recognize your authority, the more likely they are to come to you for answers not available in the book. Since cloning isn’t perfect, the public cannot pirate your personal knowledge and experience, and you get to charge the money for consulting services.

With everything going to the web, attention is rising in value. Your content is just one drop in a vast ocean of stuff and announcing your existence and value to potential clients becomes ever more difficult.

If pirated copies of a book generate more searches on the author and drive traffic to your site or blog, then perhaps there will come a time when you can’t afford DRM.