001package org.apache.maven.doxia.module.docbook;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import javax.swing.text.html.HTML.Tag;
023
024import org.apache.maven.doxia.markup.XmlMarkup;
025
026/**
027 * List of <code>DocBook</code> markups.
028 * TODO: only use <a href="http://www.docbook.org/schemas/sdocbook/elements.html">Simplified DocBook elements</a>,
029 * remove full DocBook-only ones.
030 *
031 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
032 * @since 1.0
033 * @deprecated This interface is incomplete and will be removed. Use {@link SimplifiedDocbookMarkup} instead.
034 */
035@SuppressWarnings( "checkstyle:interfaceistype" )
036public interface DocbookMarkup
037    extends XmlMarkup
038{
039    /** DocBook V4.4 SGML public id: "-//OASIS//DTD DocBook V4.4//EN" */
040    String DEFAULT_SGML_PUBLIC_ID = "-//OASIS//DTD DocBook V4.4//EN";
041
042    /** DocBook XML V4.4 XML public id: "-//OASIS//DTD DocBook XML V4.4//EN" */
043    String DEFAULT_XML_PUBLIC_ID = "-//OASIS//DTD DocBook V4.4//EN";
044
045    /** DocBook XML V4.4 XML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" */
046    String DEFAULT_XML_SYSTEM_ID = "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd";
047
048    /** DocBook XML V4.4 SGML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" */
049    String DEFAULT_SGML_SYSTEM_ID = "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd";
050
051    // ----------------------------------------------------------------------
052    // Specific DocBook tags
053    // ----------------------------------------------------------------------
054
055    /** DocBook tag for <code>anchor</code> */
056    Tag ANCHOR_TAG = new Tag()
057    {
058        /** {@inheritDoc} */
059        public String toString()
060        {
061            return "anchor";
062        }
063    };
064
065    /** DocBook tag for <code>article</code> */
066    Tag ARTICLE_TAG = new Tag()
067    {
068        /** {@inheritDoc} */
069        public String toString()
070        {
071            return "article";
072        }
073    };
074
075    /** DocBook tag for <code>articleinfo</code> */
076    Tag ARTICLEINFO_TAG = new Tag()
077    {
078        /** {@inheritDoc} */
079        public String toString()
080        {
081            return "articleinfo";
082        }
083    };
084
085    /** DocBook tag for <code>book</code> */
086    Tag BOOK_TAG = new Tag()
087    {
088        /** {@inheritDoc} */
089        public String toString()
090        {
091            return "book";
092        }
093    };
094
095    /** DocBook tag for <code>bookinfo</code> */
096    Tag BOOKINFO_TAG = new Tag()
097    {
098        /** {@inheritDoc} */
099        public String toString()
100        {
101            return "bookinfo";
102        }
103    };
104
105    /** DocBook tag for <code>chapter</code> */
106    Tag CHAPTER_TAG = new Tag()
107    {
108        /** {@inheritDoc} */
109        public String toString()
110        {
111            return "chapter";
112        }
113    };
114
115    /** DocBook tag for <code>colspec</code> */
116    Tag COLSPEC_TAG = new Tag()
117    {
118        /** {@inheritDoc} */
119        public String toString()
120        {
121            return "colspec";
122        }
123    };
124
125    /** DocBook tag for <code>corpauthor</code> */
126    Tag CORPAUTHOR_TAG = new Tag()
127    {
128        /** {@inheritDoc} */
129        public String toString()
130        {
131            return "corpauthor";
132        }
133    };
134
135    /** DocBook tag for <code>date</code> */
136    Tag DATE_TAG = new Tag()
137    {
138        /** {@inheritDoc} */
139        public String toString()
140        {
141            return "date";
142        }
143    };
144
145    /** DocBook tag for <code>email</code> */
146    Tag EMAIL_TAG = new Tag()
147    {
148        /** {@inheritDoc} */
149        public String toString()
150        {
151            return "email";
152        }
153    };
154
155    /** DocBook tag for <code>entry</code> */
156    Tag ENTRY_TAG = new Tag()
157    {
158        /** {@inheritDoc} */
159        public String toString()
160        {
161            return "entry";
162        }
163    };
164
165    /** DocBook tag for <code>figure</code> */
166    Tag FIGURE_TAG = new Tag()
167    {
168        /** {@inheritDoc} */
169        public String toString()
170        {
171            return "figure";
172        }
173    };
174
175    /** DocBook tag for <code>formalpara</code> */
176    Tag FORMALPARA_TAG = new Tag()
177    {
178        /** {@inheritDoc} */
179        public String toString()
180        {
181            return "formalpara";
182        }
183    };
184
185    /** DocBook tag for <code>imagedata</code> */
186    Tag IMAGEDATA_TAG = new Tag()
187    {
188        /** {@inheritDoc} */
189        public String toString()
190        {
191            return "imagedata";
192        }
193    };
194
195    /** DocBook tag for <code>imageobject</code> */
196    Tag IMAGEOBJECT_TAG = new Tag()
197    {
198        /** {@inheritDoc} */
199        public String toString()
200        {
201            return "imageobject";
202        }
203    };
204
205    /** DocBook tag for <code>info</code> */
206    Tag INFO_TAG = new Tag()
207    {
208        /** {@inheritDoc} */
209        public String toString()
210        {
211            return "info";
212        }
213    };
214
215    /** DocBook tag for <code>informalfigure</code> */
216    Tag INFORMALFIGURE_TAG = new Tag()
217    {
218        /** {@inheritDoc} */
219        public String toString()
220        {
221            return "informalfigure";
222        }
223    };
224
225    /** DocBook tag for <code>informaltable</code> */
226    Tag INFORMALTABLE_TAG = new Tag()
227    {
228        /** {@inheritDoc} */
229        public String toString()
230        {
231            return "informaltable";
232        }
233    };
234
235    /** DocBook tag for <code>itemizedlist</code> */
236    Tag ITEMIZEDLIST_TAG = new Tag()
237    {
238        /** {@inheritDoc} */
239        public String toString()
240        {
241            return "itemizedlist";
242        }
243    };
244
245    /** DocBook tag for <code>link</code> */
246    Tag LINK_TAG = new Tag()
247    {
248        /** {@inheritDoc} */
249        public String toString()
250        {
251            return "link";
252        }
253    };
254
255    /** DocBook tag for <code>listitem</code> */
256    Tag LISTITEM_TAG = new Tag()
257    {
258        /** {@inheritDoc} */
259        public String toString()
260        {
261            return "listitem";
262        }
263    };
264
265    /** DocBook tag for <code>mediaobject</code> */
266    Tag MEDIAOBJECT_TAG = new Tag()
267    {
268        /** {@inheritDoc} */
269        public String toString()
270        {
271            return "mediaobject";
272        }
273    };
274
275    /** DocBook tag for <code>orderedlist</code> */
276    Tag ORDEREDLIST_TAG = new Tag()
277    {
278        /** {@inheritDoc} */
279        public String toString()
280        {
281            return "orderedlist";
282        }
283    };
284
285    /** DocBook tag for <code>para</code> */
286    Tag PARA_TAG = new Tag()
287    {
288        /** {@inheritDoc} */
289        public String toString()
290        {
291            return "para";
292        }
293    };
294
295    /** DocBook tag for <code>programlisting</code> */
296    Tag PROGRAMLISTING_TAG = new Tag()
297    {
298        /** {@inheritDoc} */
299        public String toString()
300        {
301            return "programlisting";
302        }
303    };
304
305    /** DocBook tag for <code>row</code> */
306    Tag ROW_TAG = new Tag()
307    {
308        /** {@inheritDoc} */
309        public String toString()
310        {
311            return "row";
312        }
313    };
314
315    /** DocBook tag for <code>section</code> */
316    Tag SECTION_TAG = new Tag()
317    {
318        /** {@inheritDoc} */
319        public String toString()
320        {
321            return "section";
322        }
323    };
324
325    /** DocBook tag for <code>simpara</code> */
326    Tag SIMPARA_TAG = new Tag()
327    {
328        /** {@inheritDoc} */
329        public String toString()
330        {
331            return "simpara";
332        }
333    };
334
335    /** DocBook tag for <code>tbody</code> */
336    Tag TBODY_TAG = new Tag()
337    {
338        /** {@inheritDoc} */
339        public String toString()
340        {
341            return "tbody";
342        }
343    };
344
345    /** DocBook tag for <code>term</code> */
346    Tag TERM_TAG = new Tag()
347    {
348        /** {@inheritDoc} */
349        public String toString()
350        {
351            return "term";
352        }
353    };
354
355    /** DocBook tag for <code>tgroup</code> */
356    Tag TGROUP_TAG = new Tag()
357    {
358        /** {@inheritDoc} */
359        public String toString()
360        {
361            return "tgroup";
362        }
363    };
364
365    /** DocBook tag for <code>thead</code> */
366    Tag THEAD_TAG = new Tag()
367    {
368        /** {@inheritDoc} */
369        public String toString()
370        {
371            return "thead";
372        }
373    };
374
375    /** DocBook tag for <code>ulink</code> */
376    Tag ULINK_TAG = new Tag()
377    {
378        /** {@inheritDoc} */
379        public String toString()
380        {
381            return "ulink";
382        }
383    };
384
385    /** DocBook tag for <code>url</code> */
386    Tag URL_TAG = new Tag()
387    {
388        /** {@inheritDoc} */
389        public String toString()
390        {
391            return "url";
392        }
393    };
394
395    /** DocBook tag for <code>variablelist</code> */
396    Tag VARIABLELIST_TAG = new Tag()
397    {
398        /** {@inheritDoc} */
399        public String toString()
400        {
401            return "variablelist";
402        }
403    };
404
405    /** DocBook tag for <code>varlistentry</code> */
406    Tag VARLISTENTRY_TAG = new Tag()
407    {
408        /** {@inheritDoc} */
409        public String toString()
410        {
411            return "varlistentry";
412        }
413    };
414
415    /** DocBook tag for <code>xref</code> */
416    Tag XREF_TAG = new Tag()
417    {
418        /** {@inheritDoc} */
419        public String toString()
420        {
421            return "xref";
422        }
423    };
424
425    // ----------------------------------------------------------------------
426    // Specific Docbook attributes
427    // ----------------------------------------------------------------------
428
429    /** DocBook attribute <code>cols</code> used in <code>tgroup</code> tags */
430    String COLS_ATTRIBUTE = "cols";
431
432    /** DocBook attribute <code>colsep</code> used in <code>informaltable</code> tags */
433    String COLSEP_ATTRIBUTE = "colsep";
434
435    /** DocBook attribute <code>fileref</code> used in <code>orderedlist, imageobject</code> tags */
436    String FILEREF_ATTRIBUTE = "fileref";
437
438    /** DocBook attribute <code>format</code> used in <code>imagedata</code> tags */
439    String FORMAT_ATTRIBUTE = "format";
440
441    /** DocBook attribute <code>frame</code> used in <code>informaltable</code> tags */
442    String FRAME_ATTRIBUTE = "frame";
443
444    /** DocBook attribute <code>linkend</code> used in <code>link</code> tag */
445    String LINKEND_ATTRIBUTE = "linkend";
446
447    /** DocBook attribute <code>numeration</code> used in <code>orderedlist</code> tag */
448    String NUMERATION_ATTRIBUTE = "numeration";
449
450    /** DocBook attribute <code>rowsep</code> used in <code>informaltable</code> tags */
451    String ROWSEP_ATTRIBUTE = "rowsep";
452
453    /** DocBook attribute <code>url</code> used in <code>ulink</code> tags */
454    String URL_ATTRIBUTE = "url";
455
456    // ----------------------------------------------------------------------
457    // Specific Docbook styles
458    // ----------------------------------------------------------------------
459
460    /** Docbook style <code>arabic</code> used in <code>numeration</code> attribute */
461    String ARABIC_STYLE = "arabic";
462
463    /** DocBook style <code>loweralpha</code> used in <code>numeration</code> attribute */
464    String LOWERALPHA_STYLE = "loweralpha";
465
466    /** DocBook style <code>lowerroman</code> used in <code>numeration</code> attribute */
467    String LOWERROMAN_STYLE = "lowerroman";
468
469    /** DocBook style <code>upperalpha</code> used in <code>numeration</code> attribute */
470    String UPPERALPHA_STYLE = "upperalpha";
471
472    /** DocBook style <code>upperroman</code> used in <code>numeration</code> attribute */
473    String UPPERROMAN_STYLE = "upperroman";
474}