# Підручник з &karm;

Jonathan
Singer

    &Jonathan.Singer.mail;

Mark
Bucciarelli

    mark@hubcapconsulting.com

Sirtaj
Singh
Kang

    &Sirtaj.Singh.Kang.mail;

Lauri
Watts
Рецензент

    &Lauri.Watts.mail;

Юрій
Чорноіван

    yurchor@ukr.net

Переклад українською
2000-2004
&Jonathan.Singer;
2004-2005
Mark Bucciarelli
&FDLNotice;
2005-02-02
1.5.0

&karm; — інструмент для слідкування за часом, витраченим на різноманітні завдання.

KDE
karm
kdeutils
час
інструмент спостереження
проект

## Вступ

&karm; стежить за часом, який ви витрачаєте на роботу над різноманітними задачами. Ця програма корисна для стеження за обліком годин, вона може створювати звіти за даними, записаними для завдання або протягом дня.

Цей журнал розподілу часу можна експортувати як файл тексту, розміченого комами, для наступного імпорту до інших інструментів обліку часу і/або керування проектами.

&karm; може визначати час, коли клавіатуру та мишу вашого комп’ютера не буде задіяно, а також пов’язувати різні завдання з різними стільницями, ці два інструменти можуть допомогти вам стежити за тим, щоб таймер виконував відлік часу для належної задачі.

Першу версію &karm; було створено &Sirtaj.Singh.Kang;. Слово karm означає робота або дії рідною мовою автора, пенджабі, і є тим самим словом (але краще транслітерованим), що і карма.

## Користування &karm;

### Як запустити &karm;

Введіть команду `karm` у командному рядку або оберіть пункт Персональний лічильник часу з групи Утиліти у меню запуску KDE. Для запуску програми можна використовувати стандартні параметри &Qt; і &kde; командного рядка, ви можете ознайомитися з цим списком параметрів за допомогою команди ``karm` `--help``, відданої з командного рядка.

Під час запуску &karm; можна скористатися додатковим параметром командного рядка, за допомогою якого можна вказати назву файла iCalendar, який використовується для зберігання журналу вашої роботи. Ви можете вказати віддалений файл iCalendar за допомогою частин адрес http або ftp, доданих до назви файла; наприклад, http://www.mysite.com/mydata/mylabor.ics.

### Завдання

Проблема: Ви є консультантом з вільного програмного забезпечення, у вас багато клієнтів. Деякі з клієнтів мають по декілька проектів. Протягом дня ви перемикаєтеся з одного проекту на інший. Вам потрібно стежити за вашим часом, щоб потім створити рахунок за місяць роботи.

Вирішення: Створіть по одній задачі верхнього рівня для кожного з клієнтів і по підзадачі на кожен з проектів клієнта. Для проектів, які потребують докладнішого стеження, створіть список підзадач. Увімкнути стеження за часом можна подвійним клацанням на задачі, над якою ви зараз працюєте.

У &karm; закладено значну гнучкість у стеженні за розподілом вашого часу, ви можете задавати необмежену кількість задач і необмежену глибину вкладеності підзадач. Ви можете увійти до будь-якої з задач і активізовувати декілька задач одночасно у будь-який момент часу.

Щоб створити задачу найвищого рівня, скористайтеся пунктом меню &Ctrl;N Задача Створити задачу . Щоб створити підзадачу, оберіть основну задачу і скористайтеся пунктом меню &Ctrl;&Alt;N Задача Нова підзадача

Під час виходу з &karm; список задач зберігається у файлі, вказаному за допомогою пункту меню Параметри Налаштувати KArm . Під час наступного запуску програми цей список буде завантажено з вказаного файла.

&karm; може імпортувати і експортувати задачі, що полегшить вам життя. Див. Інші системи.

### Таймери

Проблема: Щоб мати достатньо грошей, вам слід працювати в середньому п’ять годин на добу. Щоб бути в курсі подій, вам слід переглянути загальні цифри за день і тиждень.

