==================================================================
The biblatex-publist package

A biblatex bibliography style file to produce academic
publication lists.

Maintained by Jürgen Spitzmüller
E-mail: juergen (at) spitzmueller (dot) org
Code repository and issue tracker:
    https://github.com/jspitz/biblatex-publist

Released under the LaTeX Project Public License v1.3 or later
See http://www.latex-project.org/lppl.txt
==================================================================

== PURPOSE ==

The biblatex-publist package provides a biblatex bibliography
style file (*.bbx) for publication lists, i.e. a bibliography
containing one's own publications. The style file draws on
biblatex's authoryear style per default (which can be changed),
but provides some extra features needed for publication lists,
such as the omission of the own name from author or editor data.

The package requires at least version 3.4 of the biblatex
package.


== CONTENTS ==

The package consists of the following files:

* publist.bbx (biblatex bibliography style file)
* publist.cbx (biblatex citation style file)
* publist.dbx (biblatex database model file)
* biblatex-publist.pdf (package documentation)
* biblatex-publist.tex (documentation source)
* README (this very file)


== DOCUMENTATION ==

See the included manual biblatex-publist.pdf for usage
instructions.


== CHANGES ==

* V. 2.13 (2024-08-21):
	- Add basic support for author annotations.
	- Add support for information about number of citations.
	- Add support for \citesecitem and \citesecitem* in
	  descending order.
	- Fix \citeitem in first refsection.

* V. 2.12 (2024-07-16):
	- Externalize localization to *.lbx files.
	- Add \citeitemrange and \citesecitemrange commands.
	- Fix error with section count on first run.

* V. 2.11 (2024-07-02):
	- Add \citesecitem and \citesecitem* commands.
	- Support multiple sections in \GetSectionCount.

* V. 2.10 (2024-06-17):
	- Add bibchecks to show only/no peer-reviewed items.
	- Fix bibchecks to work with braced and non-braced values.

* V. 2.9 (2024-05-09):
	- Add bibchecks to exclude (specific kinds of) unpublished work.

