git.iko.soy/typeable/pandoc
on master help sign in
Rename README to MANUAL.txt
commita396003a31afd2c3baa9657669cbbb77460e5cf2 authorAlbert Krewinkel <albert@zeitkraut.de> dateWed 20 Jul 2016, 14:12 (10 years ago) parente2d5946
11 files changed+26−26
.gitignore+2−2 CONTRIBUTING.md+4−4 INSTALL+1−1 README → MANUAL.txt Makefile+1−1 appveyor.yml+1−1 pandoc.cabal+2−2 src/Text/Pandoc/Data.hsb+1−1 src/Text/Pandoc/Shared.hs+2−2 windows/make-windows-installer.bat+2−2 windows/pandoc.wxs+10−10
.gitignore+2−2
@@ -1,7 +1,7 @@
11*~
22dist/*
3−README.*
4−!README.Debian
3+MANUAL.*
4+!MANUAL.txt
55INSTALL.*
66.configure-stamp
77.cabal-sandbox
CONTRIBUTING.md+4−4
@@ -29,7 +29,7 @@ Out of scope?
2929-------------
3030
3131A less than perfect conversion does not necessarily mean there's
32−a bug in pandoc. Quoting from the README:
32+a bug in pandoc. Quoting from the MANUAL:
3333
3434> Because Pandoc's intermediate representation of a document is less
3535> expressive than many of the formats it converts between, one should
@@ -124,7 +124,7 @@ Please follow these guidelines:
124124 below under [Tests](#tests).) If you are adding a new writer or reader,
125125 you must include tests.
126126
127−7. If you are adding a new feature, include updates to the README.
127+7. If you are adding a new feature, include updates to the README and MANUAL.
128128
1291298. All code must be released under the general license governing pandoc
130130 (GPL v2).
@@ -259,7 +259,7 @@ The library is structured as follows:
259259 - `Text.Pandoc.Shared` is a grab-bag of shared utility functions.
260260 - `Text.Pandoc.Writers.Shared` contains utilities used in writers only.
261261 - `Text.Pandoc.Slides` contains functions for splitting a markdown document
262− into slides, using the conventions described in the README.
262+ into slides, using the conventions described in the MANUAL.
263263 - `Text.Pandoc.Templates` defines pandoc's templating system.
264264 - `Text.Pandoc.UTF8` contains functions for converting text to and from
265265 UTF8 bytestrings (strict and lazy).
@@ -270,7 +270,7 @@ The library is structured as follows:
270270
271271[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss
272272[issue tracker]: https://github.com/jgm/pandoc/issues
273−[User's Guide]: http://pandoc.org/README.html
273+[User's Guide]: http://pandoc.org/MANUAL.html
274274[FAQs]: http://pandoc.org/faqs.html
275275[EditorConfig]: http://editorconfig.org/
276276[Haskell platform]: http://www.haskell.org/platform/
INSTALL+1−1
@@ -95,7 +95,7 @@ Quick install with cabal
9595
9696The `pandoc.1` man page will be installed automatically. cabal shows
9797you where it is installed: you may need to set your `MANPATH`
98−accordingly. If `README` has been modified, the man page can be
98+accordingly. If `MANUAL.txt` has been modified, the man page can be
9999rebuilt: `make man/pandoc.1`.
100100
101101The `pandoc-citeproc.1` man page will also be installed automatically.
README → MANUAL.txtrenamed

The content is the same.

Makefile+1−1
@@ -56,7 +56,7 @@ pandoc-$(version)-windows.msi:
5656 osslsigncode sign -pkcs12 ~/Private/ComodoCodeSigning.exp2017.p12 -in pandoc.msi -i http://johnmacfarlane.net/ -t http://timestamp.comodoca.com/ -out $@ -askpass
5757 rm pandoc.msi
5858
59−man/pandoc.1: README man/pandoc.1.template
59+man/pandoc.1: MANUAL.txt man/pandoc.1.template
6060 pandoc $< -t man -s --template man/pandoc.1.template \
6161 --filter man/capitalizeHeaders.hs \
6262 --filter man/removeNotes.hs \
appveyor.yml+1−1
@@ -37,7 +37,7 @@ after_test:
3737 # .\ in the stack commandline seems to be .\windows\ (where the stack-appveyor.yaml is)
3838 - cd windows
3939 - 7z a "pandoc.zip" pandoc.exe
40− - .\pandoc.exe -s -S --toc ..\README -o README.html
40+ - .\pandoc.exe -s -S --toc ..\MANUAL.txt -o MANUAL.html
4141 - .\pandoc.exe -s -S ..\COPYING -o COPYING.rtf
4242 - copy ..\COPYRIGHT COPYRIGHT.txt
4343 - |
pandoc.cabal+2−2
@@ -105,10 +105,10 @@ Data-Files:
105105 -- bash completion template
106106 data/bash_completion.tpl
107107 -- documentation
108− README, COPYRIGHT
108+ MANUAL.txt, COPYRIGHT
109109Extra-Source-Files:
110110 -- documentation
111− INSTALL, BUGS, CONTRIBUTING.md, changelog
111+ INSTALL, BUGS, README.md, CONTRIBUTING.md, changelog
112112 man/pandoc.1
113113 -- stack build plan
114114 stack.yaml
src/Text/Pandoc/Data.hsb+1−1
@@ -12,4 +12,4 @@ dataFiles = map (\(fp, contents) ->
1212 (Posix.joinPath (splitDirectories fp), contents)) dataFiles'
1313
1414dataFiles' :: [(FilePath, B.ByteString)]
15−dataFiles' = ("README", %blob "README") : %blobs "data"
15+dataFiles' = ("MANUAL.txt", %blob "MANUAL.txt") : %blobs "data"
src/Text/Pandoc/Shared.hs+2−2
@@ -873,7 +873,7 @@ readDefaultDataFile fname =
873873 go as x = x : as
874874#else
875875 getDataFileName fname' >>= checkExistence >>= BS.readFile
876− where fname' = if fname == "README" then fname else "data" </> fname
876+ where fname' = if fname == "MANUAL.txt" then fname else "data" </> fname
877877
878878checkExistence :: FilePath -> IO FilePath
879879checkExistence fn = do
@@ -1071,7 +1071,7 @@ blocksToInlinesWithSep sep blks = intercalate sep $ map blockToInlines blks
10711071
10721072blocksToInlines :: [Block] -> [Inline]
10731073blocksToInlines = blocksToInlinesWithSep [Space, Str "¶", Space]
1074−
1074+
10751075
10761076--
10771077-- Safe read
windows/make-windows-installer.bat+2−2
@@ -2,7 +2,7 @@
22stack install --test
33if %errorlevel% neq 0 exit /b %errorlevel%
44for /f "delims=" %%a in ('stack path --local-bin-path') do @set BINPATH=%%a
5−%BINPATH%\pandoc.exe -s -S --toc ..\README -o README.html
5+%BINPATH%\pandoc.exe -s -S --toc ..\MANUAL -o MANUAL.html
66if %errorlevel% neq 0 exit /b %errorlevel%
77%BINPATH%\pandoc.exe -s ..\COPYING -t rtf -S -o COPYING.rtf
88if %errorlevel% neq 0 exit /b %errorlevel%
@@ -14,7 +14,7 @@ for /f "tokens=1-2 delims= " %%a in ('%BINPATH%\pandoc.exe --version') do (
1414:next
1515if "%VERSION%" == "" (
1616 echo Error: could not determine version number.
17− exit /b 1
17+ exit /b 1
1818)
1919echo Detected version %VERSION%
2020echo Creating msi...
windows/pandoc.wxs+10−10
@@ -57,8 +57,8 @@
5757
5858 <Component Id="Documentation"
5959 Guid="A8D54A76-1A3D-4647-8327-81B69D39D8A3">
60− <File Id="pandocREADME" Name="Pandoc User's Guide.html"
61− Source="README.html" KeyPath="yes">
60+ <File Id="pandocMANUAL" Name="Pandoc User's Guide.html"
61+ Source="MANUAL.html" KeyPath="yes">
6262 <Shortcut Id="ApplicationStartMenuShortcut"
6363 Directory="ApplicationProgramsFolder"
6464 Name="Pandoc User’s Guide" Advertise="yes" />
@@ -123,18 +123,18 @@
123123 </Feature>
124124 </Feature>
125125
126−
126+
127127 <!-- Set properties for add/remove programs -->
128128 <Property Id="ARPURLINFOABOUT" Value="http://pandoc.org" />
129129 <Property Id="ARPHELPLINK" Value="http://pandoc.org" />
130130 <Property Id="ARPNOREPAIR" Value="yes" Secure="yes" /> <!-- Remove repair -->
131131 <Property Id="ARPNOMODIFY" Value="yes" Secure="yes" /> <!-- Remove modify -->
132132
133−
133+
134134 <!--Needed for WixUI_Advanced-->
135135 <Property Id="ApplicationFolderName" Value="Pandoc" />
136136 <Property Id="WixAppFolder" Value="WixPerUserFolder" />
137−
137+
138138 <!--For Single Package for dual purpose i.e. per User/Machine-->
139139 <!--<Property Id="ALLUSERS" Value="2" Secure="yes" />-->
140140 <Property Id="MSIINSTALLPERUSER" Value="1" />
@@ -145,7 +145,7 @@
145145 <CustomAction Id="SetExitDialogOptText"
146146 Property="WIXUI_EXITDIALOGOPTIONALTEXT"
147147 Value="!(loc.ExitDialogText)" />
148−
148+
149149 <!--Offer Per User installs only on workstations (block on servers)-->
150150 <!--Unless ALLUSERS=1 is specified on command line-->
151151 <SetProperty Id="WixUISupportPerUser" Value="0" Before="FindRelatedProducts">
@@ -177,12 +177,12 @@
177177 NOT Installed
178178 </Custom>
179179 </InstallUISequence>
180−
180+
181181 <UIRef Id="WixUI_Advanced_Custom"/>
182182 <!--Enable better description when debug logging-->
183183 <UIRef Id="WixUI_ErrorProgressText" />
184−
184+
185185 </Product>
186−
187−
186+
187+
188188</Wix>