de.h2b.taglets.biblets
Class CiteTaglet

java.lang.Object
  extended by de.h2b.taglets.InlineTaglet
      extended by de.h2b.taglets.biblets.CiteTaglet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet

@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
extends InlineTaglet

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.

For example, {@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.

Since:
h2taglets 0.1
Version:
$Revision: 1.9 $, $Date: 2008/12/14 17:05:37 $
Author:
h2b
See Also:
BiblioTaglet
Bibliography:
[1] M. Abramowitz and I. A. Stegun (ed.). Handbook of Mathematical Functions. Dover Publications, New York (1964). 9th printing, 1970.
[2] D. E. Knuth. The TeXbook. Addison-Wesley, Reading, Massachusetts (1986).
[3] L. Lamport. LaTeX: A Document Preparation System. Addison-Wesley, Reading, Massachusetts (1986).

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

CiteTaglet

public CiteTaglet()
Creates this taglet.

Since:
h2taglets 0.1
Method Detail

register

@Deprecated
public static void register(java.util.Map tagletMap)
Deprecated. Use central registration of Registration instead.

Registers this taglet.

Parameters:
tagletMap - the map to register this tag to
Since:
h2taglets 0.1

getName

public java.lang.String getName()
Description copied from class: InlineTaglet
Returns the name of this custom tag.

Specified by:
getName in interface com.sun.tools.doclets.Taglet
Specified by:
getName in class InlineTaglet
Returns:
taglet's name

toString

public java.lang.String toString(com.sun.javadoc.Tag tag)
Returns the processed text of the tag.

Specified by:
toString in interface com.sun.tools.doclets.Taglet
Specified by:
toString in class InlineTaglet
Parameters:
tag - the tag to be processed
Returns:
the processed text
See Also:
InlineTaglet.toString(com.sun.javadoc.Tag)


Copyright © 2008 Hans-Hermann Bode, Berlin, Germany. All Rights Reserved.