DITA Users Progress Blog

DITA Users Progress Blog http://www.ditanews.com/about_us/blog/index.html skyBuilders.com timeLines en-us http://backend.userland.com/rss Bob Doyle and Bob Doyle editor@cmsreview.com Mon, 25 Jun 2007 11:00:00 EDT DITA Users on <a href="http://thecontentwrangler.com/article/dita_users_helps_tech_writers_learn_to_master_topic_based_authoring/">The Content Wrangler</a> http://www.ditanews.com/about_us/blog/index.33.en.html Launched in January 2007, <a href="http://www.ditanews.com/">DITA Users</a> is a 200 member organization for technical communicators just getting started with topic-based structured authoring. Members from sixteen countries around the world participate in various online learning opportunities designed to teach them “DITA from A to B”. “DITA from A to B” means that members can get direct experience from authoring to building their own DITA documentation sets. Their deliverables appear on the web in personalized workspace folders. Members can publish links to their projects and easily show their colleagues, clients, or employers work they did in DITA. The DITA Users <a href="http://www.ditanews.com/">website</a> utilizes a DITA Open Toolkit running on the DITA Users server. Typically, the Open Toolkit requires a rather complicated installation that prevents many tech writers from getting self-lead, hands-on experience with DITA. By providing a shared, hosted version of the Open Toolkit online, members who don’t have a clue about installing Java components can get access to the end-to-end publishing process offered by DITA. Another thing that makes DITA Users possible is a web-based DITA XML editor called <a href="http://www.ditastorm.com/">DITA Storm</a>. There are several good DITA editors, but they are meant for use on the desktop and they cost from a few to several hundred dollars. DITA Storm provides members with a WYSIWYG, Word-style authoring tool with no installation whatsoever. A third online technology utilized by DITA Users is an IBM Eclipse Help server. DITA offers multiple output formats from the same single-source original files. In addition to XHTML web outputs and PDF print outputs, DITA Users can output online help files. They show up on the web at the <a href="http://www.ditanews.com/eclipse">DITA Users Infocenter</a>. For a modest investment ($100/year), members develop skills they can transfer to the top DITA XML Editors and XML Component Content Management Systems. The DITA Users website lists over fifty DITA-related tools from editors to publishing engines. They also offer <a href="http://www.ditanews.com/tools/">comprehensive product listings</a> in their Tools A-Z section. DITA Users also has web-based localization support for translating content into many languages. <a href="http://www.idiominc.com/">Idiom Technologies</a> has provided a WorldServer On-Demand globalization management system (GMS) to DITA Users. The website already has its navigation labels translated into French, Italian, German, and Spanish. Reduced translation costs are one of the largest returns on investment in DITA technology. Members around the world can access a web-based Translator’s Workbench that allows them to translate into locales where they are native speakers. Set your browser language preference to one of the FIGS languages and <a href="http://www.ditanews.com/">browse to the DITA Users website</a> to see how it works. DITA Users offers three sample documentation sets organized into projects, complete with ditamaps to build out the projects as separate deliverables for XHTML, PDF, and Help. Members can modify these docsets to get their first experience with DITA. They can also build their own projects from scratch. In addition to sections called What Is DITA?, Why DITA?, The Business Case for DITA, and a History of DITA, the website also offers a comprehensive set of resources for DITA, including DITA news sources, websites, mailing lists, publications, communities, and a glossary of DITA terms. As a technology demonstration and community support tool, DITA Users maintains the <a href="http://www.ditainfocenter.com/">DITA Infocenter</a>, offering searchable help-style access to the major specifications for DITA – the language and architectural specifications (versions 1.0 and 1.1) and the DITA Open Toolkit User Guide. With a single search phrase, you can retrieve technical information from all these support documents in one place. DITA Users publishes a <a href="http://www.ditanews.com/about_us/road_map/">Development Road Map</a> and a <a href="http://www.ditanews.com/about_us/blog/">Progress Blog</a>. They plan to launch officially at the end of August 2007. Until then, a trial membership is free. You don’t have to install anything or know XML to begin topic-based structured writing today. <a href="http://www.ditanews.com/membership/how_to_join/">Consider joining today!</a>. Bob Doyle http://www.ditanews.com/timelines/PageComment.html?doWhat=ReadSeriesComments&RelDirPath=/about_us/blog/&PageID=1728 Mon, 25 Jun 2007 11:00:00 EDT http://www.ditanews.com/about_us/blog/index.33.en.html Idiom WorldServer On-Demand for DITA Users http://www.ditanews.com/about_us/blog/index.32.en.html We are very happy to announce that Idiom Technologies has provided DITA Users with a WorldServer On-Demand Globalization Management System (GMS). <a onclick="return top.js.OpenExtLink(window,event,this)" href="http://www.idiominc.com/" target="_blank">http://www.idiominc.com/</a> WorldServer On-Demand will greatly facilitate our efforts to localize the DITA Users website. It will allow any of you who want to be volunteer translators to have an account with access to an online translation memory (TM). This means we need only translate a given sentence (or segment) once. Since translation costs are often the leading contributor to ROI for DITA implementations, this is a great addition to the learning experience for members getting started with DITA. Localization of the DITA Users website is already underway. We have draft translations of the main website navigation into French, Italian, German, and Spanish. The three DITA docsets in your workspace folders have also been machine translated into these FIGS languages. But they need polished idiomatic translations that only native speakers, preferably living in their native culture, can provide. Our goal is to add Arabic, Chinese (simplified), Hebrew, Japanese, Korean, and Portuguese. With these languages we will reach over ninety percent of web users, according to Common Sense Advisory. <a onclick="return top.js.OpenExtLink(window,event,this)" href="http://www.commonsenseadvisory.com/" target="_blank">http://www.commonsenseadvisory.com/</a> If you can help us translate, you will have the opportunity to use the browser-based version of the Idiom WorldServer. You may also download a copy of their Desktop Workbench if you prefer to work offline. We will train you with an online screen sharing session, then provide you with an account and privileges to translate pages into your locale. We will also provide you with tech support. If you are not ready for translation, you may serve instead as reviewers and approvers of translated content. WorldServer has a sophisticated workflow that moves translations through a translate-review-approve process. Our top localization priority is of course the home page. <a onclick="return top.js.OpenExtLink(window,event,this)" href="http://www.ditanews.com/" target="_blank">http://www.ditanews.com</a> Bob Doyle http://www.ditanews.com/timelines/PageComment.html?doWhat=ReadSeriesComments&RelDirPath=/about_us/blog/&PageID=1727 Fri, 22 Jun 2007 11:00:00 EDT http://www.ditanews.com/about_us/blog/index.32.en.html 200th Member of DITA Users http://www.ditanews.com/about_us/blog/index.29.en.html The 200th member joined DITA Users today. We analyzed how members who join are finding us. Most come from Google (including foreign googles) after specific DITA searches, or from DITA.XML.org after a product search. Many come from our own sites like CMS Review, CMS Wiki, and DITA Infocenter. A significant number join after trying the free online demo. We are still trying to put together enough valuable member benefits to ask members for $100 a year. Is the opportunity to edit DITA docsets and share the results online enough? We should probably poll the current members to see how they feel... We added four pages that put DITA in the broader context of structured writing characteristics like modularity, information typing, minimalism, inheritance, specialization, simplified XML, simplified English, single-source, topic-based, conditional processing, component publishing, task-orientation, content reuse, multiple output formats, multi-channel delivery, writing for translation, localization, globalization, and component content management. <a href="http://www.ditanews.com/about_us/what_is_dita/">What is DITA</a>, <a href="http://www.ditanews.com/about_us/what_is_dita/">Why DITA</a>, <a href="http://www.ditanews.com/about_us/what_is_dita/">Business Case</a>, and <a href="http://www.ditanews.com/about_us/what_is_dita/">History of DITA</a> Detailed discussion on these pages will be for members only. Bob Doyle http://www.ditanews.com/timelines/PageComment.html?doWhat=ReadSeriesComments&RelDirPath=/about_us/blog/&PageID=1584 Wed, 20 Jun 2007 14:53:04 EDT http://www.ditanews.com/about_us/blog/index.29.en.html Final Boston DITA Users Group meeting http://www.ditanews.com/about_us/blog/index.28.en.html <div class="nodecontent">June 2007 meeting of Boston DITA Users Group The final topic for 2006-2007 was High Tech Tools for Low Tech People. Neil Perlin discussed DITA for non-technical authors. David Pearson described development of a technology planning tool. And Susan Czerepak showed her Eclipse Help project for the DITA Manager on DITA Users.  Perlin is a certified trainer for Adobe RoboHelp and Captivate, as well as Madcap Flare and Mimic. See <a href="http://www.hyperword.com/">http://www.hyperword.com</a>. Sixty percent of his clients are low-tech. There is widespread ignorance of DITA and structured authoring among them. They don't know what DITA is or the benefits needed to make the business case. He recommends we evangelize DITA by selling the benefits. Establish whether the company needs reuse. Nancy Harrison added translation as a big benefit. Perlin says forget about XML initially. Don't show them the underlying code. Start with Word-style (WYSIWYG) tools, or tools that integrate DITA into Word, like Information Mapping's <a href="http://www.infomap.com/index.cfm/Technology/ContentMapper">ContentMapper</a>. Neil's powerpoint slides are online at <a href="http://dita.xml.org/boston">DITA.XML.org/boston</a>. David Pearson showed his projects with DITA Storm on the DITA Users website. He is developing a general template for technology planning.  <a href="../Users/dpearson/">http://www.ditanews.com/Users/dpearson/</a>  David's presentation is online at <a href="http://www.shawmuteducation.org/">http://www.shawmuteducation.org</a> (<a href="http://tinyurl.com/yvht4w">http://tinyurl.com/yvht4w</a>) Susan Czerepak showed her draft DITA Manager User Guide pages. They are visible as online help at <a href="../eclipse">http://www.ditanews.com/eclipse</a> Bob Doyle presented the results of a survey of possible presentation topics for the coming year. Poll results are at <a href="../topics.html">http://www.ditanews.com/topics.html</a>. The most popular topic was Stylesheets. Next were Conditional Processing, Reuse, Relation Tables, DITA CMS, DITA Maps, Publishing, and Help Authoring. Stan Doherty announced a summer project in DITA 1.1 Reuse techniques. It will include a library of sample files, ready-to-build demos, and supporting explanations. Contact him at stanley dot doherty at sun.com if you would like to participate. </div Bob Doyle http://www.ditanews.com/timelines/PageComment.html?doWhat=ReadSeriesComments&RelDirPath=/about_us/blog/&PageID=1512 Thu, 14 Jun 2007 13:15:00 EDT http://www.ditanews.com/about_us/blog/index.28.en.html Tutorial Topics http://www.ditanews.com/about_us/blog/index.31.en.html We are identifying areas where members would like to have tutorial materials - self-paced instruction - on various DITA topics. Tutorials will be locked (<img src="/images/lock/html" />) members-only content. <a href="/membership/how_to_join">Join us today</a> to access them. <a href="/tutorials/basics/">DITA Basics</a> <img src="/images/lock/html" /> <blockquote> Why concepts, tasks, and references? You learn the three basic information types. Writing a concept. Writing a task. Writing a reference. </blockquote> <a href="/tutorials/elements/">Topic elements</a> <img src="/images/lock/html" /> <blockquote> Title, ID, shortdesc, prolog metadata, body, sections, examples, paragraphs, lists, tables, phrases, keywords, images, multimedia, related links, topic nesting. How to find every element in the language specification. </blockquote> <a href="/tutorials/conditional_processing/">Conditional processing</a> <img src="/images/lock/html" /> <blockquote> What is metadata? How to set attributes and filter or flag output for different audiences, products, etc. </blockquote> <a href="/tutorials/ditamaps/">DITA maps</a> <img src="/images/lock/html" /> <blockquote> What is a DITA Map? How to design a map hierarchy. How to assemble your topics into maps. </blockquote> <a href="/tutorials/reuse/">Reuse</a> <img src="/images/lock/html" /> <blockquote> Designing content for reuse. What is a conref? </blockquote> <a href="/tutorials/cms/">DITA CMS</a> <img src="/images/lock/html" /> <blockquote> Why does DITA need a CMS? Locating your reusable components. </blockquote> <a href="/tutorials/reltables/">Relationship Tables</a> <img src="/images/lock/html" /> <blockquote> Adding reltables to your DITA Maps. Why are reltables better than related links in topics? </blockquote> <a href="/tutorials/localization/">Localization</a> <img src="/images/lock/html" /> <blockquote> Why is DITA ideal for content that must be localized? Writing for translation. Best practices for translation. </blockquote> <a href="/tutorials/help/">DITA as a Help Authoring Tool</a> <img src="/images/lock/html" /> <blockquote> DITA map as a Help TOC. DITA Open Toolkit Help options - CHM files, Eclipse Help, Jave Help. </blockquote> <a href="/tutorials/localization/">Specialization</a> <img src="/images/lock/html" /> <blockquote> Specialization of a DITA topic. Inheritance rules. </blockquote> <a href="/tutorials/open_toolkit/">Open Toolkit</a> <img src="/images/lock/html" /> <blockquote> Working with the toolkit. Build files. Output files. </blockquote> <a href="/tutorials/stylesheets/">Stylesheets</a> <img src="/images/lock/html" /> <blockquote> Designing stylesheets for your deliverables. </blockquote> <a href="/tutorials/publishing/">Publishing</a> <img src="/images/lock/html" /> <blockquote> Publishing with the Open Toolkit and Publishing Engines. </blockquote> Bob Doyle http://www.ditanews.com/timelines/PageComment.html?doWhat=ReadSeriesComments&RelDirPath=/about_us/blog/&PageID=1586 Fri, 01 Jun 2007 15:25:00 EDT http://www.ditanews.com/about_us/blog/index.31.en.html Localization of sample docsets http://www.ditanews.com/about_us/blog/index.30.en.html The <a href=ëxamples/">three example docsets</a> have now been localized into French, Italian, German, and Spanish. We hope to find volunteer translators to localize to many more languages. Members can now get a quick computer gist translation of assets in their workspace folder. We are also working on localizing the site navigation. We have been talking to <a href="http://lionbridge.com">Lionbridge</a> and <a href="http://idiominc.com">Idiom Technologies</a> about supporting our localization efforts with a browser-based, hosted translation management system. Then members who want to help us do translations can share our tranlation memories easily. Bob Doyle http://www.ditanews.com/timelines/PageComment.html?doWhat=ReadSeriesComments&RelDirPath=/about_us/blog/&PageID=1585 Wed, 23 May 2007 15:00:00 EDT http://www.ditanews.com/about_us/blog/index.30.en.html DITA and SCORM http://www.ditanews.com/about_us/blog/index.27.en.html <div class="nodecontent">At the May meeting of the Boston DITA Users Group, John Hunt of IBM described the work of the DITA subcommittee for learning and training content specialization. The goal of the subcommittee is one or more new information types for learning content, at the same level as the current three main types, concept, task, and reference, plus a new map domain to assemble the content as learning objects suitable for processing as deliverables for learning management systems (LMS). Subcommittee members went to the recent Summit meeting of the Advanced Distributed Learning (ADL) Initiative of the Department of Defense in Alexandria, VA. ADL developed the Shareable Content Object Reference Model (SCORM), which has been adopted as a standard exchange format by all the major LMS vendors, both commercial and open-source. Just as a DITA topic is the fundamental element of reuse, a SCO is the element of learning content reuse. Reusable learning objects (RLO) are made up of instructional objects and information objects. In the Cisco/Clark model (developed by Cisco Systems with the assistance of Dr. Ruth Clark) an RLO is made up from 7 plus or minus 2 reusable information objects (RIO). These are typically wrapped in an Overview, then followed by various practice and exercise steps. Summary and Assessment objects complete the instructional object. Assessment includes testing and the subcommittee is also studying the Question-Test Interoperability (QTI) specification. They will probably adopt a subset of QTI for their question and test data model. To turn content into learning and training, the subcommittee will define four new DITA learning types for instructional objects: Instructional Design type, Learning Overview topic type, Learning Summary topic type, and Learning Assessment topic type. Information objects will need one new Learning Content topic type. They will develop a map specialization for learning, with processing options for tutorials, courseware, instructor-led training (ILT), computer-based training (CBT), web-based training (WBT), and the exchange standard SCORM. The subcommittee has laid out a timetable of seven phases culminating in submission of a draft specification to the DITA TC in spring 2008 in time for incorporation in DITA 1.2. Hunt's slides are on the Boston DITA User Group page <a href="http://dita.xml.org/boston">http://dita.xml.org/boston</a> and the subcommittee's phased plan is available at <a href="http://wiki.oasis-open.org/dita/LearningContent/Phased_Design_Plan">http://wiki.oasis-open.org/dita/LearningContent/Phased_Design_Plan</a> (may require an OASIS member sign on).</div> Bob Doyle http://www.ditanews.com/timelines/PageComment.html?doWhat=ReadSeriesComments&RelDirPath=/about_us/blog/&PageID=1511 Tue, 15 May 2007 13:10:00 EDT http://www.ditanews.com/about_us/blog/index.27.en.html DITA Storm RC 9 http://www.ditanews.com/about_us/blog/index.22.en.html Release Candidate 9 of version 2.0 adds DITA References, a neat Outline view where you can move blocks up and down in the document, and properly formatted XML source code. We can now edit all the sample files in our three docsets. Bob Doyle http://www.ditanews.com/timelines/PageComment.html?doWhat=ReadSeriesComments&RelDirPath=/about_us/blog/&PageID=928 Wed, 11 Apr 2007 14:50:12 EDT http://www.ditanews.com/about_us/blog/index.22.en.html Bugs from Boston DITA Users Group http://www.ditanews.com/about_us/blog/index.15.en.html Last night's DITA Users Group meeting yielded a number of bugs in our current deployment as 14 people sat down at 12 workstations. Many joined for the first time (we now have over 50 testers). A longer report on the meeting will follow. These are the most important fixed bugs and other requested changes. We added a support email link at top of DITA Manager where members can report bugs easily. We changed the "login" link in the banner to link to a login to the user's DITA Manager instead of the timelines interface to the CMS. Added a link to DITA Manager from the File Manager. The index page in the dita subdirectory of a user home directory (workspace folder) will open the DITA Manager in a new window when double clicked. There is also a "DITA Manager" link in the toolbar when the file is selected, in the place where you might expect to find "Series Manager" in the CMS). BAsically, we are hiding the backend CMS from the average user. It will still be available for those comfortable with editing DITA sources. Many DITA Manager pages had a line of PHP being exposed at the top (like sHeadSpace); this has been corrected. We collected a few parsing errors to feedback to the DITA Storm team. Attempts to include an xref did not add the hyperlink to the output. We identified a number of users whose orders did not submit properly, keeping them from getting proper privileges, home directories, welcome emails, and mailing list subscriptions. The join process has been completed for those we know about, so that they now have all of the docset examples in their workspace folders, with privileges, etc. Any unrecognized users will be contacted for further assistance and join completion. Some users had two accounts due to problems in the join process. These have been corrected to one account per user. Bob Doyle http://www.ditanews.com/timelines/PageComment.html?doWhat=ReadSeriesComments&RelDirPath=/about_us/blog/&PageID=652 Tue, 13 Mar 2007 17:25:00 EDT http://www.ditanews.com/about_us/blog/index.15.en.html