Вирішення: Повертайте таймер сеансу у нульове значення на початку кожного робочого дня і повертайте нульові значення всім таймерам на початку кожного тижня.

З &karm; слідкувати за часом просто. Щоб розпочати відлік часу для задачі, просто наведіть вказівник на позначку задачі і двічі клацніть лівою кнопкою миші. Щоб зупинити відлік часу, ще раз наведіть вказівник миші на запис задачі і двічі клацніть лівою кнопкою миші. Для активних задач у стовпчику Час сеансу буде показано маленький секундомір.

Ще одним засобом показу спостереження за поточною активністю &karm; є піктограма системного лотка. Якщо активною є певна задача, друга стрілка годинника на піктограмі рухається. Якщо ви наведете вказівник миші на цю піктограму, у контекстному вікні буде показано назву поточної задачі. Якщо активними є декілька задач, назви задач у контекстному вікні буде відокремлено комами.

У &karm; кожній задачі відповідають два таймери: один лічить час сеансу, а інший — загальний час. За типового налаштування, &karm; показує для кожного з таймерів по два стовпчики, що дає нам загалом чотири стовпчики для кожної задачі:

Час сеансу

  Час, витрачений на задачу з початку сеансу.

Загальний час сеансу

  Час, витрачений на задачу і всі її підзадачі з початку сеансу.

Час

  Час, витрачений на задачу, з моменту останнього скидання показань таймерів.

Всього часу

  Час, витрачений на задачу і всі її підзадачі, з моменту останнього скидання показань таймерів.

Щоб розпочати новий сеанс, скористайтеся пунктом меню Файл Запустити новий сеанс

Щоб повернути нульові значення всіх таймерів, скористайтеся пунктом меню Файл Скинути всі таймери

#### Стеження за стільницями

Проблема: Протягом дня ви перемикаєтеся між двома задачами. Для того, щоб впорядкувати вашу роботу, ви зберігаєте файли проекту 1 на Стільниці 1, а файли проекту 2 — на Стільниці 2.

Вирішення: Пов’яжіть задачу проекту 1 зі Стільницею 1, а задачу проекту 2 зі Стільницею 2. Коли ви перемикатиметеся зі Стільниці 2 на Стільницю 1, &karm; автоматично зупинятиме таймер задачі проекту 2 і запускатиме таймер задачі проекту 1.

Щоб пов’язати задачу з одною або декількома стільницями, скористайтеся пунктом меню &Ctrl;E Задача Редагувати . Позначте у вікні, що відкриється, пункт Автоматичне стеження, а потім позначте стільницю або стільниці, які буде пов’язано з задачею. Коли ставатиме активною одна з позначених стільниць, протягом короткого проміжку часу &karm; автоматично розпочинатиме відлік часу для відповідної задачі.

#### Визначення бездіяльності

Проблема: Ви полишили роботу вранці у п’ятницю через важливе доручення і забули зупинити таймер. Коли ви повернулися до роботи у понеділок, таймер все ще продовжував відлік часу.

Вирішення: Увімкніть визначення бездіяльності.

&karm; можна налаштувати так, щоб програма виявляла відсутність руху миші і натискань клавіш клавіатури. Якщо з боку миші і клавіатури не спостерігається руху протягом вказаної кількості хвилин, &karm; відкриває таке діалогове вікно:

Визначення бездіяльності у &karm;
Діалогове вікно визначення бездіяльності &karm;

Повернути і зупинити

  Відняти час бездіяльності від всіх активних таймерів і зупинити їх.

  Ви не працювали над задачами, доки комп’ютер був бездіяльним, і продовжуєте робити інші речі.

Повернути і продовжити

  Відняти час бездіяльності від усіх активних таймерів, але продовжувати відлік.

  Ви не працювали над задачами, доки комп’ютер був бездіяльним, але зараз починаєте працювати.

