Documentation: Formatting fixes.

2014-12-27 00:08:56 +01:00 · 2014-12-27 00:08:56 +01:00 · ed84360a49
commit ed84360a49
parent e382ed8b63
2 changed files with 44 additions and 61 deletions
--- a/doc/Manual.html
+++ b/doc/Manual.html
@ -199,7 +199,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.<
 <p>If you fully understand what the consequences of the &quot;portable mode&quot; are and still want to <em>enable</em> this mode, then simply <strong>rename</strong> the LameXP program file form <code>LameXP.exe</code> to <code>LameXP-Portable.exe</code>. You must exit LameXP, before you can rename the program file!</p>
 <p><em>Note:</em> By default, the LameXP installation directory is either <code>C:\Program Files (x86)\MuldeR\LameXP</code> or <code>C:\Program Files\MuldeR\LameXP</code>. However, this can be changed by the user during the setup process.</p>
 <p><img src="img/lamexp/setup_3a.png" alt="Figure" /></p>
-<p> <br /><strong>Warning:</strong> While the &quot;portable mode&quot; is in effect, it is the <em>user's</em> responsibility to ensure that LameXP will be provided with the proper access rights to save/load its configuration files to/from the LameXP installation directory!</p>
+<h4 id="warning"><span class="header-section-number">3.2.1.1</span> Warning</h4>
 <p>While the &quot;portable mode&quot; is in effect, it is the <em>user's</em> responsibility to ensure that LameXP will be provided with the proper access rights to save/load its configuration files to/from the LameXP program directory!</p>
 <p>Note that the directories <code>C:\Program Files (x86)</code> and <code>C:\Program Files</code> usually are &quot;protected&quot; by the operating system, so LameXP may <strong>not</strong> be able to write into these directories.</p>
 <h3 id="disable-the-portable-mode"><span class="header-section-number">3.2.2</span> Disable the Portable Mode</h3>
 <p>If you wish to <em>disable</em> the &quot;portable mode&quot; again, then all you need to do is <strong>renaming</strong> the LameXP program file form <code>LameXP-Portable.exe</code> back to <code>LameXP.exe</code>. You must exit LameXP, before you can rename the program file!</p>
 <p><em>Note:</em> After the &quot;portable mode&quot; has been <em>disabled</em>, any configurations files that may have been created in the LameXP installation directory will <strong>no</strong> longer be recognized. Therefore, you can delete these files safely…</p>
@ -302,13 +304,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.<
 <li><a href="http://www.free-codecs.com/lamexp_download.htm">http://www.free-codecs.com/lamexp_download.htm</a><br /></li>
 <li><a href="http://www.videohelp.com/tools/LameXP">http://www.videohelp.com/tools/LameXP</a></li>
 </ul>
-<p> <br />It is <em>highly recommended</em> to download LameXP <em>only</em> from one of the official mirrors listed above. We assume <em>no responsibility</em> for the integrity and trustworthiness of LameXP downloads you may have received from other locations!</p>
+<p> <br />It is <em>highly recommended</em> to download LameXP <em>only</em> from one of the official mirrors listed above. We are <strong>not</strong> responsible for the integrity and trustworthiness of LameXP downloads you may have received from other locations!</p>
 <h2 id="diagnostic-output"><span class="header-section-number">5.2</span> Diagnostic Output</h2>
 <p>If you want to report any problems that you have encountered with the LameXP software, please provide as much details as possible. <em>Diagnostic output</em> can be especially helpful here!</p>
 <ul>
 <li><p>If a certain encoding job has failed, you can double-click the failed job in the LameXP &quot;Processing&quot; dialogue, which will bring up a detailed <em>log</em> for that job. Use the &quot;Copy to Clipboard&quot; button to save that information.</p></li>
