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

[Ajit George <ajitgeorge sympatico ca>]

Hi everyone,

Sorry for the delay.  Things have been pretty rough over the past few
weeks.  But don't worry - I didn't forget gedit :)

At any rate - I've finished the documentation on the remaining plugins
and I need some advice as to what to fix etc.  All comments are welcome
- I want to make this documentation really good so that GNOME2 can be a
great desktop!

One thing - I couldn't get the CVS changelog plugin to work.  Its greyed
out on my copy of gedit (GARNOME 0.17.x).  Is it still being worked on?

Hope this documentation is good...

Regards,
Allen

Title: CVS Changelog Plugin

...

********DONEISH*********

The tag list plugin allows you to insert commonly used tags into your document without typing them. To use the <>Tag List<> plugin choose View Item . The Tag list plugin dialog contains the list of tags you can add to your document. The following tag types are available: Tag Name Use HTML - Tags Tags used in HTML files HTML - Special Characters Special character tags for HTML files Latex - Tags Tags used in Latex formatted files Choose the tag type you want from the drop down list. Select the location in your document where you want the tag to be placed. Select the Tag list plugin dialog and double-click the tag you want to insert. The tag will be inserted at the selected location in your current document. When you are finished adding all the tags you need you can close the Tag list plugin dialog. ------------------------------------------------------ The <>Compare Files Plugin<> compares two files and creates a list of differences. You must configure the <>Compare Files Plugin<> before you use it. Please refer to for help on configuring the <>Compare Files<> plugin<>. To use the <>Compare Files Plugin<> choose File Compare Files . The Compare two files... dialog has the Help, Cancel and Compare buttons. The Help displays the &app; help. The Cancel closes the Compare two files... without comparing any files. The Compare compares two files using the choices you made. To compare two files, you must first choose the two documents to compare. The Compare two files... dialog is split into the First and Second sections. These are the two files you are comparing. By default both are set to the first document opened in &app;. You can choose to compare a file that is currently opened in &app; or one that is on the disk. To choose a file that you have opened in &app; Select the From document radio button. Select the document you want to compare from the drop down list. To choose a file that is on disk Select the From a file on disk. Enter the location of the file in the text box. You can also choose the document by clicking the Browse... and selecting the file from the Select the file... dialog. Select both files you want to compare by following the same steps in the First and Second section. To have the comparison output in the unified output format, select the check box next to the Use the unified output format (-u option) option. This option is on by default. For more information on the unified output format, please check the diff manual entry. To have the comparison compare blank lines, select the check box next to the Ignore blanks (-b option) option. This option is on by default. Click Compare to compare both the files. A new file containing the output is opened. You should configure the <>Compare Files<> plugin before using it. To configure the plugin choose Edit Preferences . In the Preferences dialog, choose Plugins Manager . In the Manager subcategory you can see a list of plugins available in &app;. Choose the Compare Files item from the list. Then click the Configure Plugin button. The Set program location... dialog has the Help, Cancel and the Ok. The Helpdisplays the &app; help file. The Cancel closes the dialog without making any changes to your program location settings. The Okcloses the dialog and saves the changes you made. The <>Compare Files<> plugin uses a program called diff to get its output. You must set the location of this program. The default is <>/usr/bin/diff<>. This default will work on most systems. To set a new program location, enter the path to the program in the Location to search for text box. You can also select the program location by clicking the Browse... button and selecting the correct location in the Browse for program location... dialog. Select the correct program location and click the Ok button. Click the Close button on the Preferences dialog to close the dialog and return to &app;. ------------------------------------------------- The <>Insert Shell Output<> plugin allows you to capture the output from a shell command in &app;. To use the <>Insert Shell Output<> plugin choose Edit Insert Shell Output . The Shell Output has the Help, Close and Run buttons. The Help dialog displays the &app; help file. The Close button closes the Shell Output dialog without running any shell commands. The Run runs the currently entered command. To run a shell command enter your command in the Shell command text box. To change the directory that the command will run in, change the entry in the Working Directory text box. You can also change the working directory by choosing the Browse... and choosing the correct directory in the Select the working directory... dialog. By default the Working Directory is set to your home directory. To see the command output in &app; select the check box next to Capture the command output. By default this check box is selected. Click Run to run the command. If you do not enter a command and click the Run button then you will get an error message. If you did not select the check box next to Capture the command output the command will execute but the output will not be displayed. If the check box is selected, a new file containing the command output is opened. ---------------------------------------------------------------- The <>Insert Date/Time<> plugin allows you to insert the current date and time into a document. To use the <>Insert Date/Time<> plugin, select the format you want your date/time in. Please refer to for help on changing your date/time format. Click the position in the document where you want the date/time to be inserted. Choose Edit Insert Date/Time . You can change the format of the date and time before you insert them into your document. To change your settings, choose Edit Preferences . In the Preferences dialog, choose Plugins Manager . In the Manager subcategory you can see a list of plugins available in &app;. Choose the Insert Date/Time item from the list. Then click the Configure Plugin button. The Configure insert date/time plugin dialog has the Help, Cancel and the Ok. The Helpdisplays the &app; help file. The Cancel closes the dialog without making any changes to your date/time settings. The Okcloses the dialog and saves the changes you made. The Configure insert date/time plugin dialog displays a list of available date/time formats you can use. Select the format you want to use and click the Ok button. Click the Close button on the Preferences dialog to close the dialog and return to &app;. ------------------------------------------------------------------------------------- The <>ASCII Table plugin allows you to insert ASCII characters into a document. To use the <>ASCII Table plugin, choose View ASCII Table. The ASCII Table dialog lists the following information: Title Meaning Char Displays the ASCII character. This is the character displayed when it is inserted into the currently selected document Dec# The decimal number of the ASCII character Hex# The hexadecimal number of the ASCII character Name The name of the ASCII character The ASCII Table dialog has the Help, Close and Insert char buttons. The Help button displays the &app; help file. The Close button closes the ASCII Table dialog. ------------------------------------------------------------------------------------ You can use the <>Word Count plugin to count the number of words in your document. To use this plugin, choose Search Word Count . The Word Count dialog lists the following information: Name Meaning Lines Displays the number of lines in the selected document Words Displays the number of words in the selected document Characters (with spaces) Displays the number of characters including spaces, in the selected document Characters (no spaces) Displays the number of characters excluding spaces, in the selected document Bytes Displays the size of the selected document in bytes The Close button closes the Word Count dialog. The Update button updates the information in the Word Count dialog if changes were made to the currently selected document. You can still update your current document while the Word Count dialog is open.