diff options
Diffstat (limited to 'docs/lib')
| -rw-r--r-- | docs/lib/edit_sh.html | 204 | ||||
| -rw-r--r-- | docs/lib/environment_sh.html | 68 | ||||
| -rw-r--r-- | docs/lib/global_sh.html | 169 | ||||
| -rw-r--r-- | docs/lib/project_sh.html | 93 |
4 files changed, 433 insertions, 101 deletions
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 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Style-Type" content="text/css" /> +<meta http-equiv="Content-type" content="text/html; charset=UTF-8" /> +<link rel="stylesheet" href="../robodoc.css" type="text/css" /> +<script src="../robodoc.js"></script> +<title>edit.sh</title> +<!-- Source: ./lib/edit.sh --> +<!-- Generated with ROBODoc Version 4.99.44 (May 7 2025) --> +</head> +<body> +<div id="logo"> +<a name="robo_top_of_doc"></a> +</div> <!-- logo --> +<div id="navigation"> +<a class="menuitem" href="../toc_index.html#top">Table of Contents</a> +<a class="menuitem" href="../robo_sourcefiles.html#top">Sourcefiles</a> +<a class="menuitem" href="../masterindex.html#top">Index</a> +<a class="menuitem" href="../robo_dirs.html#top">Directories</a> +<a class="menuitem" href="../robo_files.html#top">Files</a> +<a class="menuitem" href="../robo_definitions.html#top">Definitions</a> +<a class="menuitem" href="../robo_functions.html#top">Functions</a> +<a class="menuitem" href="../robo_modules.html#top">Modules</a> +</div> <!-- navigation --> +<div id="content"> +<hr /> +<a name="lib2fedit2esh"></a> +<a name="robo0"></a><h2>lib/edit.sh [ Files ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo6">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>edit.sh</strong> - функции для <a href="../edit_project_sh.html#robo_top_of_doc">edit_project.sh</a>. +</p> +<p class="item_name">USED BY</p> +<ul><li> <a href="../edit_project_sh.html#robo_top_of_doc">edit_project.sh</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="edit2esh2fbackupStages"></a> +<a name="robo8"></a><h2>edit.sh/backupStages [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">edit.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>backupStages</strong> - создание копии TMP_TSKW_EDIT. +</p> +<p class="item_name">DESCRIPTION</p> +<p> Делается для дальнейшего сравнения в <a href="#robo9">compareTaskFiles</a>. +</p> +<p class="item_name">USED BY</p> +<ul><li> <a href="#robo0">edit.sh</a> +</li> +<li> <a href="#robo11">editStageProject</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="edit2esh2fcompareTaskFiles"></a> +<a name="robo9"></a><h2>edit.sh/compareTaskFiles [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">edit.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>compareTaskFiles</strong> - сравнивает файлы TMP_TSKW_EDIT и TMP_TSKW_BAK. +</p> +<p class="item_name">DESCRIPTION</p> +<p> TMP_TSKW_EDIT - файл содержит все шаги которые содержит проект с тегом current. + TMP_TSKW_BAK - копия TMP_TSKW_EDIT. +</p> +<p class="item_name">USED BY</p> +<ul><li> <a href="#robo0">edit.sh</a> +</li> +<li> <a href="#robo11">editStageProject</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="edit2esh2fdeleteProject"></a> +<a name="robo10"></a><h2>edit.sh/deleteProject [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">edit.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>deleteProject</strong> - удаление проекта. +</p> +<p class="item_name">USES</p> +<ul><li> <a href="#robo13">getIdsTask</a> +</li> +<li> <a href="./global_sh.html#robo24">getNameProject</a> +</li> +</ul> +<p></p> +<p class="item_name">USED BY</p> +<ul><li> <a href="../edit_project_sh.html#robo_top_of_doc">edit_project.sh</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="edit2esh2feditStageProject"></a> +<a name="robo11"></a><h2>edit.sh/editStageProject [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">edit.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>editStageProject</strong> - записывает шаги проекта в TMP_TSKW_EDIT, делает копию TMP_TSKW_EDIT, сравнивает TMP_TKSW_EDIT с копией. +</p> +<p class="item_name">DESCRIPTION</p> +<p> Фактически объединяет в себе несколько других функций: <a href="#robo8">backupStages</a>, <a href="#robo12">editStages</a>, <a href="#robo9">compareTaskFiles</a>. +</p> +<p class="item_name">USES</p> +<ul><li> <a href="#robo8">backupStages</a> +</li> +<li> <a href="#robo12">editStages</a> +</li> +<li> <a href="#robo9">compareTaskFiles</a> +</li> +</ul> +<p></p> +<p class="item_name">USED BY</p> +<ul><li> <a href="../edit_project_sh.html#robo_top_of_doc">edit_project.sh</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="edit2esh2feditStages"></a> +<a name="robo12"></a><h2>edit.sh/editStages [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">edit.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>editStages</strong> - открытие TMP_TSKW_EDIT в nvim. +</p> +<p class="item_name">DESCRIPTION</p> +<p> Нужна для редактирования шагов проекта. +</p> +<p class="item_name">USED BY</p> +<ul><li> <a href="#robo0">edit.sh</a> +</li> +<li> <a href="#robo11">editStageProject</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="edit2esh2fgetIdsTask"></a> +<a name="robo13"></a><h2>edit.sh/getIdsTask [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">edit.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>getIdsTask</strong> - возвращает массив из id задач. +</p> +<p class="item_name">ARGUMENTS</p> +<pre class="source"># uuid - uuid задачи. +</pre> +<p class="item_name">USAGE</p> +<pre class="source"># <strong>getIdsTask</strong> uuid +</pre> +<p class="item_name">RETURN VALUE</p> +<pre class="source"># return {array} - Id задач +</pre> +<p class="item_name">USES</p> +<ul><li> <a href="./global_sh.html#robo24">getNameProject</a> +</li> +</ul> +<p></p> +<p class="item_name">USED BY</p> +<ul><li> <a href="#robo0">edit.sh</a> +</li> +<li> <a href="#robo11">editStageProject</a> +</li> +<li> <a href="#robo10">deleteProject</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="edit2esh2frecreateProject"></a> +<a name="robo14"></a><h2>edit.sh/recreateProject [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">edit.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>recreateProject</strong> - пересоздание проекта. +</p> +<p class="item_name">USES</p> +<ul><li> <a href="./global_sh.html#robo23">getLatestTaskUuid</a> +</li> +</ul> +<p></p> +<p class="item_name">USED BY</p> +<ul><li> <a href="../edit_project_sh.html#robo_top_of_doc">edit_project.sh</a> +</li> +</ul> +<p></p> + +</div> <!-- content --> +<div id="footer"> +<p>Generated from ./lib/edit.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-08-08 06:55:59</p> +</div> <!-- footer --> +</body> +</html> 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 @@ <script src="../robodoc.js"></script> <title>environment.sh</title> <!-- Source: ./lib/environment.sh --> -<!-- Generated with ROBODoc Version 4.99.44 (Mar 23 2025) --> +<!-- Generated with ROBODoc Version 4.99.44 (May 7 2025) --> </head> <body> <div id="logo"> @@ -28,65 +28,63 @@ <div id="content"> <hr /> <a name="lib2fenvironment2esh"></a> -<a name="robo2"></a><h2>lib/environment.sh [ Files ]</h2> +<a name="robo1"></a><h2>lib/environment.sh [ Files ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo5">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo6">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> <p class="item_name">NAME</p> -<p> environment - файл c основными константами и переменными. -</p> -<p class="item_name">USED BY</p> -<ul><li> <a href="../edit_project_sh.html#robo0">edit_project.sh</a> -</li> -<li> <a href="../jtx_sh.html#robo_top_of_doc">jtx.sh</a> -</li> -<li> someday.sh -</li> -<li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> -</li> -<li> start_stop.sh -</li> -</ul> -<p></p> - -<hr /> -<a name="environment2esh2fFOOTE"></a> -<a name="robo7"></a><h2>environment.sh/FOOTE [ Definitions ]</h2> - -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> -<p class="item_name">NAME</p> -<p> <strong>FOOTE</strong> - bash-скрипт $HOME/bin/foote.sh. +<p> <strong>environment.sh</strong> - файл c основными константами и переменными. </p> <hr /> <a name="environment2esh2fLIB5fDIR"></a> -<a name="robo8"></a><h2>environment.sh/LIB_DIR [ Definitions ]</h2> +<a name="robo15"></a><h2>environment.sh/LIB_DIR [ Definitions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> <p class="item_name">NAME</p> <p> <strong>LIB_DIR</strong> - папка с вспомогательными функциями. </p> +<p class="item_name">USED BY</p> +<ul><li> <a href="../tskw_sh.html#robo_top_of_doc">tskw.sh</a> +</li> +<li> <a href="../edit_project_sh.html#robo_top_of_doc">edit_project.sh</a> +</li> +</ul> +<p></p> <hr /> -<a name="environment2esh2fPEACLOCK5fCUSTOM5fCONFIG"></a> -<a name="robo9"></a><h2>environment.sh/PEACLOCK_CUSTOM_CONFIG [ Definitions ]</h2> +<a name="environment2esh2fMY5fCAL"></a> +<a name="robo16"></a><h2>environment.sh/MY_CAL [ Definitions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> <p class="item_name">NAME</p> -<p> <strong>PEACLOCK_CUSTOM_CONFIG</strong> - кастомный файл конфигурации для peaclock. +<p> <strong>MY_CAL</strong> - папка с ics файлами календаря my_cal. </p> +<p class="item_name">USED BY</p> +<ul><li> <a href="../jtx_sh.html#robo_top_of_doc">jtx.sh</a> +</li> +</ul> +<p></p> +<p class="item_name">NOTES</p> +<pre> <a href="https://baikal.bluig.space/dav.php/calendars/me/my_cal/">https://baikal.bluig.space/dav.php/calendars/me/my_cal/</a> +</pre> <hr /> <a name="environment2esh2fROOT5fDIR"></a> -<a name="robo10"></a><h2>environment.sh/ROOT_DIR [ Definitions ]</h2> +<a name="robo17"></a><h2>environment.sh/ROOT_DIR [ Definitions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> <p class="item_name">NAME</p> <p> <strong>ROOT_DIR</strong> - корень проекта. </p> +<p class="item_name">USED BY</p> +<ul><li> <a href="../tskw_sh.html#robo_top_of_doc">tskw.sh</a> +</li> +</ul> +<p></p> </div> <!-- content --> <div id="footer"> -<p>Generated from ./lib/environment.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-05-01 19:58:11</p> +<p>Generated from ./lib/environment.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-08-08 06:55:59</p> </div> <!-- footer --> </body> </html> 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 @@ <script src="../robodoc.js"></script> <title>global.sh</title> <!-- Source: ./lib/global.sh --> -<!-- Generated with ROBODoc Version 4.99.44 (Mar 23 2025) --> +<!-- Generated with ROBODoc Version 4.99.44 (May 7 2025) --> </head> <body> <div id="logo"> @@ -28,23 +28,23 @@ <div id="content"> <hr /> <a name="lib2fglobal2esh"></a> -<a name="robo3"></a><h2>lib/global.sh [ Files ]</h2> +<a name="robo2"></a><h2>lib/global.sh [ Files ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo5">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo6">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> <p class="item_name">NAME</p> <p> <strong>global.sh</strong> - общие функции для всех скриптов. </p> <p class="item_name">USES</p> -<ul><li> <a href="./environment_sh.html#robo2">environment.sh</a> +<ul><li> <a href="./environment_sh.html#robo_top_of_doc">environment.sh</a> </li> </ul> <p></p> <hr /> <a name="global2esh2fcheckExistingProject"></a> -<a name="robo11"></a><h2>global.sh/checkExistingProject [ Functions ]</h2> +<a name="robo18"></a><h2>global.sh/checkExistingProject [ Functions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> <p class="item_name">NAME</p> <p> <strong>checkExistingProject</strong> - проверка на наличие существующего проекта. </p> @@ -53,18 +53,17 @@ </pre> <p class="item_name">USAGE</p> <pre class="source"># <strong>checkExistingProject</strong> <id | uuid> +# +# USES BY +# +# - <a href="./project_sh.html#robo_top_of_doc">project.sh</a> </pre> -<p class="item_name">USES</p> -<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> -</li> -</ul> -<p></p> <hr /> <a name="global2esh2fdenotateAllAnnotations"></a> -<a name="robo12"></a><h2>global.sh/denotateAllAnnotations [ Functions ]</h2> +<a name="robo19"></a><h2>global.sh/denotateAllAnnotations [ Functions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> <p class="item_name">NAME</p> <p> <strong>denotateAllAnnotations</strong> - удаление всех аннотаций у задачи. </p> @@ -75,16 +74,21 @@ <pre class="source"># <strong>denotateAllAnnotations</strong> <id | uuid> </pre> <p class="item_name">USES</p> -<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +<ul><li> <a href="#robo20">getAnnotationCount</a> </li> </ul> -<p></p> +<p> + USES BY +</p> + +<p> - <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</p> <hr /> <a name="global2esh2fgetAnnotationCount"></a> -<a name="robo13"></a><h2>global.sh/getAnnotationCount [ Functions ]</h2> +<a name="robo20"></a><h2>global.sh/getAnnotationCount [ Functions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> <p class="item_name">NAME</p> <p> <strong>getAnnotationCount</strong> - возвращает длину массива аннотаций задачи. </p> @@ -93,44 +97,98 @@ </pre> <p class="item_name">USAGE</p> <pre class="source"># <strong>getAnnotationCount</strong> <id | uuid> +# +# USES BY +# +# - <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +# - <a href="#robo19">denotateAllAnnotations</a> </pre> <p class="item_name">RETURN VALUE</p> <pre class="source"># return {String} - Количество аннотаций </pre> -<p class="item_name">USES</p> -<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> -</li> -</ul> -<p></p> <hr /> <a name="global2esh2fgetLatestTaskId"></a> -<a name="robo14"></a><h2>global.sh/getLatestTaskId [ Functions ]</h2> +<a name="robo22"></a><h2>global.sh/getLatestTaskId [ Functions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> <p class="item_name">NAME</p> <p> <strong>getLatestTaskId</strong> - возвращает id задачи. </p> <p class="item_name">DESCRIPTION</p> <p> Возвращает id задачи с тегом +LATEST, которая является самой последней из добавленных. </p> + +<p> USES BY +</p> + +<p> - <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</p> <p class="item_name">RETURN VALUE</p> <pre class="source"># return {string} - Id задачи </pre> -<p class="item_name">USES</p> -<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> -</li> -</ul> -<p></p> <p class="item_name">NOTES</p> <pre> <a href="https://taskwarrior.org/docs/tags/">https://taskwarrior.org/docs/tags/</a> </pre> <hr /> +<a name="global2esh2fgetLatestTaskUuid"></a> +<a name="robo23"></a><h2>global.sh/getLatestTaskUuid [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>getLatestTaskUuid</strong> - возвращает id задачи. +</p> +<p class="item_name">DESCRIPTION</p> +<p> Возвращает uuid задачи с тегом +LATEST, которая является самой последней из добавленных. +</p> + +<p> USES BY +</p> + +<p> - <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</p> +<p class="item_name">RETURN VALUE</p> +<pre class="source"># return {string} - Uuid задачи +</pre> +<p class="item_name">NOTES</p> +<pre> <a href="https://taskwarrior.org/docs/tags/">https://taskwarrior.org/docs/tags/</a> +</pre> + +<hr /> +<a name="global2esh2fgetNameProject"></a> +<a name="robo24"></a><h2>global.sh/getNameProject [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>getNameProject</strong> - возвращает название проекта задачи. +</p> +<p class="item_name">ARGUMENTS</p> +<pre class="source"># id | uuid - id или uuid задачи. +</pre> +<p class="item_name">USAGE</p> +<pre class="source"># <strong>getNameProject</strong> <id | uuid> +</pre> +<p class="item_name">RETURN VALUE</p> +<pre class="source"># return {String} - Uuid задачи +</pre> +<p class="item_name">USED BY</p> +<ul><li> <a href="./edit_sh.html#robo0">edit.sh</a> +</li> +</ul> +<p> + USES BY +</p> + +<p> - <a href="./edit_sh.html#robo0">edit.sh</a> + - <a href="../edit_project_sh.html#robo_top_of_doc">edit_project.sh</a> +</p> + +<hr /> <a name="global2esh2fgetTags"></a> -<a name="robo15"></a><h2>global.sh/getTags [ Functions ]</h2> +<a name="robo26"></a><h2>global.sh/getTags [ Functions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> <p class="item_name">NAME</p> <p> <strong>getTags</strong> - возвращает массив тегов задачи. </p> @@ -139,25 +197,21 @@ </pre> <p class="item_name">USAGE</p> <pre class="source"># <strong>getTags</strong> <id | uuid> +# +# USES BY +# +# - <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +# - <a href="../edit_project_sh.html#robo_top_of_doc">edit_project.sh</a> </pre> <p class="item_name">RETURN VALUE</p> <pre class="source"># return {Array} - Массив тегов </pre> -<p class="item_name">USES</p> -<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> -</li> -<li> someday.sh -</li> -<li> <a href="../edit_project_sh.html#robo0">edit_project.sh</a> -</li> -</ul> -<p></p> <hr /> <a name="global2esh2fhasProject"></a> -<a name="robo16"></a><h2>global.sh/hasProject [ Functions ]</h2> +<a name="robo27"></a><h2>global.sh/hasProject [ Functions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> <p class="item_name">NAME</p> <p> <strong>hasProject</strong> - проверка на наличие проекта у задачи. </p> @@ -175,9 +229,9 @@ <hr /> <a name="global2esh2fnotify"></a> -<a name="robo17"></a><h2>global.sh/notify [ Functions ]</h2> +<a name="robo28"></a><h2>global.sh/notify [ Functions ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> <p class="item_name">NAME</p> <p> <strong>notify</strong> - вывод сообщения через <strong>notify</strong>-send. </p> @@ -191,28 +245,21 @@ <p class="item_name">EXAMPLE</p> <pre class="source"># <strong>notify</strong> "msg-error" "Ошибка!" </pre> -<p class="item_name">USES</p> -<ul><li> <a href="#robo_top_of_doc">global.sh</a> -</li> -<li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> -</li> -<li> edit.sh -</li> -<li> someday.sh -</li> -<li> start_stop.sh -</li> -<li> <a href="../edit_project_sh.html#robo0">edit_project.sh</a> -</li> -</ul> -<p></p> <p class="item_name">NOTES</p> -<pre> Категории уведомлений находятся в $HOME/.config/mako/category +<pre> Категории уведомлений находятся в ~/.config/mako/category + + USES BY + + - <a href="../tskw_sh.html#robo_top_of_doc">tskw.sh</a> + - <a href="./project_sh.html#robo_top_of_doc">project.sh</a> + - <a href="#robo_top_of_doc">global.sh</a> + - <a href="./edit_sh.html#robo0">edit.sh</a> + - <a href="../edit_project_sh.html#robo_top_of_doc">edit_project.sh</a> </pre> </div> <!-- content --> <div id="footer"> -<p>Generated from ./lib/global.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-05-01 19:58:11</p> +<p>Generated from ./lib/global.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-08-08 06:55:59</p> </div> <!-- footer --> </body> </html> 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 @@ <script src="../robodoc.js"></script> <title>project.sh</title> <!-- Source: ./lib/project.sh --> -<!-- Generated with ROBODoc Version 4.99.44 (Mar 23 2025) --> +<!-- Generated with ROBODoc Version 4.99.44 (May 7 2025) --> </head> <body> <div id="logo"> @@ -28,16 +28,99 @@ <div id="content"> <hr /> <a name="lib2fproject2esh"></a> -<a name="robo4"></a><h2>lib/project.sh [ Files ]</h2> +<a name="robo3"></a><h2>lib/project.sh [ Files ]</h2> -<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo5">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo6">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> <p class="item_name">NAME</p> -<p> <strong>project.sh</strong> - общие функции для всех скриптов. +<p> <strong>project.sh</strong> - bash-скрипт для создания проекта в taskwarrior-tui. </p> +<hr /> +<a name="global2esh2fgetExitCriteria"></a> +<a name="robo21"></a><h2>global.sh/getExitCriteria [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="./global_sh.html#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>getExitCriteria</strong> - возвращает критерий завершения. +</p> + +<p> USES BY +</p> + +<p> - <a href="#robo30">taskProj</a> +</p> +<p class="item_name">RETURN VALUE</p> +<pre class="source"># return {string} - критерий завершения задачи. +</pre> +<p class="item_name">NOTES</p> +<pre> Следующее после самого первого описания (description) идёт - критерий завершения. +</pre> + +<hr /> +<a name="global2esh2fgetProjName"></a> +<a name="robo25"></a><h2>global.sh/getProjName [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="./global_sh.html#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>getProjName</strong> - возвращает название проекта. +</p> + +<p> USES BY +</p> + +<p> - <a href="#robo30">taskProj</a> +</p> +<p class="item_name">RETURN VALUE</p> +<pre class="source"># return {string} - название задачи. +</pre> +<p class="item_name">NOTES</p> +<pre> Cамое первое описание (description) является названием задачи. +</pre> + +<hr /> +<a name="global2esh2ftaskCheck"></a> +<a name="robo29"></a><h2>global.sh/taskCheck [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="./global_sh.html#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>taskCheck</strong> - проверка обрабатываемой задачи. +</p> +<p class="item_name">DESCRIPTION</p> +<p> Проверка задачи на наличие: критерия завершения, названия проекта, первого шага и существующего проекта. +</p> + +<p> USES BY +</p> + +<p> - <a href="#robo30">taskProj</a> +</p> +<p class="item_name">RETURN VALUE</p> +<pre class="source"># return {number} - статус завершения. +</pre> + +<hr /> +<a name="global2esh2ftaskProj"></a> +<a name="robo30"></a><h2>global.sh/taskProj [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="./global_sh.html#robo2">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>taskProj</strong> - создание проекта. +</p> +<p class="item_name">NOTES</p> +<pre> Проект создается на основе: + + - названия проекта; + - критерия завершения; + - первого шага. + + USES BY + + - <a href="../tskw_sh.html#robo_top_of_doc">tskw.sh</a> +</pre> + </div> <!-- content --> <div id="footer"> -<p>Generated from ./lib/project.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-05-01 19:58:11</p> +<p>Generated from ./lib/project.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-08-08 06:55:59</p> </div> <!-- footer --> </body> </html> |
