diff options
| author | 2025-08-08 06:58:11 +0500 | |
|---|---|---|
| committer | 2025-08-08 06:58:11 +0500 | |
| commit | ce97ea9826d63072c676f007d4f9e1526cb32f8d (patch) | |
| tree | 41a356584dea88df8b520cbf5d2332606fa3550a /docs/lib/global_sh.html | |
| parent | a7be2fb01bd356cd7c1edafd8e8505cfd508fbe5 (diff) | |
update docs
Diffstat (limited to 'docs/lib/global_sh.html')
| -rw-r--r-- | docs/lib/global_sh.html | 169 |
1 files changed, 108 insertions, 61 deletions
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> |
