Skip to content

Commit

Permalink
v2.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
ChapelR committed May 31, 2020
1 parent cc56ed0 commit 4100ada
Show file tree
Hide file tree
Showing 6 changed files with 138 additions and 45 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Chapel's Custom Macro Collection (v2.5.2)
## Chapel's Custom Macro Collection (v2.5.3)

- [Try the demo!](https://macros.twinelab.net/demo)
- [Downloads](./download ':ignore')
Expand Down Expand Up @@ -26,7 +26,7 @@
- [The Message Macro](./message-macro.md)
- [The Typing Simulation Macro](./type-sim.md)
- **Grammar and Language**
- [The Pronoun Templates](./pronoun-templates.md)
- [The Pronoun Templates](./pronoun-templates.md) *updated*
- [The Articles (A/An) Macros](./articles.md)
- **Utilities and Other**
- [The Done Macro](./done-macro.md)
Expand Down
8 changes: 8 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
> [!NOTE]
> I'm going to start keeping a changelog for these macros because keeping track of them is becoming a nightmare. The overall version numbers are not really helpful for tracking what's happening on a macro-by-macro basis, but I'm trying to stick to major version bumps meaning breaking changes in any macro, or complete refactors of the whole collection, like what v2.0.0 was. Minor version updates indicate new macros have been added. Patch version updates means individual macro updates and bug fixes, or documentation, website, or demo updates.
### March 31, 2020 (v2.5.3)

- **[Update]** Several improvements to the pronoun macros:
- Additional verb support.
- Manually setting pronouns from code, either via presets or otherwise, is now possible.
- Added a set of templates for the common "to be" contractions like "he's" and "they're."
- Thanks to AcademyOfFetishes on the Twine Discord server for suggestions, feedback, and implementation ideas.

### March 31, 2020 (v2.5.2)

- **[Retired]** Removed the fullscreen macros.
Expand Down
45 changes: 44 additions & 1 deletion docs/pronoun-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This macro will attempt to pluralize verbs when the pronouns are set to `they/th

### Included Templates

See the [documentation](http://www.motoslave.net/sugarcube/2/docs/#markup-template) for more on template markup.
See the [documentation](http://www.motoslave.net/sugarcube/2/docs/#markup-template) for more on template markup. Contractions `he's`, `she's` and `they're` are represented with a hyphen (e.g., `?he-s`) rather than an apostrophe.

#### Determiner warning:

Expand Down Expand Up @@ -141,6 +141,15 @@ Here is the complete list of templates provided by this system.
- `?person`
- `?Person`

##### **Contractions**

- `?he-s`
- `?He-s`
- `?she-s`
- `?She-s`
- `?they-re`
- `?They-re`

<!-- tabs:end -->

#### Template Examples
Expand All @@ -157,6 +166,8 @@ The following functions are available on `window.gender` and on `setup.gender`.

**Syntax**: `gender.pronouns()` or `setup.gender.pronouns()`

**Returns**: a pronoun object.

Returns an object containing all of the configured pronouns. Has the following properties:

- `subjective`
Expand All @@ -171,6 +182,38 @@ Returns an object containing all of the configured pronouns. Has the following p
<<= gender.pronouns().subjective>> /* prints the subjective pronoun, eg. "he" */
```

#### the `gender.setPronouns()` function

**Syntax**: `gender.setPronouns(presetOrObj)` or `setup.gender.setPronouns(presetOrObj)`

**Returns**: a pronoun object, as above.

Allows you to set the pronouns. You may set them by providing the name of a preset as a string (`"male"`, `"female"`, or `"other"`), or by passing an object. If you pass an object you may set as many or as few of the pronouns as you want.

**Arguments**:

- `presetOrObj` (*string* | *object*) a string representing a built-in preset to set the pronouns to, or an object enumerating the pronouns you wish to set. See above for a list of pronoun properties you can set.

**Example:**

```
/* set the pronouns to female */
<<run gender.setPronouns("female")>>
/* set the pronouns to e/em */
<<run gender.setPronouns({
"subjective" : "e",
"objective" : "em",
"possessive" : "eirs",
"determiner" : "eir",
"reflexive" : "eirself",
"noun" : "person"
})>>
/* set only one pronoun */
<<run gender.setPronouns({ "noun" : "person" })>>
```

#### the `gender.dialog()` function

**Syntax**: `gender.dialog()` or `setup.gender.dialog()`
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "custom-macros-for-sugarcube-2",
"version": "2.5.2",
"version": "2.5.3",
"description": "Collection of custom macros and systems for Twine/SugarCube2.",
"main": "build.js",
"directories": {
Expand Down
2 changes: 1 addition & 1 deletion scripts/minified/pronouns.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 4100ada

Please sign in to comment.