Unpublishing draft documentation using Publican

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Publican.cfg file)
(Publican.cfg file)
Line 49: Line 49:
 
Be sure that you understand (and require) the effect of any other parameters specified in this file.  
 
Be sure that you understand (and require) the effect of any other parameters specified in this file.  
  
{{admon/warning|If you do not remove these parameters from the publican.cfg file, you will damage the site navigation menu the next time anyone publishes this book.}}
+
{{admon/warning|If you do not remove the ''version'' and ''web_version_label'' parameters from the publican.cfg file, you will damage the site navigation menu the next time anyone publishes this book.}}
  
 
==Republish the book==
 
==Republish the book==

Revision as of 02:22, 1 November 2010

If you have previously published a book or article in the "Draft Documentation" section on docs.fedoraproject.org (as described at Publishing draft documentation using Publican) make the following changes before you publish a version for a particular Fedora release:

Contents

Remove the book from the website

Warning (medium size).png
Be sure to remove the book from the website before you alter the Book_Info.xml or publican.cfg files.

Follow the instructions in Publishing a document with Publican to remove the draft book from the website. If the book was published in more than one language, be sure to remove it in all the languages in which is was published.

Book_Info.xml (or Article_Info.xml)

  • Change the <productname> tag to Fedora
  • Add the Fedora release for which this document is to be published to the <productnumber> tag.

For example, the relevant lines should now look like this:

	<productname>Fedora</productname>
	<productnumber>14</productnumber>
  • Check the <edition> tag and remove any Fedora release number contained there. The first edition of the book for any release of Fedora will be edition 1.0.

Therefore, if the <edition> tag contains something like:

	<edition>14.0.1</edition>

change it to:

	<edition>1.0</edition>


Publican.cfg file

  • Delete any lines containing the parameters version or web_version_label from the book or article's publican.cfg file.

A typical publican.cfg file looks like:

# Config::Simple 4.59
# Thu Dec  3 08:57:41 2009

xml_lang: en-US
type: Book
brand: fedora

Be sure that you understand (and require) the effect of any other parameters specified in this file.

Warning (medium size).png
If you do not remove the version and web_version_label parameters from the publican.cfg file, you will damage the site navigation menu the next time anyone publishes this book.

Republish the book

Follow the instructions in Publishing a document with Publican to upload the new version of the book.