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