Mercurial > mozilla > hg > DocumentIt
annotate README.txt @ 26:ce7cbf3e08e1 default tip
fix bug with local files, index.html, and manifest order
| author | Jeff Hammel <jhammel@mozilla.com> |
|---|---|
| date | Thu, 04 Aug 2011 18:43:12 -0700 |
| parents | 0ce6b501f62d |
| children |
| rev | line source |
|---|---|
| 9 | 1 # DocumentIt |
| 0 | 2 |
| 25 | 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 | |
|
21
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
30 |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
31 |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
32 ## TODO |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
33 |
| 25 | 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: | |
|
21
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
43 |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
44 - inclusion of other files |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
45 - inclusion of `--help` documentation |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
46 |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
47 In general the approach taken shouldn't compromise the general |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
48 approach that the documentation should be the documentation, not |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
49 pre-documentation. This may be achieved by the use of (e.g. regex) |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
50 macros. For instance: |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
51 |
|
10c5e6d11ef8
add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
52 append(--help.*$,shell(mozmill --help)) |