|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.h2b.taglets.InlineTaglet
de.h2b.taglets.biblets.CiteTaglet
@ClassLabel(copyright="Copyright (C) 2008 Hans-Hermann Bode", ident="$Id: CiteTaglet.java,v 1.9 2008/12/14 17:05:37 h2b Exp $") public class CiteTaglet
An inline taglet for citing bibliographical items.
The @cite
tag is intended to be used in conjunction with the
@bibitem
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; also, a hyperlink is created that points from the
citation to the referenced bibitem.
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 {@cite
key} or
{@cite
key1,key2,...}, i.e., you can cite
several items at once. 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.
{@cite math-func}
results in the citation
[1] and {@cite texbook,latex}
yields
[2, 3]. Note the bibliography block below which arises
from corresponding @bibitem
tags.
BiblioTaglet
Constructor Summary | |
---|---|
CiteTaglet()
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. |
Methods inherited from class de.h2b.taglets.InlineTaglet |
---|
inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CiteTaglet()
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()
InlineTaglet
getName
in interface com.sun.tools.doclets.Taglet
getName
in class InlineTaglet
public java.lang.String toString(com.sun.javadoc.Tag tag)
toString
in interface com.sun.tools.doclets.Taglet
toString
in class InlineTaglet
tag
- the tag to be processed
InlineTaglet.toString(com.sun.javadoc.Tag)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |