File: 030_users_guide.html

package info (click to toggle)
mp3diags 1.5.01-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 21,124 kB
  • sloc: cpp: 34,487; sh: 319; makefile: 101; xml: 97; python: 14
file content (170 lines) | stat: -rw-r--r-- 8,802 bytes parent folder | download
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="keywords" content="MP3, diags, diagnosis, tag editor, tagger, normalizer" />
<meta name="description" content="End-user documentation for MP3 Diags, an MP3 analysis tool that also includes correction and tag editing functionality" />
<title>MP3 Diags - User's guide</title>
<link rel="stylesheet" type="text/css" media="screen" href="style.css" />
<!--[if lte IE 6]>  <link rel="stylesheet" type="text/css" href="style_ie6.css" />  <![endif]-->
<!--[if IE 7]>  <link rel="stylesheet" type="text/css" href="style_ie7.css" />  <![endif]-->
</head>

<link rel="icon" href="favicon.ico" type="image/x-icon" />
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon" />

<body>

<!-- add_this_conf -->

<div class="HeaderTableText RegFnt ChpCol1">
<table width="100%" class="HeaderTable">
    <tr>
        <td border="0" class="HeaderText">
            <span class="HeaderPadLeft">
                <a href="index.html" class="RightMargin"><img src="logo.png" border="0" alt="MP3 Diags" align="middle" /></a>
                <!-- add_this_link -->
            </span>
        </td>

        <!-- sf_hosting -->
    </tr>
</table>
</div>


<!-- ========================================================================================================== -->
<!-- ========================================================================================================== -->
<!-- ========================================================================================================== -->
<!-- ========================================================================================================== -->




<div class="NavPadTable RegFnt ChpCol2">
<div style="width:100%">
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="NavTable">
    <tr>
        <td width="30%" align="left"> <a href="020_mp3_introduction.html"><img src="arrow_left_small.png" class="ImgNoBorder NavPadLeft" align="absmiddle" /></a> <a href="020_mp3_introduction.html"> Short MP3 introduction </a> </td>
        <td width="40%" align="center" valign="middle" class="NavBarText"> User's guide </td>
        <td width="30%" align="right"> <a href="035_suggested_usage.html">Suggested usage</a> <a href="035_suggested_usage.html"> <img src="arrow_right_small.png" class="ImgNoBorder NavPadRight" align="absmiddle" /> </a> </td>
    </tr>
</table>
</div>
</div>


<div class="SubChapterText RegFnt ChpCol1">
Notes about the documentation
</div>


<div class="NormalText RegFnt ChpCol1">
There are enough features and options that more than 100 printed pages would be needed to describe them all in detail. Currently I have no plans to document everything, but I hope that the interface is intuitive enough to allow most users to easily figure out what can be done and how to do it, especially if they read the limited documentation that is available. However, if I receive questions about how to do one thing or another, it's quite likely that I'll add the answer to the appropriate place in the documentation.
</div>


<div class="NormalText RegFnt ChpCol1">
Given that a picture is worth a thousand words, I figure that some 20 pictures with plenty of words in them should be worth a lot. So the approach to documentation is to mainly use annotated screenshots. I think you should look at the screenshots and read some of the text before trying to use MP3 Diags.
</div>

<div class="NormalText RegFnt ChpCol1">
If you didn't already, it's probably a good idea to take a look at the <a href="020_mp3_introduction.html">MP3 introduction</a>; while it won't turn somebody who knows nothing about MP3s into an expert (BTW, I'm not seeing myself as an MP3 expert), it puts things into MP3 Diags' perspective.
</div>

<div class="NormalText RegFnt ChpCol1">
Besides being available online, the documentation can be downloaded to your computer from <a href="http://sourceforge.net/projects/mp3diags/files/mp3diags-doc/" onClick="javascript: pageTracker._trackPageview('/files/doc');">this link</a>.
</div>

<div class="NormalText RegFnt ChpCol1">
<b>F1 Help</b> is available. In most cases pressing F1 will bring up the "right" documentation page. The files are first searched on the local computer and, if not found there, the page is loaded from SourceForge. If the documentation isn't installed (which is the default for all the binaries that I distribute) and you want to use local files, you need to download the documentation manually and copy the files to the appropriate folder. These folders are searched for .html and .png files:

</div>

