|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.h2b.taglets.BlockTaglet
de.h2b.taglets.biblets.BiblioTaglet
@ClassLabel(copyright="Copyright (C) 2008 Hans-Hermann Bode", ident="$Id: BiblioTaglet.java,v 1.10 2008/12/14 17:05:37 h2b Exp $") public class BiblioTaglet
A block taglet for typesetting bibliograhical items.
The @bibitem
tag is intended to be used in conjunction with the
@cite
tag. By providing the same symbolic key as argument
to both tags, in the output an identical number enclosed in brackets will
appear at both places.
For simplicity and to get the references in one pass, a number is allocated
to a key at the first occurrence—whether as citation or as bib item.
The scope of this mechanism is limited to the file boundary.
The syntax is
{@bibitem
key, text}.
Obviously, a key string must not contain a comma;
furthermore, to avoid conflicts with future versions you should restrict
the key string to alphanumeric characters, periods, colons, hyphens and
underlines. Keys are case-sensitive.
The text may contain any characters except for a closing brace.
In the output, the number associated with the key, enclosed in brackets, will be placed in front of the text. Multiple items of one doc comment will be sorted by numbers.
For example, the three items in the bibliography block below result from@bibitem math-func, M. Abramowitz...
,
@bibitem texbook, D. E. Knuth...
and
@bibitem latex, L. Lamport...
(trailing text omitted, but items
defined in this order). When corresponding @cite
tags appear in a
different order before the block tags are declared, like this
{@cite texbook,latex,math-func}
[1, 2, 3], the order is changed as you see below.
(Note that the actual @bibitem
tags reside in the block section
below.)
CiteTaglet
Constructor Summary | |
---|---|
BiblioTaglet()
Creates this taglet. |
Method Summary | |
---|---|
java.lang.String |
getName()
Returns the name of this custom tag. |
static void |
register(java.util.Map tagletMap)
Deprecated. Use central registration of Registration instead. |
java.lang.String |
toString(com.sun.javadoc.Tag tag)
Returns the processed text of the tag. |
java.lang.String |
toString(com.sun.javadoc.Tag[] tags)
Returns the processed text of multiple tags. |
Methods inherited from class de.h2b.taglets.BlockTaglet |
---|
inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BiblioTaglet()
Method Detail |
---|
@Deprecated public static void register(java.util.Map tagletMap)
Registration
instead.
tagletMap
- the map to register this tag topublic java.lang.String getName()
BlockTaglet
getName
in interface com.sun.tools.doclets.Taglet
getName
in class BlockTaglet
public java.lang.String toString(com.sun.javadoc.Tag tag)
toString
in interface com.sun.tools.doclets.Taglet
toString
in class BlockTaglet
tag
- the tag to be processed
BlockTaglet.toString(com.sun.javadoc.Tag)
public java.lang.String toString(com.sun.javadoc.Tag[] tags)
toString
in interface com.sun.tools.doclets.Taglet
toString
in class BlockTaglet
tags
- the tags to be processed
BlockTaglet.toString(com.sun.javadoc.Tag)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |