Wortsammler (colloquial German for word collector) is an environment to maintain doucmentation in markdown and publish it in various formats for different audiences. It originated in some project specific hacks wrapping around pandoc. But now I refactored it since I use it in more than two projects now and think it might be beneficial for others as well.
Typical application of Wortsammler is user manuals, project documents, user manuals.
Particular features of wortsammler are
Basically Wortsammler comprises of
a directory structure for source document sources
a manifest file to control the publication process
a command line tool to produce the doucments (wortsammler
)
Wortsammler is built on top of other open source tools, in particular:
I did not invent new markdown syntax to implement the features mentioned aforehead. In other words, any wortsammler flavored markdown file should reasonably be processed in standalone pandoc. I implemented particular patterns which are boiled down to either vanilla pandoc markdown or to LaTeX / HTML.
The features are based on three appraoches:
$ gem install wortsammler
In order to use Wortsammler, you need to install the prerequisites:
ruby 1.9.3 of course
pandoc 1.9.4.2 or above
I plan to upgrade to 1.11.1 asap
tex, in particular xelatex 3.1415926-2.4-0.9998
wortsammler -h
wortsammler -pi readme.md -o.
-- generates readme.pdf
wortsammler -pi readme.md -f pdf:docx:html -o.
-- generates readme.pdf, readme.html, readme.docx
wortsammler -bi readme.md
-- beautifies readme.md (normalizes the markdown)
wortsammler -bi .
-- recursively beautifies all markdown files in the current folder
wortsammler init <folder>
This command generates the proposed directory structure, a first document manifest and a rake file to do the processing.
The rakefile is in <folder>/30_Sources/ZSUPP_Tools
rake -T -- show all rake tasks
rake sample -- format the sample document
String
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)MIT: http://www.opensource.org/licenses/mit-license.php
Please use Ruby 1.9.3
mac:
gem install wortsammler
windows
development kit installieren DevKit-tdm-32-4.5.2-20111229-1559-sfx.exe
Das braucht man nur, wenn man den Windows-Debugger verwenden muss. In den scripten ist rquire ruby-debug aukommentiert.
mac: download http://tug.org/mactex/
windows:
Alternatively you can use