[documentation-guide: 1/3] Added tool sections
by Eric Christensen
commit 912820e76e53c9cc032e811097d1cb26da33f9bd
Author: Eric Christensen <eric(a)christensenplace.us>
Date: Sun Sep 11 11:58:42 2011 -0400
Added tool sections
en-US/translations.xml | 6 +++++-
1 files changed, 5 insertions(+), 1 deletions(-)
---
diff --git a/en-US/translations.xml b/en-US/translations.xml
index 869ae07..d2edc43 100644
--- a/en-US/translations.xml
+++ b/en-US/translations.xml
@@ -9,6 +9,10 @@
<para>The Fedora Documentation Team utilizes the <ulink url="https://www.transifex.net">Transifex</ulink> platform for providing pot files to translators and receiving po files for publishing onto the <ulink url="https://docs.fedoraproject.org">Fedora Documentation website</ulink>.</para>
<section id="sect-documentation_guide-translations-tools">
<title>Tools for working with Transifex</title>
- <para/>
+ <para></para>
+ <section id="sect-documentation_guide-translations-tools-installing">
+ <title>Installing the Transifex tools</title>
+ <para/>
+ </section>
</section>
</chapter>
12 years, 8 months
[user-guide] Removed information from Media section to stop duplicated work
by Zach Oglesby
commit c3de5560a74d934ba050cc6125f949f5b537eabc
Author: Zach Oglesby <oglesbyzm(a)gmail.com>
Date: Sun Sep 11 11:57:41 2011 -0400
Removed information from Media section to stop duplicated work
en-US/Book_Info.xml | 6 +-
en-US/Media.xml | 252 +-------------------------------------------------
en-US/User_Guide.ent | 2 +-
publican.cfg | 2 +
4 files changed, 11 insertions(+), 251 deletions(-)
---
diff --git a/en-US/Book_Info.xml b/en-US/Book_Info.xml
index e400ac6..625b1f0 100644
--- a/en-US/Book_Info.xml
+++ b/en-US/Book_Info.xml
@@ -5,9 +5,9 @@
<bookinfo id="book-User_Guide-User_Guide">
<title>User Guide</title>
<subtitle>Using Fedora &PRODVER; for common desktop computing tasks</subtitle>
- <productname>Fedora</productname>
- <productnumber>14</productnumber>
- <edition>1.0</edition>
+ <productname>Fedora Draft Documentation</productname>
+ <productnumber></productnumber>
+ <edition>16.0.1</edition>
<pubsnumber>1</pubsnumber>
<abstract>
<para>The Fedora User Guide is focused on the end-user looking to
diff --git a/en-US/Media.xml b/en-US/Media.xml
index 0eb0716..af06b82 100644
--- a/en-US/Media.xml
+++ b/en-US/Media.xml
@@ -3,253 +3,11 @@
]>
<chapter id="chap-User_Guide-Media">
- <title>Media</title>
- <para>
- When you insert or connect <firstterm>media</firstterm> such as a CD, DVD, hard drive, or flash drive, to your computer, the desktop enviroments in Fedora automatically recognizes the media and make it available for use. In GNOME, a <application>Nautilus</application> file manager window appears displaying the media's contents, and you can also find the media in the Activities overview by typing <token>files</token> in the search bar (it will be listed under <guilabel>Places and Devices</guilabel>). On the <application>KDE</application> desktop an icon is placed in the bottom panel next to the <application>pager</application>.
- </para>
- <para>
-<!-- you do not need to umount in KDE? -->
- In <application>GNOME</application> you should <firstterm>unmount</firstterm> media before removing it from the computer. To do this, right-click on the device's icon and then select <guilabel>Unmount Volume</guilabel> or <guilabel>Eject</guilabel>, depending on what type of media you are using. During this process any remaining changes to the data on the media are <firstterm>written</firstterm> to the device, allowing safe removal without data loss. If you remove media without unmounting it first, you could cause data to be corrupted or lost.
- </para>
- <para>
- There are several multi-media applications available for <application>GNOME</application> and <application>KDE</application> desktops. These applications will run in either Fedora desktop environment. To install software packages not already installed, refer to <xref linkend="chap-User_Guide-Managing_software" />. You can install applications either by using the <application>PackageKit</application> application or on the command line by using <application>Yum</application>.
- </para>
- <section id="sect-User_Guide-Media-ISO_images">
- <title>ISO images</title>
- <para>
- The instructions in this chapter refer to <firstterm>image files</firstterm> at various points. In this context, an <firstterm>image file</firstterm> (or <firstterm>disc image</firstterm>) is an archive file of an <firstterm>optical disc</firstterm>, in a format defined by the International Organization for Standardization (ISO). ISO image files typically have an <filename>.iso</filename> extension. The name ISO is taken from the <firstterm>ISO 9660 file system</firstterm> used with CD-ROM media, but an ISO image can also contain <firstterm>Universal Disk Format</firstterm> (UDF) file system because UDF is backward-compatible with ISO 9660. An ISO image includes all the data of files contained on the archived CD or DVD. They are stored in an uncompressed format.
- </para>
- <para>
- In addition to data of the files it also contains all the file system metadata, including boot code, structures, and attributes. ISO images do not support <firstterm>multi-track</firstterm>, thus they cannot be used for audio CDs, VCD, and hybrid audio CDs.
- </para>
+ <title>Media Creation</title>
+ <section>
+ <para>
+ For guides related to the creation of media please see the <citetitle>Burning ISO Images Guide</citetitle> or <citetitle>Live Images Guide</citetitle> on <ulink>http://docs.fedoraproject.org</ulink>
+ </para>
</section>
-
- <section id="sect-User_Guide-Media-Writing_CDs_or_DVDs">
- <title>Writing CDs or DVDs</title>
- <para>
- Fedora includes support for writing to CDs and DVDs. This means that you can permanently <firstterm>burn</firstterm> files to CDs or DVDs for backup, file transport, or any other reason.
- </para>
- <note>
- <title>Required hardware</title>
- <para>
- Not all optical drives (CD or DVD drives) are equipped to burn new media. An easy way to check whether that you can burn optical media is to look at the front of your disc drive. It should indicate the drive's capabilities. You can also look up the model of your drive on line. An even easier way is to simply try burning a disc; chances are, if you cannot select the option for burning discs, it is not a problem with Fedora; your drive simply does not support this operation.
- </para>
- </note>
- <section id="sect-User_Guide-Writing_CDs_or_DVDs-Using_Brasero_in_GNOME">
- <title>Using Brasero in GNOME</title>
- <para>
- <application>Brasero</application> is the default GNOME application for burning audio and video media. It can also be used to backup data or to burn an ISO image. To launch the program, go to the Activities overview. Type the first few letters of the application's name, then click on the icon that appears or press <keycap>Enter</keycap>. Alternatively, look for the <application>Brasero</application> icon in <menuchoice><guimenu>Applications</guimenu><guimenuitem>Accessories</guimenuitem></menuchoice>.
- </para>
- <para>
- When first launched, the left side of <application>Brasero</application> features buttons to create a new project. This can be an audio project, data project, video project, or it can be a project to copy a disk or burn an image.
-Once you choose a new project type, <application>Brasero</application> will provide instructions for that project. For example, to burn and Audio CD, click the <guilabel>Audio Project</guilabel> button or select <menuchoice><guimenu>Project </guimenu><guisubmenu> New Project </guisubmenu><guisubmenu> New Audio Project</guisubmenu></menuchoice>. On the following screen click the plus icon to add open a file browser and select files for the project.
- </para>
- <para>
-When you are ready to burn your CD/DVD, select the image or media at the bottom of the application and click the <guilabel>Burn...</guilabel> button. If you need to delay burning your media, you can save your project and return to it later. Use the <menuchoice><guimenu>Project</guimenu></menuchoice> menu for these options.
- </para>
- </section>
-
- <section id="sect-User_Guide-Writing_CDs_or_DVDs-Using_K3b_to_burn_media_in_KDE">
- <title>Using K3b to burn media in KDE</title>
- <!-- [[Image:Docs_Drafts_DesktopUserGuide_Media_k3b.png]] -->
- <para>
- <application>K3b</application> is included on the Live-KDE media but is not installed by default from the Gnome Live CD or the DVD. If you do not have access to the Internet, you can use the Fedora DVD to install <application>K3b</application>. After you install <application>K3b</application>, using one of the methods described above, launch the program by clicking the <menuchoice><guimenu>Kickoff Application Launcher </guimenu><guisubmenu> Applications </guisubmenu><guisubmenu> Multimedia </guisubmenu><guisubmenu> K3b</guisubmenu></menuchoice>.
- </para>
- <para>
- When the application opens the <firstterm>action buttons</firstterm> are displayed at the bottom of the window:
- <itemizedlist>
- <listitem>
- <para>
- <guilabel>New Data CD Project</guilabel>
- </para>
- </listitem>
- <listitem>
- <para>
- <guilabel>New Audio CD Project</guilabel>
- </para>
- </listitem>
- <listitem>
- <para>
- <guilabel>Copy Medium...</guilabel>
- </para>
- </listitem>
- <listitem>
- <para>
- <guilabel>More actions...</guilabel>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- To add files to your <application>K3b</application> project, drag the files into the project pane at the bottom of the screen. Everything in this project pane will be burned to your optical medium.
- </para>
- <para>
- When you are ready to burn the files or folders to disk click the <guilabel>Burn</guilabel> button. If you need to delay burning the media, you can use the menus at the top to save your work and return at a later time.
- </para>
- <para>
- To burn an ISO image file, use the <menuchoice><guimenu>Tools </guimenu><guisubmenu> Burn Image</guisubmenu></menuchoice>. Navigate to and select the .iso image, then click the <guilabel>Start</guilabel> button.
- </para>
- </section>
-
-
-
- </section>
-
- <section id="sect-User_Guide-Media-Making_bootable_USB_media">
- <title>Making bootable USB media</title>
- <para>
- With the <application>liveusb-creator</application> tool, you can set up USB media to hold a bootable copy of Fedora. This allows you to run Fedora on a computer without making any changes to the computer's hard drive, as long as the computer is capable of booting from USB media, and is set up to do so.
- </para>
- <para>
- To create a bootable copy of Fedora on USB media, you will need:
- <itemizedlist>
- <listitem>
- <para>
- a USB media device with at least 1 GB of free space will work for most images but 2 GB of free space is strongly recommended. USB media often comes in the form of flash devices sometimes called pen drives, thumb disks, or keys; or as an externally connected hard disk device. Almost all media of this type is formatted as a vfat file system. You can create bootable USB media on media formatted as ext2, ext3, or vfat.
- </para>
- <note>
- <title>USB Image Writing is Non-destructive</title>
- <para>
- Existing data on the media is not harmed and there is no need to repartition or reformat your media. However, it is always a good idea to back up important data before performing sensitive disk operations.
- </para>
- </note>
- <note>
- <title>Unusual USB media</title>
- <para>
- In a few cases with oddly formatted or partitioned USB media, the image writing may fail.
- </para>
- </note>
- <para>
- The Fedora installation using the Fedora Live CD will occupy about 1 GB. Beyond this, you might want to allocate space for Fedora to store files such as documents or software installations. These documents and programs will be available to you every time you start a computer with this USB media device, since they are stored on the device itself and not on the computer to which it is attached. This feature is a major advantage of running Fedora from Live USB media rather than from a Live CD.
- </para>
- </listitem>
- <listitem>
- <para>
- a copy of the Fedora Live CD or Fedora KDE Live CD, or a connection to the Internet. The <application>liveusb-creator</application> tool copies the files from a Fedora Live CD or Fedora KDE Live CD to create bootable USB media. If you do not have a Fedora Live CD or Fedora KDE Live CD, <application>liveusb-creator</application> can download a CD image from the Internet. However, because this CD image is a very large file, you might find this approach impractical if you do not have a broadband Internet connection.
- </para>
- </listitem>
- <listitem>
- <para>
- the <application>liveusb-creator</application> tool, for Fedora or Microsoft Windows. Instructions for obtaining this tool appear in the following sections specific to each operating system.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <section id="sect-User_Guide-Making_bootable_USB_media-USB_image_creation_in_Windows">
- <title>USB image creation in Windows</title>
- <orderedlist>
- <listitem>
- <para>
- Download the <application>liveusb-creator</application> program for Microsoft Windows at <ulink url="http://fedorahosted.org/liveusb-creator">http://fedorahosted.org/liveusb-creator</ulink>.
- </para>
- </listitem>
- <listitem>
- <para>
- Follow the instructions given at the site and in the <application>liveusb-creator</application> program to create the bootable USB media.
- </para>
- </listitem>
- </orderedlist>
- </section>
-
- <section id="sect-User_Guide-Making_bootable_USB_media-USB_image_creation_in_Fedora">
- <title>USB image creation in Fedora</title>
- <para>
- To install <application>liveusb-creator</application> in GNOME, go to the Activities overview. TType <token>add</token> into the search field, then select on the <application>Add/Remove Programs</application> icon that appears. Alternatively, look for the <application>Add/Remove Programs</application> icon in <menuchoice><guimenu>Applications</guimenu><guimenuitem>System Tools</guimenuitem></menuchoice>. This will open the <application>Add/Remove Software</application> application. Searching for <literal>liveusb-creator</literal> and install it by ticking on the box next to it and clicking on <guilabel>Apply</guilabel>.
- </para>
- <para>
- You can also install the application from the command line with the following command:
- </para>
-
-<screen>
-# yum install liveusb-creator
-</screen>
- <para>
- To open <application>liveusb-creator</application>, go to the Activities overview. Type the first few letters of the application's name, then click on the icon that appears or press <keycap>Enter</keycap>. Alternatively, look for the <application>liveusb-creator</application> icon in <menuchoice><guimenu>Applications</guimenu><guimenuitem>System Tools</guimenuitem></menuchoice>. To create live USB media,
- <orderedlist>
- <listitem>
- <para>
- Enter the root password if prompted.
- </para>
- </listitem>
- <listitem>
- <para>
- Choose whether to <menuchoice><guimenu>Use existing Live CD</guimenu></menuchoice> and specify its location on your comptuer, or to <menuchoice><guimenu>Download Fedora</guimenu></menuchoice> and select a file from the <firstterm>drop-down menu</firstterm>.
- </para>
- </listitem>
- <listitem>
- <para>
- Select your <guilabel>Target Device</guilabel> for your Fedora installation, such as a USB memory stick.
- </para>
- </listitem>
- <listitem>
- <para>
- select how much <guilabel>Persistent Storage</guilabel> you want. This is space that Fedora can use to hold documents and other files.
- </para>
- </listitem>
- </orderedlist>
- </para>
- <para>
- After you have made all of your choices just press the <guilabel>Create Live USB</guilabel> button to start the process.
- </para>
- <para>
- Visit the <ulink url="http://fedorahosted.org/liveusb-creator">liveusb-creator web page</ulink> or the Fedora Wiki <ulink url="http://fedoraproject.org/wiki/How_to_create_and_use_Live_USB">How to Create a Live USB</ulink> page for more information.
- </para>
- <para>
- Another option to create a USB Image is:
- </para>
- <important>
- <title>Advanced usage</title>
- <para>
- This content is written for the more advanced user. It assumes that you are comfortable with the command line and have a relatively good knowledge of Linux terminology. It is probably not necessary to using Fedora as a desktop user, but can help a desktop user expand his or her knowledge base and face more complicated troubleshooting issues.
- </para>
- </important>
- <orderedlist>
- <listitem>
- <para>
- Install the ''livecd-tools package'' on your system with the following command:
- </para>
-
-<screen>
-su -c 'yum -y install livecd-tools'
-</screen>
- </listitem>
- <listitem>
- <para>
- Plug in your USB media.
- </para>
- </listitem>
- <listitem>
- <para>
- Find the device name for your USB media. If the media has a volume name, look up the name in <filename>/dev/disk/by-label</filename> or use <command>findfs</command>
- </para>
-
-<screen>
-su -c 'findfs LABEL="MyLabel"'
-</screen>
- <para>
- If the media does not have a volume name, or you do not know it, use <command>blkid</command> or consult the <filename>/var/log/messages</filename> log for details:
- </para>
-
-<screen>
-su -c 'less /var/log/messages'
-</screen>
- </listitem>
- <listitem>
- <para>
- Use the <command>livecd-iso-to-disk</command> command to write the ISO image to the media:
- </para>
-
-<screen>
-su -c 'livecd-iso-to-disk the_image.iso /dev/<replaceable>sdX1</replaceable>'
-</screen>
- <para>
- Replace <replaceable>sdX1</replaceable> with the device name for the partition on the USB media. Most flash drives and external hard disks use only one partition. If you have changed this behavior or have oddly partitioned media, you may need to consult other sources of help.
- </para>
- </listitem>
- </orderedlist>
- </section>
-
- </section>
-
</chapter>
diff --git a/en-US/User_Guide.ent b/en-US/User_Guide.ent
index 2c981c9..36fa3bc 100644
--- a/en-US/User_Guide.ent
+++ b/en-US/User_Guide.ent
@@ -2,4 +2,4 @@
<!ENTITY BOOKID "user-guide">
<!ENTITY YEAR "2010">
<!ENTITY HOLDER "Red Hat, Inc. and others">
-<!ENTITY PRODVER "14">
+<!ENTITY PRODVER "16">
diff --git a/publican.cfg b/publican.cfg
index 870bc81..eec3090 100644
--- a/publican.cfg
+++ b/publican.cfg
@@ -5,3 +5,5 @@ debug: 1
xml_lang: en-US
brand: fedora
+version: 16.0
+web_version_label: UNUSED
12 years, 8 months
[documentation-guide: 1/2] Help flesh out the introduction
by Jared K. Smith
commit b658d5d6751588db5e8a840871821d7f9857598d
Author: Jared K. Smith <jsmith(a)fedoraproject.org>
Date: Sun Sep 11 11:09:29 2011 -0400
Help flesh out the introduction
en-US/introduction.xml | 66 ++++++++++++++++++++++++++++++++++++-----------
en-US/tools.xml | 2 +-
2 files changed, 51 insertions(+), 17 deletions(-)
---
diff --git a/en-US/introduction.xml b/en-US/introduction.xml
index 53363a6..a49b9b8 100644
--- a/en-US/introduction.xml
+++ b/en-US/introduction.xml
@@ -4,22 +4,56 @@
%BOOK_ENTITIES;
]>
<chapter id="chap-documentation_guide-intro">
- <title>Introduction</title>
- <para>
- This chapter will introduce you to some of the best practices that the Fedora Documentation Project uses to help its writers be most productive.
- </para>
- <section>
- <title>Be bold!</title>
- <para/>
- </section>
- <section>
- <title>Don't let the tools scare you</title>
- <para/>
- </section>
- <section>
- <title>There's a team to back you up</title>
- <para/>
- </section>
+ <title>Introduction</title>
+ <para>This chapter will introduce you to some of the best
+practices that the Fedora Documentation Project uses to help its writers
+be most productive. </para>
+ <section>
+ <title>Purpose of this guide</title>
+ <para/>
+ </section>
+ <section>
+ <title>Tips for success</title>
+ <para>Before we dive into the mechanics of the
+documentation, let's look at some important points that will help ensure
+your success in your documentation efforts.</para>
+ <section>
+ <title>Be bold!</title>
+ <para>Although it might seem a bit trite at first
+ glance, the most important part of writing documentation is writing.
+ There's no need to ask permission before writing... just start
+ writing!</para>
+ </section>
+ <section>
+ <title>Don't let the tools scare you</title>
+ <para>The Fedora documentation group uses a number of
+ different tools, but please don't be intimidated by the tools. A bit of
+ practice and mentoring may be necessary to get proficient with the
+ tools. In the meantime, just write in a text editor of your choice, and
+ the text can always be converted into the proper format at a later time. </para>
+ <para>We will discuss the various tools in <xref
+ linkend="chap-documentation_guide-tools"/>.</para>
+ </section>
+ <section>
+ <title>There's a team to back you up</title>
+ <para>Don't be afraid to ask for assistance. The Fedora
+ documentation team is more than willing to help you both with writing
+ and with learning the tools and workflow. If you're on IRC, join the
+ <literal>#fedora-docs</literal> channel on the Freenode network.
+ <indexterm significance="normal">
+ <primary>IRC (Internet Relay Chat)</primary>
+ <secondary>communicating with the Docs team</secondary>
+ </indexterm>
+ We also have a mailing list where we discuss various issues related to
+ documentation. For more information on the joining the mailing list,
+ visit <ulink
+ url="https://lists.fedoraproject.org/mailman/listinfo/docs"/>.</para>
+ </section>
+ </section>
+ <section>
+ <title>Organization of this guide</title>
+ <para/>
+ </section>
</chapter>
<!--
Local variables:
diff --git a/en-US/tools.xml b/en-US/tools.xml
index 776abd3..adf348e 100644
--- a/en-US/tools.xml
+++ b/en-US/tools.xml
@@ -3,7 +3,7 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "documentation-guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-documentation_guide-Test_Chapter">
+<chapter id="chap-documentation_guide-tools">
<title>XML tools</title>
<para>
This chapter will walk you through a few of the commonly-used XML tools that will make it easier to work with DocBook files.
12 years, 8 months
[documentation-guide] Added information for next version release.
by Eric Christensen
commit 19c7daa7c1457374d5f923b12c1c83479e71d405
Author: Eric Christensen <eric(a)christensenplace.us>
Date: Sun Sep 11 11:09:27 2011 -0400
Added information for next version release.
en-US/Book_Info.xml | 2 +-
en-US/Revision_History.xml | 14 ++++++++++++++
2 files changed, 15 insertions(+), 1 deletions(-)
---
diff --git a/en-US/Book_Info.xml b/en-US/Book_Info.xml
index 49a5b84..8006490 100644
--- a/en-US/Book_Info.xml
+++ b/en-US/Book_Info.xml
@@ -8,7 +8,7 @@
<subtitle>A how-to guide for creating and maintaining documentation for Fedora.</subtitle>
<productname>Fedora Draft Documentation</productname>
<productnumber></productnumber>
- <edition>0.1</edition>
+ <edition>0.22</edition>
<pubsnumber>0</pubsnumber>
<abstract>
<para>
diff --git a/en-US/Revision_History.xml b/en-US/Revision_History.xml
index c7ecdce..5cfdf22 100644
--- a/en-US/Revision_History.xml
+++ b/en-US/Revision_History.xml
@@ -8,6 +8,20 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>0.2-0</revnumber>
+ <date></date>
+ <author>
+ <firstname></firstname>
+ <surname></surname>
+ <email></email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Added the translation chapter.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>0.1-0</revnumber>
<date>Mon Jun 13 2011</date>
<author>
12 years, 8 months
[documentation-guide: 1/3] Added translation chapter and introduction paragraph
by Eric Christensen
commit 511f64863c4cc49617d1f929cd46e1d4f5cbbf1c
Author: Eric Christensen <eric(a)christensenplace.us>
Date: Sun Sep 11 10:58:06 2011 -0400
Added translation chapter and introduction paragraph
en-US/translations.xml | 14 ++++++++++++++
1 files changed, 14 insertions(+), 0 deletions(-)
---
diff --git a/en-US/translations.xml b/en-US/translations.xml
new file mode 100644
index 0000000..869ae07
--- /dev/null
+++ b/en-US/translations.xml
@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "documentation-guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-documentation_guide-translations">
+ <title>Translations</title>
+ <para>Translations are an important piece of the documentation process. If users can't read the native language that the documentation is written in then the documentation isn't helpful to that user and the hard work that went into the documentation isn't being utilized to its fullest extent.</para>
+ <para>The Fedora Documentation Team utilizes the <ulink url="https://www.transifex.net">Transifex</ulink> platform for providing pot files to translators and receiving po files for publishing onto the <ulink url="https://docs.fedoraproject.org">Fedora Documentation website</ulink>.</para>
+ <section id="sect-documentation_guide-translations-tools">
+ <title>Tools for working with Transifex</title>
+ <para/>
+ </section>
+</chapter>
12 years, 8 months