Started porting the LameXP documentation to Pandoc/Markdown.

diff --git a/.gitignore b/.gitignore
index 804c605..1e19774 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,6 @@
 *.user
 *.opensdf
+*.local.*
 *.sdf
 *.suo
 *.ncb
@@ -14,6 +15,7 @@
 /obj
 /out
 /tmp
+/doc/img
 /etc/Addins
 /etc/Deployment/_postproc.bat
 /etc/Deployment/buildenv.txt

diff --git a/doc/Manual.md b/doc/Manual.md
new file mode 100644 (file)
index 0000000..93a4762
--- /dev/null
+++ b/doc/Manual.md
@@ -0,0 +1,84 @@
+% LameXP - User Manual
+
+Introduction
+============
+
+![LameXP](http://lamexp.sourceforge.net/lamexp.png)
+
+LameXP is a graphical user-interface (front-end) for various of audio encoders: It allows you 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 encoder, but supports a wide range of output formats, including MP3, Ogg Vorbis, AAC/MP4, FLAC, AC-3 and Wave Audio. The number of supported input formats is even bigger! Furthermore LameXP does NOT only run on Windows XP, but also on Windows Vista, Windows 7 and many other operating systems.
+
+As all the encoders and decoders used by LameXP are already "built-in" (with one exception), you do NOT need to install any additional software, such as "Codecs", "Filters" or "Plug-ins", on your computer. Everything works "out of the box"! You can even use LameXP as a "portable" application, e.g. run it from your USB stick. Moreover LameXP was designed for batch processing. This means that you can convert a huge number of audio files, e.g. a complete album or even your entire music collection, in a single step. And, as LameXP is able to process several audio files in parallel, it takes full advantage of modern multi-core processors! However LameXP is NOT only optimized for speed, it also provides excellent sound quality by using the most sophisticated encoders available and by giving the user unrestricted control over all encoding parameters. In addition to that, LameXP provides full support for metadata, including cover art. So when converting your audio files, LameXP will retain existing meta tags. But there also is an easy-to-use editor for adding or modifying metadata. LameXP supports Unicode for both, meta tags and filenames, so there won't be any problems with "foreign" characters. And, thanks to our translators, the user-interface of LameXP is available in multiple languages. Last but not least, LameXP supports a number of post-processing filters, including sample rate conversion, normalization (gain), tone adjustment and downmixing of multi-channel sources.
+
+
+Platform Support
+----------------
+
+**Tier #1:** LameXP is currently being developed on the following platforms:
+
+* Microsoft Windows 8.1, 32-Bit and 64-Bit editions
+* Microsoft Windows 7 with Service Pack 1, 32-Bit and 64-Bit editions
+* Microsoft Windows XP with Service Pack 3 (see remarks below!)
+
+
+**Tier #2:** The following platforms should work too, but aren't tested extensively:
+
+* Microsoft Windows 10, 32-Bit and 64-Bit editions
+* Microsoft Windows 8.0, 32-Bit and 64-Bit editions
+* Microsoft Windows Vista with Service Pack 2, 32-Bit and 64-Bit editions
+* Microsoft Windows XP x64 Edition with Service Pack 2
+* Microsoft Windows Server 2008 with Service Pack 2
+* Microsoft Windows Server 2008 R2 with Service Pack 1
+* GNU/Linux (e.g. Ubuntu 12.04) using Wine v1.4+, native Linux version planned
+
+**Legacy:** The following platforms are NOT actively supported any longer:
+
+* Microsoft Windows 2000
+* Microsoft Windows NT 4.0
+* Microsoft Windows Millennium Edition
+* Microsoft Windows 98
+* Microsoft Windows 95
+
+*Remarks:* Windows XP has reached "end of life" on April 8th, 2014. This means that Microsoft has stopped all support for Windows XP, i.e. *no* updates or bugfixes are made available to regular Windows XP uses since that date, *not* even security fixes! Thus, all the security vulnerabilities that have been discovered *after* this deadline - and all the security vulnerabilities that will be discovered in the future - are going remain *unfixed* 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.
+
+
+Supported Output Formats (Encoders)
+-----------------------------------
+
+Currently the following output formats are supported by LameXP:
+
+* Opus Audio Codec, using the Opus-Tools by Xiph.org/Mozilla [built-in]
+* Ogg Vorbis, using the OggEnc2/libvorbis encoder with aoTuV [built-in]
+* MPEG Audio-Layer III (MP3), using the LAME encoder [built-in]
+* Advanced Audio Coding (AAC), using Nero AAC encoder [separate download!]
+* ATSC A/52 (aka "AC-3"), using the Aften encoder [built-in]
+* DCA, using the DCA Enc encoder (still experimental) [built-in]
+* Free Lossless Audio Codec (FLAC) [built-in]
+* Uncompressed PCM / Waveform Audio File (WAV/RIFF)
+
+
+Supported Input Formats (Decoders)
+----------------------------------
+
+Currently the following input formats are supported by LameXP:
+
+* AC-3 (ATSC A/52), using Valib decoder [built-in]
+* Advanced Audio Coding (AAC), using FAAD decoder [built-in]
+* Apple Lossless (ALAC)
+* Apple/SGI AIFF
+* Avisynth, audio only [requires Avisynth 2.5.x to be installed]
+* Digital Theater System, using Valib decoder [built-in]
+* Free Lossless Audio Codec (FLAC)
+* Microsoft ADPCM
+* Monkey's Audio (APE)
+* MPEG Audio-Layer I (MP1), using mpg123 decoder [built-in]
+* MPEG Audio-Layer II (MP2), using mpg123 decoder [built-in]
+* MPEG Audio-Layer III (MP3), using mpg123 decoder [built-in]
+* Musepack
+* Opus Audio Codec
+* Shorten
+* Speex
+* Sun/NeXT Au
+* The True Audio (TTA)
+* Uncompressed PCM / Waveform Audio File (WAV/RIFF)
+* WavPack Hybrid Lossless Audio
+* Windows Media Audio (WMA), using wma2wav [built-in]

diff --git a/doc/z_make.bat b/doc/z_make.bat
new file mode 100644 (file)
index 0000000..afb2c2e
--- /dev/null
+++ b/doc/z_make.bat
@@ -0,0 +1,2 @@
+@echo off
+call "../etc/Deployment/_mkdocs.bat"

diff --git a/etc/Deployment/_mkdocs.bat b/etc/Deployment/_mkdocs.bat
new file mode 100644 (file)
index 0000000..d850bc4
--- /dev/null
+++ b/etc/Deployment/_mkdocs.bat
@@ -0,0 +1,20 @@
+@echo off
+setlocal ENABLEDELAYEDEXPANSION
+REM -----------------------------------------------------------------
+set "LAMEXP_ERROR=1"
+echo ----------------------------------------------------------------
+echo Building software documentation
+echo ----------------------------------------------------------------
+call "%~dp0\_paths.bat"
+if not "%LAMEXP_ERROR%"=="0" GOTO:EOF
+REM -----------------------------------------------------------------
+set "LAMEXP_ERROR=1"
+REM -----------------------------------------------------------------
+for %%i in ("%~dp0\..\..\doc\*.md") do (
+       echo PANDOC: %%~nxi
+       "%PATH_PANDOC%\pandoc.exe" --from markdown_github+pandoc_title_block --to html5 --toc -N --standalone -H "%~dp0\..\Style\style.css" "%%~i" --output "%%~dpni.local.html"
+       echo.
+       if not "!ERRORLEVEL!"=="0" GOTO:EOF
+)
+echo ----------------------------------------------------------------
+set "LAMEXP_ERROR=0"

diff --git a/etc/Deployment/_paths.bat b/etc/Deployment/_paths.bat
index 6b82f51..40e0410 100644 (file)
--- a/etc/Deployment/_paths.bat
+++ b/etc/Deployment/_paths.bat
@@ -6,6 +6,7 @@ set "PATH_MKNSIS="
 set "PATH_MSCDIR="
 set "PATH_QTMSVC="
 set "PATH_GNUPG1="
+set "PATH_PANDOC="
 set "PATH_VCPROJ="
 REM ------------------------------------------
 set "BUILDENV_TXT=%~dp0\buildenv.txt"
@@ -28,6 +29,7 @@ for /f "tokens=2,*" %%s in (%BUILDENV_TXT%) do (
        if "%%s"=="PATH_MSCDIR" set "PATH_MSCDIR=%%~t"
        if "%%s"=="PATH_QTMSVC" set "PATH_QTMSVC=%%~t"
        if "%%s"=="PATH_GNUPG1" set "PATH_GNUPG1=%%~t"
+       if "%%s"=="PATH_PANDOC" set "PATH_PANDOC=%%~t"
        if "%%s"=="PATH_VCPROJ" set "PATH_VCPROJ=%%~t"
 )
 REM ------------------------------------------
@@ -39,21 +41,22 @@ echo PATH_MKNSIS = "%PATH_MKNSIS%"
 echo PATH_MSCDIR = "%PATH_MSCDIR%"
 echo PATH_QTMSVC = "%PATH_QTMSVC%"
 echo PATH_GNUPG1 = "%PATH_GNUPG1%"
+echo PATH_PANDOC = "%PATH_PANDOC%"
 echo PATH_VCPROJ = "%PATH_VCPROJ%"
 echo === END PATHS ===
 REM ------------------------------------------
 set "LAMEXP_ERROR=1"
 REM ------------------------------------------
-if not exist "%PATH_UPXBIN%\upx.exe" GOTO:EOF
-if not exist "%PATH_MKNSIS%\makensis.exe" GOTO:EOF
+if not exist "%PATH_UPXBIN%\upx.exe"          GOTO:EOF
+if not exist "%PATH_MKNSIS%\makensis.exe"     GOTO:EOF
 if not exist "%PATH_MSCDIR%\VC\vcvarsall.bat" GOTO:EOF
-if not exist "%PATH_MSCDIR%\VC\bin\cl.exe" GOTO:EOF
-if not exist "%PATH_QTMSVC%\bin\uic.exe" GOTO:EOF
-if not exist "%PATH_QTMSVC%\bin\moc.exe" GOTO:EOF
-if not exist "%PATH_QTMSVC%\bin\rcc.exe" GOTO:EOF
-if not exist "%PATH_GNUPG1%\gpg.exe" GOTO:EOF
-if not exist "%PATH_GNUPG1%\gpg.exe" GOTO:EOF
-if not exist "%~dp0\..\..\%PATH_VCPROJ%" GOTO:EOF
+if not exist "%PATH_MSCDIR%\VC\bin\cl.exe"    GOTO:EOF
+if not exist "%PATH_QTMSVC%\bin\uic.exe"      GOTO:EOF
+if not exist "%PATH_QTMSVC%\bin\moc.exe"      GOTO:EOF
+if not exist "%PATH_QTMSVC%\bin\rcc.exe"      GOTO:EOF
+if not exist "%PATH_GNUPG1%\gpg.exe"          GOTO:EOF
+if not exist "%PATH_PANDOC%\pandoc.exe"       GOTO:EOF
+if not exist "%~dp0\..\..\%PATH_VCPROJ%"      GOTO:EOF
 REM ------------------------------------------
 if exist "%PATH_QTMSVC%\bin\qtvars.bat" goto qtvars_found
 if exist "%PATH_QTMSVC%\bin\qtenv2.bat" goto qtvars_found

diff --git a/etc/Deployment/buildenv.template.txt b/etc/Deployment/buildenv.template.txt
index 751220f..a0c8628 100644 (file)
--- a/etc/Deployment/buildenv.template.txt
+++ b/etc/Deployment/buildenv.template.txt
@@ -3,4 +3,5 @@
 #define PATH_MSCDIR "C:\Program Files\Microsoft Visual Studio 12.0"
 #define PATH_QTMSVC "C:\QtSDK\Desktop\Qt\4.8.5\msvc2012"
 #define PATH_GNUPG1 "C:\Program Files\GNU\GnuPG"
+#define PATH_GNUPG1 "C:\Program Files\Pandoc"
 #define PATH_VCPROJ "LameXP_VS2013.sln"

diff --git a/etc/Style/style.css b/etc/Style/style.css
new file mode 100644 (file)
index 0000000..3fc74f5
--- /dev/null
+++ b/etc/Style/style.css
@@ -0,0 +1,12 @@
+<style type="text/css">
+<!--
+  body { font-family: "Times New Roman", Times, serif; color: #000000; background-color: #FFFFFF; }
+  tt, pre, code { font-family: Courier New, Courier, mono; background-color: #EDF3F7; padding: 1px; }
+  h2 { margin-top: 2.0em; }
+  h3, h4 { margin-top: 1.75em; }
+  a { color: #0000BB; text-decoration: none; }
+  a:visited { color: #0000BB; text-decoration: none; }
+  a:active { color: #0000FF; text-decoration: none; }
+  a:hover { color: #0000FF; text-decoration: underline; }
+-->
+</style>