edit.sh

Date: Fri, 8 Aug 2025 06:58:11 +0500 Subject: update docs --- docs/lib/edit_sh.html | 204 +++++++++++++++++++++++++++++++++++++++++++ docs/lib/environment_sh.html | 68 +++++++-------- docs/lib/global_sh.html | 169 ++++++++++++++++++++++------------- docs/lib/project_sh.html | 93 ++++++++++++++++++-- 4 files changed, 433 insertions(+), 101 deletions(-) create mode 100644 docs/lib/edit_sh.html (limited to 'docs/lib') diff --git a/docs/lib/edit_sh.html b/docs/lib/edit_sh.html new file mode 100644 index 0000000..765c729 --- /dev/null +++ b/docs/lib/edit_sh.html @@ -0,0 +1,204 @@ + + + + + + + + +edit.sh + + + + +

+ +

lib/edit.sh [ Files ]

+ +

[ Top ] [ lib ] [ Files ]

NAME

edit.sh - функции для edit_project.sh. +

USED BY

edit_project.sh +

+ +

edit.sh/backupStages [ Functions ]

+ +

[ Top ] [ edit.sh ] [ Functions ]

NAME

backupStages - создание копии TMP_TSKW_EDIT. +

DESCRIPTION

Делается для дальнейшего сравнения в compareTaskFiles. +

USED BY

edit.sh +
editStageProject +

+ +

edit.sh/compareTaskFiles [ Functions ]

+ +

[ Top ] [ edit.sh ] [ Functions ]

NAME

compareTaskFiles - сравнивает файлы TMP_TSKW_EDIT и TMP_TSKW_BAK. +

DESCRIPTION

TMP_TSKW_EDIT - файл содержит все шаги которые содержит проект с тегом current. + TMP_TSKW_BAK - копия TMP_TSKW_EDIT. +

USED BY

edit.sh +
editStageProject +

+ +

edit.sh/deleteProject [ Functions ]

+ +

[ Top ] [ edit.sh ] [ Functions ]

NAME

deleteProject - удаление проекта. +

USES

getIdsTask +
getNameProject +

USED BY

edit_project.sh +

+ +

edit.sh/editStageProject [ Functions ]

+ +

[ Top ] [ edit.sh ] [ Functions ]

NAME

editStageProject - записывает шаги проекта в TMP_TSKW_EDIT, делает копию TMP_TSKW_EDIT, сравнивает TMP_TKSW_EDIT с копией. +

DESCRIPTION

Фактически объединяет в себе несколько других функций: backupStages, editStages, compareTaskFiles. +

USES

backupStages +
editStages +
compareTaskFiles +

USED BY

edit_project.sh +

+ +

edit.sh/editStages [ Functions ]

+ +

[ Top ] [ edit.sh ] [ Functions ]

NAME

editStages - открытие TMP_TSKW_EDIT в nvim. +

DESCRIPTION

Нужна для редактирования шагов проекта. +

USED BY

edit.sh +
editStageProject +

+ +

edit.sh/getIdsTask [ Functions ]

+ +

[ Top ] [ edit.sh ] [ Functions ]

NAME

getIdsTask - возвращает массив из id задач. +

ARGUMENTS

# uuid - uuid задачи.
+

USAGE

# getIdsTask uuid
+

RETURN VALUE

# return {array} - Id задач
+

USES

getNameProject +

USED BY

edit.sh +
editStageProject +
deleteProject +

+ +

edit.sh/recreateProject [ Functions ]

+ +

[ Top ] [ edit.sh ] [ Functions ]

NAME

recreateProject - пересоздание проекта. +

USES

getLatestTaskUuid +

USED BY

edit_project.sh +

+ +

+ + + diff --git a/docs/lib/environment_sh.html b/docs/lib/environment_sh.html index 792b83b..3b3d55c 100644 --- a/docs/lib/environment_sh.html +++ b/docs/lib/environment_sh.html @@ -9,7 +9,7 @@ environment.sh - +

@@ -28,65 +28,63 @@

lib/environment.sh [ Files ]

[ Top ] [ lib ] [ Files ]

NAME

environment - файл c основными константами и переменными. -

USED BY

edit_project.sh -
jtx.sh -
someday.sh -
project.sh -
start_stop.sh -

- -

environment.sh/FOOTE [ Definitions ]

- -

[ Top ] [ environment.sh ] [ Definitions ]

NAME

FOOTE - bash-скрипт $HOME/bin/foote.sh. +

environment.sh - файл c основными константами и переменными.

environment.sh/LIB_DIR [ Definitions ]

[ Top ] [ environment.sh ] [ Definitions ]

NAME

LIB_DIR - папка с вспомогательными функциями.

USED BY

tskw.sh +
edit_project.sh +

- -

environment.sh/PEACLOCK_CUSTOM_CONFIG [ Definitions ]

+ +

environment.sh/MY_CAL [ Definitions ]

[ Top ] [ environment.sh ] [ Definitions ]

NAME

PEACLOCK_CUSTOM_CONFIG - кастомный файл конфигурации для peaclock. +

MY_CAL - папка с ics файлами календаря my_cal.

USED BY

jtx.sh +

NOTES

 https://baikal.bluig.space/dav.php/calendars/me/my_cal/
+

environment.sh/ROOT_DIR [ Definitions ]

[ Top ] [ environment.sh ] [ Definitions ]

NAME

ROOT_DIR - корень проекта.

USED BY

tskw.sh +

diff --git a/docs/lib/global_sh.html b/docs/lib/global_sh.html index 3600ff8..6d444c8 100644 --- a/docs/lib/global_sh.html +++ b/docs/lib/global_sh.html @@ -9,7 +9,7 @@ global.sh - +

@@ -28,23 +28,23 @@

lib/global.sh [ Files ]

[ Top ] [ lib ] [ Files ]

NAME

global.sh - общие функции для всех скриптов.

USES

environment.sh +
- environment.sh
-
global.sh/checkExistingProject [ Functions ]
+
global.sh/checkExistingProject [ Functions ]
-
[ Top ] [ global.sh ] [ Functions ]
+
[ Top ] [ global.sh ] [ Functions ]

NAME

checkExistingProject - проверка на наличие существующего проекта.
@@ -53,18 +53,17 @@
USAGE
```
# checkExistingProject <id | uuid>
+#
+# USES BY
+#
+# - project.sh
 
```
-
USES
-
- project.sh -
-

-
global.sh/denotateAllAnnotations [ Functions ]
+
global.sh/denotateAllAnnotations [ Functions ]
-
[ Top ] [ global.sh ] [ Functions ]
+
[ Top ] [ global.sh ] [ Functions ]

NAME

denotateAllAnnotations - удаление всех аннотаций у задачи.
@@ -75,16 +74,21 @@
```
# denotateAllAnnotations <id | uuid>
 
```
USES
-
- project.sh +
  - getAnnotationCount
  -
  +
  + USES BY +
  + +
  - project.sh +
  
  -
  global.sh/getAnnotationCount [ Functions ]
  +
  global.sh/getAnnotationCount [ Functions ]
  -
  [ Top ] [ global.sh ] [ Functions ]
  +
  [ Top ] [ global.sh ] [ Functions ]
  
  NAME
  
  getAnnotationCount - возвращает длину массива аннотаций задачи.
  @@ -93,44 +97,98 @@
  USAGE
```
# getAnnotationCount <id | uuid>
+#
+# USES BY
+#
+# - project.sh
+# - denotateAllAnnotations
 
```
  RETURN VALUE
```
# return {String} - Количество аннотаций
 
```
  -
  USES
  -
  - project.sh -
  -
  
  -
  global.sh/getLatestTaskId [ Functions ]
  +
  global.sh/getLatestTaskId [ Functions ]
  -
  [ Top ] [ global.sh ] [ Functions ]
  +
  [ Top ] [ global.sh ] [ Functions ]
  
  NAME
  
  getLatestTaskId - возвращает id задачи.
  
  DESCRIPTION
  
  Возвращает id задачи с тегом +LATEST, которая является самой последней из добавленных.
  + +
  USES BY +
  + +
  - project.sh +
  
  RETURN VALUE
```
# return {string} - Id задачи
 
```
  -
  USES
  -
  - project.sh -
  -
  
  NOTES
```
 https://taskwarrior.org/docs/tags/
 
```
  +
  + +
  global.sh/getLatestTaskUuid [ Functions ]
  + +
  [ Top ] [ global.sh ] [ Functions ]
  +
  NAME
  +
  getLatestTaskUuid - возвращает id задачи. +
  +
  DESCRIPTION
  +
  Возвращает uuid задачи с тегом +LATEST, которая является самой последней из добавленных. +
  + +
  USES BY +
  + +
  - project.sh +
  +
  RETURN VALUE
  +
```
# return {string} - Uuid задачи
+
```
  +
  NOTES
  +
```
 https://taskwarrior.org/docs/tags/
+
```
  + +
  + +
  global.sh/getNameProject [ Functions ]
  + +
  [ Top ] [ global.sh ] [ Functions ]
  +
  NAME
  +
  getNameProject - возвращает название проекта задачи. +
  +
  ARGUMENTS
  +
```
# id | uuid - id или uuid задачи.
+
```
  +
  USAGE
  +
```
# getNameProject <id | uuid>
+
```
  +
  RETURN VALUE
  +
```
# return {String} - Uuid задачи
+
```
  +
  USED BY
  +
  - edit.sh +
  +
  + USES BY +
  + +
  - edit.sh + - edit_project.sh +
  +
  -
  global.sh/getTags [ Functions ]
  +
  global.sh/getTags [ Functions ]
  -
  [ Top ] [ global.sh ] [ Functions ]
  +
  [ Top ] [ global.sh ] [ Functions ]
  
  NAME
  
  getTags - возвращает массив тегов задачи.
  @@ -139,25 +197,21 @@
  USAGE
```
# getTags <id | uuid>
+#
+# USES BY
+#
+# - project.sh
+# - edit_project.sh
 
```
  RETURN VALUE
```
# return {Array} - Массив тегов
 
```
  -
  USES
  -
  - project.sh -
  - someday.sh -
  - edit_project.sh -
  -
  
  -
  global.sh/hasProject [ Functions ]
  +
  global.sh/hasProject [ Functions ]
  -
  [ Top ] [ global.sh ] [ Functions ]
  +
  [ Top ] [ global.sh ] [ Functions ]
  
  NAME
  
  hasProject - проверка на наличие проекта у задачи.
  @@ -175,9 +229,9 @@
  -
  global.sh/notify [ Functions ]
  +
  global.sh/notify [ Functions ]
  -
  [ Top ] [ global.sh ] [ Functions ]
  +
  [ Top ] [ global.sh ] [ Functions ]
  
  NAME
  
  notify - вывод сообщения через notify-send.
  @@ -191,28 +245,21 @@
  EXAMPLE
```
# notify "msg-error" "Ошибка!"
 
```
  -
  USES
  -
  - global.sh -
  - project.sh -
  - edit.sh -
  - someday.sh -
  - start_stop.sh -
  - edit_project.sh -
  -
  
  NOTES
  -
```
 Категории уведомлений находятся в $HOME/.config/mako/category
+ Категории уведомлений находятся в ~/.config/mako/category
+
+ USES BY
+
+ - tskw.sh
+ - project.sh
+ - global.sh
+ - edit.sh
+ - edit_project.sh
 
 
 
```

diff --git a/docs/lib/project_sh.html b/docs/lib/project_sh.html index aded21a..e674c45 100644 --- a/docs/lib/project_sh.html +++ b/docs/lib/project_sh.html @@ -9,7 +9,7 @@ project.sh - +

@@ -28,16 +28,99 @@

lib/project.sh [ Files ]

[ Top ] [ lib ] [ Files ]

NAME

project.sh - общие функции для всех скриптов. +

project.sh - bash-скрипт для создания проекта в taskwarrior-tui.

+ +

global.sh/getExitCriteria [ Functions ]

+ +

[ Top ] [ global.sh ] [ Functions ]

NAME

getExitCriteria - возвращает критерий завершения. +

+ +

USES BY +

+ +

- taskProj +

RETURN VALUE

# return {string} - критерий завершения задачи.
+

NOTES

 Следующее после самого первого описания (description) идёт - критерий завершения.
+

+ +

global.sh/getProjName [ Functions ]

+ +

[ Top ] [ global.sh ] [ Functions ]

NAME

getProjName - возвращает название проекта. +

+ +

USES BY +

+ +

- taskProj +

RETURN VALUE

# return {string} - название задачи.
+

NOTES

 Cамое первое описание (description) является названием задачи.
+

+ +

global.sh/taskCheck [ Functions ]

+ +

[ Top ] [ global.sh ] [ Functions ]

NAME

taskCheck - проверка обрабатываемой задачи. +

DESCRIPTION

Проверка задачи на наличие: критерия завершения, названия проекта, первого шага и существующего проекта. +

+ +

USES BY +

+ +

- taskProj +

RETURN VALUE

# return {number} - статус завершения.
+

+ +

global.sh/taskProj [ Functions ]

+ +

[ Top ] [ global.sh ] [ Functions ]

NAME

taskProj - создание проекта. +

NOTES

 Проект создается на основе:
+
+ - названия проекта;
+ - критерия завершения;
+ - первого шага.
+
+ USES BY
+
+ - tskw.sh
+

-- cgit

lib/edit.sh [ Files ]

edit.sh/backupStages [ Functions ]

edit.sh/compareTaskFiles [ Functions ]

edit.sh/deleteProject [ Functions ]

edit.sh/editStageProject [ Functions ]

edit.sh/editStages [ Functions ]

edit.sh/getIdsTask [ Functions ]

edit.sh/recreateProject [ Functions ]

lib/environment.sh [ Files ]

lib/environment.sh [ Files ]

environment.sh/FOOTE [ Definitions ]

environment.sh/LIB_DIR [ Definitions ]

environment.sh/LIB_DIR [ Definitions ]

environment.sh/PEACLOCK_CUSTOM_CONFIG [ Definitions ]

environment.sh/MY_CAL [ Definitions ]

environment.sh/ROOT_DIR [ Definitions ]

environment.sh/ROOT_DIR [ Definitions ]

lib/global.sh [ Files ]

lib/global.sh [ Files ]

global.sh/checkExistingProject [ Functions ]

global.sh/checkExistingProject [ Functions ]

global.sh/denotateAllAnnotations [ Functions ]

global.sh/denotateAllAnnotations [ Functions ]

global.sh/getAnnotationCount [ Functions ]

global.sh/getAnnotationCount [ Functions ]

global.sh/getLatestTaskId [ Functions ]

global.sh/getLatestTaskId [ Functions ]

global.sh/getLatestTaskUuid [ Functions ]

global.sh/getNameProject [ Functions ]

global.sh/getTags [ Functions ]

global.sh/getTags [ Functions ]

global.sh/hasProject [ Functions ]

global.sh/hasProject [ Functions ]

global.sh/notify [ Functions ]

global.sh/notify [ Functions ]

lib/project.sh [ Files ]

lib/project.sh [ Files ]

global.sh/getExitCriteria [ Functions ]

global.sh/getProjName [ Functions ]

global.sh/taskCheck [ Functions ]

global.sh/taskProj [ Functions ]