README
1Tableconvert
2============
3
4.. contents::
5
6
7About
8-----
9
10Tableconvert is a plugin which helps on converting a tabulator
11separated selection into a table.
12
13
14Installation
15------------
16
17This version of the plugin is installed with the combined
18geany-plugins release. Please check README of this package.
19
20
21Usage
22-----
23
24After the plugins has been installed successfully, load the plugin via
25Geany's plugin manager. This will add a new keybinding into Geany's
26list of keybindings inside the preferences dialog. You might like to
27set up a keybinding for the function. Once this is done, the plugin is
28ready to use. Alternativly it's also possible to use the plugin via the
29menu entry at the Tools menu.
30
31Inside the Tools menu there is also another submenu avaialble wich is
32allowing you to convert to a table without changing Geany's file type
33settings for the current document.
34
35When using the plugin, just mark the area you like to transform and
36push your keybinding. All line endings will be taken as end of a row
37and therefor transformed to fitting row endings. The plugin is taking
38care of you line ending stil.
39
40Currently the plugin is supporting
41* HTML
42* LaTeX
43* SQL
44
45Rectangle selections are currently not supported and might lead to
46some weird output you didn't expect -- just don't try it if you have
47heart issues or working on an important document :)
48
49HTML
50^^^^
51
52When transforming HTML, line endings will be replace with <tr> and
53</tr>. Occurrences of tabulator will be interpreted as column
54separators and replaced by <td> and </td>.
55
56The first line will be treaded as header and surrounded by
57<thead></thead> tags. The rest of the table will be included into
58<tbody></tbody>.
59
60
61LaTeX
62^^^^^
63
64In case of working with LaTeX line endings will be replaced with \\
65and tabulators with &.
66
67
68However, after you transformed your selection to a table you might
69want to update the number and orientation of columns at begin of
70tabular-environment.
71
72SQL
73^^^
74
75At SQL line endings will be replaced with with closing braces )
76followed by a komma if is not the last line.
77
78Tabulators will be repace with ', ', so in the end, a tabulator
79seperated liste as e.g.
80
81foo baa
82baa foo
83
84will be transformed to
85
86
87| (
88| ('foo', 'baa'),
89| ('baa', 'foo')
90| )
91
92
93Development
94-----------
95
96You can checkout the current source code from the git repository at
97github.com. Get the code by:
98
99git clone https://github.com/geany/geany-plugins.git
100
101If you want to create a patch, please respect the license of
102Tableconvert as well as intellectual property of third. Patches that
103should be included to the default distribution must be licensed under
104the same conditions as Tableconvert by the copyright owner (GPL2+).
105
106
107Known issues
108------------
109
110The plugin currently is not supporting rectangle selections very
111well. Also it is not able to support <thead> and <tbody> at the
112moment. However, at least the second point is planned for some later
113release.
114
115For more recent information reported issues will be tracked at
116https://github.com/geany/geany-plugins/issues
117
118
119License
120-------
121
122Tableconvert and all its parts is distributed under the terms of the
123GNU General Public License as published by the Free Software
124Foundation; either version 2 of the License, or (at your option) any
125later version. A copy of this license can be found in the file COPYING
126included with the source code of this program. If not, you will be
127able to get a copy by contacting the Free Software Foundation, Inc.,
12851 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
129
130
131Bugs, questions, bugs, homepage
132-------------------------------
133
134If you found any bugs or want to provide a patch, please contact Frank
135Lanitz (frank(at)geany(dot)org). Please also do so, if you got any
136questions.
137