Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update list #38

Open
37 of 41 tasks
smeech opened this issue Feb 13, 2024 · 1 comment
Open
37 of 41 tasks

Documentation update list #38

smeech opened this issue Feb 13, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@smeech
Copy link
Collaborator

smeech commented Feb 13, 2024

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

ToDo:

Done:

  • 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 Command-line basics and reference pages #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 Addition of Quotes section to Matches #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
  • 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 #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.
  • force_mode: clipboard|keys and force_clipboard: true (possible duplicate of the first) #1690 Are there other undocumented controls? (See parse.rs.)
  • left_word: ord right_word: controls. See here.
  • 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?) #1736 #1749 #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 #383
@smeech
Copy link
Collaborator Author

smeech commented Feb 13, 2024

Moved from espanso/espanso Issue #1788.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant