[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: User Guide status?



On Tue, Jan 06, 2009 at 12:44:41PM -0500, Betty Harvey wrote:
> As of Friday, I have converted the available pieces of the Users Guide to
> Docbook XML.  I don't know where to upload the files so I still have them.

In coordination with the rest of the User Guide team, you want to
upload them to the git repository.

To start, install git:

  sudo yum install git

Then, clone the repository:

  git clone ssh://<username>@git.fedorahosted.org/git/docs/userguide.git

The repository is entirely blank, save for an initiating file (I
think.)

From there you want to install Publican, create a blank book, put that
in the repository, and then start adding your XML files.

  cd userguide/
  sudo yum install publican
  ...
  create_book --name=User_Guide --brand=fedora --lang=en-US --type=Book
  cp /path/to/converted/*.xml User_Guide/en-US/

Using Publican is covered in the Publican guide:

  https://fedorahosted.org/publican

Using git, there are a number of good tutorials.  You can start here:

  https://fedoraproject.org/wiki/Git_Quickref
  http://book.git-scm.com/index.html

> I created a PDF of the users guide and sent a copy out to the group on
> Friday (or Saturday).
> 
> When other pieces are completed I will convert those as well.  The
> conversion process is pretty smooth now - only occasional minor
> tweaks.

Similarly to the XML, we want to get working code, configurations, and
usage READMEs in to the 'fedora-doc-utils' repository:

  https://fedorahosted.org/fedora-doc-utils/

That way other people can do the conversions, etc.

> I used the standard Docbook XSLT's to create the PDF - it would probably
> be worthwhile to run the file through Publican (I don't know where a
> copy of that stylesheet resides).

  rpm -ql publican|grep xsl
  /usr/share/publican/xsl
  /usr/share/publican/xsl/CatalogManager.properties
  /usr/share/publican/xsl/changelog.xsl
  /usr/share/publican/xsl/defaults.xsl
  /usr/share/publican/xsl/docbook.dtd.xml
  /usr/share/publican/xsl/dt_htmlsingle_spec.xsl
  /usr/share/publican/xsl/dt_xml_spec.xsl
  /usr/share/publican/xsl/eclipse.xsl
  /usr/share/publican/xsl/html-single.xsl
  /usr/share/publican/xsl/html.xsl
  /usr/share/publican/xsl/htmlhelp.xsl
  /usr/share/publican/xsl/omf.xsl
  /usr/share/publican/xsl/pdf.xsl
  /usr/share/publican/xsl/saxon65.jar
  /usr/share/publican/xsl/sub_package_htmlsingle.xsl
  /usr/share/publican/xsl/sub_package_xml.xsl
  /usr/share/publican/xsl/subtitle.xsl
  /usr/share/publican/xsl/txt.xsl
  /usr/share/publican/xsl/web-spec.xsl
  /usr/share/publican/xsl/xhtml-common.xsl

- Karsten
-- 
Karsten 'quaid' Wade, Community Gardener
http://quaid.fedorapeople.org
AD0E0C41

Attachment: pgpu2VvLQyADh.pgp
Description: PGP signature


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]