VirtualBox

source: vbox/trunk/src/libs/dbdita-1.0/doc/ditaWriter.html@ 99012

Last change on this file since 99012 was 98585, checked in by vboxsync, 2 years ago

Docs: bugref:10302. Setting svn properties of db2dita converter.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.7 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<!--
3 | LICENSE: This file is part of the DITA Open Toolkit project hosted on
4 | Sourceforge.net. See the accompanying license.txt file for
5 | applicable licenses.
6 *-->
7<!--
8 | (C) Copyright IBM Corporation 2006. All Rights Reserved.
9 *-->
10<html lang="en-us" xml:lang="en-us">
11<head>
12<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
13<meta name="copyright" content="(C) Copyright 2005" />
14<meta name="DC.rights.owner" content="(C) Copyright 2005" />
15<meta content="public" name="security" />
16<meta content="index,follow" name="Robots" />
17<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
18<meta content="topic" name="DC.Type" />
19<meta name="DC.Title" content="DITA writer" />
20<meta name="abstract" content="This directory contains the DITA output writer." />
21<meta name="description" content="This directory contains the DITA output writer." />
22<meta scheme="URI" name="DC.Relation" content="../doc/docbook2dita.html" />
23<meta content="XHTML" name="DC.Format" />
24<meta content="ditawriter" name="DC.Identifier" />
25<meta content="en-us" name="DC.Language" />
26<link href="../commonltr.css" type="text/css" rel="stylesheet" />
27<title>DITA writer</title>
28</head>
29<body id="ditawriter"><a name="ditawriter"><!-- --></a>
30
31
32<h1 class="topictitle1">DITA writer</h1>
33
34
35<div><p>This directory contains the DITA output writer.</p>
36
37<p>The output writer provides the following rules for each output element.
38(In the descriptions, <var class="varname">moduleName</var> stands for a module that
39provides an element or attribute, <var class="varname">elementName</var> stands for
40an element, and <var class="varname">attributeName</var> stands for an attributeName.)
41Each rule consists of a mode:</p>
42
43<dl>
44<dt class="dlterm"><var class="varname">moduleName</var>.<var class="varname">elementName</var>.out</dt>
45
46<dd>Generates the <var class="varname">elementName</var> element from the <var class="varname">moduleName</var> module.
47For instance, the <samp class="codeph">topic.keyword.out</samp> rule generates a <samp class="codeph">&lt;keyword&gt;</samp> element.
48The rule also fires the wrapper rules to request the attributes and content
49of the element. </dd>
50
51
52<dt class="dlterm"><var class="varname">moduleName</var>.<var class="varname">elementName</var>.atts.in</dt>
53
54<dd>Provides a wrapper for requesting the attributes of the <var class="varname">elementName</var> element
55from <var class="varname">moduleName</var> module.</dd>
56
57
58<dt class="dlterm"><var class="varname">moduleName</var>.<var class="varname">elementName</var>.<var class="varname">attributeName</var>.att.in</dt>
59
60<dd>Requests the value of <var class="varname">attributeName</var> in the context
61of the <var class="varname">elementName</var> element from the <var class="varname">moduleName</var> module.
62The default handler for this rule requests the value of <var class="varname">attributeName</var> in
63any context. </dd>
64
65
66<dt class="dlterm"><var class="varname">attributeName</var>.att.in</dt>
67
68<dd>Requests the value of <var class="varname">attributeName</var> in any context. </dd>
69
70
71<dt class="dlterm"><var class="varname">moduleName</var>.<var class="varname">elementName</var>.content.in</dt>
72
73<dd>Provides a wrapper for requesting the content of the <var class="varname">elementName</var> element
74from <var class="varname">moduleName</var> module. If the content model isn't shared,
75the default handler for this rule requests content from the children and text
76(if the content model supports mixed content) of the current input node.<p>If
77the content model is shared, the default handler invokes a rule for the shared
78content model. For instance, elements that accept content conforming to the <samp class="codeph">words.cnt</samp> group
79invoke the rule for <samp class="codeph">words.cnt.text.in</samp>.</p>
80<p>If the content
81model takes a simple sequence, the default handler for this rule requests
82the subelements in sequence. </p>
83</dd>
84
85
86<dt class="dlterm"><var class="varname">moduleName</var>.<var class="varname">elementName</var>.child</dt>
87
88<dd>Requests the current input element as a child in the context of the <var class="varname">elementName</var> element
89from the <var class="varname">moduleName</var> module. The default handler for this
90rule requests the current input element as a child in any context.</dd>
91
92
93<dt class="dlterm">child</dt>
94
95<dd>Requests the current input element as a child in any context.</dd>
96
97
98<dt class="dlterm"><var class="varname">moduleName</var>.<var class="varname">elementName</var>.in</dt>
99
100<dd>Requests the <var class="varname">elementName</var> element from the <var class="varname">moduleName</var> module.
101This rule gets invoked only by a content wrapper when the content model has
102a simple sequence.</dd>
103
104</dl>
105
106<p>The reader can handle a request in a specific output context or in any
107context as appropriate. For instance, the Docbook reader handles a context-free
108request for an id attribute by copying the id (if present) on the current
109input element to the output. In addition, however, the Docbook reader handles
110the request for an id attribute in a topic context by generating an id if
111necessary. </p>
112
113<pre />
114
115</div>
116
117<div>
118<div class="familylinks">
119<div class="parentlink"><strong>Parent topic:</strong> <a href="../doc/docbook2dita.html" title="This directory provides the docbook-to-dita transform.">The Docbook to DITA transform</a></div>
120</div>
121</div>
122
123</body>
124</html>
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette