[PR #181] [MERGED] Macros 2.0 - Add documentation for variable shorthand syntax and case-insensitivity #186

Closed
opened 2026-10-15 18:02:26 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/SillyTavern/SillyTavern-Docs/pull/181
Author: @Wolfsblvt
Created: 1/3/2026
Status: ✅ Merged
Merged: 1/3/2026
Merged by: @Cohee1207

Base: main ← Head: macros-2.0-variable-shorthands


📝 Commits (4)

  • 4affe90 Add documentation for variable shorthand syntax and case-insensitivity
  • 26d4ce2 Fix incorrect macro equivalents in variable shorthand documentation
  • fa5d3dd Add examples and clarify variable shorthand syntax documentation
  • 57bffa6 Add clarification section for flags-like prefix operators in variable shorthand

📊 Changes

1 file changed (+123 additions, -2 deletions)

View changed files

📝 Usage/macros.md (+123 -2)

📄 Description

This pull request updates the documentation in Usage/macros.md to clarify macro usage and introduce a new "Variable Shorthand Syntax" feature for working with variables in macros. The most important changes are the addition of detailed instructions and examples for using variable shorthands, updates to condition handling, and the reorganization of flag documentation.

Variable Shorthand Feature

  • Added a new section detailing "Variable Shorthand Syntax," including how to get, set, increment, decrement, and add to variables using concise notation (.myvar, $myvar, etc.), with examples and notes on staging availability.
  • Documented the rules for variable names and whitespace handling in shorthand operations.

Condition Handling

  • Updated condition documentation to include support for variable shorthands (e.g., .myFlag, $globalFlag) in macro conditions, with examples.

Macro Usage Clarification

  • Clarified that macro names are case-insensitive, giving examples for different casing.

Flags Documentation Reorganization

  • Moved documentation for variable shorthand flags (. and `) from the planned flags section to a new "Implemented Flags" table, with descriptions and usage notes.
  • Removed variable shorthand flags from the "Planned Flags" table to reflect their implemented status.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/SillyTavern/SillyTavern-Docs/pull/181 **Author:** [@Wolfsblvt](https://github.com/Wolfsblvt) **Created:** 1/3/2026 **Status:** ✅ Merged **Merged:** 1/3/2026 **Merged by:** [@Cohee1207](https://github.com/Cohee1207) **Base:** `main` ← **Head:** `macros-2.0-variable-shorthands` --- ### 📝 Commits (4) - [`4affe90`](https://github.com/SillyTavern/SillyTavern-Docs/commit/4affe90ec6edc96f3c7b93d9e4462d52b24123b7) Add documentation for variable shorthand syntax and case-insensitivity - [`26d4ce2`](https://github.com/SillyTavern/SillyTavern-Docs/commit/26d4ce2b45ae7f3bfb9d9149d6907b7d949a571e) Fix incorrect macro equivalents in variable shorthand documentation - [`fa5d3dd`](https://github.com/SillyTavern/SillyTavern-Docs/commit/fa5d3dd710e49328f254021fac1bc56e0c8408a9) Add examples and clarify variable shorthand syntax documentation - [`57bffa6`](https://github.com/SillyTavern/SillyTavern-Docs/commit/57bffa6bbcea20e4a55fca18906913c792767581) Add clarification section for flags-like prefix operators in variable shorthand ### 📊 Changes **1 file changed** (+123 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `Usage/macros.md` (+123 -2) </details> ### 📄 Description This pull request updates the documentation in `Usage/macros.md` to clarify macro usage and introduce a new "Variable Shorthand Syntax" feature for working with variables in macros. The most important changes are the addition of detailed instructions and examples for using variable shorthands, updates to condition handling, and the reorganization of flag documentation. ### Variable Shorthand Feature * Added a new section detailing "Variable Shorthand Syntax," including how to get, set, increment, decrement, and add to variables using concise notation (`.myvar`, `$myvar`, etc.), with examples and notes on staging availability. * Documented the rules for variable names and whitespace handling in shorthand operations. ### Condition Handling * Updated condition documentation to include support for variable shorthands (e.g., `.myFlag`, `$globalFlag`) in macro conditions, with examples. ### Macro Usage Clarification * Clarified that macro names are case-insensitive, giving examples for different casing. ### Flags Documentation Reorganization * Moved documentation for variable shorthand flags (`.` and `) from the planned flags section to a new "Implemented Flags" table, with descriptions and usage notes. * Removed variable shorthand flags from the "Planned Flags" table to reflect their implemented status. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-10-15 18:02:26 +00:00
Sign in to join this conversation.
No labels
pull-request
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
SillyTavern/SillyTavern-Docs#186
No description provided.