Продовжити лічити час

  Застосуйте час бездіяльності до всіх активних таймерів і продовжувати відлік.

  Ви працювали над задачами, доки комп’ютер був бездіяльним, і продовжуєте працювати далі.

### Створення звітів

У &karm; передбачено три способи повідомлення про час, протягом якого вівсі відлік. Ви можете надіслати результати сеансу або загальні результати на принтер, скопіювати загальні результати до буфера обміну інформацією або скопіювати історію відліку часу до буфера обміну інформацією (кишені).

#### Друк загальних даних

Для створення звіту з загальних даних для друку, скористайтеся пунктом меню &Ctrl;P Файл Друкувати . Програма створить звіт у вигляді таблиці з трьома стовпчиками і повним списком задач. У першому стовпчику буде назва задачі, у другому — Загальний час сеансу, а у третьому — Загальний час.

#### Копіювання загальних даних

Щоб створити копію звіту з загальних даних у буфері обміну інформацією, скористайтесь пунктом меню &Ctrl;C Файл Копіювати підсумки до кишені .

Звіт буде створено для поточної обраної задачі і всіх її підзадач. Якщо поточна задача є задачею найвищого рівня, &karm; запитає вас про те, чи бажаєте ви створити звіт для поточної задачі і всіх її підзадач, чи для всього списку задач.

Копіювання завдання у &karm;
Діалогове вікно «Копіювати цю задачу» &karm;

Тільки-но звіт буде створено, відкрийте &kwrite; або якийсь інший текстовий редактор і вставте туди дані звіту.

    Підсумки задачі
    2004-07-10 02:26

      Час    Задача
    ----------------------------------------------
      9:14    kde
       9:14    karm
        1:08    bugs
        0:00    checkin changes
       0:00    promo
       0:00    web stuff
    ----------------------------------------------
      9:14 Всього

У першому стовпчику буде Загальний час, його буде показано з відступом (так само, як і назви задач), щоб показати зв’язки задача-підзадача. Час у звіті включатиме час всіх підзадач.

#### Копіювання історії

Щоб створити копію історії у буфері обміну інформацією, скористайтеся пунктом меню &Ctrl;&Alt;C Файл Копіювати історію до кишені .

Спочатку вам слід позначити пункт Записувати історію у вікні, що відкривається за допомогою пункту меню Параметри Налаштувати KArm . У іншому випадку, &karm; стежитиме лише за загальними даними і зберігатиме докладної історії задачі.

Цей звіт буде створено для поточної обраної задачі і всіх її підзадач. Ви також можете створити звіт одразу для всіх задач.

Якщо ви обрали звіт з історії, &karm; спочатку запитає вас про діапазон дати для звіту:

Діалогове вікно введення діапазону дат &karm;
Діалогове вікно введення діапазону дат &karm;

Після введення діапазону дат, відкрийте &kwrite; або якийсь інший текстовий редактор і вставте туди дані звіту.

    Історія задачі
    З Четвер 01 липня 2004 до Понеділок 12 липня 2004
    Надруковано: 2004-07-12 17:18

                                   Тиждень з Понеділок 05 липня 2004
         5     6     7     8     9    10    11
    -------------------------------------------------------------------------
                                                 0:00 kde
                                                 0:00  dc
                  !:22  1:46  3:14  1:44         8:06  karm
                                                 0:00   3.2 feature plan
                  1:08                           1:08   bugs
                                                 0:00   checkin changes
                                                 0:00  promo
                                                 0:00  web stuff
    -------------------------------------------------------------------------
                  2:30  1:46  3:14  1:44         9:14 Всього

Підсумки історії підбиваються для кожного дня і задачі і групуються за тижнями. У перших сімох стовпчиках буде показано дані від понеділка до неділі. У восьмому стовпчику — підсумок за тиждень, а у дев’ятому — назву задачі. Назви задач буде показано з відступами для позначення зв’язку задача-підзадача.

### Інші системи

#### &korganizer;

&karm;, подібно до &korganizer; і Apple iCal, використовує для зберігання даних загальноприйнятий стандартний формат даних iCalendar. &karm; може читати і записувати списки завдань, створені цими двома програмами.