-<li><p>You can launch the LameXP application with the additional <a href="http://en.wikipedia.org/wiki/Command-line_interface">command-line</a> parameter <code>--console</code> in order to enable the LameXP <em>debug console</em>, which provides many additional information on what is going on &quot;behind the scenes&quot;.</p></li>
+<li><p>You can launch the LameXP application with the additional <a href="http://en.wikipedia.org/wiki/Command-line_interface">command-line</a> parameter <code>--console</code> in order to enable the LameXP <em>debug console</em>, which provides many information on what is going on &quot;behind the scenes&quot;.</p></li>
-<li><p>The <a href="http://en.wikipedia.org/wiki/Environment_variable">environment variable</a> <code>MUTILS_LOGFILE</code> may be set in order to specify a log file that will be created by LameXP. The information saved to the log file is the same as the information available from the debug console.</p></li>
+<li><p>The <a href="http://en.wikipedia.org/wiki/Environment_variable">environment variable</a> <code>MUTILS_LOGFILE</code> may be used to specify a <em>log file</em> that will be created by LameXP. The information that are saved to the log file are the same as those available from the debug console.</p></li>
 </ul>
 <p> <br /><em>Note:</em> We highly recommend using a web-service like <a href="https://gist.github.com/">Gist</a>, <a href="http://pastie.org/">Pastie</a> or <a href="http://pastebin.com/">Pastebin</a> in order to share your diagnostic information. Please avoid posting long log files directly on the forums!</p>
 <h2 id="bugtracker"><span class="header-section-number">5.3</span> Bugtracker</h2>
--- a/doc/Manual.md
+++ b/doc/Manual.md
@ -1,7 +1,6 @@
 % LameXP Audio-Encoder Front-End &ndash; Manual
-Introduction
+# Introduction #
 ============
 LameXP is a graphical user-interface (front-end) for various of audio encoders: It allows you to convert your audio files from one audio format to another one in the most simple way. Despite its name, LameXP is **not** only a front-end for the LAME MP3 encoder, but supports a wide range of *output formats*, including MP3, Ogg Vorbis, Opus, AAC/MP4, FLAC, AC-3 and Wave Audio. The number of supported *input formats* is even bigger! Furthermore LameXP **not** only runs on Windows XP, but also on Windows 7, 8 and 10 as well as many other operating systems.
@ -12,8 +11,7 @@ Since all the encoders and decoders that are used by the LameXP software are alr
 In addition to that, LameXP provides full support for *meta information*, including cover artwork. So when converting your audio files with LameXP, any existing meta information will be retained &ndash; to the highest possible extent. Of course, there also is an easy-to-use *meta-tag editor* for adding new meta information or managing the existing meta information. On top of it all, LameXP provides full *Unicode support*, for meta information as well as file names, thus problems with "intentional" character sets are avoided. Likewise, thanks to our *translators*, the user-interface of the LameXP software is available in many different languages, including English, German, Spanish and Chinese. Last but not least, LameXP supports a number of post-processing filters, including sample rate conversion, normalization (gain adjustment), tone adjustment as well as down-mixing.
-Platform Support
+## Platform Support##
 ----------------
 **Tier #1:** LameXP is currently being developed on the following platforms:
@ -44,8 +42,7 @@ The following *legacy* platforms are **not** actively supported any longer:
 *Remarks:* Windows XP has reached "end of life" on April 8th, 2014. This means that Microsoft has stopped all support for Windows XP. Thus **no** updates or bugfixes are made available to regular Windows XP users since that date, **not** even security fixes! Thus, all the security vulnerabilities that have been discovered *after* the deadline &ndash; and all the security vulnerabilities that are going to be discovered in the future &ndash; will *persists* forever! Consequently, using Windows XP has become a severe security risk, and the situation is only going to get worse. While LameXP will continue to support Windows XP (note that Service Pack 3 is required!) for the foreseeable future, we *highly* recommend everybody to update to a less antiquated system now. Windows XP support will be discontinued in a future version, when most users have migrated to a contemporary system.
-Output Formats (Encoders)
+## Output Formats (Encoders) ##
 -------------------------
 Currently the following output formats (audio encoders) are supported by LameXP:
@ -60,8 +57,7 @@ Currently the following output formats (audio encoders) are supported by LameXP:
 * Uncompressed PCM / Waveform Audio File (WAV/RIFF)
-Input Formats (Decoders)
+## Input Formats (Decoders) ##
 ------------------------
 Currently the following input formats (audio decoders) are supported by LameXP:
