Skip to content

Commit 13844a6

Browse files
tonnesfnhoraciochacon
authored andcommitted
Added documentation on publication buttons (alshedivat#651)
* Added documentation on publication buttons * Added missing </details>
1 parent a3e0083 commit 13844a6

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

+22-3
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,27 @@ If the entry matches one of the combinations of the last names and the first nam
303303

304304
</details>
305305

306-
306+
<details><summary>(click to expand) <strong>Buttons (through custom bibtex keywords):</strong></summary>
307+
308+
There are several custom bibtex keywords that you can use to affect how the entries are displayed on the webpage:
309+
310+
- `abbr`: Adds an abbreviation to the left of the entry. You can add links to these by creating a venue.yaml-file in the _data folder and adding entries that match.
311+
- `abstract`: Adds an "Abs" button that expands a hidden text field when clicked to show the abstract text
312+
- `arxiv`: Adds a link to the Arxiv website (Note: only add the arxiv identifier here - the link is generated automatically)
313+
- `bibtex_show`: Adds a "Bib" button that expands a hidden text field with the full bibliography entry
314+
- `html`: Inserts a "HTML" button redirecting to the user-specified link
315+
- `pdf`: Adds a "PDF" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)
316+
- `supp`: Adds a "Supp" button to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)
317+
- `blog`: Adds a "Blog" button redirecting to the specified link
318+
- `code`: Adds a "Code" button redirecting to the specified link
319+
- `poster`: Adds a "Poster" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)
320+
- `slides`: Adds a "Slides" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)
321+
- `website`: Adds a "Website" button redirecting to the specified link
322+
323+
You can implement your own buttons by editing the bib.html file.
324+
325+
</details>
326+
307327
### Collections
308328

309329
This Jekyll theme implements `collections` to let you break up your work into categories.
@@ -315,8 +335,7 @@ Items from the `projects` collection are displayed on a responsive grid on proje
315335

316336
You can easily create your own collections, apps, short stories, courses, or whatever your creative work is.
317337
To do this, edit the collections in the `_config.yml` file, create a corresponding folder, and create a landing page for your collection, similar to `_pages/projects.md`.
318-
319-
338+
320339
### Layouts
321340

322341
**al-folio** comes with stylish layouts for pages and blog posts.

0 commit comments

Comments
 (0)