Documentation update list

[smeech]

A few items I have spotted. By no means exclusive!

ToDo:

• Privacy Policy #1560 security.md is due for an update
• feat: add usage statistics tracking espanso#2568 - awaits version >2.3.0
• Allow multiple choices in the form list to be selected espanso#2595 - awaits version >2.3.0
• search_shortcut: value has to include a modifier https://www.reddit.com/r/espanso/comments/1t55l4q/using_insert_key_for_search/

v2.3.0 items to be amended at a later date

• Add support for .yaml extension for config and match files (#2184) espanso#2519
• feat: Add max_regex_buffer_size config option espanso#2504
• Add timezone support to date extension (#2225) espanso#2526 (comment)
• Add a note to packages submissions about the need to engage with the team, best to keep to .yml files for now.

Done:

• Add non-breaking space \u{00A0} to list of word_separators espanso#2433 (comment)
• In KDE Wayland kdotool now enables app-specific configurations: https://discord.com/channels/884163483409731584/1200502073754656838/1456390006317777041 and may help other issues: Install documentation for Linux (Wayland) should mention that kdotool is required #126
• inject_delay: and key_delay: have little effect in Windows inject_delay: and key_delay: don't behave as expected espanso#1321
• Minor improvement to Nested Matches Revise nested match examples in basics.md #125 (comment)
• Add trim: false documentation to the shell extension, ?reverse the order
• Add details of max_form_width: Option<usize> & max_form_height: Option<usize>, Improve form size constraints and text overflow behavior espanso#1991 once the merged code makes its way to a Release
• ?remove --version 0.34.0 from the compilation instructions (Does Espanso require cargo-make version 0.34.0 specifically? #87)
• Accept Update MacOS homebrew installation guide #94 if we can get Espanso added to the Homebrew autobump list.
• right_word: true may be useful instead of word: true for triggers used at the beginnings of fields The beginning of a field isn't always recognised as a word separator for word: true to work. espanso#2354
• Various
• Update version number in docusaurus.config.js to latest (2.2.3)
• espanso daemon and espanso start --unmanaged pick up ESPANSO_CONFIG_DIR, ESPANSO_PACKAGE_DIR and ESPANSO_RUNTIME_DIR. and document --config_dir, --package_dir and --runtime_dir Discord
• Add a note that a N: Download is performed unsandboxed as root warning can be safely ignored Changes the Debian (and relatives) install command to avoid warning #112
• x11_use_xdotool_backend=true implements the inject backend, not clipboard
• ?add a link to https://github.com/espanso/espanso/tree/5d5d0d4d59abac07e3cab52b851aeaf570f5253c/espanso/src/patch/patches in the options item for apply_patch:. See the Discord discussion.
• Add mention of EspansoEdit Cookbook to https://espanso.org/docs/matches/examples/
• macOS supports configuration located at $HOME/.config/espanso
• Add an entry to https://espanso.org/docs/matches/extensions/#utf-8-characters regarding UTF-8 in html:. Problem with bad encoding on MacOS using markdown with polish characters espanso#1810 (comment), Create a tigger that contains rich text/formatting espanso#1302 (reply in thread), & in Bash: Multiple characters dynamic replacement: 123superscript → ¹²³ espanso#1319 (reply in thread)
• Make a homepage: item mandatory in _manifest.yml for new packages (Add homepage field to pkg template hub#133)
• Remove Legacy documentation Remove Legacy documentation #80
• Add information about the VSCode/Redhat YAML config and match schemas
• EspansoEdit works with Wine, with some directory configuration
• Update Wayland keyboard detection instructions no triggers happen on fedora 40 wayland espanso#2070
• Remove reference to snap installation: unused file /snap/hooks/remove espanso#1848
• Extend inline code section within extensions.mdx
• Command-line documentation SystemManager does not detect Window attributes on Ubuntu espanso#66
• Usage of use_standard_includes:. I think I have worked it out - see this Discord entry. For a while I thought it should be deprecated like force_clipboard: true, rather than documented, but it may simplify things for some people.
• Examples of single-line format [...] for short sequences
• Add section about quoting (or not) values in Espanso YAML Add package search bar to espanso hub espanso#46
• I'd like to rewrite many of the simple code examples without quote marks where they're not needed
• cmd.exe won't work as a multiline inline shell: expansion
• Only one app-specific config can apply at any time
• Include examples of embedding multiline scripts and shell commands in triggers
• Remove the link to our out-dated gist list of date formats, leaving a link to the source material only - "%Z" does not convert to local time zone name with Date Extension espanso#1072
• Update migration advice to suggest moving the legacy packages folder to espanso/match/packages
• Add #acfg#, #pacfg# & #pdetect#
• Variable names can only be alphanumeric or underscore characters.
• Available match options Include list of available match options #10 - all these are now present in the documentation in appropriate sections - I'm not sure a separate list would be useful, so I've added a link to the relevant file and lines in the main repo.
• Usage of search_terms:
• Other options listed here: x11_use_xdotool_backend, emulate_alt_codes, post_search_delay, post_form_delay.
• emulate_alt_codes: true see here
• filter_os: rule

See below for older completed items.

[smeech]

Moved from espanso/espanso Issue #1788.

[smeech]

I'm having trouble moving items about in the above list, so am moving older completed items here for reference:

• Autofix in the documentation seems to be outdated #1767
• Update links to federico-terzi/espanso to espanso/espanso?
• MacOS brew installation docs should be updated MacOS brew installation docs should be updated espanso#1804
• ?add Discord server to the docs header
• Plain scalar Regex triggers are easier to debug if we don't have to escape every “\”. I'll add a note about this.
• left_word: ord right_word: controls. See here.
• force_mode: clipboard|keys and force_clipboard: true (possible duplicate of the first) #1690 Are there other undocumented controls? (See parse.rs.)
• Document markdown & html #1806
• paragraph: prevents markdown: starting a new paragraph. See here.
• Factors determining size of forms - [Discord conversation] (https://discord.com/channels/884163483409731584/1013916990760554608/1185019971185692682) & [Reddit] (https://www.reddit.com/r/espanso/comments/18ibpbi/help_with_making_forms_better/) summary
• Output of UTF8 foreign characters (in Windows?) Espanso does not support UTF-8 return values from PowerShell espanso#1736 Problem with encoding Polish characters in shell espanso#1749 The inclusion of Chinese characters in the Script Extension will result in garbled text espanso#1698
• Ability to output Unicode characters, e.g. replace: "\u0105" (UTF-16), or "\U00000105" (UTF-32) or "\xC4" (UTF-8?)
• Multiple filters, need to apply alphabetically by filename to determine application order #1269
• CTRL-character triggers are possible but likely to cause problems in editors, and over-delete characters on triggering Way to run a match using a keyboard shortcut espanso#383