Skip to content

Commit

Permalink
Update documentation regarding tags
Browse files Browse the repository at this point in the history
  • Loading branch information
jwjacobson committed Sep 16, 2024
1 parent 9379f33 commit dc49dfa
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 11 deletions.
8 changes: 6 additions & 2 deletions _sources/about/fields.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ I index all composers by last name as a way of showing equal respect to jazz and

Key
-----
Key can be left blank, or you can fill it with 'none' or 'atonal'. There can only be one Key; in tonal tunes without an obvious "main" key I leave this blank and put all the keys in Other Keys. A '-' after the letter denotes minor; unadorned is major.
There can only be one Key; in tonal tunes without an obvious "main" key I leave this blank and put all the keys in Other Keys. A '-' after the letter denotes minor; unadorned is major. Key can be left blank, or you can fill it with 'none' or 'atonal'.

Other Keys
-----------
Expand All @@ -26,7 +26,7 @@ I've opted not to include primes etc. to make the form categories as broadly app

Style
------
'Standard' is for pop or Broadway tunes played by jazz musicians, while 'jazz' is for tunes written by jazz musicians. Other stylistic descriptors can be added as tags (eventually).
'Standard' is for pop or Broadway tunes played by jazz musicians, while 'jazz' is for tunes written by jazz musicians. Other stylistic descriptors can be added as tags.

Meter
------
Expand All @@ -36,6 +36,10 @@ Year
-----
For a lot of the jazz tunes the year is when the first album featuring the tune came out. Let me know if you have more accurate knowledge!

Tags
-----
These are extra descriptive qualifiers of a tune. None are assigned by default. Currently only tags I've defined are available; contact me if there's any you'd like to see!

Last Played
------------
The date you last played a tune. I try to keep as many out of the "haven't played in 3 months" category as I can.
Expand Down
2 changes: 1 addition & 1 deletion _sources/about/future.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are two major features still to be implemented:
Custom tags
------------

The user can add any tag to they want to any tune, e.g. "ballad".
Tags now exist, but the user can only choose among predefined tags. They should be able to create their own.

Tune analytics
---------------
Expand Down
2 changes: 1 addition & 1 deletion _sources/using/adding.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ To create a tune, click the **create** button on the navbar. The only required f

Taking tunes
-------------
The public repertoire contains 200 common tunes. Access it by clicking the **public** button on the navbar.
The public repertoire contains approximately 200 common tunes. Access it by clicking the **public** button on the navbar.
To add a tune, click the **take** button. the tune will immediately enter your repertoire, and you will have the option of setting when you last played the tune and your knowledge of it.
2 changes: 1 addition & 1 deletion _sources/using/searching.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ Jazz composer names have built-in substitutions using their nicknames or first n

Use a ``-`` before a term to exclude it from the search results.

