Re: [gedit-list] gedit tasks (user documentation for the plugins) [Start of Documentation]

[Ajit George <ajitgeorge sympatico ca>]

Hi,

	Here's what I've done so far.  I'm aiming to have the rest done bye
next week hopefully (real life perimitting ;)).  I would appreciate any
comments.  It would be great to have them now so I can apply them to the
stuff I will write.

	One thing - the date plugin and other plugins have a conifguration
dialog.  Are these subsections of the "Using the date/time plugin"
section or are they sections in their own right?

Insert Shell Output

CVS Changelog

Tag list

Compare files

*****DONEISH*****

<sect2 id="gedit-insert-date-time-plugin">
<title>Insert Date/Time Plugin</title>

<para>The <>Insert Date/Time<> plugin allows you to insert the current date and time into a document.  To use the <>Insert Date/Time<> plugin, click the position in the document where you want the date/time to be inserted.  Choose

<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Insert Date/Time</guimenuitem>
</menuchoice>.
</para>

	<sect3 id="gedit-change-date-time-prefs">
	<title>Changing the Insert Date/Time Plugin Preferences</title>
		<para>You can change the format of the date and time before you insert them into your document.  To change your settings, choose
		<menuchoice>
		<guimenu>Edit</guimenu>
		<guimenuitem>Preferences</guimenuitem>
		</menuchoice>.
		The <

</sect2>

*****1stDRAFT*****

-------------------------------------------------------------------------------------

<sect1 id="gedit-plugin-usage">

<sect2 id="gedit-ascii-table-plugin">
<title>ASCII Table Plugin</title>

<para>
The <>ASCII Table</> plugin allows you to insert ASCII characters into a document.  To use the <>ASCII Table</> plugin, choose
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>ASCII Table</guimenuitem>.  
</menuchoice>
The <guilabel>ASCII Table</guilabel> dialog lists the following information:
</para>
<informaltable frame="topbot"> 
	<tgroup cols="2"> 
	<colspec colname="col1"/> 
	<colspec colname="col2"/> 
	<thead> 
	<row valign="top">
		<entry colname="col1" colsep="0" valign="top"><para>Title</para></entry>
		<entry colname="col2" valign="top"><para>Meaning</para></entry> 
		</row> 
		</thead>
		<tbody> 
		<row valign="top"> 
			<entry><para>Char</para></entry> 
			<entry><para>Displays the ASCII character.  This is the character displayed when it is inserted into the currently selected document</para></entry> 
		</row>  
		<row valign="top"> 
			<entry><para>Dec#</para></entry> 
			<entry><para>The decimal number of the ASCII character</para></entry> 
		</row>
		<row valign="top"> 
			<entry><para>Hex#</para></entry> 
			<entry><para>The hexadecimal number of the ASCII character</para></entry> 
		</row> 
		<row valign="top"> 
			<entry><para>Name</para></entry> 
			<entry><para>The name of the ASCII character</para></entry> 
		</row> 
		</tbody> 
		</tgroup>
		</informaltable> 
<para>
The <guilabel>ASCII Table</guilabel> dialog has the <guibutton>Help</guibutton>, <guibutton>Close</guibutton> and <guibutton>Insert char</guitton>.  The <guibutton>Help</guibutton> button displays the <application>&app;</application> help file.  The <guibutton>Close</guibutton> button closes the <guilabel>ASCII Table</guilabel> dialog.
</para>
</sect2>
------------------------------------------------------------------------------------
<sect2 id="gedit-user-name-plugin</sect2>
<title>User Name Plugin</title>

<para>
You can use the <>User Name</> plugin to insert your user name in the currently selected document.  To use this plugin, click the position in your document where you want the name to be inserted.  Choose
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Insert User Name</guimenu>
</menuchoice>.
</para>
</sect2>
------------------------------------------------------------------------------------
<sect2 id="gedi-word-count-plugin</sect2>
<title>Word Count Plugin</title>

<para>
You can use the <>Word Count</> plugin to count the number of words in your document.  To use this plugin, choose
<menuchoice>
<guimenu>Search</guimenu>
<guimenuitem>Word Count</guimenuitem>
</menuchoice>.
The <guilabel>Word Count</guilabel> dialog lists the following information:</para>
<informaltable frame="topbot"> 
	<tgroup cols="2"> 
	<colspec colname="col1"/> 
	<colspec colname="col2"/> 
	<thead> 
	<row valign="top">
		<entry colname="col1" colsep="0" valign="top"><para>Name</para></entry>
		<entry colname="col2" valign="top"><para>Meaning</para></entry> 
		</row> 
		</thead>
		<tbody> 
		<row valign="top"> 
			<entry><para>Lines</para></entry> 
			<entry><para>Displays the number of lines in the selected document</para></entry> 
		</row>  
		<row valign="top"> 
			<entry><para>Words</para></entry> 
			<entry><para>Displays the number of words in the selected document</para></entry> 
		</row>
		<row valign="top"> 
			<entry><para>Characters (with spaces)</para></entry> 
			<entry><para>Displays the number of characters including spaces, in the selected document</para></entry> 
		</row> 
		<row valign="top"> 
			<entry><para>Characters (no spaces)</para></entry> 
			<entry><para>Displays the number of characters excluding spaces, in the selected document</para></entry> 
		</row> 
		<row valign="top"> 
			<entry><para>Bytes</para></entry> 
			<entry><para>Displays the size of the selected document in bytes</para></entry> 
		</row> 

		</tbody> 
		</tgroup>
		</informaltable> 

<para>
The <guibutton>Close</guibutton> button closes the <quilabel>Word Count</guilabel> dialog and allows you to edit the currently selected document.  The <guibutton>Update</guibutton> button updates the information in the <guilabel>Word Count</guilabel> dialog if changes were made to the currently selected document.
</para>
</sect2>
</sect1>