From 91e14ba9a05ca89d83c9fad65b6e99721af177bd Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Tue, 9 Apr 2024 20:54:39 +0800 Subject: [PATCH 1/9] Update command history docs --- docs/UserGuide.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 034aa7d7419..cb5bac6cccd 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -440,27 +440,40 @@ The autocomplete suggestions will be listed in alphabetical order, meaning if yo

-### Retrieving command history +### Retrieving command history TAPro saves successful commands input, so you can retrieve them later, using the -Up and -Down keys. + UP and + DOWN arrow keys. #g#Example:## -We have entered `mark nn/e0123456` as the previous command, and it was successful. Now the command input box is empty. +We have entered `mark nn/e0123456` as the previous command, and it was successful. + +Now the command input box is empty. + +Pressing UP will update the text in the command input box to +the previous command `mark nn/e0123456`! + +You can continue pressing UP to scroll through all the previous commands you have entered. + +Pressing DOWN will scroll back to the more recent commands you have entered. -Pressing Up will update the text in the command input box to -the previous command `mark nn/e0123456`. -**Only successful commands will be retrieved:** +**Caution:** +Only commands that has succeeded previously will be retrieved. If you enter an invalid command, it will not appear +when attempting to retrieve it. + + + -If you enter an invalid command, it will not appear when attempting to retrieve it. +**Warning:** +When retrieving commands, be aware that it will erase the current text in the command input box. --- From 69490bfdde72f3f98f7be9e5e8ffa384d518e902 Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Tue, 9 Apr 2024 21:56:28 +0800 Subject: [PATCH 2/9] Make command history example clearer --- docs/UserGuide.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index cb5bac6cccd..c1320299d4a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -450,16 +450,15 @@ TAPro saves successful commands input, so you can retrieve them later, using the #g#Example:## -We have entered `mark nn/e0123456` as the previous command, and it was successful. - -Now the command input box is empty. - -Pressing UP will update the text in the command input box to +1. `mark nn/e0123456` was the previous successful command. +1. Now the command input box is empty. +1. Pressing UP will + fill the text in the command input box to the previous command `mark nn/e0123456`! - -You can continue pressing UP to scroll through all the previous commands you have entered. - -Pressing DOWN will scroll back to the more recent commands you have entered. +1. You can press + UP continuously to scroll through all the previous commands you have entered. +1. Pressing DOWN will + scroll back to the more recent commands you have entered. From 80c88d72c6edb17d52536714270cffbda55a65f2 Mon Sep 17 00:00:00 2001 From: Ethan Wei Yuxin Date: Wed, 10 Apr 2024 14:34:51 +0800 Subject: [PATCH 3/9] Update docs/UserGuide.md Co-authored-by: Titus Chew <39845485+tituschewxj@users.noreply.github.com> --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c1320299d4a..80878ef0949 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -454,7 +454,7 @@ TAPro saves successful commands input, so you can retrieve them later, using the 1. Now the command input box is empty. 1. Pressing UP will fill the text in the command input box to -the previous command `mark nn/e0123456`! +the previous command `mark nn/E0123456`! 1. You can press UP continuously to scroll through all the previous commands you have entered. 1. Pressing DOWN will From 5f295a19a328b877884f54508c3cdff3bb5a3327 Mon Sep 17 00:00:00 2001 From: Ethan Wei Yuxin Date: Wed, 10 Apr 2024 14:34:56 +0800 Subject: [PATCH 4/9] Update docs/UserGuide.md Co-authored-by: Titus Chew <39845485+tituschewxj@users.noreply.github.com> --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 80878ef0949..1a46eab7424 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -450,7 +450,7 @@ TAPro saves successful commands input, so you can retrieve them later, using the #g#Example:## -1. `mark nn/e0123456` was the previous successful command. +1. `mark nn/E0123456` was the previous successful command. 1. Now the command input box is empty. 1. Pressing UP will fill the text in the command input box to From c07761bc19d1df294c7c444ed8661a010abb6415 Mon Sep 17 00:00:00 2001 From: Ethan Wei Yuxin Date: Wed, 10 Apr 2024 14:35:01 +0800 Subject: [PATCH 5/9] Update docs/UserGuide.md Co-authored-by: Titus Chew <39845485+tituschewxj@users.noreply.github.com> --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 1a46eab7424..8590d691bbd 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -469,7 +469,7 @@ Only commands that has succeeded previously will be retrieved. If you enter an i when attempting to retrieve it. - + **Warning:** When retrieving commands, be aware that it will erase the current text in the command input box. From 9a1983aa41ed5159739a43a6fb74e0881b769f34 Mon Sep 17 00:00:00 2001 From: Ethan Wei Yuxin Date: Wed, 10 Apr 2024 14:35:07 +0800 Subject: [PATCH 6/9] Update docs/UserGuide.md Co-authored-by: Titus Chew <39845485+tituschewxj@users.noreply.github.com> --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8590d691bbd..a6b0285a03d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -462,7 +462,7 @@ the previous command `mark nn/E0123456`! - + **Caution:** Only commands that has succeeded previously will be retrieved. If you enter an invalid command, it will not appear From 284534dfcc5c674c66737bc27d4887729dc0bc3f Mon Sep 17 00:00:00 2001 From: Ethan Wei Yuxin Date: Wed, 10 Apr 2024 14:35:14 +0800 Subject: [PATCH 7/9] Update docs/UserGuide.md Co-authored-by: Titus Chew <39845485+tituschewxj@users.noreply.github.com> --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a6b0285a03d..17db34a3360 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -446,7 +446,7 @@ TAPro saves successful commands input, so you can retrieve them later, using the UP and DOWN arrow keys. - + #g#Example:## From 57f0965f471226e91cf31f97a1d7eedee044f760 Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Wed, 10 Apr 2024 14:39:19 +0800 Subject: [PATCH 8/9] Test macros --- docs/UserGuide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 17db34a3360..242cedf4146 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -445,6 +445,8 @@ The autocomplete suggestions will be listed in alphabetical order, meaning if yo TAPro saves successful commands input, so you can retrieve them later, using the UP and DOWN arrow keys. +{{ macros.keyFormat(' Up') }} and +{{ macros.keyFormat(' Down') }} arrow keys. From 7db1c6f7546ceb43d380f80e368f059e2e41a69b Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Wed, 10 Apr 2024 15:46:47 +0800 Subject: [PATCH 9/9] Further clarify why pressing down alone won't work --- docs/UserGuide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 010ad7da8f0..13336025a5f 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -657,6 +657,14 @@ the previous command `mark nn/E0123456`! +**Caution:** +Pressing DOWNwithout +having ever pressed +UPwill not make any changes, because you are at your most recent command. + + + + **Caution:** Only commands that has succeeded previously will be retrieved. If you enter an invalid command, it will not appear when attempting to retrieve it.