Hi all,
We are deprecating the old wiki-maintained manual in favor of a
Sphinx-based manual. Sphinx is the documentation system used by Python and
hundreds of other open-source projects.
The reasons for using Sphinx are:
* Translations will be a snap -- Sphinx can export PO templates which we
just upload to Launchpad.
* Support for exporting the manual in HTML, PDF, and QtHelp formats.
* Support for maintaining a glossary of terms.
* Searchable -- sphinx has a built in search feature
* Indexable -- the manual text will be indexed by Google and associated
with the pagerank of mixxx.org
* Version-controlled -- we can keep track of old changes and branch the
manual just as we do for code. This allows us to maintain a 1.10.x manual
at the same time as a 1.11.x manual. That way, point releases of the 1.10.x
series of Mixxx will not include manual tidbits from the 1.11.x series.
This is key for not confusing users.
Additionally, we will be requiring new feature merges to also include
manual updates. As we lock more and more professional-level features into
place, having a top-quality manual will be key to helping us retain new
users and make them comfortable with Mixxx. I think especially with the
opportunities for QtHelp integration, we could make the manual a nicely
integrated part of using Mixxx.
Please check out a beta version of the manual -- it has most of the
material from the old manual and new material covering some 1.10.x features:
http://mixxx.org/manual/latest
You can check out the corresponding code to the manual here:
https://code.launchpad.net/~mixxxdevelopers/mixxx/manual
The branch information has details on how to compile it and some guides for
learning the syntax of restructured text (ReST).
As we have manuals for each series, we will host them on mixxx.org with the
following style:
http://mixxx.org/manual/1.10
http://mixxx.org/manual/1.11
http://mixxx.org/manual/2.0
etc. and the 'latest' link will always point to the latest stable release
manual.
Thanks, and get documenting!
RJ
------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure
contains a definitive record of customers, application performance,
security threats, fraudulent activity, and more. Splunk takes this
data and makes sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-novd2d
_______________________________________________
Mixxx-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mixxx-devel
