Additional Auto-Type improvements based on PR feedback

* Improve documentation and remove external links to keepass.info documentation
2025-07-31 18:48:48 -04:00 · 2021-02-15 17:26:23 -05:00 · 2021-02-15 17:26:23 -05:00 · 8d058cbd04
commit 8d058cbd04
parent 02446af743
11 changed files with 292 additions and 194 deletions
--- a/docs/UserGuide.adoc
+++ b/docs/UserGuide.adoc
@ -34,3 +34,5 @@ include::topics/AutoType.adoc[tags=*]
 include::topics/KeeShare.adoc[tags=*]

 include::topics/SSHAgent.adoc[tags=*]
+
+include::topics/Reference.adoc[tags=*]
--- a/docs/topics/AutoType.adoc
+++ b/docs/topics/AutoType.adoc
@ -31,7 +31,7 @@ To configure Auto-Type sequences for your entries, perform the following steps:
 .Auto-Type entry sequences
 image::autotype_entry_sequences.png[]

-2. _(Optional)_ Define a custom Auto-Type sequence for each window title match by selecting the _Use specific sequence for this association_ checkbox. Sequence action codes and field placeholders are detailed in the following table. Beyond the most important ones detailed below, there are additional action codes and placeholders available: https://keepass.info/help/base/autotype.html#autoseq[KeePass Auto-Type Action Codes, window=_blank] and https://keepass.info/help/base/placeholders.html[KeePass Placeholders, window=_blank]. Action codes and placeholders are not case sensitive.
+2. _(Optional)_ Define a custom Auto-Type sequence for each window title match by selecting the _Use specific sequence for this association_ checkbox. Sequence action codes and field placeholders are detailed in the following table. Beyond the most important ones detailed below, there are additional action codes and placeholders available: xref:UserGuide.adoc#_auto_type_actions[Auto-Type Actions Reference] and xref:UserGuide.adoc#_entry_placeholders[Entry Placeholders Reference]. Action codes and placeholders are not case sensitive.
 +
 [grid=rows, frame=none, width=90%]
 |===
@ -43,10 +43,7 @@ image::autotype_entry_sequences.png[]
 |{URL}      |URL
 |{NOTES}    |Notes
 |{TOTP}     |Current TOTP value (if configured)
-|{DT_SIMPLE} |Current date-time
-|{DB_DIR}   |Absolute directory path for database file
 |{S:<ATTRIBUTE_NAME>}   |Value for the given attribute name
-|{REF:<FIELD>@<SEARCH_IN>:<SEARCH_TEXT>} |Search for a field in another entry using the reference syntax. https://keepass.info/help/base/fieldrefs.html[Read more…, window=_blank]
 |===
 +
 [grid=rows, frame=none, width=90%]
@ -57,22 +54,13 @@ image::autotype_entry_sequences.png[]
 |Press the corresponding keyboard key

 |{UP}, {DOWN}, {LEFT}, {RIGHT}  |Press the corresponding arrow key
-|{F1}, {F2}, ..., {F16}         |Press F1, F2, etc.
 |{LEFTBRACE}, {RIGHTBRACE}      |Press `{` or `}`, respectively
-|{<KEY> X}  |Repeat <KEY> X times (e.g., {SPACE 5} inserts five spaces)
+|{<KEY> X}     |Repeat <KEY> X times (e.g., {SPACE 5} inserts five spaces)
 |{DELAY=X}     |Set delay between key presses to X milliseconds
 |{DELAY X}     |Pause typing for X milliseconds
 |{CLEARFIELD}  |Clear the input field
 |{PICKCHARS}   |Pick specific password characters from a dialog
 |===
-+
-*Text Conversions:*
-+
-*{T-CONV:/<PLACEHOLDER>/<METHOD>/}* +
-Convert resolved placeholder (e.g., {USERNAME}, {PASSWORD}, etc.) using the following methods: UPPER, LOWER, BASE64, HEX, URI, URI-DEC. https://keepass.info/help/base/placeholders.html#conv[Read more…, window=_blank]
-+
-*{T-REPLACE-RX:/<PLACEHOLDER>/<SEARCH>/<REPLACE>/}* +
-Use regular expressions to find and replace data from a resolved placeholder. Refer to match groups using $1, $2, etc. https://keepass.info/help/base/placeholders.html#replacerx[Read more…, window=_blank]

 === Performing Global Auto-Type
 The global Auto-Type keyboard shortcut is used when you have focus on the window you want to type into. To make use of this feature, you must have previously configured an Auto-Type hotkey.
--- a/docs/topics/DatabaseOperations.adoc
+++ b/docs/topics/DatabaseOperations.adoc
@ -120,18 +120,7 @@ image::clone_entry_dialog.png[,70%]
 .References in a cloned entry
 image::clone_entry_references.png[]

-4. You can create your own references using the following syntax:
-+
-`{REF:<ShortCode>@I:<UUID>}`
-+
-Where `<UUID>` is the Unique Identifier of the entry to pull data from and `<ShortCode>` is from the following:
-+
- * T - Title
- * U - Username
- * P - Password
- * A - URL
- * N - Notes
- * I - UUID
+4. You can create your own references using the xref:UserGuide.adoc#_entry_cross_reference[Entry Reference Syntax]

 == Searching the Database
 KeePassXC provides an enhanced and granular search features the enables you to search for specific entries in the databases using the different modifiers, wild card characters, and logical operators.