Якщо у обох програмах, &karm; і &korganizer; буде відкрито один і той самий файл, і ви редагуватимете файл у &korganizer;, ви ризикуєте втратити дані. Щоб убезпечити ваші дані, редагуйте файл лише у одній з програм.

#### Планувальник

У типовому випадку використання, у вас може виникнути потреба у плануванні проекту за допомогою інструменту для керування проектами Imendio Planner (from planner.imendio.org), а потім імпортувати список задач до &karm;, щоб отримувати їх у загальноприйнятому стандартному форматі iCalendar. Якщо ви зробите це, ви зможете скласти розклад задач у &korganizer;, а потім здійснювати облік за допомогою &karm;. Таким чином, можна контролювати стан виконання і бюджет проекту.

#### &DCOP;

&DCOP; — це механізм, за допомогою якого програм &kde; здійснюють обмін інформацією. У кожній програмі &kde; передбачено список функцій, які можуть використовувати інші програми (наприклад, скрипти Bash).

##### Скрипт Bash, який виводить версію &karm;

    DCOPID=`dcop | grep karm`
            if [ $DCOPID ]
            then
                    VERS=`dcop $DCOPID KarmDCOPIface version`
                    echo "Версія &karm; — $VERS"
            else
                    echo "&karm; не запущено"
            fi

У поточній версії &karm; інтерфейс &DCOP; використовується в основному з метою автоматизації перевірки, він є дуже обмеженим. Повний опис інтерфейсу можна знайти у розділі Додаток з інтерфейсу &DCOP;.

Щоб ознайомитися з повним переліком інтерфейсів &DCOP;, які надає у ваше розпорядження версія &karm;, встановлена у вашій системі, виконайте такий скрипт Bash:

##### Показує список інтерфейсів &DCOP; &karm; у консолі

    DCOPID=`dcop | grep karm`
            if [ $DCOPID ]
            then
                    dcop $DCOPID KarmDCOPIface
            else
                    echo "&karm; не запущено"
            fi

#### Експорт загальних даних до CSV

&karm; може експортувати як підсумкові дані, так і дані історії у текстовому форматі з відокремленням комами. Щоб експортувати підсумкові дані, скористайтеся пунктом меню Файл Імпорт/Експорт Експортувати до файл CSV... , &karm; відкриє таке діалогове вікно експорту:

Діалогове вікно експорту до CSV &karm;
Діалогове вікно експорту до CSV &karm;

Введіть назву файла, до якого ви бажаєте експортувати дані, а також, за потреби, змініть інші типові параметри з діалогового вікна. Зауважте, що засоби визначення діапазону дат буде вимкнено, оскільки ви експортуєте підсумкові дані, а не історію. Натисніть кнопку Експортувати, і &karm; експортує підсумкові дані для всіх задач до обраного вами файла.

Ось приклад формату виведення:

    "kde",,,,,0.00,0.00,6.88,9.83
    ,"karm",,,,6.88,8.70,6.88,9.83
    ,,"3.2 feature plan",,,0.00,0.00,0.00,0.00
    ,,"bugs",,,0.00,1.13,0.00,1.13
    ,,"checkin changes - translation strings",,,0.00,0.00,0.00,0.00
    ,,"time card report",,,0.00,0.00,0.00,0.00
    ,"kopete",,,,0.00,0.00,0.00,0.00
    ,"promo",,,,0.00,0.00,0.00,0.00
    ,"web stuff",,,,0.00,0.00,0.00,0.00

Задачі верхнього рівня буде виведено до першого стовпчика, підзадачі — до другого тощо. Дані щодо часу буде наведено після найглибшої задачі у ієрархії задач (у нашому прикладі у п’ятому стовпчику). Перший стовпчик з часом буде мати назву Час сеансу, другий — Час, третій — Загальний час сеансу, а четвертий — Загальний час.

