File: preferences.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 (265 lines) | stat: -rw-r--r-- 16,656 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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265

<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Preferences &#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="../docs.html">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="col-md-3">
        <div id="sidebar" class="bs-sidenav" role="complementary"><ul>
<li><a class="reference internal" href="#">Preferences</a><ul>
<li><a class="reference internal" href="#general">General</a></li>
<li><a class="reference internal" href="#confirmations">Confirmations</a></li>
<li><a class="reference internal" href="#mappings">Mappings</a></li>
<li><a class="reference internal" href="#playlist">Playlist</a></li>
<li><a class="reference internal" href="#colours">Colours</a></li>
<li><a class="reference internal" href="#genres">Genres</a></li>
<li><a class="reference internal" href="#tags">Tags</a></li>
<li><a class="reference internal" href="#plugins">Plugins</a></li>
<li><a class="reference internal" href="#shortcuts">Shortcuts</a></li>
<li><a class="reference internal" href="#tag-panel">Tag Panel</a></li>
<li><a class="reference internal" href="#tag-sources">Tag Sources</a></li>
<li><a class="reference internal" href="#patterns">Patterns</a></li>
<li><a class="reference internal" href="#columns">Columns</a></li>
</ul>
</li>
</ul>


<hr style='width:80%'>


        </div>
      </div>
    <div class="body col-md-9 content" role="main">
      
  <div class="section" id="preferences">
