How to convert from fedora-doc-utils to Publican

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(adding new page and some content to it)
 
(updating with where I am so far)
Line 2: Line 2:
 
[[Category:Docs Project process]]
 
[[Category:Docs Project process]]
  
 +
# Install Publican and the Fedora branding: <pre>su -c "yum install publican publican-fedora"</pre>
 
# Make sure you have an updated source set from the version control system
 
# Make sure you have an updated source set from the version control system
 
# Branch as appropriate for new work, e.g.: <code>git branch f11-publican-conversion</code>
 
# Branch as appropriate for new work, e.g.: <code>git branch f11-publican-conversion</code>
 +
# Switch to the branch, e.g.: <code>git checkout f11-publican-conversion</code>
 +
# The XML is written in a primary language, for example, US English.  This is needs to be stored in a sub-directory that is named in a method acceptable to Publican: ''lang''-''country''.  For example, <code>en-US</code>.  If the guide used a different method, the XML-holding directory needs to be created or renamed: <pre>git mv en_US en-US</pre>
 +
#* Commit fine-grained activities changes regularly
 +
# Create a blank Publican book for parts harvesting: <pre>cd /tmp;
 +
create_book --name=Guide_Name --brand=fedora --lang=en-US --type=Book</pre>
 +
# Copy in the template <code>Makefile</code>: <pre>cd /path/to/guide_name ; cp /tmp/Guide_Name/Makefile ./</pre>
 +
# If there are existing translations to work from, add the language codes in to the Publican-based Makefile

Revision as of 17:53, 28 December 2008


  1. Install Publican and the Fedora branding:
    su -c "yum install publican publican-fedora"
  2. Make sure you have an updated source set from the version control system
  3. Branch as appropriate for new work, e.g.: git branch f11-publican-conversion
  4. Switch to the branch, e.g.: git checkout f11-publican-conversion
  5. The XML is written in a primary language, for example, US English. This is needs to be stored in a sub-directory that is named in a method acceptable to Publican: lang-country. For example, en-US. If the guide used a different method, the XML-holding directory needs to be created or renamed:
    git mv en_US en-US
    • Commit fine-grained activities changes regularly
  6. Create a blank Publican book for parts harvesting:
    cd /tmp; 
    
create_book --name=Guide_Name --brand=fedora --lang=en-US --type=Book
  1. Copy in the template Makefile:
    cd /path/to/guide_name ; cp /tmp/Guide_Name/Makefile ./
  2. If there are existing translations to work from, add the language codes in to the Publican-based Makefile