From ef68d1785f50091beb01d75405f99c6e2adb79f6 Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Mon, 24 Oct 2011 00:30:42 -0400 Subject: [PATCH] Documentation - Shorted the command usage strings shown in the 'help' output, to match the names in the reference PDF. --- src/Config.cpp | 26 +++++++++++++------------- src/en-US.h | 30 +++++++++++++++--------------- 2 files changed, 28 insertions(+), 28 deletions(-) diff --git a/src/Config.cpp b/src/Config.cpp index cb67462f4..b060e949e 100644 --- a/src/Config.cpp +++ b/src/Config.cpp @@ -324,7 +324,7 @@ std::string Config::_defaults = "# Dateformat: due date format in reports\n" "\n" "# task long\n" - "report.long.description=Lists all tasks, matching the specified criteria\n" + "report.long.description=Lists all pending tasks\n" "report.long.columns=id,project,priority,entry,start,due,recur,due.countdown,entry.age,depends,tags,description\n" "report.long.labels=ID,Project,Pri,Added,Started,Due,Recur,Countdown,Age,Deps,Tags,Description\n" "report.long.sort=due+,priority-,project+,description+\n" @@ -333,7 +333,7 @@ std::string Config::_defaults = "#report.long.annotations=full\n" "\n" "# task list\n" - "report.list.description=Lists all tasks matching the specified criteria\n" + "report.list.description=Lists all pending tasks\n" "report.list.columns=id,project,priority,due,start.active,entry.age,description\n" "report.list.labels=ID,Project,Pri,Due,Active,Age,Description\n" "report.list.sort=due+,priority-,start-,project+,description+\n" @@ -342,7 +342,7 @@ std::string Config::_defaults = "#report.list.annotations=full\n" "\n" "# task ls\n" - "report.ls.description=Minimal listing of all tasks matching the specified criteria\n" + "report.ls.description=Minimal listing of all pending tasks\n" "report.ls.columns=id,project,priority,description\n" "report.ls.labels=ID,Project,Pri,Description\n" "report.ls.sort=priority-,project+,description+\n" @@ -351,7 +351,7 @@ std::string Config::_defaults = "#report.ls.annotations=full\n" "\n" "# task minimal\n" - "report.minimal.description=A really minimal listing\n" + "report.minimal.description=Minimal listing of all pending tasks\n" "report.minimal.columns=id,project,description.truncated\n" "report.minimal.labels=ID,Project,Description\n" "report.minimal.sort=project+,description+\n" @@ -378,7 +378,7 @@ std::string Config::_defaults = "#report.oldest.annotations=full\n" "\n" "# task overdue\n" - "report.overdue.description=Lists overdue tasks matching the specified criteria\n" + "report.overdue.description=Lists overdue tasks\n" "report.overdue.columns=id,project,priority,due,start.active,entry.age,description\n" "report.overdue.labels=ID,Project,Pri,Due,Active,Age,Description\n" "report.overdue.sort=due+,priority-,start-,project+,description+\n" @@ -387,7 +387,7 @@ std::string Config::_defaults = "#report.overdue.annotations=full\n" "\n" "# task active\n" - "report.active.description=Lists active tasks matching the specified criteria\n" + "report.active.description=Lists active tasks\n" "report.active.columns=id,project,priority,due,start.active,entry.age,description\n" "report.active.labels=ID,Project,Pri,Due,Active,Age,Description\n" "report.active.sort=due+,priority-,project+,description+\n" @@ -396,7 +396,7 @@ std::string Config::_defaults = "#report.active.annotations=full\n" "\n" "# task completed\n" - "report.completed.description=Lists completed tasks matching the specified criteria\n" + "report.completed.description=Lists completed tasks\n" "report.completed.columns=end,project,priority,entry.age,description\n" "report.completed.labels=Complete,Project,Pri,Age,Description\n" "report.completed.sort=end+,priority-,project+,description+\n" @@ -405,7 +405,7 @@ std::string Config::_defaults = "#report.completed.annotations=full\n" "\n" "# task recurring\n" - "report.recurring.description=Lists recurring tasks matching the specified criteria\n" + "report.recurring.description=Lists recurring tasks\n" "report.recurring.columns=id,project,priority,due,recur,start.active,entry.age,description\n" "report.recurring.labels=ID,Project,Pri,Due,Recur,Active,Age,Description\n" "report.recurring.sort=due+,priority-,start-,project+,description+\n" @@ -414,7 +414,7 @@ std::string Config::_defaults = "#report.recurring.annotations=full\n" "\n" "# task waiting\n" - "report.waiting.description=Lists all waiting tasks matching the specified criteria\n" + "report.waiting.description=Lists all waiting tasks\n" "report.waiting.columns=id,project,priority,wait,entry.age,description\n" "report.waiting.labels=ID,Project,Pri,Wait,Age,Description\n" "report.waiting.sort=wait+,priority-,project+,description+\n" @@ -423,7 +423,7 @@ std::string Config::_defaults = "#report.waiting.annotations=full\n" "\n" "# task all\n" - "report.all.description=Lists all tasks matching the specified criteria, including parents of recurring tasks\n" + "report.all.description=Lists all pending and completed tasks\n" "report.all.columns=id,status,project,priority,due,end,start.active,entry.age,description\n" "report.all.labels=ID,Status,Project,Pri,Due,Completed,Active,Age,Description\n" "report.all.sort=project+,due+,end+,priority-,start-,description+\n" @@ -432,8 +432,8 @@ std::string Config::_defaults = "#report.all.annotations=full\n" "\n" "# task next\n" - "report.next.columns=id,project,priority,due,start.active,entry.age,urgency,description\n" "report.next.description=Lists the most urgent tasks\n" + "report.next.columns=id,project,priority,due,start.active,entry.age,urgency,description\n" "report.next.filter=status:pending limit:page\n" "report.next.labels=ID,Project,Pri,Due,A,Age,Urgency,Description\n" "report.next.sort=urgency-,due+,priority-,start-,project+,description+\n" @@ -441,7 +441,7 @@ std::string Config::_defaults = "#report.next.annotations=full\n" "\n" "# task blocked\n" - "report.blocked.description=Lists all blocked tasks matching the specified criteria\n" + "report.blocked.description=Lists all blocked tasks\n" "report.blocked.columns=id,depends,project,priority,due,start.active,entry.age,description\n" "report.blocked.labels=ID,Deps,Project,Pri,Due,Active,Age,Description\n" "report.blocked.sort=due+,priority-,start-,project+,description+\n" @@ -449,7 +449,7 @@ std::string Config::_defaults = "#report.blocked.dateformat=m/d/Y\n" "\n" "# task unblocked\n" - "report.unblocked.description=Lists all unblocked tasks matching the specified criteria\n" + "report.unblocked.description=Lists all unblocked tasks\n" "report.unblocked.columns=id,depends,project,priority,due,start.active,entry.age,description\n" "report.unblocked.labels=ID,Deps,Project,Pri,Due,Active,Age,Description\n" "report.unblocked.sort=due+,priority-,start-,project+,description+\n" diff --git a/src/en-US.h b/src/en-US.h index 70fc55e51..846331701 100644 --- a/src/en-US.h +++ b/src/en-US.h @@ -206,11 +206,11 @@ #define STRING_CMD_LOG_NO_RECUR "You cannot log recurring tasks." #define STRING_CMD_LOG_NO_WAITING "You cannot log waiting tasks." #define STRING_CMD_LOG_LOGGED "Logged task." -#define STRING_CMD_IDS_USAGE_RANGE "Shows only the IDs of matching tasks, in the form of a range" +#define STRING_CMD_IDS_USAGE_RANGE "Shows the IDs of matching tasks, as a range" #define STRING_CMD_IDS_USAGE_LIST "Shows only the IDs of matching tasks, in the form of a list" #define STRING_CMD_IDS_USAGE_ZSH "Shows the IDs and descriptions of matching tasks" #define STRING_CMD_EXPORT_USAGE "Exports tasks in JSON format" -#define STRING_CMD_INFO_USAGE "Shows all data and metadata for specified tasks" +#define STRING_CMD_INFO_USAGE "Shows all data and metadata" #define STRING_CMD_INFO_BLOCKED "This task blocked by" #define STRING_CMD_INFO_BLOCKING "This task is blocking" #define STRING_CMD_INFO_RECUR_UNTIL "Recur until" @@ -272,7 +272,7 @@ #define STRING_CMD_DONE_1 "Completed {1} task." #define STRING_CMD_DONE_N "Completed {1} tasks." -#define STRING_CMD_PROJECTS_USAGE "Shows a list of all project names used, and how many tasks are in each" +#define STRING_CMD_PROJECTS_USAGE "Shows all project names used" #define STRING_CMD_PROJECTS_USAGE_2 "Shows only a list of all project names used" #define STRING_CMD_PROJECTS_NO "No projects." #define STRING_CMD_PROJECTS_PRI_N "Pri:None" @@ -289,7 +289,7 @@ #define STRING_CMD_SUMMARY_REMAINING "Remaining" #define STRING_CMD_SUMMARY_AVG_AGE "Avg age" #define STRING_CMD_SUMMARY_COMPLETE "Complete" -#define STRING_CMD_COUNT_USAGE "Shows only the number of matching tasks" +#define STRING_CMD_COUNT_USAGE "Counts matching tasks" #define STRING_CMD_DELETE_USAGE "Deletes the specified task" #define STRING_CMD_DELETE_CONFIRM "Permanently delete task {1} '{2}'?" @@ -301,7 +301,7 @@ #define STRING_CMD_DELETE_1 "Deleted {1} task." #define STRING_CMD_DELETE_N "Deleted {1} tasks." -#define STRING_CMD_DUPLICATE_USAGE "Duplicates the specified tasks, and allows modifications" +#define STRING_CMD_DUPLICATE_USAGE "Duplicates the specified tasks" #define STRING_CMD_DUPLICATE_NON_REC "Note: task {1} was a recurring task. The duplicate task is not." #define STRING_CMD_DUPLICATE_CONFIRM "Duplicate task {1} '{2}'?" #define STRING_CMD_DUPLICATE_TASK "Duplicated task {1} '{2}'." @@ -352,7 +352,7 @@ #define STRING_CMD_ANNO_1 "Annotated {1} task." #define STRING_CMD_ANNO_N "Annotated {1} tasks." -#define STRING_CMD_COLUMNS_USAGE "Displays all supported columns and formatting styles" +#define STRING_CMD_COLUMNS_USAGE "All supported columns and formatting styles" #define STRING_CMD_COLUMNS_NOTE "* Means default format, and therefore optional. For example, 'due' and 'due.formatted' are equivalent." #define STRING_CMD_COLUMNS_USAGE2 "Displays only a list of supported columns" @@ -377,7 +377,7 @@ #define STRING_CMD_SHELL_HELP3 "Enter 'quit' (or 'bye', 'exit') to end the session." #define STRING_CMD_SYNCH_USAGE "Synchronizes data with the Task Server" #define STRING_CMD_SYNCH_NO_SERVER "Task Server is not configured." -#define STRING_CMD_DIAG_USAGE "Shows information needed when reporting a problem" +#define STRING_CMD_DIAG_USAGE "Platform, build and environment details" #define STRING_CMD_DIAG_PLATFORM "Platform" #define STRING_CMD_DIAG_UNKNOWN "" #define STRING_CMD_DIAG_COMPILER "Compiler" @@ -397,12 +397,12 @@ #define STRING_CMD_DIAG_UUID_GOOD "1000 unique UUIDs generated." #define STRING_CMD_DIAG_UUID_BAD "Failed - duplicate UUID at iteration {1}" #define STRING_CMD_DIAG_NONE "-none-" -#define STRING_CMD_PUSH_USAGE "Pushes the local *.data files to the URL" +#define STRING_CMD_PUSH_USAGE "Pushes the local files to the URL" #define STRING_CMD_PUSH_SAME "Cannot push files when the source and destination are the same." #define STRING_CMD_PUSH_NONLOCAL "The uri '{1}' is not a local directory." #define STRING_CMD_PUSH_TRANSFERRED "Local tasks transferred to {1}" #define STRING_CMD_PUSH_NO_URI "No uri was specified for the push. Either specify the uri of a remote .task directory, or create a 'push.default.uri' entry in your .taskrc file." -#define STRING_CMD_PULL_USAGE "Overwrites the local *.data files with those found at the URL" +#define STRING_CMD_PULL_USAGE "Pulls remote files from the URL" #define STRING_CMD_PULL_SAME "Cannot pull files when the source and destination are the same." #define STRING_CMD_PULL_TRANSFERRED "Local tasks transferred from {1}" #define STRING_CMD_PULL_NO_URI "No uri was specified for the pull. Either specify the uri of a remote .task directory, or create a 'pull.default.uri' entry in your .taskrc file." @@ -426,7 +426,7 @@ #define STRING_CMD_MODIFY_RECUR "This is a recurring task. Do you want to modify all pending recurrences of this same task?" #define STRING_CMD_MODIFY_NEED_TEXT "Additional text must be provided." -#define STRING_CMD_COLOR_USAGE "Displays all possible colors, a named sample, or a legend containing all currently defined colors" +#define STRING_CMD_COLOR_USAGE "All colors, a sample, or a legend" #define STRING_CMD_COLOR_HERE "Here are the colors currently in use:" #define STRING_CMD_COLOR_COLOR "Color" #define STRING_CMD_COLOR_DEFINITION "Definition" @@ -440,7 +440,7 @@ #define STRING_CMD_COLOR_RAMP "Gray ramp" #define STRING_CMD_COLOR_TRY "Try running '{1}'." #define STRING_CMD_COLOR_OFF "Color is currently turned off in your .taskrc file. To enable color, remove the line 'color=off', or change the 'off' to 'on'." -#define STRING_CMD_CONFIG_USAGE "Add, modify and remove settings in the task configuration" +#define STRING_CMD_CONFIG_USAGE "Change settings in the task configuration" #define STRING_CMD_CONFIG_CONFIRM "Are you sure you want to change the value of '{1}' from '{2}' to '{3}'?" #define STRING_CMD_CONFIG_CONFIRM2 "Are you sure you want to add '{1}' with a value of '{2}'?" #define STRING_CMD_CONFIG_CONFIRM3 "Are you sure you want to remove '{1}'?" @@ -456,10 +456,10 @@ #define STRING_CMD_CUSTOM_COUNT "1 task" #define STRING_CMD_CUSTOM_COUNTN "{1} tasks" #define STRING_CMD_CUSTOM_TRUNCATED "truncated to {1} lines" -#define STRING_CMD_TIMESHEET_USAGE "Shows a weekly report of tasks completed and started" +#define STRING_CMD_TIMESHEET_USAGE "Weekly summary of completed and started tasks" #define STRING_CMD_TIMESHEET_STARTED "Started ({1} tasks)" #define STRING_CMD_TIMESHEET_DONE "Completed ({1} tasks)" -#define STRING_CMD_MERGE_USAGE "Merges the specified undo.data file with the local data files" +#define STRING_CMD_MERGE_USAGE "Merges the remote files with the local files" #define STRING_CMD_MERGE_COMPLETE "Merge complete." #define STRING_CMD_MERGE_CONFIRM "Would you like to push the merged changes to '{1}'?" #define STRING_CMD_MERGE_NO_URI "No uri was specified for the merge. Either specify the uri of a remote .task directory, or create a 'merge.default.uri' entry in your .taskrc file." @@ -485,7 +485,7 @@ #define STRING_CMD_CAL_LABEL_DATE "Date" #define STRING_CMD_CAL_LABEL_HOL "Holiday" #define STRING_CMD_CAL_SUN_MON "The 'weekstart' configuration variable may only contain 'Sunday' or 'Monday'." -#define STRING_CMD_EDIT_USAGE "Launches an editor to let you modify all aspects of a task directly" +#define STRING_CMD_EDIT_USAGE "Launches an editor to modify a task directly" // Config #define STRING_CONFIG_OVERNEST "Configuration file nested to more than 10 levels deep - this has to be a mistake." @@ -619,7 +619,7 @@ #define STRING_RECUR_PAST_UNTIL "Task ({1}) has past its 'until' date, and has been deleted." // 'show' command -#define STRING_CMD_SHOW "Shows the entire task configuration variables or the ones containing substring." +#define STRING_CMD_SHOW "Shows all configuration variables or subset" #define STRING_CMD_SHOW_ARGS "You can only specify 'all' or a search string." #define STRING_CMD_SHOW_NONE "No matching configuration variables." #define STRING_CMD_SHOW_UNREC "Your .taskrc file contains these unrecognized variables:"