aglc2.cbx

% AGLC2 citation style for Biblatex
% This file was created by editing the standard biblatex style

\ProvidesFile{verbose-ibid.cbx}
\ExecuteBibliographyOptions{citetracker=context,ibidtracker=constrict,
                            pagetracker,autocite=footnote}
\providecommand*{\mkibid}[1]{#1}
\newbool{cbx@loccit}

\setlength\bibhang{0pt}
\renewcommand\bibfont{\small}

\defbibheading{articles}{\subsection*{Articles/Books/Reports}}
\defbibheading{cases}{\subsection*{Case Law}}
\defbibheading{legislation}{\subsection*{Legislation}}
\defbibheading{treaties}{\subsection*{Treaties}}
\defbibheading{other}{\subsection*{Other Sources}}

\defbibfilter{articles}{\not \keyword{citeonly} \and \( \type{book} \or \type{inbook} \or \type{incollection} \or \type{article} \or \type{report} \)}
\defbibfilter{cases}{\not \keyword{citeonly} \and \type{jurisdiction}}
\defbibfilter{legislation}{\not \keyword{citeonly} \and \type{legislation}}
\defbibfilter{treaties}{\not \keyword{citeonly} \and \type{legal}}
\defbibfilter{other}{\not\keyword{citeonly} \and \not \( \type{book} \or \type{inbook} \or \type{incollection} 
                     \or \type{article} \or \type{jurisdiction} \or 
                     \type{legislation} \or \type{legal} \or \type{report} \)}

\DefineBibliographyStrings{english}{%
  andothers            = {et al},
  editor           = {\addspace{}(ed)},
  editors          = {\addspace{}(eds)},
  edition              = {ed},
  january              = {January},
  february             = {February},
  march                = {March},
  april                = {April},
  may                  = {May},
  june                 = {June},
  july                 = {July},
  august               = {August},
  september            = {September},
  october              = {October},
  november             = {November},
  december             = {December},
}

\DeclareListFormat{endash}{% 
#1% 
\ifthenelse{\value{listcount}<\value{liststop}} 
{--} 
{}}
\renewcommand*{\UrlFont}{\normalfont}
\newrobustcmd{\mkbibangle}[1]{%
  \begingroup%
  \let\mkbibangle\blx@nobrackets%
  $<$#1$>$%
  \endgroup}
\DeclareFieldFormat{angle}{\mkbibangle{#1}}
\DeclareFieldFormat{url}{\mkbibangle{\url{#1}}}


\def\wmkbibordinal#1{%
    \@tempcnta0#1 \the\@tempcnta
    \ifthenelse{\@tempcnta>1000}{\hspace{0.2em}}{%
    \@whilenum\@tempcnta>100\do{\advance\@tempcnta-100}%
    \ifnum\@tempcnta>20
      \@whilenum\@tempcnta>9\do{\advance\@tempcnta-10}%
    \fi
    $^{\ifcase\@tempcnta th\or st\or nd\or rd\else th\fi}$}}%
\DeclareFieldFormat{edition}{\wmkbibordinal{#1}\hspace{0.1em}\bibstring{edition}}


% Used in the bibliography, first name displayed as last-first and subsequent names
% displayed as first-last.  If too many names show the first with "et al"
\DeclareNameFormat{sortname}{%
	\ifthenelse{\value{listcount}=1}
		{%
			\usebibmacro{name:last-first}{#1}{#3}{#5}{#7}%
			\usebibmacro{name:andothers}%
		} {%
  			\ifthenelse{\value{listcount}>1\and\value{listtotal}>\value{liststop}}
			{}%
			{\usebibmacro{name:first-last}{#1}{#3}{#5}{#7}}%
		}%
}

% Used in all citations, always first-last, if too many names show the first with "et al"
\DeclareNameFormat{default}{%
  \ifthenelse{\value{listcount}>1\and\value{listtotal}>\value{liststop}}{}{%
    \usebibmacro{name:first-last}{#1}{#3}{#5}{#7}}%
  \usebibmacro{name:andothers}}


% Print "et al" with only the first author
%\renewbibmacro*{name:andothers}{% 
%  \ifthenelse{\value{listtotal}>\value{liststop}\AND\value{listcount}=2\AND\ifmorenames}%
%    {\addspace\bibstring{andothers}}%
%    {}} 

\DeclareBibliographyOption{ibidpage}[true]{%
  \ifstrequal{#1}{true}
    {\ExecuteBibliographyOptions{loccittracker=constrict}}%
    {\ExecuteBibliographyOptions{loccittracker=false}}}%


% Redefine how backref works, to use footnotes, not pages.
\def\blx@backref@global{%
  \iffootnote{%
  \blx@leavevmode%
  \if@filesw%
    \protected@write\@mainaux{}{\string\abx@aux@backref%
      {\the\c@instcount}{\abx@field@entrykey}%
      {\the\c@refsection}{\thefootnote}}%
  \fi}{}}

\DeclareListFormat{last}{\ifthenelse{\value{listcount}=1}{#1}{}}
\DeclareNameFormat{surname}{\ifthenelse{\value{listcount}=1}{#1}{}}
\DeclareNameFormat{firstname}{\ifthenelse{\value{listcount}=1}{#3}{}}

\newbibmacro{author/editor:surname}{%
  \ifthenelse{\ifuseauthor\AND\NOT\ifnameundef{author}}%
    {\ifuseauthor{\printnames[surname]{author}}{}}%
    {\ifthenelse{\ifuseeditor\AND\NOT\ifnameundef{editor}}{\printnames[surname]{editor}}{}}}

\newbibmacro{author/editor:firstname}{%
  \ifthenelse{\ifuseauthor\AND\NOT\ifnameundef{author}}%
    {\ifuseauthor{\printnames[firstname]{author}}{}}%
    {\ifthenelse{\ifuseeditor\AND\NOT\ifnameundef{editor}}{\printnames[firstname]{editor}}{}}}

\newbibmacro*{author/editor:lastnamefirst}{%
  \ifthenelse{\ifuseauthor\AND\NOT\ifnameundef{author}}%
    {\ifuseauthor{\printnames[sortname]{author}}{}}%
    {\ifthenelse{\ifuseeditor\AND\NOT\ifnameundef{editor}}{\printnames[sortname]{editor}}{}}}

\newbibmacro*{cite:save}{%
	\csxdef{cbx@\thefield{entrykey}}{\the\value{instcount}}%
	\label{cbx@\the\value{instcount}}%
}

\newbibmacro*{cite}{%
	\global\boolfalse{cbx@loccit}%
	\ifciteseen
	{%
		\iffieldundef{shorthand}
		{%
			\ifthenelse{\ifciteibid\AND\NOT\iffirstonpage}
			{%
				% citeibid is true and this citation has been seen on this page previously
				% and citation is in a footnote
				\usebibmacro{cite:ibid}%
				\setunit{\space}\newblock\printfield{prenote}\setunit{}%
			} {%else
				% either citeibid is false or this is the first time the citation appears
				% on this page
				\ifthenelse{\(\equal{\thefield{entrytype}}{jurisdiction}\or%
						\equal{\thefield{entrytype}}{legislation}\or%
						\equal{\thefield{entrytype}}{legal}\)%
					\or\not\ifciteseen}%
             			{%
					% If the entry is a jurisdiction or legislation or legal
					% or if the citation has not been seen before
					% ie: this is how to print a first citation.  Legislation, legal and
					% jurisdictions are always printed as though they were a first citation.
					\usebibmacro{cite:short}%
				} {% else
					% Must be something else or a subsequent citation
					\usebibmacro{author/editor:surname}\addnbspace%
					above n\addnbspace\ref{cbx@\csuse{cbx@\thefield{entrykey}}}%
					\iffieldundef{postnote}{.\nopunct}{\nopunct\finentry}%
				}%
			} {%
				% shorthand field is defined
				\usebibmacro{cite:shorthand}%
			}%
		}%

	}{%
		% citation has not been seen before
		\usebibmacro{cite:full}%
		\usebibmacro{cite:save}%
	}%
}


\newbibmacro*{cite:full}{%
  \printtext[bibhypertarget]{%
    \usedriver%
      {\DeclareNameAlias{sortname}{default}}%
      {\thefield{entrytype}}}%
  \usebibmacro{shorthandintro}}


% Display the shorthand, for AGLC2 rules 2.1.8 and 2.1.9. eg (`Mabo')
% This can be overridden by the field "shorthandintro" eg (I will sometimes refer to this case as Mabo)
\renewbibmacro*{shorthandintro}{%
  \iffieldundef{shorthandintro}
    {\ifthenelse{\iffieldundef{shorttitle} \and \iffieldundef{shorthand}}
       {}
       {\setunit{\addspace}%
        \printtext[parens]{%
          `{\it \usebibmacro{shorthand-or-title}'\hspace{0.15em}}}}}
    {\setunit{\addspace}%
     \printtext[parens]{\printfield{shorthandintro}}}}


% Pick either the shorthand or the shorttitle, if there is no shorthand.
\newbibmacro*{shorthand-or-title}{%
    {\it \iffieldundef{shorthand}%
        {\iffieldundef{shorttitle}%
            {\thefield{title}}%
            {\thefield{shorttitle}}}%
        {\thefield{shorthand}}%
}}


\newbibmacro*{cite:short}{%
  %\printnames{labelname}%
  %\setunit*{\addcomma\space}%
  %\printtext[bibhyperlink]{%
    %\printfield[citetitle]{labeltitle}}}
  \printtext[bibhypertarget]{%
    \usedriver{}{short:\thefield{entrytype}}}}%

\newbibmacro*{cite:shorthand}{%
  \printtext[bibhyperlink]{%
    \printfield{shorthand}}}

\newbibmacro*{cite:ibid}{%
  \printtext[bibhyperref]{Ibid}%
  \ifloccit
    {\global\booltrue{cbx@loccit}}
    {}\iffieldundef{postnote}{.\nopunct}{\nopunct}}

\newbibmacro*{cite:postnote}{%
  \ifbool{cbx@loccit}%
    {}%
    {\usebibmacro{postnote}}%
}

\renewbibmacro*{postnote}{%
  \setunit{}\newblock\printfield{postnote}\setunit{}
}

\DeclareCiteCommand{\casename}
  {\citetrackerfalse
   \pagetrackerfalse
   \usebibmacro{prenote}}
  {\iffieldundef{shorttitle}{\printfield{title}}{\ifciteseen{\printfield{shorttitle}}{\printfield{title}\addspace\mkbibparens{`\printfield{shorttitle}'}}}}
  {\multicitedelim}
  {\usebibmacro{postnote}}

% This command prints only the citation for a given case, eg [2006] HCA 14
\DeclareCiteCommand{\citecase}
  {\citetrackerfalse
   \pagetrackerfalse
   \usebibmacro{prenote}}
  {%\indexfield{indextitle}%
   \printfield[citecase]{note}}
  {\multicitedelim}
  {\usebibmacro{postnote}}

% TODO: Allow cases to be cited in footnotes (inline citation).
% TODO: Ibid should be allowed for \case but not above n.
% TODO: Also seem the note, pinpoint format of the footnote is no longer valid.
\DeclareCiteCommand{\case}
	{}
	{%
		\ifciteseen {%
				% First print the mainline title and a postnote if it exists
				\iffieldundef{shorttitle}
				{%
					\printfield{title}%
				} {%
					\printfield{shorttitle}%
				}%
				% Now print the footnote but only if the postnote exists.
				% Note the trailin full-stop at the end.
				\iffieldundef{postnote}%
				{} % No need to print anything if there's no postnote
				{%
					%Manage ibids
					\ifthenelse{\ifciteibid\AND\NOT\iffirstonpage}%
					{%
						\mkbibfootnote{%
							\usebibmacro{cite:ibid}%
						}%
					} {%
						% Print a footnote with the note field and then the postnote
						% as a pinpoint afterwards.  Note the trailing full-stop
						\mkbibfootnote{%
							\printfield[citecase]{note}%
							\setunit{\addcomma\space}\newblock\printfield{postnote}\setunit{}.%
						}%
					}%
				}%
				\iffieldundef{postnote}%
					{}% Do nothing if the postnote is not defined
					{%
						% Otherwise print a space and the postnote
						\setunit{\space}\newblock\printfield{postnote}\setunit{}%
					}%
			}%
			{% Print the first citation
				\printfield{title}%
				%
				% Print the footnote. No need to manage ibids as this is the first 
				% occurrence of the citation
				\mkbibfootnote{%
					\printfield[citecase]{note}%
					% Print the prenote if it exists
					\iffieldundef{postnote}
					{}
					{%
						\setunit{\space}\newblock%
						\printfield{postnote}%
						\setunit{}.%
					}%
				}%
				%
				% Print a postnote if it exists
 				% a prenote is where we keep comments to print after the case.
				\iffieldundef{prenote}
					{} % Do nothing if the postnote is not defined
					{%
						% Print a space and the postnote
						\setunit{\space}\newblock\printfield{prenote}\setunit{}%
					}%
				%
				% Print the short title if it exists
				\iffieldundef{shorttitle}
				{}
				{%
					\addspace%
					\mkbibparens{`\printfield{shorttitle}'}%
				}%
			}%
	}
	{}
	{}
	{}
\DeclareCiteCommand{\footcase}[\mkbibfootnote]
	{}
	{%
		\ifciteseen
		{%
			\ifthenelse{\ifciteibid\AND\NOT\iffirstonpage}
			{%
				\usebibmacro{cite:ibid}%
				\iffieldundef{postnote}
				{} {%
					\setunit{\space}\newblock\printfield{postnote}\setunit{}.%
				}%
			} {%
				% First print the title or the shorttitle
				\iffieldundef{shorttitle}
				{%
					\printfield{title}%
				} {%
					\printfield{shorttitle}%
				}%
				%
				% Always print the note
				\addspace\printfield[citecase]{note}%
				%
				% Print the pinpoint if it exists
				\iffieldundef{postnote}
				{}%
				{%
					\setunit{\space}\newblock\printfield{postnote}\setunit{}.%
				}%
			}%
		} {%
			% If the citation is not seen always print the title first
			\printfield{title}%
			%
			% Always print the note
			\addspace\printfield[citecase]{note}%
			%
			% Print the pinpoint if it exists
			\iffieldundef{postnote}
			{} {%
				\setunit{\space}\newblock\printfield{postnote}\setunit{}.%
			}%
			% Print the shorttitle at the end if it exists
			\iffieldundef{shorttitle}
			{}%
			{%
				\addspace%
				\mkbibparens{`\printfield{shorttitle}'}%
			}%
		}%
	}
	{}
	{}
	{}

\DeclareCiteCommand{\cite}
{%
	\iffootnote
		{}
		{\citetrackerfalse}\usebibmacro{prenote}%
}
{%
	\usebibmacro{citeindex}%
   	\usebibmacro{cite}%
}
{\multicitedelim}
{\usebibmacro{cite:postnote}}

\DeclareCiteCommand{\parencite}[\mkbibparens]
  {\usebibmacro{prenote}}
  {\usebibmacro{citeindex}%
   \usebibmacro{cite}}
  {\multicitedelim}
  {\usebibmacro{cite:postnote}}

\DeclareCiteCommand{\footcite}[\mkbibfootnote]
  {\bibsentence
   \usebibmacro{prenote}}
  {\usebibmacro{citeindex}%
   \usebibmacro{cite}}
  {\multicitedelim}
  {\usebibmacro{cite:postnote}}

\endinput