@ -89,22 +85,19 @@ Currently the following input formats (audio decoders) are supported by LameXP:
-Leagl Information
+# Leagl Information #
 =================
 The LameXP software was developed, from the scratch, by LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;. Consequently, all copyrights on the LameXP software exclusively belong to LoRd_MuldeR. The right to use, modify and redistribute the LameXP software *according to the license terms* is granted to everybody. Please see below for license details! If you want to use the LameXP software in a way that is *not* covered by the license terms, e.g. if you want to include the LameXP software (or parts of it) in a *proprietary* software, written permission by LoRd_MuldeR is required.
 More OpenSource projects by LoRd_MuldeR can be found at <http://muldersoft.com/> and <https://github.com/lordmulder>. Please do **not** send e-mail to LoRd_MuldeR directly, if the problem or suggestion can be discussed on the support forums or on the issue tracker!
-Third-party Software
+## Third-party Software ##
 --------------------
 It has to be noticed that LameXP uses a number of *third-party* applications and libraries. The copyright on these third-party tools belongs to the individual authors. *All* third-party tools that are included in the official distribution packages of LameXP are distributed in accordance with the respective software license. For legal reasons, some of the third-party tools can *not* be redistributed along with LameXP and therefore need to be obtained separately. For more details on the third-party tools that are used by the LameXP software, please refer to the "Third-party software" tab in the "About" dialogue. Moreover, various people have contributed translations to the LameXP project. These translation are redistributed with permission of the respective contributor. For more information about our contributors, please refer to the "Contributors" tab in the "About" dialogue.