#### Експорт історії до CSV

Щоб експортувати історію задачі, скористайтеся пунктом меню Файл Імпорт/Експорт Експортувати історію до файла CSV... , &karm; відкриє те саме діалогове вікно, що і показане вище.

Введіть назву файла, до якого ви бажаєте експортувати дані, і оберіть діапазон дат, для якого буде створено історію задачі. За потреби, змініть інші типові параметри з діалогового вікна. Натисніть кнопку Експортувати, &karm; експортує історію всіх задач до вказаного вами файла.

Ось приклад формату виведення:

    Історія задач
    З Вівторок 06 липня 2004 до Вівторок 13 липня 2004
    Надруковано: 2004-07-13 18:10
    2004-07-06,2004-07-07,2004-07-08,2004-07-09,2004-07-10,2004-07-11,2004-07-12,2004-07-13,
    ,,,,,,,,0.00,"kde"
    ,,1.77,3.23,1.73,,1.37,0.82,8.95,,"karm"
    ,,,,,,,,0.00,,,"3.2 feature plan"
    ,1.13,,,,,,,1.13,,,"bugs"
    ,,,,,,,,0.00,,,"checkin changes - translation strings"
    ,,,,,,,,0.00,,,"time card report"
    ,,,,,,,,0.00,,"kopete"
    ,,,,,,,,0.00,,"promo"
    ,,,,,,,,0.00,,"web stuff"

Перші три рядки вказують на те, коли було створено звіт, і для якого проміжку часу його було створено. У четвертому рядку буде показано список дат у діапазоні дат, у форматі ISO 8601 (РРРР-ММ-ДД). У наступних рядках списку буде показано час, відлічений для кожної з задач. У останньому стовпчику буде показано загальний підсумок для всіх днів. Назву задачі буде виведено за останнім стовпчиком з відступом, який позначатиме зв’язок задача-підзадача. Назви задач верхнього рівня буде показано у першому стовпчику після підсумків.

## Інтерфейс &karm;

Головне вікно &karm; складається з таких елементів: смужки меню, панелі інструментів, вікна задач і відліку часу і смужки стану.

Вікно &karm;
Вікно &karm;

### Вікно «Задача/Час»

У цьому вікні буде показано різноманітні задачі разом з часом, який було відлічено для кожної з них протягом поточного сеансу і загалом. Задачі, для яких виконується відлік, буде позначено маленьким годинничком поряд з часом сеансу.

Для кожної з задач можна створювати підзадачі. Натискання значка з плюсом і мінусом перед записом головної задачі розгортатиме або згортатиме перегляд пов’язаних підзадач. До загального часу, відліченого для задачі, буде включено час, витрачений на кожну з підзадач, а також власний час задачі.

### Смужка меню &karm;

#### Меню Файл

&Ctrl;S Файл Зберегти

  Зберігає поточні задачі і підзадачі з витраченим на них часом

&Ctrl;P Файл Друкувати

  Друкує зображення вікна &karm;

Файл Запустити новий сеанс

  Повертає нульові значення часу для всіх сеансів

Файл Скинути всі таймери

  Повертає нульові значення для всіх таймерів

Файл Імпорт/Експорт Імпортувати застарілий простий файл...

  Імпортувати збережений файл &karm; у застарілому форматі (тепер &karm; використовує файли збереження у стилі iCalendar.)

Файл Імпорт/Експорт Імпортувати задачі з плановика...

  Імпортувати проект планувальника imendio (див. planner.imendio.org). З файла .planner буде імпортовано всі задачі, підзадачі і їх позначки «завершення». Ви можете імпортувати їх як підзадачу, для цього слід створити підзадачу, залишити її позначеною або вже потім здійснити імпорт.

Файл Імпорт/Експорт Експортувати до файла CSV...

  Експортувати Загальний час сеансу, Час сеансу, Час і Загальний час до текстового файла.

Файл Імпорт/Експортувати Експортувати історію до файла CSV...

  Експортувати історію задачі до текстового файла.