<div class="NormalText RegFnt ChpCol1">
<table border="1" cellpadding="5" cellspacing="2" class="RegFnt ChpCol2">
    <tr>
        <td>On Windows</td>
        <td>
            <ul>
                <li>a folder called "doc" located in the same folder as the executable</li>
            </ul>
        </td>
    </tr>
    <tr>
        <td>On other systems</td>
        <td>
            <ul>
                <li>/usr/share/mp3diags-doc/html</li>
                <li>/usr/share/doc/mp3diags/html</li>
                <li>/usr/share/doc/mp3diags-&lt;VER&gt;/html, where &lt;VER&gt; should be replaced with the actual version of the program</li>
            </ul>
        </td>
    </tr>
</table>

</div>



<div class="SubChapterText RegFnt ChpCol2">
    Contents
</div>

<div class="NormalText RegFnt ChpCol2">
<table border="0" cellpadding="0" cellspacing="0" class="NormalText RegFnt ChpCol2">
    <tr> <td> <a href="035_suggested_usage.html">Suggested usage</a> </td> </tr>
    <tr> <td> <a href="110_first_run.html">First run</a> </td> </tr>
    <tr> <td> <a href="120_first_scan.html">Scanning MP3 files</a> </td> </tr>
    <tr> <td> <a href="130_main_window.html">Main window</a> </td> </tr>
    <tr> <td> <a href="140_main_window_tools.html">Main window - Tools</a> </td> </tr>
    <tr> <td> <a href="145_transformations_list.html">Transformations - Details</a> </td> </tr>
    <tr> <td> <a href="150_main_window_all_notes.html">Main window - All notes</a> </td> </tr>
    <tr> <td> <a href="160_main_window_tag_details.html">Main window - Tag details</a> </td> </tr>
    <tr> <td> <a href="170_note_filter.html">Note filter</a> </td> </tr>
    <tr> <td> <a href="180_folder_filter.html">Folder filter</a> </td> </tr>
    <tr> <td> <a href="190_tag_editor.html">Tag editor</a> </td> </tr>
    <tr> <td> <a href="200_discogs_query.html">Querying Discogs or MusicBrainz</a> </td> </tr>
    <tr> <td> <a href="210_tag_editor_assign_image.html">Tag editor - Assigning images</a> </td> </tr>
    <tr> <td> <a href="220_tag_editor_patterns.html">Tag editor - Patterns</a> </td> </tr>
    <tr> <td> <a href="230_normalize.html">Normalization</a> </td> </tr>
    <tr> <td> <a href="240_file_renamer.html">File renamer</a> </td> </tr>
    <tr> <td> <a href="250_config_files.html">Config - Files</a> </td> </tr>
    <tr> <td> <a href="260_config_ignored_notes.html">Config - Ignored notes</a> </td> </tr>
    <tr> <td> <a href="270_config_custom_transf.html">Config - Custom transformations</a> </td> </tr>
    <tr> <td> <a href="290_config_transf_params.html">Config - Transformation parameters</a> </td> </tr>
    <tr> <td> <a href="292_config_visible_transf.html">Config - Visible transformations</a> </td> </tr>
    <tr> <td> <a href="295_config_quality.html">Config - Audio quality</a> </td> </tr>
    <tr> <td> <a href="297_config_colors.html">Config - Colors</a> </td> </tr>
    <tr> <td> <a href="298_config_shell.html">Config - Shell integration</a> </td> </tr>
    <tr> <td> <a href="299_ext_tools.html">Config - External tools</a> </td> </tr>
    <tr> <td> <a href="300_config_others.html">Config - Others</a> </td> </tr>
    <tr> <td> <a href="310_advanced.html">Advanced features</a> </td> </tr>
</table>
</div>




<div class="NavPadTable RegFnt ChpCol1">
<div style="width:100%">
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="NavTable">
    <tr>
        <td width="30%" align="left"> <a href="020_mp3_introduction.html"><img src="arrow_left_small.png" class="ImgNoBorder NavPadLeft" align="absmiddle" /></a> <a href="020_mp3_introduction.html"> Short MP3 introduction </a> </td>
        <td width="40%" align="center" valign="middle" class="NavBarText"> User's guide </td>
        <td width="30%" align="right"> <a href="035_suggested_usage.html">Suggested usage</a> <a href="035_suggested_usage.html"> <img src="arrow_right_small.png" class="ImgNoBorder NavPadRight" align="absmiddle" /> </a> </td>
    </tr>
</table>
</div>
</div>




<!--QQQStatCounterQQQ-->

</body>

</html>