You can also use the format ``field:term`` to search a specific field. Currently supported fields are **title**, **composer**, **key** (the key column, a tune's main key), **keys** (both the Key and Other Keys columns), **form**, **style**, **meter**, and **year**. It is most useful for key, keys, meter, and form.
You can also use the format ``field:term`` to search a specific field. Currently supported fields are **title**, **composer**, **key** (the key column, a tune's main key), **keys** (both the Key and Other Keys columns), **form**, **style**, **meter**, **year**, and **tags**. It is most useful for key, keys, meter, and form.

The **haven't played in** dropdown lets you filter by how long it's been since you've played a tune. This allows you to easily target tunes at the highest risk of being forgotten.
8 changes: 6 additions & 2 deletions about/fields.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ <h2>Composer<a class="headerlink" href="#composer" title="Link to this heading">
</section>
<section id="key">
<h2>Key<a class="headerlink" href="#key" title="Link to this heading"></a></h2>
<p>Key can be left blank, or you can fill it with ‘none’ or ‘atonal’. There can only be one Key; in tonal tunes without an obvious “main” key I leave this blank and put all the keys in Other Keys. A ‘-’ after the letter denotes minor; unadorned is major.</p>
<p>There can only be one Key; in tonal tunes without an obvious “main” key I leave this blank and put all the keys in Other Keys. A ‘-’ after the letter denotes minor; unadorned is major. Key can be left blank, or you can fill it with ‘none’ or ‘atonal’.</p>
</section>
<section id="other-keys">
<h2>Other Keys<a class="headerlink" href="#other-keys" title="Link to this heading"></a></h2>
Expand All @@ -66,7 +66,7 @@ <h2>Form<a class="headerlink" href="#form" title="Link to this heading">¶</a></
</section>
<section id="style">
<h2>Style<a class="headerlink" href="#style" title="Link to this heading"></a></h2>
<p>‘Standard’ is for pop or Broadway tunes played by jazz musicians, while ‘jazz’ is for tunes written by jazz musicians. Other stylistic descriptors can be added as tags (eventually).</p>
<p>‘Standard’ is for pop or Broadway tunes played by jazz musicians, while ‘jazz’ is for tunes written by jazz musicians. Other stylistic descriptors can be added as tags.</p>
</section>
<section id="meter">
<h2>Meter<a class="headerlink" href="#meter" title="Link to this heading"></a></h2>
Expand All @@ -76,6 +76,10 @@ <h2>Meter<a class="headerlink" href="#meter" title="Link to this heading">¶</a>
<h2>Year<a class="headerlink" href="#year" title="Link to this heading"></a></h2>
<p>For a lot of the jazz tunes the year is when the first album featuring the tune came out. Let me know if you have more accurate knowledge!</p>
</section>
<section id="tags">
<h2>Tags<a class="headerlink" href="#tags" title="Link to this heading"></a></h2>
<p>These are extra descriptive qualifiers of a tune. None are assigned by default. Currently only tags I’ve defined are available; contact me if there’s any you’d like to see!</p>
</section>
<section id="last-played">
<h2>Last Played<a class="headerlink" href="#last-played" title="Link to this heading"></a></h2>
<p>The date you last played a tune. I try to keep as many out of the “haven’t played in 3 months” category as I can.</p>
Expand Down
2 changes: 1 addition & 1 deletion about/future.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ <h1>Planned features<a class="headerlink" href="#planned-features" title="Link t
<p>There are two major features still to be implemented:</p>
<section id="custom-tags">
<h2>Custom tags<a class="headerlink" href="#custom-tags" title="Link to this heading"></a></h2>
<p>The user can add any tag to they want to any tune, e.g. “ballad”.</p>
<p>Tags now exist, but the user can only choose among predefined tags. They should be able to create their own.</p>
</section>
<section id="tune-analytics">
<h2>Tune analytics<a class="headerlink" href="#tune-analytics" title="Link to this heading"></a></h2>
Expand Down
1 change: 1 addition & 0 deletions about/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ <h1>About jazztunes<a class="headerlink" href="#about-jazztunes" title="Link to
<li class="toctree-l2"><a class="reference internal" href="fields.html#style">Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="fields.html#meter">Meter</a></li>
<li class="toctree-l2"><a class="reference internal" href="fields.html#year">Year</a></li>
<li class="toctree-l2"><a class="reference internal" href="fields.html#tags">Tags</a></li>
<li class="toctree-l2"><a class="reference internal" href="fields.html#last-played">Last Played</a></li>
<li class="toctree-l2"><a class="reference internal" href="fields.html#knowledge">Knowledge</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion using/adding.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h2>Creating tunes manually<a class="headerlink" href="#creating-tunes-manually"
</section>
<section id="taking-tunes">
<h2>Taking tunes<a class="headerlink" href="#taking-tunes" title="Link to this heading"></a></h2>
<p>The public repertoire contains 200 common tunes. Access it by clicking the <strong>public</strong> button on the navbar.
<p>The public repertoire contains approximately 200 common tunes. Access it by clicking the <strong>public</strong> button on the navbar.
To add a tune, click the <strong>take</strong> button. the tune will immediately enter your repertoire, and you will have the option of setting when you last played the tune and your knowledge of it.</p>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion using/searching.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h3>Navigation</h3>
<p>By default, every field is searched for your search term. If you enter multiple terms, the search uses AND logic. For example, if you search <code class="docutils literal notranslate"><span class="pre">monk</span></code> you will see all tunes with monk in any fields (usually composer). If you search <code class="docutils literal notranslate"><span class="pre">monk</span> <span class="pre">bud</span></code>, you will only see “In Walked Bud” (assuming it’s in your repertoire).</p>
<p>Jazz composer names have built-in substitutions using their nicknames or first names, so searching <code class="docutils literal notranslate"><span class="pre">miles</span></code> will return Miles Davis tunes, <code class="docutils literal notranslate"><span class="pre">bird</span></code> will return Charlie Parker tunes, etc.</p>
<p>Use a <code class="docutils literal notranslate"><span class="pre">-</span></code> before a term to exclude it from the search results.</p>
<p>You can also use the format <code class="docutils literal notranslate"><span class="pre">field:term</span></code> to search a specific field. Currently supported fields are <strong>title</strong>, <strong>composer</strong>, <strong>key</strong> (the key column, a tune’s main key), <strong>keys</strong> (both the Key and Other Keys columns), <strong>form</strong>, <strong>style</strong>, <strong>meter</strong>, and <strong>year</strong>. It is most useful for key, keys, meter, and form.</p>
<p>You can also use the format <code class="docutils literal notranslate"><span class="pre">field:term</span></code> to search a specific field. Currently supported fields are <strong>title</strong>, <strong>composer</strong>, <strong>key</strong> (the key column, a tune’s main key), <strong>keys</strong> (both the Key and Other Keys columns), <strong>form</strong>, <strong>style</strong>, <strong>meter</strong>, <strong>year</strong>, and <strong>tags</strong>. It is most useful for key, keys, meter, and form.</p>
<p>The <strong>haven’t played in</strong> dropdown lets you filter by how long it’s been since you’ve played a tune. This allows you to easily target tunes at the highest risk of being forgotten.</p>
</section>

Expand Down

0 comments on commit dc49dfa

Please sign in to comment.