&Ctrl;C Файл Копіювати підсумки до кишені

  Копіює поточний загальний час для задачі або для всіх задач до буфера обміну інформацією (кишені) &kde;

&Ctrl;&Alt;C Файл Копіювати історію до кишені

  Копіює часові дані за день протягом вказаного періоду часу до буфера обміну інформацією (кишені) &kde;

&Ctrl;Q Файл Вийти

  Завершує роботу &karm;

#### Меню Годинник

П Годинник Пуск

  Запускає таймер для вибраного завдання

Годинник Стоп

  Зупиняє таймер для поточного завдання

&Esc; Годинник Зупинити всі таймери

  Зупиняє відлік часу для всіх задач

#### Меню Задача

&Ctrl;N Задача Створити задачу

  Додати нову задачу

&Ctrl;&Alt;N Задача Нова підзадача

  Додати нову підзадачу до обраної задачі

Del Задача Вилучити

  Вилучити виділену задачу або підзадачу

&Ctrl;E Задача Змінити

  Змінити назву або нагромаджений час для поточної задачі

  Існує два нових варіанти для зміни часу: «Редагувати абсолютний», за якого таймер сеансу і загальний таймер можна змінювати окремо; і «Редагувати відносний», за якого до обох таймерів, таймера сеансу і загального таймера, буде додано чи віднято певне значення зміни.

  Пункт «Автоматичне стеження» надає вам змогу автоматично вмикати або вимикати відлік під час перемикання на певну стільницю &kde;.

#### Меню Параметри

Параметри Налаштування скорочень

  Відкриває діалогове вікно, у якому користувач зможе налаштувати клавіатурні скорочення

Параметри Налаштувати KArm

  Відкриває діалогове вікно, за допомогою якого користувач може налаштувати &karm;

  У цьому діалоговому вікні ви побачите три вкладки-панелі: Поведінка, за допомогою якої ви зможете визначити нагадування за відсутності активності і повідомлення-попередження, під час вилучення набору задач, Вигляд, за допомогою якої ви можете налаштувати поля, які буде показано у головному меню, і Зберігання, за допомогою якої ви можете налаштувати розташування файла зберігання, увімкнути або вимкнути автоматичне збереження і встановити інтервал автоматичного збереження.

#### Меню Довідка

&help.menu.documentation;

### Панель інструментів

На панелі інструментів (пеналі) буде показано піктограми для таких команд:

(Результат дії цих команд повністю збігається з відповідними командами меню.)

- Почати

- Зупинити

- Створити

- Нова підзадача

- Вилучити

- Змінити

### Смужка стану

Сповіщає про час, що минув з початку сеансу.

## Подяки і ліцензія

&karm;

Авторські права на програму:

- 1997-2000 &Sirtaj.Singh.Kang; &Sirtaj.Singh.Kang.mail;.

- 2001-2002 Tomas Pospisek tpo_deb@sourcepole.ch

- 2003-2004 Mark Bucciarellimark@hubcapconsulting.com

Учасники розробки (за абеткою)

- Allen Winter winterz@verizon.net

- &David.Faure; &David.Faure.mail;

- &Espen.Sand; espen@kde.org

- Gioele Barabucci gioele@gioelebarabucci.com

- Jan Schaumann jschauma@netmeister.org

- &Jesper.Pedersen; blackie@ifad.dk

- Kalle Dalheimer &Matthias.Kalle.Dalheimer.mail;

- Klarälvdalens Datakonsult AB

- Mark Bucciarelli mark@hubcapconsulting.com

- Thorsten Stärk dev@staerk.de

- Tomas Pospisek tpo_deb@sourcepole.ch

- Willi Richert w.richert@cox.net

Ідею &karm; було запозичено з дуже корисної програми Harald Tveit Alvestrand з назвою titrax, єдиним недоліком якої було те, що її було засновано на наборі інструментів Xt.

