/bib-shortcode

a WordPress shortcode to display a bibtexbrowser entry

Primary LanguagePHP

=== PRG Bibliography Shortcode ===
Contributors: masuhara
Tags: bibtex, bibliography, citation
Requires at least: 5.2
Tested up to: 6.6.1
Stable tag: v0.1.5-alpha
Requires PHP: 7.2
License: GPL v2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Shortcode to embed publication lists for PRG.

== Description ==
This plugin provides `prg-bib` shortcode that embeds a bibliography entry in a page.

It is customized for PRG\'s website where `bibtexbrowser.php` is installed under `/papers/`, the bibliography files like `prg-e.bib` are available under the same path.  

Usage
```
[prg-bib key=alice2099abc]
```

= How to update =
1. Decide the release name (e.g., v0.1.3-alpha)
2. Write the release name on Stable tag in readme.txt and prg-bib.php.
3. Add a Changelog section in readme.txt
4. Locally commit changes
5. Locally add a release tag (git tag v0.1.3-alpha)
6. Push the tag to github (git push --tags)
7. Make an archive by locally running rake
8. On https://github.com/prg-titech/bib-shortcode/tags, select the pushed tag
9. Create a release from a tag
10. Upload the archive (created at step 7) to the release

== Changelog ==

- v0.1.5-alpha
  IMPROVEMENT: support multiple keys

- v0.1.4-alpha
  FIX: check release tag in .php

- v0.1.3-alpha
  FIX: .js and readme files are included.

- v0.1.2-alpha
  Another test release with a feature to build a release archive.

- v0.1.1-alpha
  A test release for checking how it would look like in the installation.

- v0.1-alpha
  The initial release.