<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::ItemTags
— Documentation by YARD 0.9.34
</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::ItemTags";
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 (I)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">ItemTags</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>Module: Doing::ItemTags
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/item/tags.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A Doing entry</p>
</div>
</div>
<div class="tags">
</div>
<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="#tag-instance_method" title="#tag (instance method)">#<strong>tag</strong>(tags, **options) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Add (or remove) tags from the title of the item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tag_array-instance_method" title="#tag_array (instance method)">#<strong>tag_array</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>convert tags on item to an array with @ symbols removed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tags-instance_method" title="#tags (instance method)">#<strong>tags</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get a list of tags on the item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tags_with_values-instance_method" title="#tags_with_values (instance method)">#<strong>tags_with_values</strong> ⇒ Array<Array> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return all tags including parenthetical values.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="tag-instance_method">
#<strong>tag</strong>(tags, **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>Add (or remove) tags from the title of the item</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>tags</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 tags to apply</p>
</div>
</li>
<li>
<span class='name'>options</span>
<span class='type'></span>
—
<div class='inline'><p>Additional options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>**options</tt>):</p>
<ul class="option">
<li>
<span class="name">:date</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>Include timestamp?</p>
</div>
</li>
<li>
<span class="name">:single</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>Log as a single change?</p>
</div>
</li>
<li>
<span class="name">:value</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>A value to include as @tag(value)</p>
</div>
</li>
<li>
<span class="name">:remove</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>if true remove instead of adding</p>
</div>
</li>
<li>
<span class="name">:rename_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>
— <div class='inline'><p>if not nil, rename target tag to this tag name</p>
</div>
</li>
<li>
<span class="name">:regex</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>treat target tag string as regex pattern</p>
</div>
</li>
<li>
<span class="name">:force</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>with rename_to, add tag if it doesn't exist</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tag_array-instance_method">
#<strong>tag_array</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>convert tags on item to an array with @ symbols removed</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>array of tags</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tags-instance_method">
#<strong>tags</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>Get a list of tags on the item</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>array of tags (no values)</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tags_with_values-instance_method">
#<strong>tags_with_values</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span><<span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return all tags including parenthetical values</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><<span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>></tt>)</span>
—
<div class='inline'><p>Array of array pairs,
[[tag1, value], [tag2, value]]</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Aug 17 09:53:01 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
</div>
</div>
</body>
</html>