Debian Codegraph @

tableconvert/README

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