Авторські права на документацію до програми належать ©2000-2004 &Jonathan.Singer; &Jonathan.Singer.mail; і &Sirtaj.Singh.Kang; &Sirtaj.Singh.Kang.mail;.

Переклад українською: Юрій Чорноіванyurchor@ukr.net

&underFDL; &underGPL;
активне завдання

  Завдання, для якого запущено таймер.

&DCOP;

  Протокол взаємодії між процесами, який використовується у &kde;. Назва є скороченням від Desktop COmmunication Protocol (протокол обміну інформацією стільниці).

стільниця

  У &GNU;/&Linux;, FreeBSD та інших системах, де працює X-Window існує декілька стільниць. Типово, буде встановлено чотири різних стільниці. На кожній зі стільниць може бути показано власний набір програм і файлів. Після першого запуску &kde; ви побачите Стільницю 1. Якщо натиснути комбінацію клавіш &Ctrl;F2, ви побачите Стільницю 2. Натискання комбінації клавіш &Ctrl;F1 поверне вас на Стільницю 1.

історія

  Якщо &karm; налаштовано на запис історії, програма запише кожну подію з запуску/зупинки таймера. Ця історія не спорожнюється під час скидання значень таймерів і залишається записаною у файлі до того часу, доки ви не вилучите задачу.

сеанс

  Визначена користувачем точка запуску таймерів сеансу. Розпочати новий сеанс можна розпочати за допомогою пункту меню Файл Запустити новий сеанс . Дані сеансу не зберігаються під час створення нового сеансу.

Час сеансу

  Час, витрачений на задачу з початку сеансу.

системний лоток

  Системний лоток — це панель, яка (типово) розташовується в нижній частині екрана. У цьому системному лотку піктограма &karm; розташовується праворуч.

завдання найвищого рівня

  Завдання, у якого немає батьківських завдань.

Загальний час сеансу

  Час, витрачений на задачу і всі її підзадачі з початку сеансу.

Час

  Час, витрачений на задачу, з моменту останнього скидання показань таймерів.

Всього часу

  Час, витрачений на задачу і всі її підзадачі, з моменту останнього скидання показань таймерів.

## Встановлення

### Як отримати &karm;

&install.intro.documentation; &install.compile.documentation;

## Інтерфейс &DCOP;

version

### version

Повертає версію &karm;.

    QString version()

#### Опис

Функція `version()` — це виклик &DCOP;, який повертає номер версії &karm;, наприклад, 1.5.0. Номер версії повертається як рядок у типовому форматі &GNU;, основна.додаткова.виправлення.

quit

### quit

Повертає стан виходу з &karm;.

    QString quit()

#### Опис

`quit()` — це виклик &DCOP;, за допомогою якого зовнішня програма може належним чином завершити роботу &karm;.

hastodo

### hastodo

Перевіряє, чи є на верхньому рівні завдання.

    QString hastodo(QString назва_задачі)

#### Параметри

`назва_задачі`

  Назва завдання, яке слід знайти.

#### Опис

Функція `hastodo(QString назва_завдання)` — це виклик &DCOP;, за якого буде виконано пошук за вказаною назвою. Якщо щось буде знайдено, функція поверне унікальний ідентифікатор (UID) iCalendar UID, за яким можна буде визначити. Якщо нічого не буде знайдено, функція поверне порожній рядок.

Пошук буде виконано у файлі iCalendar, який на поточний момент відкрито у &karm;. Пошук виконуватиметься у всьому дереві завдань, не лише на верхньому рівні завдань. Якщо за вказаною назвою буде знайдено декілька завдань, повернуто буде лише першу знайдену.

addtodo

### addtodo

Додає нове завдання.

    QString addtodo(QString назва_завдання)

#### Параметри

`назва_завдання`

  Назва нового завдання.

#### Опис

Функція `addtodo(QString todoname)` — це виклик &DCOP;, який додає нове завдання найвищого рівня до поточного списку. Функція поверне унікальний ідентифікатор (UID) створеного завдання.

&documentation.index;