Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
grizzly committed Dec 11, 2024
1 parent aa8bd9f commit 1faf2dd
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions packages/preview/acrostiche/0.5.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,18 @@ Finally, you can call the `#display-def(...)` function to display the definition
| **#display-def(...)** | Displays the definition of an acronym. Use `plural: true` to display the plural version of the definition. |
| **racr, raacr, acrf, acrfpl** | Shortcuts names for respectively `reset-acronym`, `reset-all-acronyms`, `acrfull`, and `acrfullpl`. |

Shortcut names inspired by the `acronym` package for LaTeX by Tobias Oetiker:

| **Function** | **Description** |
|-------------------------------|---------------------------------------------------------------------------------------------------------------------|
| **#ac(...)** | Same as `acr`, display an acronym.|
| **#acf(...)** | Same as `acrfull`, display the long version of an acronym.|
| **#acfp(...)** | Same as `acf` but plural.|
| **#acs(...)** | Display the short version of the acronym, does not update the acronym state.|
| **#acsp(...)** | Same as `acs` but plural.|
| **#acused(...)** | Mark an acronym as used without printing anything.|
| **#acresetall(...)** | Reset all acronyms.|

## Advanced Definitions
This is a bit of a hacky feature coming from pure serendipity.
There is no enforcement of the type of the definitions.
Expand Down

0 comments on commit 1faf2dd

Please sign in to comment.