From 5b186000d31eecd90de83f2598d99e2f72d038ed Mon Sep 17 00:00:00 2001 From: Jared K. Smith Date: Aug 08 2014 14:15:36 +0000 Subject: Update the "Why Docbook" section --- diff --git a/en-US/Documentation_for_Beginners.xml b/en-US/Documentation_for_Beginners.xml index 0b97382..8acb55e 100644 --- a/en-US/Documentation_for_Beginners.xml +++ b/en-US/Documentation_for_Beginners.xml @@ -6,7 +6,8 @@ - + + diff --git a/en-US/Why_DocBook.xml b/en-US/Why_DocBook.xml new file mode 100644 index 0000000..0815625 --- /dev/null +++ b/en-US/Why_DocBook.xml @@ -0,0 +1,65 @@ + + +%BOOK_ENTITIES; +]> + + + Why DocBook? + + DocBook has many features which make it suitable for + documentation in Fedora and other projects. + +
+ DocBook as an XML Markup Language + + DocBook is an implementation of + Extensible Markup Language (XML) + . XML gives DocBook powerful + flexibility. + +
+
+ Human-readable Tags + + DocBook tags are generally self-explaining. + They are named after what they define, even + though shorter terms might make more effiecient + use of space. This makes it easy for writers + and editors to quickly look at a document and + understand how it is constructed. + +
+
+ Text-based Format for Easy Revision Control + + Version control provides two critical features + for collaborative documentation work: + concurrent editing and history. The text-based + format of DocBook makes it well-suited to + being managed by a version control system. + +
+
+ Separation Between Content and Style + + The DocBook standard separates a document's + content and its formatting. The writer uses XML + tags to structure the elements of document, and + the formatting can be changed independently + later. A change to the formatting of an element + does not require changing every instance of that + element. + +
+
+ Output in a Variety of Formats + + DocBook is a source format. The + publican tool is used to + generate rendered documents in several different + formats. publican can generate HTML, PDF, and + epub formats from the same source file. + +
+ diff --git a/en-US/why_docbook.xml b/en-US/why_docbook.xml deleted file mode 100644 index 0815625..0000000 --- a/en-US/why_docbook.xml +++ /dev/null @@ -1,65 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - Why DocBook? - - DocBook has many features which make it suitable for - documentation in Fedora and other projects. - -
- DocBook as an XML Markup Language - - DocBook is an implementation of - Extensible Markup Language (XML) - . XML gives DocBook powerful - flexibility. - -
-
- Human-readable Tags - - DocBook tags are generally self-explaining. - They are named after what they define, even - though shorter terms might make more effiecient - use of space. This makes it easy for writers - and editors to quickly look at a document and - understand how it is constructed. - -
-
- Text-based Format for Easy Revision Control - - Version control provides two critical features - for collaborative documentation work: - concurrent editing and history. The text-based - format of DocBook makes it well-suited to - being managed by a version control system. - -
-
- Separation Between Content and Style - - The DocBook standard separates a document's - content and its formatting. The writer uses XML - tags to structure the elements of document, and - the formatting can be changed independently - later. A change to the formatting of an element - does not require changing every instance of that - element. - -
-
- Output in a Variety of Formats - - DocBook is a source format. The - publican tool is used to - generate rendered documents in several different - formats. publican can generate HTML, PDF, and - epub formats from the same source file. - -
-