* V. 2.8 (2024-03-08):
	- Fix delimiter with plauthor second in a truncated author list (#50).

* V. 2.7 (2023-10-07):
	- Fix acending numbering without refsections (#49).

* V. 2.6 (2023-07-01):
	- Fix marginyear output with fixyear=false.

* V. 2.5 (2023-06-08):
	- New macros \GetSectionCount[<int>] and \GetTotalCount to output statistics (#46).
	- Fix issues with fixyear=false (#47).

* V. 2.4 (2023-05-18)
	- New option "fixyear" to opt-out special year handling and positioning (#45).
	- Make delimiters of author list with plauthorhandling=omit configurable.

* V. 2.3 (2023-03-18)
	- Change of sorting by means of \ExecutePublistOptions (via plsorting
	  or plauthorhandling) now works for all subsequent refsections.

* V. 2.2 (2022-03-01)
	- Fix plsorting with custom sorting schemes (#44).

* V. 2.1 (2022-12-03)
	- Honor \mkbibname* (#41).
	- Fix reverse numbering without refsections (#42).

* V. 2.0 (2022-10-24):
	- Provide \ExecutePublistOptions to change (most) biblatex-publist options
	  on the fly.
	- Properly support reverse numbering even if filtering is done (#38).
	- Add plnumgroup environment to temporarily suspend plnumbering=local.
	- Add new macro \setplnum (#39).
	- Rename macro \shiftbplnum to \shiftplnum (old macro kept for compatibility).
	- Fix with \shiftplnum with ascending enumeration.
	- Introduce one option (plnumbering) that replaces the previous two
	  (plnumbered + reversenumbering). Old options are kept for compatibility.
	- Introduce one multichoice option (linktitles) that replaces the previous
	  options (linktitleall, linktitledoi, linktitleurl, linktitleisbn,
	  linktitleissn). Old options are kept for compatibility.
	- Rename option boldyear to hlyear. Old option kept for compatibility.
	- Allow customization of the highlighting set with hlyear.
	- Introduce plsorting option.
	- Add support for OpenAccess information.
	- Add support for Journal Impact Factor.

* V. 1.27 (2022-10-03):
	- Fix once more plauthor check with non-ASCII chars and macros.

* V. 1.26 (2022-01-05):
	- Provide means to add peer review information.
	- Add a data model (*.dbx) file.
	- Fix \textcite output at least for the standard cases (#36).
	- Do not highlight/omit author/editor names in related entries.
	- Rename bpl:review:* macros to bpl:plain:* and add bpl:plain:editor.

* V. 1.25 (2021-12-14):
	- More robustification with names consisting of non-ASCII chars.
	- With "pubstateextra", differentiate between pubstates.

* V. 1.24 (2021-12-11):
	- Robustify handling of names with non-ASCII chars (#35).

* V. 1.23 (2021-09-01):
	- Fix omission of plauthor after related field (#34).

* V. 1.22 (2021-06-14)
	- Add option "pubstateextra".
	- Use \revsdnamepunct rather than hardcoded comma.

* V. 1.21 (2020-09-21)
	- Add option "reversenumbering".
	- Add \citeitem command.
	- Add \shiftbplnum and \shiftciteitem helper macros for manual
	  adjustment of numbering.
	- Properly sort "prepublished" pubstate type.

* V. 1.20 (2020-09-15)
	- Do not output "(with <authors>)" if no plauthor is among the authors.

* V. 1.19 (2020-08-21)
	- Fix parsing of name with initials (#24).
	- Fix output of et al. in byeditor lists.
	- Do not omit names in related entries.

* V. 1.18 (2020-07-31)
	- Support name truncation via maxnames.
	- Fix mine filter with author lists longer than maxnames.
	- Fix double editor with @periodical type.
	- Use editortypedelim.

* V. 1.17 (2020-07-10):
	- Add options to get clickable titles.

* V. 1.16 (2019-04-16):
	- Major code cleanup.

* V. 1.15 (2019-02-22):
	- Add support for omitting multiple authors.
	- Fix documentation issues.

* V. 1.14 (2019-02-21):
	- Add support for highlighting multiple authors.
	- Fix handling of non-ASCII names.
	- Use \DeclareStyleSourcemap rather that \DeclareSourcemap.
	- Update sorting documentation in the wake of biblatex changes.

* V. 1.13 (2018-11-30):
        - Introduce new sorting templates that ignore names.
        - CHANGE OF OUTPUT! Use ydt tempate by default.
        - Assign extralabel independent of author group with plauthorhandling=omit.

* V. 1.12 (2018-11-25):
        - Switch name parsing toggles globally (fixes regression with biblatex 3.12).
        - Account for omitted author when adding \finalnamedelim.
        - Fix issue with initial dot in nameorder=family-given.
	- Add option "plauthorfirstinit" that allows for specifying initials in
          first names of \plauthorname.

* V. 1.11 (2018-09-01):
	- Fix marginyear=true with labeldateparts=false.
	- Fix problem with empty parentheses in article with standard base style
	  and with labeldateparts=false.

* V. 1.10 (2018-04-08):
	- Extend option "plnumbered" with "plnumbered=reset".
	  This allows to restart the numbering of the publication list items
	  at \refsection's.
	- Documentation improvements.

* V. 1.9 (2018-03-01):
	- Add option "plnumbered" to switch of numbering in bibliography.
	- Documentation improvements.

* V. 1.8 (2017-11-14):
	- Adapt to biblatex 3.8. This version is now required.
	- Rename some macros, using pseudo-namespaces:
		* date:makedate => bpl:date:makedate
	    	* date:labelyear+extrayear => bpl:date:labeldate+extradate
	    	* marginyear => bpl:marginyear
	    	* rauthor => bpl:review:author
	    	* rauthor/label => bpl:review:author/label
	    	* year+labelyear => bpl:year+labelyear

* V. 1.7 (2017-04-12):
        - Output marginyear before the author list. This prevents it from being vertically
          shifted in case of long author lists.

* V. 1.6 (2017-04-02):
	- New option 'nameorder' that allows to change the ordering of author and editor
	  name ("given-family" vs. "family-given" [= default]).
	- Use proper name delimiters also for bookauthor.

* V. 1.5 (2017-02-28):
	- Fix extra "and" in name list with plauthorhandling=highlight.
	- Whitespace fix with plauthorhandling=highlight.
	- Use proper name delimiters.

* V. 1.4 (2017-02-12):
	- New option 'plauthorhandling' that defines how the publist author is
	  handled in the publication list (possible values: "omit" [= default],
	  "highlight").
	- New command \plauthorhl that determines the aforementioned highlighting.
	- Rename \omitname to \plauthorname (the old macro is still functional,
	  but marked as deprecated).
	- Rename omit* options to plauthor* (the old options are still functional,
	  but marked as deprecated).
	- Assure the margin text always starts uppercased (relevant for pubstates).
	- Minor corrections to the manual.

* V. 1.3 (2016-08-06):
	- It is now possible to change the base style that is used.
	- Proper sorting of pubstates.
	- Add possibility to increase the indentation of items (by means
          of the length extralabelnumberwidth).
	- Use pagetracker=true instead of pagetracker=spread by default
	  (avoids warning, no change in functionality).

* V. 1.2 (2016-05-12):
	- Accomodate to the backwards-incompatible changes of biblatex 3.4
	  (prefixnumber > labelprefix, \ifempty > \ifdefvoid).
	  This version of biblatex is now required.

* V. 1.1 (2016-03-09):
	- Adapt to the \Declare*Name changes of biblatex 3.3.

* V. 1.0 (2015-01-04):
	- Add portmanteau *.cbx file to allow loading biblatex-publist
	  also via the "style" option (next to "bibstyle").

* V. 0.9 (2014-03-13):
	- Fix problem with multi-token names.
	- Support name prefix in \omitname.
	- Support for pubstate.

* V. 0.8 (2013-08-16):
	- Add custom sorting schemes "ddnt", "ydmdnt" and "dnt".
	- Revise the documentation.

* V. 0.7 (2013-07-25):
	- Support full dates.

* V. 0.6 (2013-07-21):
	- Fix numbering with recent biblatex versions.

* V. 0.5 (2013-05-03):
	- Fix numbering if \printbibliography is used multiple
	  times without refsection.

* V. 0.4 (2012-10-30):
	- More robust name parsing (especially for names with
	  non-ASCII characters encoded with LaTeX macros).
	- Add \omitname command.
	- Support "firstinits" option.

* V. 0.3 (2012-10-23):
	- Bug fix: Add missing "and" if omitted name was last
	  minus one.
	- Bug fix: Fix output with "et al." if omitted name is
	  first and liststop is 1.
	- Set maxnames default to 4.
	- Add filter possibility.
	- Add French localization.
	- Some corrections to the manual.

* V. 0.2 (2012-10-21): Initial release to CTAN.