<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Doing::WWID
— Documentation by YARD 0.9.27
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Doing::WWID";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (W)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">WWID</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Doing::WWID
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></span>
<ul class="fullTree">
<li><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></li>
<li class="next">Doing::WWID</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/wwid/wwid.rb<span class="defines">,<br />
lib/doing/wwid/tags.rb,<br /> lib/doing/wwid/guess.rb,<br /> lib/doing/wwid/editor.rb,<br /> lib/doing/wwid/filter.rb,<br /> lib/doing/wwid/modify.rb,<br /> lib/doing/wwid/timers.rb,<br /> lib/doing/wwid/display.rb,<br /> lib/doing/wwid/wwidutil.rb,<br /> lib/doing/wwid/filetools.rb,<br /> lib/doing/wwid/interactive.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Main "What Was I Doing" methods</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Color.html#ATTRIBUTES-constant" title="Doing::Color::ATTRIBUTES (constant)">Color::ATTRIBUTES</a></span>, <span class='object_link'><a href="Color.html#ATTRIBUTE_NAMES-constant" title="Doing::Color::ATTRIBUTE_NAMES (constant)">Color::ATTRIBUTE_NAMES</a></span>, <span class='object_link'><a href="Color.html#COLORED_REGEXP-constant" title="Doing::Color::COLORED_REGEXP (constant)">Color::COLORED_REGEXP</a></span></p>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#additional_configs-instance_method" title="#additional_configs (instance method)">#<strong>additional_configs</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Local configuration files detected at initialization.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#config-instance_method" title="#config (instance method)">#<strong>config</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>For backwards compatibility where @wwid.config was accessed instead of Doing.config.settings.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#config_file-instance_method" title="#config_file (instance method)">#<strong>config_file</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>The location of the main config file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#content-instance_method" title="#content (instance method)">#<strong>content</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The Items object into which all entries are read.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#current_section-instance_method" title="#current_section (instance method)">#<strong>current_section</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The Currently section defined in configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_option-instance_method" title="#default_option (instance method)">#<strong>default_option</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>[Boolean] the default option to provide in Y/N dialogs.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#doing_file-instance_method" title="#doing_file (instance method)">#<strong>doing_file</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The location of the Doing file defined in configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initial_content-instance_method" title="#initial_content (instance method)">#<strong>initial_content</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A frozen copy of the content object before any modification.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#act_on-instance_method" title="#act_on (instance method)">#<strong>act_on</strong>(items, opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Perform actions on a set of entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#add_item-instance_method" title="#add_item (instance method)">#<strong>add_item</strong>(title, section = nil, opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Adds an entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#add_with_editor-instance_method" title="#add_with_editor (instance method)">#<strong>add_with_editor</strong>(**options) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#all_tags-instance_method" title="#all_tags (instance method)">#<strong>all_tags</strong>(items, opt: {}, counts: false) ⇒ Hash, Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>List all tags that exist on given items.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#archive-instance_method" title="#archive (instance method)">#<strong>archive</strong>(section = Doing.setting('current_section'), options) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Move entries from a section to Archive or other specified section.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#autotag-instance_method" title="#autotag (instance method)">#<strong>autotag</strong>(string) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Uses 'autotag' configuration to turn keywords into tags for time tracking.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#changes-instance_method" title="#changes (instance method)">#<strong>changes</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return a hash of changes between initial file read and current Items object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#choose_section-instance_method" title="#choose_section (instance method)">#<strong>choose_section</strong>(include_all: false) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Generate a menu of sections and allow user selection.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#choose_section_tag-instance_method" title="#choose_section_tag (instance method)">#<strong>choose_section_tag</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Generate a menu of sections and tags and allow user selection.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#choose_tag-instance_method" title="#choose_tag (instance method)">#<strong>choose_tag</strong>(section = 'All', items: nil, include_all: false) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Generate a menu of tags and allow user selection.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#choose_view-instance_method" title="#choose_view (instance method)">#<strong>choose_view</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Generate a menu of views and allow user selection.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#configure-instance_method" title="#configure (instance method)">#<strong>configure</strong>(filename = nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Load configuration files and updated the @settings attribute with a Doing::Configuration object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(filename = nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new doing file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#dedup-instance_method" title="#dedup (instance method)">#<strong>dedup</strong>(items, no_overlap: false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Remove items from an array that already exist in :content based on start and end times.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_items-instance_method" title="#delete_items (instance method)">#<strong>delete_items</strong>(items, force: false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Delete a set of items from the main index.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#edit_items-instance_method" title="#edit_items (instance method)">#<strong>edit_items</strong>(items) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#edit_last-instance_method" title="#edit_last (instance method)">#<strong>edit_last</strong>(section: 'All', options: {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Edit the last entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#filter_items-instance_method" title="#filter_items (instance method)">#<strong>filter_items</strong>(items = Items.new, opt: {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Filter items based on search criteria.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fork_editor-instance_method" title="#fork_editor (instance method)">#<strong>fork_editor</strong>(input = '', message: :default) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a process for an editor and wait for the file handle to return.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#format_input-instance_method" title="#format_input (instance method)">#<strong>format_input</strong>(input) ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Takes a multi-line string and formats it as an entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fuzzy_filter_items-instance_method" title="#fuzzy_filter_items (instance method)">#<strong>fuzzy_filter_items</strong>(items, query, case_type: :smart) ⇒ Items </a>
</span>
<span class="summary_desc"><div class='inline'><p>Use fzf to filter an Items object with a search query.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_diff-instance_method" title="#get_diff (instance method)">#<strong>get_diff</strong>(filename = nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get difference between current content and last backup.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_interval-instance_method" title="#get_interval (instance method)">#<strong>get_interval</strong>(item, formatted: true, record: true) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gets the interval between entry's start date and @done date.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_view-instance_method" title="#get_view (instance method)">#<strong>get_view</strong>(title, fallback: nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gets a view from configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#guess_section-instance_method" title="#guess_section (instance method)">#<strong>guess_section</strong>(frag, guessed: false, suggest: false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Attempt to match a string with an existing section.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#guess_view-instance_method" title="#guess_view (instance method)">#<strong>guess_view</strong>(frag, guessed: false, suggest: false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Attempt to match a string with an existing view.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#import-instance_method" title="#import (instance method)">#<strong>import</strong>(paths, opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Imports external entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#init_doing_file-instance_method" title="#init_doing_file (instance method)">#<strong>init_doing_file</strong>(path = nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Initializes the doing file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ WWID </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initializes the object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#interactive-instance_method" title="#interactive (instance method)">#<strong>interactive</strong>(opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Display an interactive menu of entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#last-instance_method" title="#last (instance method)">#<strong>last</strong>(times: true, section: nil, options: {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Show the last entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#last_entry-instance_method" title="#last_entry (instance method)">#<strong>last_entry</strong>(opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get the last entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#last_note-instance_method" title="#last_note (instance method)">#<strong>last_note</strong>(section = 'All') ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return the content of the last note for a given section.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#list_date-instance_method" title="#list_date (instance method)">#<strong>list_date</strong>(dates, section, times = nil, output = nil, opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Display entries within a date range.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#list_section-instance_method" title="#list_section (instance method)">#<strong>list_section</strong>(opt, items: Items.new) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Display contents of a section based on options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Logger.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#recent-instance_method" title="#recent (instance method)">#<strong>recent</strong>(count = 10, section = nil, opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Show recent entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#rename_view_keys-instance_method" title="#rename_view_keys (instance method)">#<strong>rename_view_keys</strong>(view) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#repeat_item-instance_method" title="#repeat_item (instance method)">#<strong>repeat_item</strong>(item, opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Duplicate an item and add it as a new item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#repeat_last-instance_method" title="#repeat_last (instance method)">#<strong>repeat_last</strong>(opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Restart the last entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reset_item-instance_method" title="#reset_item (instance method)">#<strong>reset_item</strong>(item, date: nil, finish_date: nil, resume: false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Reset start date to current time, optionally remove done tag (resume).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#rotate-instance_method" title="#rotate (instance method)">#<strong>rotate</strong>(opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Rename doing file with date and start fresh one.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#sections-instance_method" title="#sections (instance method)">#<strong>sections</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>List sections.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stop_start-instance_method" title="#stop_start (instance method)">#<strong>stop_start</strong>(target_tag, opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Accepts one tag and the raw text of a new item if the passed tag is on any item, it's replaced with @done.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tag_groups-instance_method" title="#tag_groups (instance method)">#<strong>tag_groups</strong>(items, opt: {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tag_last-instance_method" title="#tag_last (instance method)">#<strong>tag_last</strong>(opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Tag the last entry or X entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tag_times-instance_method" title="#tag_times (instance method)">#<strong>tag_times</strong>(format: :text, sort_by: :time, sort_order: :asc) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get total elapsed time for all tags in selection.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#today-instance_method" title="#today (instance method)">#<strong>today</strong>(times = true, output = nil, opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Show all entries from the current day.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#verify_duration-instance_method" title="#verify_duration (instance method)">#<strong>verify_duration</strong>(date, finish_date, title: nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Interactively verify an item modification if elapsed time is greater than configured threshold.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#view_to_options-instance_method" title="#view_to_options (instance method)">#<strong>view_to_options</strong>(title) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#views-instance_method" title="#views (instance method)">#<strong>views</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>List available views.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#write-instance_method" title="#write (instance method)">#<strong>write</strong>(file = nil, backup: true) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Write content to file or STDOUT.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#yesterday-instance_method" title="#yesterday (instance method)">#<strong>yesterday</strong>(section, times = nil, output = nil, opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Show entries from the previous day.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Color.html#attributes-instance_method" title="Doing::Color#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Color.html#coloring%3F-class_method" title="Doing::Color.coloring? (method)">coloring?</a></span>, <span class='object_link'><a href="Color.html#support%3F-instance_method" title="Doing::Color#support? (method)">#support?</a></span>, <span class='object_link'><a href="Color.html#template-class_method" title="Doing::Color.template (method)">template</a></span>, <span class='object_link'><a href="Color.html#uncolor-instance_method" title="Doing::Color#uncolor (method)">#uncolor</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Doing::WWID (class)">WWID</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes the object.</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="additional_configs-instance_method">
#<strong>additional_configs</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Local configuration files detected at initialization</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id="config=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="config-instance_method">
#<strong>config</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>For backwards compatibility where @wwid.config was accessed instead of Doing.config.settings</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id="config_file=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="config_file-instance_method">
#<strong>config_file</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>The location of the main config file</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="content-instance_method">
#<strong>content</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The Items object into which all entries are read</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="current_section-instance_method">
#<strong>current_section</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The Currently section defined in configuration</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id="default_option=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="default_option-instance_method">
#<strong>default_option</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>[Boolean] the default option to provide in Y/N dialogs</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="doing_file-instance_method">
#<strong>doing_file</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The location of the Doing file defined in configuration</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="initial_content-instance_method">
#<strong>initial_content</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>A frozen copy of the content object before any modification</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="act_on-instance_method">
#<strong>act_on</strong>(items, opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Perform actions on a set of entries. If
no valid action is included in the opt
hash and the terminal is a TTY, a menu
will be presented</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>items</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>Array of Items to affect</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Options and actions to perform</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opt</tt>):</p>
<ul class="option">
<li>
<span class="name">:editor</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:delete</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:tag</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:flag</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:finish</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:cancel</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:archive</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:output</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:save_to</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:again</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:resume</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="add_item-instance_method">
#<strong>add_item</strong>(title, section = nil, opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Adds an entry</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>title</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The entry title</p>
</div>
</li>
<li>
<span class='name'>section</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The section to add to</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opt</tt>):</p>
<ul class="option">
<li>
<span class="name">:date</span>
<span class="type">(<tt>Date</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>item start date</p>
</div>
</li>
<li>
<span class="name">:note</span>
<span class="type">(<tt><span class='object_link'><a href="Note.html" title="Doing::Note (class)">Note</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>item note (will be converted if value is String)</p>
</div>
</li>
<li>
<span class="name">:back</span>
<span class="type">(<tt>Date</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>backdate</p>
</div>
</li>
<li>
<span class="name">:timed</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>new item is timed entry, marks previous entry as @done</p>
</div>
</li>
<li>
<span class="name">:done</span>
<span class="type">(<tt>Date</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>If set, adds a @done tag to new entry</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="add_with_editor-instance_method">
#<strong>add_with_editor</strong>(**options) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>MissingEditor</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="all_tags-instance_method">
#<strong>all_tags</strong>(items, opt: {}, counts: false) ⇒ <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>, <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>List all tags that exist on given items</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>items</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>array of Item</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>additional options</p>
</div>
</li>
<li>
<span class='name'>counts</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>Include tag counts in
results</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>if counts is true, returns a hash with {
tag: count }.</p>
</div>
</li>
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>If counts is false, returns a simple
array of tags.</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="archive-instance_method">
#<strong>archive</strong>(section = Doing.setting('current_section'), options) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Move entries from a section to Archive or other specified
section</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>section</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>Doing.setting('current_section')</tt>)</em>
—
<div class='inline'><p>The source section</p>
</div>
</li>
<li>
<span class='name'>options</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Options</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="autotag-instance_method">
#<strong>autotag</strong>(string) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Uses 'autotag' configuration to turn keywords into tags for time tracking.
Does not repeat tags in a title, and only converts the first instance of an
untagged keyword</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>string</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The text to tag</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="changes-instance_method">
#<strong>changes</strong> ⇒ <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a hash of changes between initial file read
and current Items object</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Hash containing <code>added</code> and
<code>removed</code> keys with arrays of Item</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="choose_section-instance_method">
#<strong>choose_section</strong>(include_all: false) ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Generate a menu of sections and allow user selection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The selected section name</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="choose_section_tag-instance_method">
#<strong>choose_section_tag</strong> ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Generate a menu of sections and tags and allow user selection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The selected section or tag name</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="choose_tag-instance_method">
#<strong>choose_tag</strong>(section = 'All', items: nil, include_all: false) ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Generate a menu of tags and allow user selection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The selected tag name</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="choose_view-instance_method">
#<strong>choose_view</strong> ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Generate a menu of views and allow user selection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The selected view name</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="configure-instance_method">
#<strong>configure</strong>(filename = nil) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Load configuration files and updated the @settings
attribute with a Doing::Configuration object</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>filename</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>(optional) path to
alternative config file</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="create-instance_method">
#<strong>create</strong>(filename = nil) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new doing file</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="dedup-instance_method">
#<strong>dedup</strong>(items, no_overlap: false) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Remove items from an array that already exist in
:content based on start and end times</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>items</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>The items to
deduplicate</p>
</div>
</li>
<li>
<span class='name'>no_overlap</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>Remove items with
overlapping time spans</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_items-instance_method">
#<strong>delete_items</strong>(items, force: false) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Delete a set of items from the main index</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>items</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>The items to delete</p>
</div>
</li>
<li>
<span class='name'>force</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>Force deletion without confirmation</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="edit_items-instance_method">
#<strong>edit_items</strong>(items) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="edit_last-instance_method">
#<strong>edit_last</strong>(section: 'All', options: {}) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Edit the last entry</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>section</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>'All'</tt>)</em>
—
<div class='inline'><p>The section, default "All"</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>UserCancelled</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="filter_items-instance_method">
#<strong>filter_items</strong>(items = Items.new, opt: {}) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Filter items based on search criteria</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>items</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
<em class="default">(defaults to: <tt>Items.new</tt>)</em>
—
<div class='inline'><p>The items to filter (if empty, filters all items)</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>The filter parameters</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opt:</tt>):</p>
<ul class="option">
<li>
<span class="name">:section</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
— default:
<tt>'all'</tt>
</span>
</li>
<li>
<span class="name">:unfinished</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>false</tt>
</span>
</li>
<li>
<span class="name">:tag</span>
<span class="type">(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span> or <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
— default:
<tt>[]</tt>
</span>
— <div class='inline'><p>Array or comma-separated string</p>
</div>
</li>
<li>
<span class="name">:tag_bool</span>
<span class="type">(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<span class="default">
— default:
<tt>:and</tt>
</span>
— <div class='inline'><p>:and, :or, :not</p>
</div>
</li>
<li>
<span class="name">:search</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
— default:
<tt>''</tt>
</span>
— <div class='inline'><p>string, optional regex with <code>/string/</code></p>
</div>
</li>
<li>
<span class="name">:date_filter</span>
<span class="type">(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'><p>[[Time]start, [Time]end]</p>
</div>
</li>
<li>
<span class="name">:only_timed</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>false</tt>
</span>
</li>
<li>
<span class="name">:before</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'><p>Date/Time string, unparsed</p>
</div>
</li>
<li>
<span class="name">:after</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'><p>Date/Time string, unparsed</p>
</div>
</li>
<li>
<span class="name">:today</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>false</tt>
</span>
— <div class='inline'><p>limit to entries from today</p>
</div>
</li>
<li>
<span class="name">:yesterday</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>false</tt>
</span>
— <div class='inline'><p>limit to entries from yesterday</p>
</div>
</li>
<li>
<span class="name">:count</span>
<span class="type">(<tt>Number</tt>)</span>
<span class="default">
— default:
<tt>0</tt>
</span>
— <div class='inline'><p>max entries to return</p>
</div>
</li>
<li>
<span class="name">:age</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
— default:
<tt>new</tt>
</span>
— <div class='inline'><p>'old' or 'new'</p>
</div>
</li>
<li>
<span class="name">:val</span>
<span class="type">(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'><p>Array of tag value queries</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="fork_editor-instance_method">
#<strong>fork_editor</strong>(input = '', message: :default) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a process for an editor and wait for the file handle to return</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>''</tt>)</em>
—
<div class='inline'><p>Text input for editor</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>MissingEditor</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="format_input-instance_method">
#<strong>format_input</strong>(input) ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Takes a multi-line string and formats it as an entry</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The string to parse</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>[[String]title, [Note]note]</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>EmptyInput</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="fuzzy_filter_items-instance_method">
#<strong>fuzzy_filter_items</strong>(items, query, case_type: :smart) ⇒ <tt><span class='object_link'><a href="Items.html" title="Doing::Items (class)">Items</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Use fzf to filter an Items object with a search query.
Faster than <span class='object_link'><a href="#filter_items-instance_method" title="Doing::WWID#filter_items (method)">#filter_items</a></span> when all you need is a
text search of the title and note</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>items</span>
<span class='type'>(<tt><span class='object_link'><a href="Items.html" title="Doing::Items (class)">Items</a></span></tt>)</span>
—
<div class='inline'><p>an Items object</p>
</div>
</li>
<li>
<span class='name'>query</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The search query</p>
</div>
</li>
<li>
<span class='name'>case_type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:smart</tt>)</em>
—
<div class='inline'><p>The case type (:smart, :sensitive, :ignore)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Items.html" title="Doing::Items (class)">Items</a></span></tt>)</span>
—
<div class='inline'><p>Filtered Items array</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="get_diff-instance_method">
#<strong>get_diff</strong>(filename = nil) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get difference between current content and last backup</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>filename</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The file path</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>DoingRuntimeError</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="get_interval-instance_method">
#<strong>get_interval</strong>(item, formatted: true, record: true) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gets the interval between entry's start
date and @done date</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
—
<div class='inline'><p>The entry</p>
</div>
</li>
<li>
<span class='name'>formatted</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>Return human readable
time (default seconds)</p>
</div>
</li>
<li>
<span class='name'>record</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>Add the interval to the
total for each tag</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Interval in seconds, or [d, h, m] array if
formatted is true. False if no end date or
interval is 0</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="get_view-instance_method">
#<strong>get_view</strong>(title, fallback: nil) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gets a view from configuration</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>title</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The title of the view to retrieve</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="guess_section-instance_method">
#<strong>guess_section</strong>(frag, guessed: false, suggest: false) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Attempt to match a string with an existing section</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>frag</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The user-provided string</p>
</div>
</li>
<li>
<span class='name'>guessed</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>already guessed and failed</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="guess_view-instance_method">
#<strong>guess_view</strong>(frag, guessed: false, suggest: false) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Attempt to match a string with an existing view</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>frag</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The user-provided string</p>
</div>
</li>
<li>
<span class='name'>guessed</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>already guessed</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="import-instance_method">
#<strong>import</strong>(paths, opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Imports external entries</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>paths</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>Path to JSON report file</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="init_doing_file-instance_method">
#<strong>init_doing_file</strong>(path = nil) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes the doing file.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Override path to a doing file, optional</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="interactive-instance_method">
#<strong>interactive</strong>(opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Display an interactive menu of entries</p>
<p>Options hash is shared with #filter_items and #act_on</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional options</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NoResults</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="last-instance_method">
#<strong>last</strong>(times: true, section: nil, options: {}) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Show the last entry</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>times</span>
<span class='type'>(<tt>Bool</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>Show times</p>
</div>
</li>
<li>
<span class='name'>section</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Section to pull from, default Currently</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="last_entry-instance_method">
#<strong>last_entry</strong>(opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the last entry</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="last_note-instance_method">
#<strong>last_note</strong>(section = 'All') ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the content of the last note for a given section</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>section</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>'All'</tt>)</em>
—
<div class='inline'><p>The section to retrieve from, default
All</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NoEntryError</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="list_date-instance_method">
#<strong>list_date</strong>(dates, section, times = nil, output = nil, opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Display entries within a date range</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>dates</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>[start, end]</p>
</div>
</li>
<li>
<span class='name'>section</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The section</p>
</div>
</li>
<li>
<span class='name'>times</span>
<span class='type'>(<tt>Bool</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Show times</p>
</div>
</li>
<li>
<span class='name'>output</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Output format</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="list_section-instance_method">
#<strong>list_section</strong>(opt, items: Items.new) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Display contents of a section based on options</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="logger-instance_method">
#<strong>logger</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Logger</p>
<p>Responds to :debug, :info, :warn, and :error</p>
<p>Each method takes a topic, and a message or block</p>
<p>Example: debug('Hooks', 'Hook 1 triggered')</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="recent-instance_method">
#<strong>recent</strong>(count = 10, section = nil, opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Show recent entries</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>count</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>10</tt>)</em>
—
<div class='inline'><p>The number to show</p>
</div>
</li>
<li>
<span class='name'>section</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The section to show from, default Currently</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="rename_view_keys-instance_method">
#<strong>rename_view_keys</strong>(view) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="repeat_item-instance_method">
#<strong>repeat_item</strong>(item, opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Duplicate an item and add it as a new item</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
—
<div class='inline'><p>the item to duplicate</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>additional options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opt</tt>):</p>
<ul class="option">
<li>
<span class="name">:editor</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>open new item in editor</p>
</div>
</li>
<li>
<span class="name">:date</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>set start date</p>
</div>
</li>
<li>
<span class="name">:in</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>add new item to section :in</p>
</div>
</li>
<li>
<span class="name">:note</span>
<span class="type">(<tt><span class='object_link'><a href="Note.html" title="Doing::Note (class)">Note</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>add note to new item</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>nothing</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="repeat_last-instance_method">
#<strong>repeat_last</strong>(opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Restart the last entry</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="reset_item-instance_method">
#<strong>reset_item</strong>(item, date: nil, finish_date: nil, resume: false) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Reset start date to current time, optionally remove
done tag (resume)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
—
<div class='inline'><p>the item to reset/resume</p>
</div>
</li>
<li>
<span class='name'>resume</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>removing @done tag if true</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="rotate-instance_method">
#<strong>rotate</strong>(opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Rename doing file with date and start fresh one</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="sections-instance_method">
#<strong>sections</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>List sections</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>section titles</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="stop_start-instance_method">
#<strong>stop_start</strong>(target_tag, opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Accepts one tag and the raw text of a new item if the
passed tag is on any item, it's replaced with @done.
if new_item is not nil, it's tagged with the passed
tag and inserted. This is for use where only one
instance of a given tag should exist (@meanwhile)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>target_tag</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>Tag to replace</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opt</tt>):</p>
<ul class="option">
<li>
<span class="name">:section</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>target section</p>
</div>
</li>
<li>
<span class="name">:archive</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>archive old item</p>
</div>
</li>
<li>
<span class="name">:back</span>
<span class="type">(<tt>Date</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>backdate new item</p>
</div>
</li>
<li>
<span class="name">:new_item</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>content to use for new item</p>
</div>
</li>
<li>
<span class="name">:note</span>
<span class="type">(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>note content for new item</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tag_groups-instance_method">
#<strong>tag_groups</strong>(items, opt: {}) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="tag_last-instance_method">
#<strong>tag_last</strong>(opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Tag the last entry or X entries</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options (see</p>
<h1 id="filter_items-for-filtering">filter_items for filtering</h1>
<p>options)</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NoResults</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#filter_items-instance_method" title="Doing::WWID#filter_items (method)">#filter_items</a></span></li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tag_times-instance_method">
#<strong>tag_times</strong>(format: :text, sort_by: :time, sort_order: :asc) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get total elapsed time for all tags in
selection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>format</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:text</tt>)</em>
—
<div class='inline'><p>return format (html,
json, or text)</p>
</div>
</li>
<li>
<span class='name'>sort_by</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:time</tt>)</em>
—
<div class='inline'><p>Sort by :name or :time</p>
</div>
</li>
<li>
<span class='name'>sort_order</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:asc</tt>)</em>
—
<div class='inline'><p>The sort order (:asc or :desc)</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="today-instance_method">
#<strong>today</strong>(times = true, output = nil, opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Show all entries from the current day</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>times</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>show times</p>
</div>
</li>
<li>
<span class='name'>output</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>output format</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Options</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="verify_duration-instance_method">
#<strong>verify_duration</strong>(date, finish_date, title: nil) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Interactively verify an item modification if elapsed time is greater than configured threshold</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>date</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>Item date</p>
</div>
</li>
<li>
<span class='name'>finish_date</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The finish date</p>
</div>
</li>
<li>
<span class='name'>title</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The Item title</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="view_to_options-instance_method">
#<strong>view_to_options</strong>(title) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="views-instance_method">
#<strong>views</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>List available views</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>View names</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="write-instance_method">
#<strong>write</strong>(file = nil, backup: true) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Write content to file or STDOUT</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>file</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The filepath to write to</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="yesterday-instance_method">
#<strong>yesterday</strong>(section, times = nil, output = nil, opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Show entries from the previous day</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>section</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The section</p>
</div>
</li>
<li>
<span class='name'>times</span>
<span class='type'>(<tt>Bool</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Show times</p>
</div>
</li>
<li>
<span class='name'>output</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Output format</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>Additional Options</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Mar 21 07:53:15 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-3.0.1).
</div>
</div>
</body>
</html>