@ -287,7 +276,7 @@ image::database_security.png[]
 +
 .Database credentials
 image::database_security_credentials.png[]
-
+
 WARNING: Consider creating a backup of your YubiKey. Please refer to <<Creating a YubiKey backup>>

 5. Encryption settings allows you to change the average time it takes to encrypt and decrypt the database. The longer time that is chosen, the harder it will be to brute force attack your database. *We recommend a setting of one second.*
--- a/docs/topics/Reference.adoc
+++ b/docs/topics/Reference.adoc
@ -0,0 +1,94 @@
+= KeePassXC - Reference
+include::.sharedheader[]
+:imagesdir: ../images
+
+// tag::content[]
+== Reference
+This section contains full details on advanced features available in KeePassXC.
+
+=== Entry Placeholders
+[grid=rows, frame=none, width=90%]
+|===
+|Placeholder |Description
+
+|{TITLE}         |Entry Title
+|{USERNAME}      |Username
+|{PASSWORD}      |Password
+|{URL}           |URL
+|{NOTES}         |Notes
+|{TOTP}          |Current TOTP value (if configured)
+|{S:<ATTRIBUTE_NAME>}   |Value for the given attribute (case sensitive)
+|{URL:RMVSCM}	        |URL without scheme (e.g., https)
+|{URL:WITHOUTSCHEME}	|URL without scheme
+|{URL:SCM}	     |URL Scheme
+|{URL:SCHEME}	 |URL Scheme
+|{URL:HOST}	     |URL Host (e.g., example.com)
+|{URL:PORT}	     |URL Port
+|{URL:PATH}	     |URL Path (e.g., /path/to/page.html)
+|{URL:QUERY}	 |URL Query String
+|{URL:FRAGMENT}	 |URL Fragment
+|{URL:USERINFO}	 |URL Username:Password
+|{URL:USERNAME}	 |URL Username
+|{URL:PASSWORD}	 |URL Password
+|{DT_SIMPLE}	 |Current Date-Time (yyyyMMddhhmmss)
+|{DT_YEAR}	     |Current Year (yyyy)
+|{DT_MONTH}	     |Current Month (MM)
+|{DT_DAY}	     |Current Day (dd)
+|{DT_HOUR}	     |Current Hour (hh)
+|{DT_MINUTE}	 |Current Minutes (mm)
+|{DT_SECOND}	 |Current Seconds (ss)
+|{DT_UTC_SIMPLE} |Current UTC Date-Time (yyyyMMddhhmmss)
+|{DT_UTC_YEAR}	 |Current UTC Year (yyyy)
+|{DT_UTC_MONTH}	 |Current UTC Month (MM)
+|{DT_UTC_DAY}	 |Current UTC Day (dd)
+|{DT_UTC_HOUR}	 |Current UTC Hour (hh)
+|{DT_UTC_MINUTE} |Current UTC Minutes (mm)
+|{DT_UTC_SECOND} |Current UTC Seconds (ss)
+|{DB_DIR}	     |Absolute directory path of database file
+|===
+
+=== Entry Cross-Reference
+A reference to another entry's field is possible using the short-hand syntax:  
+`{REF:<FIELD>@<SEARCH_IN>:<SEARCH_TEXT>}`
+
+`<FIELD>` and `<SEARCH_IN>` can be one of following:
+
+* T - Title
+* U - Username
+* P - Password
+* A - URL
+* N - Notes
+* I - UUID (found on entry properties page)
+* O - Custom Attribute _(SEARCH_IN only)_
+
+Examples: +
+`{REF:U@I:033054D445C648C59092CC1D661B1B71}` +
+`{REF:P@T:Other Entry}` +
+`{REF:A@O:Attribute 1}`
+
+=== Auto-Type Actions
+[grid=rows, frame=none, width=90%]
+|===
+|Action Code |Description
+
+|{TAB}, {ENTER}, {SPACE}, {INSERT}, {DELETE}, {HOME}, {END}, {PGUP}, {PGDN}, {BACKSPACE}, {CAPSLOCK}, {ESC}
+|Press the corresponding keyboard key
+
+|{UP}, {DOWN}, {LEFT}, {RIGHT}  |Press the corresponding arrow key
+|{F1}, {F2}, ..., {F16}         |Press F1, F2, etc.
+|{LEFTBRACE}, {RIGHTBRACE}      |Press `{` or `}`, respectively
+|{<KEY> X}  |Repeat <KEY> X times (e.g., {SPACE 5} inserts five spaces)
+|{DELAY=X}     |Set delay between key presses to X milliseconds
+|{DELAY X}     |Pause typing for X milliseconds
+|{CLEARFIELD}  |Clear the input field
+|{PICKCHARS}   |Pick specific password characters from a dialog
+|===
+
+*Text Conversions:*
+
+*{T-CONV:/<PLACEHOLDER>/<METHOD>/}* +
+Convert resolved placeholder (e.g., {USERNAME}, {PASSWORD}, etc.) using the following methods: UPPER, LOWER, BASE64, HEX, URI, URI-DEC.
+
+*{T-REPLACE-RX:/<PLACEHOLDER>/<SEARCH>/<REPLACE>/}* +
+Use regular expressions to find and replace data from a resolved placeholder. Refer to match groups using $1, $2, etc.
+// end::content[]