<h1>Preferences<a class="headerlink" href="#preferences" title="Permalink to this headline">¶</a></h1>
<div class="section" id="general">
<h2>General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h2>
<div class="section" id="load-last-folder-at-startup">
<h3>Load last folder at startup<a class="headerlink" href="#load-last-folder-at-startup" title="Permalink to this headline">¶</a></h3>
<p>If checked, the last folder that was loaded upon closing puddletag will be re-opened when puddletag is started.</p>
</div>
<div class="section" id="subfolders">
<span id="id1"></span><h3>Subfolders<a class="headerlink" href="#subfolders" title="Permalink to this headline">¶</a></h3>
<p>If checked, Subfolders of directories selected for import will be checked for supported files (which’ll then be loaded). Otherwise, just files residing in the selected directories will be loaded.</p>
</div>
<div class="section" id="show-gridlines">
<h3>Show gridlines<a class="headerlink" href="#show-gridlines" title="Permalink to this headline">¶</a></h3>
<p>Shows/Hides the gridlines in the file view depending on whether it checked/unchecked.</p>
</div>
<div class="section" id="show-tooltips-in-file-view">
<h3>Show tooltips in file-view.<a class="headerlink" href="#show-tooltips-in-file-view" title="Permalink to this headline">¶</a></h3>
<p>By default tooltips will be shown in the file view showing the value of a cell on which the mouse is hovered. When in Preview Mode the tooltip will show both the Preview and value as stored in the file. Uncheck this box to disable it.</p>
</div>
<div class="section" id="show-row-numbers">
<h3>Show row numbers.<a class="headerlink" href="#show-row-numbers" title="Permalink to this headline">¶</a></h3>
<p>Check to show row numbers in the file view.</p>
</div>
<div class="section" id="automatically-resize-columns-to-contents">
<h3>Automatically resize columns to contents<a class="headerlink" href="#automatically-resize-columns-to-contents" title="Permalink to this headline">¶</a></h3>
<p>If checked, the columns will be resized to the so that all text is visible upon loading folders. They will not be resize during editing.</p>
</div>
<div class="section" id="program-to-play-files-with">
<h3>Program to play files with:<a class="headerlink" href="#program-to-play-files-with" title="Permalink to this headline">¶</a></h3>
<p>Enter the command of the program puddletag should use to play files with. The list of selected files will be appended to the argument list.</p>
</div>
<div class="section" id="edit-sort-options">
<span id="sort-option-prefs"></span><h3>Edit sort options<a class="headerlink" href="#edit-sort-options" title="Permalink to this headline">¶</a></h3>
<p>With Sort Options you can sort the file-view using a list of predefined fields. The window brough up by clicking this button is pretty self explanatory. Any field-lists you add will create a menu item in the <strong>Tools-&gt;Sort By</strong> menu.</p>
<p>Provided a single file (or none at all) is selected, clicking on a menu item will sort the file-view in order of the fields defined. So <strong>track/__dirpath/album</strong> will sort the file-view by track first, then __dirpath then album. It’s equivalent to clicking the relevant headers in order in the file-view.</p>
<p>Click on it again and the sort order will be reversed like <strong>album/__dirpath/track</strong>.</p>
<p>This sort order will be used when loading dirs unless changed (by clicking a header or using another Sort Option.) It is saved across sessions.</p>
<p>If you have more than one file selected, <strong>only</strong> the selected files will be sorted using those fields. All other files will remain as is.</p>
</div>
</div>
<div class="section" id="confirmations">
<h2>Confirmations<a class="headerlink" href="#confirmations" title="Permalink to this headline">¶</a></h2>
<p>Confirmations let you know that you’re about to do something that can’t be reversed. Turn off the ones that you find grating.</p>
</div>
<div class="section" id="mappings">
<h2>Mappings<a class="headerlink" href="#mappings" title="Permalink to this headline">¶</a></h2>
<p>With mappings you can ‘rename’ puddletag fields.</p>
<p>For instance if you want the <strong>performer</strong> to be shown as <strong>albumartist</strong> for ID3 files. You’d set up a mapping with <strong>ID3</strong> as the Tag, performer as the <strong>Original Field</strong> and albumartist as the <strong>Target</strong>.</p>
<p>Now any files that contained the <strong>performer</strong> field before the mapping will instead show it as <strong>albumartist</strong>.</p>
<p>The mapping doesn’t work in reverse, <strong>albumartist</strong> won’t be show as <strong>performer</strong>. You’ll need to set up another mapping for that.</p>
<ul class="simple">
<li><p>Tag can be one one of ID3, MP4, APEv2 (for Musepack, WavPack, etc.) or VorbisComment (for FLAC and Ogg Vorbis). Note that these are <strong>case-sensitive</strong>.</p></li>
<li><p>You can also set mappings for Tag Sources using the <strong>exact</strong> Tag Source’s name. eg. <strong>MusicBrainz</strong>.</p></li>
<li><p><strong>Mapping default fields like “__filename, __dirpath, __image, etc”. will cause undesired behaviour.</strong></p></li>
</ul>
</div>
<div class="section" id="playlist">
<span id="id2"></span><h2>Playlist<a class="headerlink" href="#playlist" title="Permalink to this headline">¶</a></h2>
<div class="section" id="write-extended-info">
<h3>Write extended info:<a class="headerlink" href="#write-extended-info" title="Permalink to this headline">¶</a></h3>
<p>When enabled the pattern you will be used to write extended info for M3U playlists.</p>
</div>
<div class="section" id="filename-pattern">
<h3>Filename pattern:<a class="headerlink" href="#filename-pattern" title="Permalink to this headline">¶</a></h3>
<p>Then default filename pattern to use when saving playlists.</p>
</div>
</div>
<div class="section" id="colours">
<h2>Colours<a class="headerlink" href="#colours" title="Permalink to this headline">¶</a></h2>
<p>Defines the background colours to used in various puddletag dialogs. Use it when needed (you’ll need to if you’re using a dark theme).</p>
</div>
<div class="section" id="genres">
<h2>Genres<a class="headerlink" href="#genres" title="Permalink to this headline">¶</a></h2>
<p>The list of genres as used in the Tag Panel.  Edit to your hearts content. If you want to reset it to the default values remove <strong>~/.puddletag/genres</strong>.</p>
</div>
<div class="section" id="tags">
<h2>Tags<a class="headerlink" href="#tags" title="Permalink to this headline">¶</a></h2>
<div class="section" id="restrict-incoming-files-to-eg-mp3-ogg-aac">
<h3>Restrict incoming files to (eg. “*.mp3; *.ogg; *.aac”)<a class="headerlink" href="#restrict-incoming-files-to-eg-mp3-ogg-aac" title="Permalink to this headline">¶</a></h3>
<p>Enter a “;”-separated list of texts to restrict the filenames puddletag loads to. “*.mp3; *.ogg; *.aac” will only load filenames beginning ending with ‘.ogg’, ‘.mp3’ or ‘.aac’. By default puddletag checks every file for a valid tag.</p>
</div>
<div class="section" id="id3">
<h3>ID3<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<p>puddletag supports writing UTF8-encoded ID3v2.4 and ID3v2.3 with the option of including ID3v1.1. Choose whichever option you want to use.</p>
</div>
</div>
<div class="section" id="plugins">
<h2>Plugins<a class="headerlink" href="#plugins" title="Permalink to this headline">¶</a></h2>
<p>Plugins are a means with which to extend puddletag. If you want to install one drop it into “~/.puddletag/plugins”. Enable it, then restart.</p>
<p><strong>Plugins are executable code akin to installing a program on you PC. Do not use any that aren’t from trustworthy sources.</strong></p>
</div>
<div class="section" id="shortcuts">
<h2>Shortcuts<a class="headerlink" href="#shortcuts" title="Permalink to this headline">¶</a></h2>
<p>With this panel you can edit the keyboard shortcuts of any menu item in puddletag. Just double-click on the desired shortcut in the shortcut column and enter the desired shortcut.</p>
</div>
<div class="section" id="tag-panel">
<span id="tag-panel-prefs"></span><h2>Tag Panel<a class="headerlink" href="#tag-panel" title="Permalink to this headline">¶</a></h2>
<p>This is where you can edit Tag Panel settings. puddletag will show the <strong>Title</strong> above a combo box that’ll be populated using the field you specify in the <strong>Field</strong> column.</p>
<p>Use &amp; in your Title to create an accelerator eg. ‘&amp;Artist’ will allow you to set focus to the relevant combo box by pressing ‘Alt+A’</p>
<p>Row refers to the row number in which to show the field. If more than one row contains the same number, the fields will be listed on one row.</p>
</div>
<div class="section" id="tag-sources">
<h2>Tag Sources<a class="headerlink" href="#tag-sources" title="Permalink to this headline">¶</a></h2>
<div class="section" id="display-format-for-individual-tracks">
<h3>Display format for individual tracks:<a class="headerlink" href="#display-format-for-individual-tracks" title="Permalink to this headline">¶</a></h3>
<p>Enter a pattern to be used to display the metadata for individual tracks in the Tag Sources dialog’s album list.</p>
</div>
<div class="section" id="display-format-for-retrieved-albums">
<h3>Display format for retrieved albums:<a class="headerlink" href="#display-format-for-retrieved-albums" title="Permalink to this headline">¶</a></h3>
<p>As above but for the album. You can use the field <strong>%__numtracks%</strong> to get the number of tracks in an album.</p>
</div>
<div class="section" id="sort-retrieved-albums-using-order">
<h3>Sort retrieved albums using order<a class="headerlink" href="#sort-retrieved-albums-using-order" title="Permalink to this headline">¶</a></h3>
<p>Will sort the retrieved album by the order listed. Use the dialog brought up by clicking ‘Edit’ to bring up an editor for the sort options. You can change the order dynamically by right clicking on the header of the Tag Sources dialog’s album list and choosing from the sort options you defined.</p>
</div>
<div class="section" id="user-agent">
<h3>User-Agent:<a class="headerlink" href="#user-agent" title="Permalink to this headline">¶</a></h3>
<p>If you use a Tag Sources to scrape a website, using anything other than the default User-Agent is a good idea.</p>
</div>
<div class="section" id="automatic-retrieval-options">
<span id="auto-retrieval-prefs"></span><h3>Automatic Retrieval options<a class="headerlink" href="#automatic-retrieval-options" title="Permalink to this headline">¶</a></h3>
<p>If automatic retrieval of albums is enabled in the Tag Sources dialog, then the options you specify here will be used to determine which album best matches. Options are as used in <a class="reference internal" href="tut5.html#tag-source-auto-options"><span class="std std-ref">Masstagging</span></a>.</p>
</div>
</div>
<div class="section" id="patterns">
<h2>Patterns<a class="headerlink" href="#patterns" title="Permalink to this headline">¶</a></h2>
<p>Modify the patterns listed in the pattern combo here.</p>
</div>
<div class="section" id="columns">
<h2>Columns<a class="headerlink" href="#columns" title="Permalink to this headline">¶</a></h2>
<p>In this panel you can modify the columns listed in the file-view.</p>
<ul class="simple">
<li><p>Any unchecked columns will not be shown.</p></li>
<li><p><strong>Title</strong> is the title that’ll be displayed on the file-view’s header.</p></li>
<li><p>Data will be retrieved from the <strong>Field</strong> you specify.</p></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>