diff options
| author | sakib <[email protected]> | 2019-05-16 01:08:55 +0600 |
|---|---|---|
| committer | raveit65 <[email protected]> | 2019-05-16 12:16:00 +0200 |
| commit | c4dffd769c574184cc7a9bd3eab128ffd6a60801 (patch) | |
| tree | df489a94125fc94d16dd5c649fe9235fe4c1a9c2 | |
| parent | af2f5a6846c53451a7c20aee8d6826c2c89d6971 (diff) | |
| download | pluma-c4dffd769c574184cc7a9bd3eab128ffd6a60801.tar.bz2 pluma-c4dffd769c574184cc7a9bd3eab128ffd6a60801.tar.xz | |
add readmes and update plugins section of manual
| -rw-r--r-- | help/C/index.docbook | 29 | ||||
| -rw-r--r-- | plugins/README.md | 3 | ||||
| -rw-r--r-- | plugins/changecase/README.md | 3 | ||||
| -rw-r--r-- | plugins/docinfo/README.md | 3 | ||||
| -rw-r--r-- | plugins/filebrowser/README.md | 3 | ||||
| -rw-r--r-- | plugins/modelines/README.md | 3 | ||||
| -rw-r--r-- | plugins/sort/README.md | 3 | ||||
| -rw-r--r-- | plugins/spell/README.md | 3 | ||||
| -rw-r--r-- | plugins/taglist/README.md | 3 | ||||
| -rw-r--r-- | plugins/time/README.md | 3 | ||||
| -rw-r--r-- | plugins/trailsave/README.md | 3 |
11 files changed, 56 insertions, 3 deletions
diff --git a/help/C/index.docbook b/help/C/index.docbook index c3d9889c..4d97757b 100644 --- a/help/C/index.docbook +++ b/help/C/index.docbook @@ -1782,7 +1782,7 @@ </listitem> <listitem> <para> - <application><!-- <link linkend="pluma-file-browser-plugin">File Browser</link>-->File Browser</application> allows you to browse your files and folders in the side pane.</para> + <xref linkend="pluma-file-browser-plugin"/> allows you to browse your files and folders in the side pane.</para> </listitem> <listitem> <para> @@ -1806,6 +1806,11 @@ </listitem> <listitem> <para> + <xref linkend="pluma-trailsave-plugin"/> allows you to strip trailing whitespaces in your document after saving. + </para> + </listitem> + <listitem> + <para> <xref linkend="pluma-snippets-plugin"/> allows you to store frequently-used pieces of text and insert them quickly into a document. </para> </listitem> @@ -2074,9 +2079,9 @@ <section xml:id="pluma-file-browser-plugin"> <info> - <title>File Browser Plugin</title> + <title>File Browser Pane Plugin</title> </info> - <para>The <application>File Browser</application> Plugin shows your files and folders in the side pane, allowing you to quickly open files.</para> + <para>The <application>File Browser Pane</application> Plugin shows your files and folders in the side pane, allowing you to quickly open files.</para> <para>To view the File Browser, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Side Pane</guimenuitem> </menuchoice> and then click on the tab showing the File Browser icon at the bottom of the side pane.</para> <section xml:id="pluma-file-browser-plugin-browsing"> @@ -2251,6 +2256,24 @@ </caution> </section> + <section xml:id="pluma-trailsave-plugin"> + <info> + <title>Save Without Trailing Spaces Plugin</title> + </info> + <para>The <application>Save Without Trailing Spaces</application> Plugin removes whitespace characters such as space (<command>˽</command>), tab (<command>\t</command>), carriage returns (<command>\r</command>) etc. from the end of a line. To use the Save Without Trailing Spaces plugin, perform the following steps:</para> + <orderedlist inheritnum="ignore" continuation="restarts"> + <listitem> + <para>Enable the plugin as described in <xref linkend="pluma-prefs-plugins"/>.</para> + </listitem> + <listitem> + <para>When your document is ready, save it.</para> + </listitem> + <listitem> + <para>You will see that any trailing whitespaces has been stripped after the document has been saved.</para> + </listitem> + </orderedlist> + </section> + <section xml:id="pluma-snippets-plugin"> <info> <title>Snippets Plugin</title> diff --git a/plugins/README.md b/plugins/README.md new file mode 100644 index 00000000..7e0d9220 --- /dev/null +++ b/plugins/README.md @@ -0,0 +1,3 @@ +## This is the plugins directory for pluma. If you want to write a plugin, you have to put the plugin folder here. Each plugin folder must contain a README file having a brief description of the plugin. See the other folders for better understanding. + +**NOTE:** As of now, all Python 2 plugins (external tools, indent lines, python console, snippets) are disabled until they are ported to Python 3 (see PR [#425](https://github.com/mate-desktop/pluma/pull/425)).
\ No newline at end of file diff --git a/plugins/changecase/README.md b/plugins/changecase/README.md new file mode 100644 index 00000000..7f9dadad --- /dev/null +++ b/plugins/changecase/README.md @@ -0,0 +1,3 @@ +# Change case Plugin + +The Change Case plugin changes the case of the selected text, like uppercase to lowercase and vice versa. To know more, see the **Plugins** section of the pluma user manual.
\ No newline at end of file diff --git a/plugins/docinfo/README.md b/plugins/docinfo/README.md new file mode 100644 index 00000000..a8c0fafd --- /dev/null +++ b/plugins/docinfo/README.md @@ -0,0 +1,3 @@ +# Document Statistics Plugin + +The Document Statistics plugin counts the number of lines, words, characters with spaces, characters without spaces, and bytes in the current file, all in a separate dialog called *Document Statistics*. To know more, see the **Plugins** section of the pluma user manual.
\ No newline at end of file diff --git a/plugins/filebrowser/README.md b/plugins/filebrowser/README.md new file mode 100644 index 00000000..2933e66a --- /dev/null +++ b/plugins/filebrowser/README.md @@ -0,0 +1,3 @@ +# File Browser Pane Plugin + +The File Browser Pane plugin shows your files and folders in the side pane, allowing you to quickly open files. To know more, see the **Plugins** section of the pluma user manual.
\ No newline at end of file diff --git a/plugins/modelines/README.md b/plugins/modelines/README.md new file mode 100644 index 00000000..f0023c82 --- /dev/null +++ b/plugins/modelines/README.md @@ -0,0 +1,3 @@ +# Modelines Plugin + +A modeline is a line of text at the start or end of the document with settings that pluma recognises. Hence with this plugin, you can set preferences for individual documents like tab width, text wrapping etc. To know more about its use, see the **Plugins** section of the pluma user manual.
\ No newline at end of file diff --git a/plugins/sort/README.md b/plugins/sort/README.md new file mode 100644 index 00000000..722c276b --- /dev/null +++ b/plugins/sort/README.md @@ -0,0 +1,3 @@ +# Sort Plugin + +The Sort plugin arranges selected lines of text into alphabetical order. To know more, see the **Plugins** section of the pluma user manual.
\ No newline at end of file diff --git a/plugins/spell/README.md b/plugins/spell/README.md new file mode 100644 index 00000000..ca4a3dad --- /dev/null +++ b/plugins/spell/README.md @@ -0,0 +1,3 @@ +# Spell Checker Plugin + +The Spell Checker plugin checks the spelling in the selected text, which can be performed both automatically and manually as desired, in any language. To know more about its use, see the **Plugins** section of the pluma user manual.
\ No newline at end of file diff --git a/plugins/taglist/README.md b/plugins/taglist/README.md new file mode 100644 index 00000000..ceb9f361 --- /dev/null +++ b/plugins/taglist/README.md @@ -0,0 +1,3 @@ +# Tag List Plugin + +The Tag List plugin allows you to insert common tags from a list in the side pane. To know more about its use, see the **Plugins** section of the pluma user manual.
\ No newline at end of file diff --git a/plugins/time/README.md b/plugins/time/README.md new file mode 100644 index 00000000..8b2f81c2 --- /dev/null +++ b/plugins/time/README.md @@ -0,0 +1,3 @@ +# Insert Date/Time Plugin + +The Insert Date/Time plugin inserts the current date and time into a document. To know more about its use, see the **Plugins** section of the pluma user manual.
\ No newline at end of file diff --git a/plugins/trailsave/README.md b/plugins/trailsave/README.md new file mode 100644 index 00000000..76c4152d --- /dev/null +++ b/plugins/trailsave/README.md @@ -0,0 +1,3 @@ +# Save Without Trailing Spaces Plugin + +Save Without Trailing Spaces plugin removes whitespace characters such as space (``˽``), tab (``\t``), carriage returns (``\r``) etc. from the end of a line. To know how to use it, see the **Plugins** section of the pluma user manual.
\ No newline at end of file |