In Need of a Tutorial

t u towsonu2003 at gmail.com
Sun Dec 24 19:40:55 UTC 2006


Do you have a tutorial that would walk me thru how to write in the
documentation format and provide patches like the below?

I guess I didn't look hard enough, but can't find such a tutorial.

thanks

Will Simpson wrote:
> Attached is a patch that fixes a few broken links with relative paths.
> 
> 
> ------------------------------------------------------------------------
> 
> Index: ubuntu/C/newtoubuntu/partitionsandbooting.xml
> ===================================================================
> --- ubuntu/C/newtoubuntu/partitionsandbooting.xml	(revision 3548)
> +++ ubuntu/C/newtoubuntu/partitionsandbooting.xml	(working copy)
> @@ -20,7 +20,8 @@
>  					<para><application>Gparted</application> is a graphical tool to edit disk partitions.</para> 
>  					<procedure>
>  						<step>
> -							<para>Install the <application>gparted</application> package (see <xref linkend="add-applications"/>).</para>
> +							<para>Install the <application>gparted</application> package (see <ulink url="../add-applications/add-applications.xml">Add Applications</ulink> section).
> +							</para>
>  						</step>
>  						<step>	
>  							<para>You can run the application with &gparted;.
> @@ -33,7 +34,7 @@
>  				<para>Sometimes it can be useful to run a custom command whenever your computer starts up. To do this:</para>
>  				<procedure>
>  					<step>
> -						<para>Edit the <application>crontab</application> with administrative privileges (see <xref linkend="root-and-sudo"/>):</para>
> +						<para>Edit the <application>crontab</application> with administrative privileges (see <ulink url="administrative.xml">Administrative Tasks</ulink> section):</para>
>  							<screen>sudo crontab -e</screen>
>  					</step>
>  					<step>
> @@ -71,14 +72,14 @@
>  					<step>
>  						<para>
>  							Save the edited file (<ulink
> -                                    url="sample/menu.list_changedefaultosgrub">an example</ulink>)
> +                                    url="../../sample/menu.list_changedefaultosgrub">an example</ulink>)
>  						</para>
>  					</step>
>  				</procedure>
>  		</sect1>
>  		<sect1 status="complete">
>  			<title>Configure startup services</title>
> -				<para>This requires administrative privileges (see <xref linkend="root-and-sudo"/>).</para>
> +				<para>This requires administrative privileges (see <ulink url="administrative.xml">Administrative Tasks</ulink> section).</para>
>  				<procedure>
>  					<step>
>  						<para>Run <application>Services Settings</application>:
> @@ -96,7 +97,7 @@
>  						<para>Select the services you want running, then click <guibutton>OK</guibutton> when done.</para>
>  					</step>
>  					<step>
> -						<para>For greater control over the boot-up services, install the <application>bum</application> from the <quote>Universe</quote> repository (see <xref linkend="add-applications"/>), and run it:
> +						<para>For greater control over the boot-up services, install the <application>bum</application> from the <quote>Universe</quote> repository (see <ulink url="../add-applications/add-applications.xml">Add Applications</ulink> section), and run it:
>  							<menuchoice>
>  								<guimenu>System</guimenu>
>  								<guisubmenu>Administration</guisubmenu>
> 




More information about the ubuntu-doc mailing list