File: docs.html

package info (click to toggle)
puddletag 2.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 29,888 kB
  • sloc: python: 24,938; javascript: 21,828; xml: 964; makefile: 129; sh: 85
file content (148 lines) | stat: -rw-r--r-- 7,229 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>puddletag Documentation &#8212; puddletag</title>
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>

  </head><body>

  <div id="navbar" class="navbar navbar-default navbar-fixed-top">
    <div class="container">
      <div class="navbar-header">
        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html">puddletag</a>
      </div>

        <div class="collapse navbar-collapse nav-collapse">
          <ul class="nav navbar-nav">
            <li class="divider-vertical"></li>
            
                <li><a href="index.html">Home</a></li>
                <li><a href="download.html">Download</a></li>
                <li><a href="news.html">News</a></li>
                <li><a href="#">Documentation</a></li>
                <li><a href="https://github.com/puddletag/puddletag/issues">Issue Tracker</a></li>
                <li><a href="screenshots.html">Screenshots</a></li>
                <li><a href="about.html">About</a></li>
            
            
              
              
            
            
            
            
            
          </ul>

          
            
<form class="navbar-form navbar-right" action="search.html" method="get">
 <div class="form-group">
  <input type="text" name="q" class="form-control" placeholder="Search" />
 </div>
  <input type="hidden" name="check_keywords" value="yes" />
  <input type="hidden" name="area" value="default" />
</form>
          
        </div>
    </div>
  </div>

<div class="container">
  <div class="row">
    <div class="body col-md-12 content" role="main">
      
  <div class="section" id="puddletag-documentation">
<h1>puddletag Documentation<a class="headerlink" href="#puddletag-documentation" title="Permalink to this headline">¶</a></h1>
<p><strong>Download these docs:</strong> <a class="reference external" href="https://github.com/puddletag/puddletag/releases/download/2.0.1/puddletag-docs-html-2.0.1.tar.bz2">HTML</a> | <a class="reference external" href="https://github.com/puddletag/puddletag/releases/download/2.0.1/puddletag-docs-rst-2.0.1.tar.bz2">ReStructuredText</a></p>
<p>First I have to introduce you to the naming conventions used by puddletag (some copied from Mp3tag).</p>
<p>Say you have a MP3 file with full path /mnt/music/Miley - Cyrus/USA Party.mp3</p>
<ul class="simple">
<li><p>The container used to store metadata will be referred to as the tag. In this case it’s like an ID3 tag. All containers are referred to as tags. So when I say tag think complete as APEv2 tag, ID3 (ID3v2, ID3v1) tag, etc.</p></li>
<li><p>Fields are what the different attributes of the file are called. Eg. <strong>artist, title</strong> or <strong>album</strong>.</p></li>
<li><p>Values associated with fields are referred to as…’values’ (like ‘Miley Cyrus’ or ‘USA Party’ ). If there’s more than one value associated with a field (eg. two genres) it’ll referred to as a multiple-valued field.</p></li>
<li><p>Sometimes I use <strong>tag</strong> to refer to the all the fields + values contained in a file.</p></li>
</ul>
</div>
<div class="section" id="tutorials">
<h1>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="source/tut1.html">Tutorial 1</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/tut2.html">Tutorial 2</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/tut3.html">Things you should know (like how to add album art)</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/tut4.html">Tag Sources Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/tut5.html">Masstagging Tutorial</a></li>
</ul>
</div>
</div>
<div class="section" id="reference">
<h1>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="source/menus.html">Menus</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/function.html">Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/scripting.html">Scripting Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/filter.html">Filter Expressions</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/tagsources.html">Tag Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/preferences.html">Preferences</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/id3.html">ID3 Frames</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/tags.html">Tag Reference</a></li>
</ul>
</div>
</div>
<div class="section" id="development">
<h1>Development<a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="source/plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/translate.html">Translating</a></li>
</ul>
</div>
</div>


    </div>
      
  </div>
</div>
<footer class="footer">
  <div class="container">
    <p class="pull-right">
      <a href="#">Back to top</a>
      
    </p>
    <p>
      This page and associated images are licensed under <a rel="license" href="http://www.apache.org/licenses/LICENSE-2.0">Apache Version 2.0</a>
	Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 3.4.3.<br/>
    </p>
  </div>
</footer>
  </body>
</html>