Mercurial > mozilla > hg > DocumentIt

comparison README.txt @ 25:0ce6b501f62d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
first real version
author Jeff Hammel <jhammel@mozilla.com>
date Wed, 03 Aug 2011 19:59:58 -0700
parents 10c5e6d11ef8
children
comparison
equal deleted inserted replaced
24:045544951756 25:0ce6b501f62d
1 # DocumentIt 1 # DocumentIt
2 2
3 Mirror documentation to https://developer.mozilla.org/en/Mozmill 3 DocumentIt renders [markdown]() syntax to HTML and uploads it to the
4 [Mozilla Developer Network](https://developer.mozilla.org/)
5
6 It is run by:
7
8 document-it [options] manifest [manifest] [...]
9
10 See `document-it --help` for options. It will render to a local
11 temporary directory by default but you can specify its output with
12 `--dest` (although you will need to pass `--user` and `--password` to
13 POST data).
14
15
16 ## Manifests
17
18 A manifest is in the form:
19
20 relative_file_path page_name
21 ...
22
23 The file path is relative to the manifest.
24
25 (*TODO: more columns of options may be added in subsequent release to
26 e.g. specify input format and expand macros)
27
28 An example manifest is at
29 http://k0s.org/mozilla/hg/DocumentIt/file/tip/example.manifest
4 30
5 31
6 ## TODO 32 ## TODO
7 33
8 There are several features that would be nice to have: 34 Currently, to POST, DocumentIt assumes `curl` is available on the
35 path. This is an obvious deficiency and it should be replaced with a
36 request from (e.g.) `urllib2`.
37
38 In addition to http://developer.mozilla.org it would be nice to POST
39 to `http://wiki.mozilla.org` as well. This would allow staging
40 documents at `wiki.mozilla.org` and then moving to MDN.
41
42 There are other features that would be nice to have:
9 43
10 - inclusion of other files 44 - inclusion of other files
11
12 - inclusion of `--help` documentation 45 - inclusion of `--help` documentation
13 46
14 In general the approach taken shouldn't compromise the general 47 In general the approach taken shouldn't compromise the general
15 approach that the documentation should be the documentation, not 48 approach that the documentation should be the documentation, not
16 pre-documentation. This may be achieved by the use of (e.g. regex) 49 pre-documentation. This may be achieved by the use of (e.g. regex)
17 macros. For instance: 50 macros. For instance:
18 51
19 append(--help.*$,shell(mozmill --help)) 52 append(--help.*$,shell(mozmill --help))
20
21
22
23