de.h2b.taglets.biblets
Class BiblioTaglet

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

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

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.)

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

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

BiblioTaglet

public BiblioTaglet()
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: BlockTaglet
Returns the name of this custom tag.

Specified by:
getName in interface com.sun.tools.doclets.Taglet
Specified by:
getName in class BlockTaglet
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 BlockTaglet
Parameters:
tag - the tag to be processed
Returns:
the processed text
See Also:
BlockTaglet.toString(com.sun.javadoc.Tag)

toString

public java.lang.String toString(com.sun.javadoc.Tag[] tags)
Returns the processed text of multiple tags. The resulting rows are sorted by numerical bibitem labels.

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


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