DITA FOR THE IMPATIENT PDF
June 21, 2020 | by admin
By reading this short tutorial, you’ll get acquainted with the DITA markup and after DITA for the Impatient Hussein Shafie August 18, XMLmind Software. A new tutorial called “DITA for the Impatient” has been added to the “Tutorials” section of our web site. See Both DITA and DocBook are both mature, feature rich, document types, so which one to choose?.
|Published (Last):||2 August 2010|
|PDF File Size:||4.21 Mb|
|ePub File Size:||15.30 Mb|
|Price:||Free* [*Free Regsitration Required]|
About topics and maps. The structure of the topic element.
The xref and link elements. Everything you’ll ever need to know about cache s. The topic element 3. Specialized topic types 4. The information unit used to compose a DITA document is called a topic.
DITA for the Impatient – XMLmind –
As its name suggests, a impateint addresses a single subject. The overall contents of a DITA document are specified using a topic map also simply called a map. A map mainly contains a hierarchy of topic references. File layout of this tutorial.
Remember It is recommended to have a single topic per XML file. The recommended filename extension for a topic file is “.
The recommended filename extension for a map file is “. Topic and map files may be contained in different directories.
You are free to organize the contents of these directories as you wish. Note that creating internal links in DITA, which is inherently modular, is slightly harder than in other, generally-monolithic, document types. Therefore it is important to read this section carefully. Use the id attribute to specify it. However, it is recommended to keep it short, approximately one paragraph long, because the contents of this element are often used during navigation e.
Topics being generally short, this section stands out clearly after the body of a topic. That’s why it is often preferred to spreading links inside the body of a topic. It is well-documented DocBook: The Complete Guidefeaturing decent XSL stylesheets allowing conversion to a variety of formats, based on the best schema technologies: However the DocBook vocabulary is comprehensive and very well thought out.
DocBook 5 is a mature document type. DITA concepts topics, maps, specialization, etc have an immediate appeal to the technical writer, making this document type more attractive than DocBook. This item contains an ordered list. This item contains a variable list. The photo converted to black and white. Tables DITA has two kinds of table element: The relcolwidth attribute may be used to specify the relative width of each column.
CALS tables are quite complex and explaining how they can be used is out of the scope of this tutorial. However like with any other document type, you should always try to use the most specific element for your needs.
DITA for the Impatient
DITA has dozens of such useful inline elements. In order to use them, we recommend authoring your documents with a DITA-aware XML editor and browsing through the element names suggested by the editor. Generally these names are very descriptive, so there is no real need to read the documentation. Let’s suppose you want to refer to the ” Open ” item of the ” File ” menu. Much nicer, isn’t it? For both elements, the target of the link is specified by the value of the href attribute, which is an absolute or relative URL, possibly ending with a fragment.
This location may be an absolute or relative URL. This location is not intended to be transformed by the DITA processing software e. Remember Always specify a text for an external link, as the DITA processing software has no way to automatically generate some text for such links. Always specify the format attribute of the link element. By doing so, you instruct the DITA processing software to use the target location as is in the deliverable.
This target element may be found in the same XML file as the link element or, on the contrary, in a different XML file. The later case is still considered to be an internal link because both the link and its target belong to the same overall DITA document. Of course, in order to use a DITA element as the target of a link, this element must have an id attribute.
The value of the href attribute of a link element is: What is the qualified ID of the target element? Let’s suppose that djta want to address elements contained in topic2. Remember There is generally no need to specify the text of internal links, as the DITA processing software can automatically generate this text.
This probably works fine for any element having a title: However this cannot work for the other elements. For example, do not expect the DITA processing software to generate some text for:.
DITA for the Impatient – XMLmind
impatienr Link targets are tedious and error prone to specify by hand. There are four more specialized topic types: What is a cache? In computer science, a cache is a temporary storage area where frequently accessed data can be stored for rapid access. A cache hit occurs when the requested data can be found in a cache, while a cache miss occurs when it cannot. To be cost-effective and to enable efficient use of data, caches must be relatively small. Procedure Unzip the distribution anywhere.
We recommend to use the free, open source, Info-ZIP utility to do so.
DITA for the Impatient
Doing this will create an emacs A confirmation dialog box is displayed. The pwd command pwd. Note Your shell may have its own version of pwdwhich usually supersedes the version described here. The following example shows three glossary entries having the following IDs: Web development techniques used on the client-side to create interactive web applications. Web development techniques used on the client-side to create interactive web sites.
It allows the development of interactive web sites and web applications. Remember It is not recommended to create XML files containing several topics because if you do so, first this makes it harder reusing your topics in different documents and second, this makes the topic map slightly harder to specify.
If the target XML file contains several topics not recommendedyou’ll have to use a fragment to specify the ID of the referenced topic. What does this mean? What follows is the topic map actually used for this tutorial contents of file tutorial.
These wrapper elements can contain references to actual, hand-written, topics: These placeholders instructs the DITA processing software to automatically generate: However we believe that what you have learned here is sufficient to start authoring your first DITA document. For example, do not expect the DITA processing software to generate some text for: A topic may contain other topics.
More about topic maps later in this tutorial.