NEWS 
====

For more fine-grained list of changes or to report a bug, consult 

* [The issues log](https://github.com/cboettig/knitcitations/issues)
* [The commit log](https://github.com/cboettig/knitcitations/commits/master)

Versioning
----------

Releases will be numbered with the following semantic versioning format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

* Breaking backward compatibility bumps the major (and resets the minor 
  and patch)
* New additions without breaking backward compatibility bumps the minor 
  (and resets the patch)
* Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org/.


v0.6-2
------

- Apply accents to names for in-text citations (issue [#51](https://github.com/cboettig/knitcitations/issues/51))
- Use first name if author last name is not available, e.g. `citet(citation())` (issue [#55](https://github.com/cboettig/knitcitations/issues/55))


v0.6-1
------

- Bugfix in default `citep` method (caused by missing `page` argument)

v0.6-0
------

- Pandoc formatting is introduced as the prefered way to handle citations.  The `.Rmd` files remain as before, importing citation data on the fly with `citep()` and `citet` taking DOIs, URLs, or bibentries as arguments, but render in pandoc's markdown. The citations used are written to a bibtex file and the user must use pandoc (either directly or through RStudio's [rmarkdown](http://rmarkdown.rstudio.com)) to format the citations appropriately.  See the updated vignette & README. This method has to be enabled with `options(citation_format = "pandoc")` at present, otherwise compatibility mode is enabled by default.  (see [#57](https://github.com/cboettig/knitcitations/issues/57)) 


v0.5-0
------
* html print method now provides support for bulleted lists, see [#41](https://github.com/cboettig/knitcitations/issues/41)


v0.4-7
------
* Hard-wrap roxygen documentation to avoid line overflows in pdf manual

v0.4-6
------
* html print method now handled directly in knitcitations just like the
  markdown print method, with ordering, etc, since default html printing 
  method sucks
* ~~Tooltip provides HTML formatting, with link (issue [#37](https://github.com/cboettig/knitcitations/issues/37))~~
* HTML formatting inside tooltip (data-html="true") removed, since incompatible
  with Pandoc parser. [pandoc/#831](https://github.com/jgm/pandoc/issues/831) 

v0.4-5
------

* Provide page range as option to `citep` and `citet` (see issue [#32](https://github.com/cboettig/knitcitations/issues/32))
* Fixes a bug in which page numbers were not grabbed from the DOI look-up  
  ([#33](https://github.com/cboettig/knitcitations/issues/33))  
* Date added to Description file so that users can cite the development version
  properly ([#34](https://github.com/cboettig/knitcitations/issues/34))

v0.4-4
------

* Depends R (>= 2.15.0)
* Released to CRAN (2013-03-18)
* Minor changes: replace paste0 with paste, sep=""


v0.4-3
------

* Some bugfixes to bib_format method
* tooltip javascript uses class 'showtooltip' rather than rel='tooltip' to 
  avoid conflicting semantic meaning and styling and to avoid clashes with  
  existing 'tooltip' class in twitter bootstrap
* cito links fix href and use rel instead of property


v0.4-2
------

* Testing out `bib_format` method to change order of citation elements in 
  reference list

v0.4-1
------

* Fixes Issue [#27](https://github.com/cboettig/knitcitations/issues/27) in 
  rdfa printing
* Nicer markdown printing
* keep each function in separate file

v0.4-0
------

### Major changes

* Support for citations by URL.  Paste the full URL of any academic
  journal or other webpage.  Uses the Greycite API 
* Introduces linked inline citations as an option (previously active
  only for CITO links).  Inline citation text will be linked directly
  to the article by DOI or URL.  Toggle on or off using cite_options
  globally, or passing `linked=FALSE` to the calls to `citet` or `citep`
* Introduces tooltips option. Mouse over an inline citation and see
  the full citation information.  * Introduces `cite_options`, to toggle
  certain settings such as tooltips, linked inline text,


### Minor changes

* in-line link will use URL if a DOI is not found
* `cite` is now exported to the namespace.  Useful to return a bibentry object 
  given a DOI or URL.  


v0.3-5
------

* Fix formatting of parenthetical citations (bug introduced previously 
  converted these to citet format)
* Additional documentation
* Install instructions for development version added to README

v0.3-4
------

* Avoid dropped citations caused by redundant key collisions, closes #21




v0.3-3
------

* Added a new display option, `bibliography('markdown')`
* fixed BUG in the printing of the text-based name in bibliography for bibstyle-based calls

v0.3-2
------

* Semantic citations now enabled.  `bibliography` can print with method 'rdfa'
  to provide RDFa enhanced HTML bibliography data, and citations can take cito
  arguments as an option. (Closes issues #16 and #17)
* `bibliography` now takes more options to match the `bibstyle` and `print.bibentry`
  functions.
* `citet` and `citep` take an optional argument for formating the citation, defaulting
  to `authoryear` format.  Future versions may move this into an option.  
* `newbib()` function initializes and clears existing cache files.  
* README.md updated with semantic examples and more background text (generated by 
  inst/examples/README.Rmd). 
* Some basic unit tests built in.  Could use more, but meanwhile closes #8.
* Test cases work with knit2html button in RStudio, closes #14

v0.3-1
------

* Switched to handling citation data using environment rather than an external bibfile.
  This does not refer to the handling of user-provided bibtex files as input data,
  which are supported as before, but changes only the backend management of that data.
  The external bibtex file method can be switched back on by setting 
  `options("bibtex_data" = TRUE)`.  
* There is no need to call `print(bibliography, "html")`, one can simply call 
  `bibliography()` or `bibliography("html")`. Sort is still an option, other 
  options that were for internal use (`debug`, `remove_duplicates`) are 
  removed as they are no longer necessary.  
* Several new functions have been added to handle the new methods.  


v0.2-0
------

* Fix vignette error that prevents knitr 1.0 submission
* Fixed errors on installing package and lack of entries in bibliography
* Semantic print option added but still in early testing 

v0.1-0
------

* `bibliography()` now takes style as an option (html, text, bibtex output)
* imports write.bib from pkgmaker package instead of from doRNG
* URL in description on CRAN

v0.0-2
------

* Initial Release
