1 | General Information |
---|
2 | =================== |
---|
3 | |
---|
4 | This is version 1.1.1 of GtkSourceView. |
---|
5 | |
---|
6 | GtkSourceView is a text widget that extends the standard gtk+ 2.x |
---|
7 | text widget GtkTextView. |
---|
8 | |
---|
9 | It improves GtkTextView by implementing syntax highlighting and other |
---|
10 | features typical of a source code editor. |
---|
11 | |
---|
12 | You can download the latest GtkSourceView tarball from the gnome ftp server: |
---|
13 | |
---|
14 | ftp://ftp.gnome.org/pub/GNOME/sources/gtksourceview |
---|
15 | |
---|
16 | Discussion of GtkSourceView happens in the gnome-devtools@gnome.org |
---|
17 | mailing list. You can subscribe and get further information here: |
---|
18 | |
---|
19 | http://mail.gnome.org/mailman/listinfo/gnome-devtools |
---|
20 | |
---|
21 | |
---|
22 | Installation |
---|
23 | ============ |
---|
24 | |
---|
25 | GtkSourceView requires GTK+-2.4.x, libxml2 2.5.x and libgnomeprint 2.7.x. |
---|
26 | |
---|
27 | Simple install procedure: |
---|
28 | |
---|
29 | % gzip -cd gtksourceview-1.1.1.tar.gz | tar xvf - # unpack the sources |
---|
30 | % cd gtksourceview-1.1.1 # change to the toplevel directory |
---|
31 | % ./configure # run the `configure' script |
---|
32 | % make # build gtksourceview |
---|
33 | [ Become root if necessary ] |
---|
34 | % make install # install gtksourceview |
---|
35 | |
---|
36 | See the file 'INSTALL' for more detailed information. |
---|
37 | |
---|
38 | |
---|
39 | Language spec files format |
---|
40 | ========================== |
---|
41 | |
---|
42 | The Document Type Definition for the XML format used in .lang files is |
---|
43 | located at gtksourceview/language-specs/language.dtd. |
---|
44 | |
---|
45 | The format for regular expressions in the .lang files is the POSIX |
---|
46 | Extended Regular Expression Syntax, plus GNU operators (word operators |
---|
47 | and buffer operators). |
---|
48 | |
---|
49 | There is a limit of 250 keywords in <keyword-list> elements. |
---|
50 | Internally keyword lists generates a branched regular expression |
---|
51 | (i.e. "a|b|c|...") and a bug in GNU libc produces stack corruption |
---|
52 | (hence crashes the application) for more than 250 or so branches. |
---|
53 | |
---|
54 | Longer lists will then be truncated to 250 keywords. To work around |
---|
55 | this, split your keyword list into smaller ones. |
---|
56 | |
---|
57 | |
---|
58 | How to report bugs |
---|
59 | ================== |
---|
60 | |
---|
61 | Bugs should be reported to the GNOME bug tracking system. |
---|
62 | (http://bugzilla.gnome.org, product gtksourceview). |
---|
63 | You will need to create an account for yourself. |
---|
64 | |
---|
65 | You can also report bugs using the GNOME program bug-buddy. |
---|
66 | |
---|
67 | In the bug report please include: |
---|
68 | |
---|
69 | * Information about your system. For instance: |
---|
70 | |
---|
71 | - What operating system and version |
---|
72 | - What version of X |
---|
73 | - What version of the gtk+, glib and gnome libraries |
---|
74 | - For Linux, what version of the C library |
---|
75 | |
---|
76 | And anything else you think is relevant. |
---|
77 | |
---|
78 | * How to reproduce the bug. |
---|
79 | |
---|
80 | * If the bug was a crash, the exact text that was printed out when the |
---|
81 | crash occurred. |
---|
82 | |
---|
83 | * Further information such as stack traces may be useful, but is not |
---|
84 | necessary. If you do send a stack trace, and the error is an X error, |
---|
85 | it will be more useful if the stacktrace is produced running the test |
---|
86 | program with the --sync command line option. |
---|
87 | |
---|
88 | Please check the bugzilla pages for the list of known bugs. |
---|
89 | |
---|
90 | http://bugzilla.gnome.org/buglist.cgi?product=gtksourceview&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED |
---|
91 | |
---|
92 | |
---|
93 | Patches |
---|
94 | ======= |
---|
95 | |
---|
96 | Patches should also be submitted to bugzilla.gnome.org. If the patch |
---|
97 | fixes an existing bug, add the patch as an attachment to that bug |
---|
98 | report. |
---|
99 | |
---|
100 | Otherwise, enter a new bug report that describes the problem the patch |
---|
101 | fixes, and attach it to that bug report. |
---|
102 | |
---|
103 | Bug reports containing patches should include the PATCH keyword in their |
---|
104 | keyword fields. |
---|
105 | |
---|
106 | Patches should be in unified diff form (use the -up options of GNU |
---|
107 | diff and cvs) and should follow the coding style described in the |
---|
108 | HACKING file. |
---|
109 | |
---|
110 | If you are interested in helping us to develop GtkSourceView, please see the |
---|
111 | file 'MAINTAINERS' for contact information and/or send a message to |
---|
112 | the GtkSourceView mailing list. See also the file 'HACKING' for |
---|
113 | information about our CVS guidelines and the file 'TODO' for a list of |
---|
114 | pending tasks. |
---|
115 | |
---|
116 | |
---|
117 | |
---|
118 | The GtkSourceView team. |
---|