On Tue, Mar 02, 2010 at 12:30:48 -0500, Mark Stosberg wrote:
> Where I can learn more about the "hunk matching" mentioned in the ChangeLog?

darcs help patterns has a couple of word about it

The contents of this are also repeated in the man page and the user
manual.

Your mail gave me the urge to write a note on the state of our
documentation (mostly from asking Trent on IRC about it).

If I understand Trent correctly, the end goal is to have (a) most
documentation editable by anyone and (b) a core set of the documentation
managed with tight editorial control by somebody with a global view on
the core set.  Things from (a) that is particularly clear and helpful
will eventually seep into (b).

Kinds of documentation
----------------------
- online help (darcs help foo; darcs foo --help)
- man page
- html manual on the web
- pdf manual
- wiki

Formats and technology used
----------------------------
- Help text written as Haskell strings

   - used in online help (darcs help foo; darcs foo --help)
   - inserted in man page w/ build scripts (darcs help manpage)
   - inserted in manual with build scripts, ie. interspersed w/ literate stuff

- Literate Haskell comments in LaTeX

   - compiled into pdf manual
   - compiled into html manual (latex2html)

- ReStructuredText

   - turned into wiki pages via Pandoc/Darcsit
   - [experimental] transformed into nice PDF via docutils

As I understand it, we are largely moving away from LaTeX and towards
reST, but because we want the transition to be smooth, we're starting
with an intermediate consolidation phase where bits of LaTeX get
translated into Haskell strings.  This means that content which was
formerly only in the online/pdf manual will now also show up in the
online help and the man page.  I'm not entirely sure how reST fits into
this (except that it's being used in the wiki).  Perhaps it is simply
that case that our help text Haskell strings are reST formatted...

-- 
Eric Kow <http://www.nltg.brighton.ac.uk/home/Eric.Kow>
PGP Key ID: 08AC04F9

Attachment: signature.asc
Description: Digital signature

_______________________________________________
darcs-users mailing list
[email protected]
http://lists.osuosl.org/mailman/listinfo/darcs-users

Reply via email to