[Kimchi-devel] [PATCH 0/4] Add DITA help pages

Adam King rak at linux.vnet.ibm.com
Thu Feb 13 18:59:59 UTC 2014


Tested and it works. I have a couple requests:

1. Rename these files to make the match between Kimchi and the help simpler:
  ui/pages/help/kimhstor.dita => ui/pages/help/storage.dita
  ui/pages/help/kimhtempl.dita => ui/pages/help/templates.dita
  ui/pages/help/kimhvirtm.dita => ui/pages/help/guests.dita

2. Generate an index.html with a simple table of contents linking to 
each of the help files. (Can be done in a subsequent patch)

3. Do some styling on the html. The text is readable but plain. (Can be 
done in a subsequent patch)


Thanks! Good work!
Adam

On 2/11/2014 3:02 PM, Crístian Viana wrote:
> Hi!
>
> This is the first patchset which adds the DITA help pages do Kimchi.
> Please read each patch's comment to find out more details about them.
>
> To test the new patches, run Kimchi (locally, via RPM or DEB) and type the
> following URL:
>
>      http://localhost:8000/help/kimhstor.html
>
> A simple HTML page should be displayed.
>
> Crístian Viana (4):
>    doc: Add DITA help pages
>    doc: Add help files to dist packages
>    doc: Export the help pages to cherrypy
>    doc: Ignore the generated files
>
>   .gitignore                    |  1 +
>   configure.ac                  |  1 +
>   contrib/DEBIAN/control.in     |  2 +-
>   contrib/kimchi.spec.fedora.in |  5 ++++
>   contrib/kimchi.spec.suse.in   |  5 ++++
>   docs/README.md                |  7 ++---
>   src/kimchi/server.py          |  5 ++++
>   ui/pages/Makefile.am          |  2 +-
>   ui/pages/help/Makefile.am     | 34 +++++++++++++++++++++++++
>   ui/pages/help/dita-help.xsl   | 24 ++++++++++++++++++
>   ui/pages/help/kimhstor.dita   | 45 +++++++++++++++++++++++++++++++++
>   ui/pages/help/kimhtempl.dita  | 59 +++++++++++++++++++++++++++++++++++++++++++
>   ui/pages/help/kimhvirtm.dita  | 47 ++++++++++++++++++++++++++++++++++
>   13 files changed, 232 insertions(+), 5 deletions(-)
>   create mode 100644 ui/pages/help/Makefile.am
>   create mode 100644 ui/pages/help/dita-help.xsl
>   create mode 100644 ui/pages/help/kimhstor.dita
>   create mode 100644 ui/pages/help/kimhtempl.dita
>   create mode 100644 ui/pages/help/kimhvirtm.dita
>

-- 
Adam King <rak at linux.vnet.ibm.com>
IBM CSI




More information about the Kimchi-devel mailing list