-License Terms
+## License Terms ##
 -------------
 LameXP is [*free software*](http://en.wikipedia.org/wiki/Free_software_movement), released under the terms of the [*GNU General Public License* (GPL), version 2](http://www.gnu.org/licenses/gpl-2.0.html). The licenses for most software and other practical works are designed to take away your freedom to share and change the works. In contrast, the GPL is designed to guarantee your freedom to share and change all versions of the software. In other words, the GPL ensures that free software will remain free for all of its users. LameXP adds some additional terms in order to keep your computer safe from unwanted software. See the *GNU General Public License* for more details!
@ -130,13 +123,12 @@ LameXP is [*free software*](http://en.wikipedia.org/wiki/Free_software_movement)
-Install Instructions
+# Install Instructions #
 ====================
 This chapter explains how to install the LameXP software on your computer. If LameXP has already been installed on your computer, you may skip this chapter.
-Install the LameXP Software
+
---------------------------
+## Install the LameXP Software ##
 Distribution packages of the LameXP software is provided in two different flavours: a self-running **setup program** and a **ZIP package**. For regular users, using the *setup program* is highly recommended!
@ -183,8 +175,7 @@ Congratulation, LameXP has been installed successfully on your computer! Now dou
 ![Figure](img/lamexp/setup_2c.png)
-Portable Mode
+## Portable Mode ##
 -------------
 First of all, it is important to note that there is **no** such thing as a *separate* "portable version" or "portable edition" of the LameXP software. Instead, **all** versions of the LameXP software always *are* "portable" &ndash; in the sense that the LameXP software is *fully self-contained* and thus **no** additional dependencies (libraries, frameworks, codecs or whatsoever) need to be installed on the computer separately. Or, in other words, the LameXP software is designed to work "out of the box". And this applies regardless of whether you choose the setup program or the ZIP package!
@ -199,8 +190,11 @@ If you fully understand what the consequences of the "portable mode" are and sti
 ![Figure](img/lamexp/setup_3a.png)
-&nbsp;  
+#### Warning ####
-**Warning:** While the "portable mode" is in effect, it is the *user's* responsibility to ensure that LameXP will be provided with the proper access rights to save/load its configuration files to/from the LameXP installation directory!
+
 While the "portable mode" is in effect, it is the *user's* responsibility to ensure that LameXP will be provided with the proper access rights to save/load its configuration files to/from the LameXP program directory!
 Note that the directories ``C:\Program Files (x86)`` and ``C:\Program Files`` usually are "protected" by the operating system, so LameXP may **not** be able to write into these directories.
 ### Disable the Portable Mode ###
@ -210,8 +204,7 @@ If you wish to *disable* the "portable mode" again, then all you need to do is *
 *Note:* After the "portable mode" has been *disabled*, any configurations files that may have been created in the LameXP installation directory will **no** longer be recognized. Therefore, you can delete these files safely&hellip;
-Install the AAC Encoder
+## Install the AAC Encoder ##
 -----------------------
 For legal reasons, the AAC (Advanced Audio Coding) encoder can **not** be included in the official LameXP distribution packages. Therefore, you need to download and install the AAC encoder *manually*. Don't worry, it's easy!
@ -304,14 +297,13 @@ Once the QAAC encoder as well as the Apple AAC encoder libraries ("Apple Applica
 *Note:* You may run ``qaac.exe --check`` from the [command prompt](http://en.wikipedia.org/wiki/Cmd.exe) to ensure that QAAC has been set up correctly. Expected output is ``qaac 2.xx, CoreAudioToolbox x.x.x.x``.
-Tutorial (Step-by-Step Guide)
+
-=============================
+# Tutorial (Step-by-Step Guide) #
 This tutorial will teach you, step by step, how to convert your audio files using the LameXP software. The tutorial assumes that LameXP is already installed on your computer.
-Source Files
+## Source Files ##
 ------------
 First of all, you need to add all **source files** that you want to convert. So switch to the "Source Files" tab, just in case that tab is not active already, and then click the "Add File(s)" button.
@ -331,8 +323,7 @@ All files you have added, so far, will show up in the list. You can click the "R
 *Did you know?* Files can also be added via [Drag &amp; Drop](http://en.wikipedia.org/wiki/Drag_and_drop). Just grab the files that you want to add in your Explorer window and drop them onto the LameXP main window (or onto the LameXP "dropbox" widget).
-Output Directory
+## Output Directory ##
 ----------------
 Next, you need to choose the **output directory**, i.e. the directory where the converted files will be saved. Switch to the "Output Directory" tab and choose the desired output directory from the directory tree view.
@ -354,8 +345,7 @@ The new folder is going to be created inside the current directory and will be s
 *Did you know?* If you enable the "Save output files in the same directory where the input file is located" option, each output file will be saved to the same location where the corresponding source file resides.
-Compression Settings
+## Compression Settings ##
 --------------------
 Finally, you need to choose your **compression settings**. First, and most important, you must decide for an output *audio format (encoder)*. Depending on your needs and preferences, you can choose between [MP3](http://en.wikipedia.org/wiki/MP3), [Ogg/Vorbis](http://en.wikipedia.org/wiki/Vorbis), [Opus](http://en.wikipedia.org/wiki/Opus_%28audio_format%29), [AAC/MP4](http://en.wikipedia.org/wiki/Advanced_Audio_Coding), [FLAC](https://xiph.org/flac/) and others.
@ -381,8 +371,7 @@ Last but not least, you need to choose the desired target *bitrate* or *quality-
 *Did you know?* You can click on the "Reset" link at any time in order to reset all available settings for all available encoders to their factory defaults.
-Processing
+## Processing ##
 ----------
 When everything has been set up properly, the time has come to actually start the encoding process. So simply click the "Encode Now" button in order to get going!
@ -405,14 +394,12 @@ The "Processing" dialogue is going to turn *green*, as soon as all encoding jobs
-Help &amp; Support
+# Help &amp; Support #
 ==================
 Before you report any problems that you may have encountered with the LameXP software, please make sure that the problem can be *reproduced* with the **latest** release version of LameXP!
-Download Mirrors
+## Download Mirrors ##
 ----------------
 The latest *official* release of the LameXP software can be obtained from one of the following *official* download mirrors:
@ -425,26 +412,24 @@ The latest *official* release of the LameXP software can be obtained from one of
 * <http://www.videohelp.com/tools/LameXP>
 &nbsp;  
-It is *highly recommended* to download LameXP *only* from one of the official mirrors listed above. We assume *no responsibility* for the integrity and trustworthiness of LameXP downloads you may have received from other locations!
+It is *highly recommended* to download LameXP *only* from one of the official mirrors listed above. We are **not** responsible for the integrity and trustworthiness of LameXP downloads you may have received from other locations!
-Diagnostic Output
+## Diagnostic Output ##
 -----------------
 If you want to report any problems that you have encountered with the LameXP software, please provide as much details as possible. *Diagnostic output* can be especially helpful here!
 * If a certain encoding job has failed, you can double-click the failed job in the LameXP "Processing" dialogue, which will bring up a detailed *log* for that job. Use the "Copy to Clipboard" button to save that information.
-* You can launch the LameXP application with the additional [command-line](http://en.wikipedia.org/wiki/Command-line_interface) parameter ``--console`` in order to enable the LameXP *debug console*, which provides many additional information on what is going on "behind the scenes".
+* You can launch the LameXP application with the additional [command-line](http://en.wikipedia.org/wiki/Command-line_interface) parameter ``--console`` in order to enable the LameXP *debug console*, which provides many information on what is going on "behind the scenes".
-* The [environment variable](http://en.wikipedia.org/wiki/Environment_variable) ``MUTILS_LOGFILE`` may be set in order to specify a log file that will be created by LameXP. The information saved to the log file is the same as the information available from the debug console.
+* The [environment variable](http://en.wikipedia.org/wiki/Environment_variable) ``MUTILS_LOGFILE`` may be used to specify a *log file* that will be created by LameXP. The information that are saved to the log file are the same as those available from the debug console.
 &nbsp;  
 *Note:* We highly recommend using a web-service like [Gist](https://gist.github.com/), [Pastie](http://pastie.org/) or [Pastebin](http://pastebin.com/) in order to share your diagnostic information. Please avoid posting long log files directly on the forums!
-Bugtracker
+## Bugtracker ##
 ----------
 The recommended way to submit *bug reports* or *feature requests* to the LameXP developers is using the *issue tracking system* at our GitHub project site:
@ -454,8 +439,7 @@ The recommended way to submit *bug reports* or *feature requests* to the LameXP
 *Note:* In order to use the issue tracking system, you need to log in with your GitHub account. Creating a GitHub account is easy and completely free of charge, simply click [here](https://github.com/join)!
-Support Forum
+## Support Forum ##
 -------------
 If you want to discuss the development of the LameXP software, help other users or receive help from other users, please use the LameXP thread at *Doom9's* Forum:
@ -467,14 +451,12 @@ If you want to discuss the development of the LameXP software, help other users
-Developer Center
+# Developer Center #
 ================
 While LameXP originally was written in Delphi/Pascal, the current version 4 series of the software has been re-written in the [**C++**](http://en.wikipedia.org/wiki/C%2B%2B) programming language. LameXP v4 uses the [*Qt cross-platform application framework*](http://www.qt.io/) and provides full [*Unicode*](http://en.wikipedia.org/wiki/Unicode) support. Furthermore, LameXP is tightly coupled with the [*MUtilities*](https://github.com/lordmulder/MUtilities) library, a vast collection of "utility" routines and classes to extend the Qt framework. Build files are currently provided for *Microsoft Visual Studio* only. Linux support is currently provided via [*Wine*](https://www.winehq.org/); a native Linux port of LameXP is planned for a future version.
-Source Code Access
+## Source Code Access ##
 ------------------
 The source code of the **LameXP** software is managed using the [*Git*](http://git-scm.com/) version control system. The Git repository can be *cloned* from one of the official Git mirrors:
@ -513,8 +495,7 @@ The source code of the **MUtilities** library is managed using the [*Git*](http:
 *Remarks:* In case you are new to Git or want to extend your knowledge, have a look at the [*Pro Git*](http://git-scm.com/book/en/v2) book by Scott Chacon! For Windows users, we highly recommend using [*MSYS Git*](http://msysgit.github.com/) in conjunction with the superb [*Tortoise Git*](http://tortoisegit.googlecode.com/) front-end.
-Build Prerequisites
+## Build Prerequisites ##
 -------------------
 LameXP is currently being developed and built using the following development tools and libraries:
@ -544,8 +525,7 @@ In order to create LameXP release packages, using the included deployment script
 * [GnuPG](ftp://ftp.gnupg.org/gcrypt/binary/) &ndash; the GNU Privacy Guard v1.4.x 
-Qt as Static Libraries
+## Qt as Static Libraries ##
 ----------------------
 In order to create a "fully static" build of LameXP, i.e. a build that does *not* depend on any "external" DLL files (except for the obligatory operating system DLL's that you cannot get around), you'll need to compile Qt as "static" libraries. The official Qt web-site *does* provide pre-compiled Qt libraries. However, they only provide DLL versions, they do *not* provide "static" libraries. Consequently, you need to build the required "static" Qt libraries yourself. The following simple instructions should make it easy to build Qt from the sources and as "static" libraries:
@ -600,11 +580,12 @@ In order to create a "fully static" build of LameXP, i.e. a build that does *not
-F.A.Q. (Frequently Asked Questions)
+# F.A.Q. (Frequently Asked Questions) #
 ===================================
 **TODO**
 &nbsp;  
 &nbsp;  
 **EOF**