<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--Rendered using the Haskell Html Library v0.2--> <HTML ><HEAD ><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8" ><TITLE >Text.CSL.Eval.Names</TITLE ><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css" ><SCRIPT SRC="haddock-util.js" TYPE="text/javascript" ></SCRIPT ><SCRIPT TYPE="text/javascript" >window.onload = function () {setSynopsis("mini_Text-CSL-Eval-Names.html")};</SCRIPT ></HEAD ><BODY ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="topbar" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD ><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" " ></TD ><TD CLASS="title" >citeproc-hs-0.3.2: A Citation Style Language implementation in Haskell</TD ><TD CLASS="topbut" ><A HREF="src/Text-CSL-Eval-Names.html" >Source code</A ></TD ><TD CLASS="topbut" ><A HREF="index.html" >Contents</A ></TD ><TD CLASS="topbut" ><A HREF="doc-index.html" >Index</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="modulebar" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD ><FONT SIZE="6" >Text.CSL.Eval.Names</FONT ></TD ><TD ALIGN="right" ><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="infohead" >Portability</TD ><TD CLASS="infoval" >unportable</TD ></TR ><TR ><TD CLASS="infohead" >Stability</TD ><TD CLASS="infoval" >unstable</TD ></TR ><TR ><TD CLASS="infohead" >Maintainer</TD ><TD CLASS="infoval" >Andrea Rossato <andrea.rossato@unitn.it></TD ></TR ></TABLE ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Description</TD ></TR ><TR ><TD CLASS="doc" >The CSL implementation </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Synopsis</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" ><A HREF="#v%3AevalNames" >evalNames</A > :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> [<A HREF="Text-CSL-Style.html#t%3AName" >Name</A >] -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-State-Lazy.html#t%3AState" >State</A > <A HREF="Text-CSL-Eval-Common.html#t%3AEvalState" >EvalState</A > [<A HREF="Text-CSL-Style.html#t%3AOutput" >Output</A >]</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AformatNames" >formatNames</A > :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> <A HREF="Text-CSL-Style.html#t%3ADelimiter" >Delimiter</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> [<A HREF="Text-CSL-Reference.html#t%3AAgent" >Agent</A >] -> <A HREF="Text-CSL-Style.html#t%3AName" >Name</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-State-Lazy.html#t%3AState" >State</A > <A HREF="Text-CSL-Eval-Common.html#t%3AEvalState" >EvalState</A > [<A HREF="Text-CSL-Style.html#t%3AOutput" >Output</A >]</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AisEtAl" >isEtAl</A > :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> [<A HREF="Text-CSL-Style.html#t%3AOption" >Option</A >] -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> [<A HREF="Text-CSL-Reference.html#t%3AAgent" >Agent</A >] -> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A >, <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A >)</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AisPlural" >isPlural</A > :: <A HREF="Text-CSL-Style.html#t%3APlural" >Plural</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AformatName" >formatName</A > :: <A HREF="Text-CSL-Eval-Common.html#t%3AEvalMode" >EvalMode</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> <A HREF="Text-CSL-Style.html#t%3AForm" >Form</A > -> <A HREF="Text-CSL-Style.html#t%3AFormatting" >Formatting</A > -> [<A HREF="Text-CSL-Style.html#t%3AOption" >Option</A >] -> [<A HREF="Text-CSL-Style.html#t%3ANamePart" >NamePart</A >] -> <A HREF="Text-CSL-Reference.html#t%3AAgent" >Agent</A > -> [<A HREF="Text-CSL-Style.html#t%3AOutput" >Output</A >]</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3Aunwords%27" >unwords'</A > :: [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AformatLabel" >formatLabel</A > :: <A HREF="Text-CSL-Style.html#t%3AForm" >Form</A > -> <A HREF="Text-CSL-Style.html#t%3AFormatting" >Formatting</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-State-Lazy.html#t%3AState" >State</A > <A HREF="Text-CSL-Eval-Common.html#t%3AEvalState" >EvalState</A > [<A HREF="Text-CSL-Style.html#t%3AOutput" >Output</A >]</TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Documentation</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:evalNames" ><A NAME="v%3AevalNames" ></A ></A ><B >evalNames</B > :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> [<A HREF="Text-CSL-Style.html#t%3AName" >Name</A >] -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-State-Lazy.html#t%3AState" >State</A > <A HREF="Text-CSL-Eval-Common.html#t%3AEvalState" >EvalState</A > [<A HREF="Text-CSL-Style.html#t%3AOutput" >Output</A >]</TD ><TD CLASS="declbut" ><A HREF="src/Text-CSL-Eval-Names.html#evalNames" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:formatNames" ><A NAME="v%3AformatNames" ></A ></A ><B >formatNames</B > :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> <A HREF="Text-CSL-Style.html#t%3ADelimiter" >Delimiter</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> [<A HREF="Text-CSL-Reference.html#t%3AAgent" >Agent</A >] -> <A HREF="Text-CSL-Style.html#t%3AName" >Name</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-State-Lazy.html#t%3AState" >State</A > <A HREF="Text-CSL-Eval-Common.html#t%3AEvalState" >EvalState</A > [<A HREF="Text-CSL-Style.html#t%3AOutput" >Output</A >]</TD ><TD CLASS="declbut" ><A HREF="src/Text-CSL-Eval-Names.html#formatNames" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >The <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A ></TT > is <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#v%3ATrue" >True</A ></TT > when formatting a name with a final <A HREF="et-al.html" >et-al</A >. The first <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A ></TT > represents the position and the second the role (e.i. editor, translator, etc.). </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:isEtAl" ><A NAME="v%3AisEtAl" ></A ></A ><B >isEtAl</B > :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> [<A HREF="Text-CSL-Style.html#t%3AOption" >Option</A >] -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> [<A HREF="Text-CSL-Reference.html#t%3AAgent" >Agent</A >] -> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A >, <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A >)</TD ><TD CLASS="declbut" ><A HREF="src/Text-CSL-Eval-Names.html#isEtAl" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >The first <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A ></TT > is <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#v%3ATrue" >True</A ></TT > if we are evaluating the bibliography. The <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A ></TT > is the cite position. The function also returns the number of contributors to be displayed. </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:isPlural" ><A NAME="v%3AisPlural" ></A ></A ><B >isPlural</B > :: <A HREF="Text-CSL-Style.html#t%3APlural" >Plural</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A ></TD ><TD CLASS="declbut" ><A HREF="src/Text-CSL-Eval-Names.html#isPlural" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:formatName" ><A NAME="v%3AformatName" ></A ></A ><B >formatName</B > :: <A HREF="Text-CSL-Eval-Common.html#t%3AEvalMode" >EvalMode</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> <A HREF="Text-CSL-Style.html#t%3AForm" >Form</A > -> <A HREF="Text-CSL-Style.html#t%3AFormatting" >Formatting</A > -> [<A HREF="Text-CSL-Style.html#t%3AOption" >Option</A >] -> [<A HREF="Text-CSL-Style.html#t%3ANamePart" >NamePart</A >] -> <A HREF="Text-CSL-Reference.html#t%3AAgent" >Agent</A > -> [<A HREF="Text-CSL-Style.html#t%3AOutput" >Output</A >]</TD ><TD CLASS="declbut" ><A HREF="src/Text-CSL-Eval-Names.html#formatName" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >Generate the <TT ><A HREF="Text-CSL-Reference.html#t%3AAgent" >Agent</A ></TT >s names applying et-al options, with all possible permutations to disambiguate colliding citations. The <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A ></TT > indicate whether we are formatting the first name or not. </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:unwords'" ><A NAME="v%3Aunwords%27" ></A ></A ><B >unwords'</B > :: [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A ></TD ><TD CLASS="declbut" ><A HREF="src/Text-CSL-Eval-Names.html#unwords%27" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:formatLabel" ><A NAME="v%3AformatLabel" ></A ></A ><B >formatLabel</B > :: <A HREF="Text-CSL-Style.html#t%3AForm" >Form</A > -> <A HREF="Text-CSL-Style.html#t%3AFormatting" >Formatting</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-State-Lazy.html#t%3AState" >State</A > <A HREF="Text-CSL-Eval-Common.html#t%3AEvalState" >EvalState</A > [<A HREF="Text-CSL-Style.html#t%3AOutput" >Output</A >]</TD ><TD CLASS="declbut" ><A HREF="src/Text-CSL-Eval-Names.html#formatLabel" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="botbar" >Produced by <A HREF="http://www.haskell.org/haddock/" >Haddock</A > version 2.6.1</TD ></TR ></TABLE ></BODY ></HTML >