From github
Go to file
Clement Lefebvre 7f38755543 Removed Caja dependencies 2016-01-25 15:52:34 +00:00
.tx Add transifex configuration file 2013-04-02 15:55:50 +02:00
data Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
debian Override xedit bin and man page (from x11-apps) 2016-01-25 15:34:04 +00:00
docs Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
help Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
m4 warning: underquoted definition of AM_CHECK_PYMOD 2011-11-07 17:16:09 -03:00
pixmaps Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
plugin-loaders Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
plugins Removed Caja dependencies 2016-01-25 15:52:34 +00:00
po Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
tests Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
tools Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
xedit Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
AUTHORS update for 1.2 release and fix executable bits 2012-03-11 20:28:11 +01:00
COPYING Fix incorrect-fsf-address rpmlint check 2013-04-17 00:58:25 +02:00
ChangeLog Add empty ChangeLog to allow build from git 2013-04-02 15:49:54 +02:00
HACKING Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
Makefile.am Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
NEWS Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
NEWS.GNOME Rename NEWS => NEWS.GNOME 2013-01-24 20:43:04 +01:00
README Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
autogen.sh Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00
configure.ac Rename Pluma to Xedit 2016-01-25 15:33:34 +00:00

README

General Information
===================

xedit is a small and lightweight UTF-8 text editor for the MATE
environment. Based on gedit, the text editor for the GNOME2 environment.

xedit is part of MATE and uses the latest GTK+ and MATE libraries.
Complete MATE integration is featured, with support for Drag and Drop (DnD)
from Caja (the MATE file manager), the use of the MATE help system,
the MATE Virtual File System and the MATE print framework.

xedit uses a Multiple Document Interface (MDI), which lets you edit more than
one document at the same time.

xedit supports most standard editing features, plus several not found in your
average text editor (plugins being the most notable of these).

xedit plugins may also be written in the python scripting language: to enable
python support you need the pygtk and mate-python-desktop bindings.

Although new features are always under development, currently xedit has:

    * Complete support for UTF-8 text
    * Syntax highlighting
    * Support for editing remote files
    * Search and Replace
    * Printing and Print Previewing Support
    * File Revert
    * A complete preferences interface
    * Configurable Plugin system, with optional python support


Some of the plugins, packaged and installed with xedit include, among others:

    * Word count
    * Spell checker
    * Change case of selected text
    * File Browser
    * Automatic snippet expansion
    * Sort
    * Insert Date/Time
    * External Tools
    * Tag list

Other external plugins are also available.


xedit is released under the GNU General Public License (GPL) version 2, see
the file 'COPYING' for more information.


The official web site is:

    http://www.mate-desktop.org/

You can download the latest xedit tarball from:

    https://pub.mate-desktop.org/releases/

Installation
============

xedit requires GTK+-2.16.x, GtkSourceView 2.4.x and MateConf libraries.
PyGobject 2.12.x, PyGtk 2.12.x and PyGtkSourceView 2.4.x are required to
enable python plugins support.

Simple install procedure:

  % gzip -cd mate-text-editor.tar.gz | tar xvf - 	# unpack the sources
  % cd mate-text-editor				# change to the toplevel directory
  % ./autogen.sh				# run the `configure' script
  % make					# build xedit
  [ Become root if necessary ]
  % make install				# install xedit


Running Tests
==================
Xedit has several test that can be run after compilation. Run them by issueing "make check". However there are a couple of requirements that need to be satified before they will pass.

* You need the gsettings schemas installed for some tests to be able to run.
* You need to mount sftp://localhost/ with gvfs-mount for one test to pass.

If test fail and you have setup the above correctly then please file a bug report as described below.

How to report bugs
==================

Bugs should be reported to the MATE bug tracking system.
(https://github.com/mate-desktop/xedit/issues). You will need to create an
account for yourself.

You can also report bugs using the MATE program bug-buddy.

In the bug report please include:

* Information about your system. For instance:

   - What operating system and version
   - What version of X
   - What version of the gtk+, glib and mate libraries
   - For Linux, what version of the C library

  And anything else you think is relevant.

* How to reproduce the bug.

* If the bug was a crash, the exact text that was printed out when the
  crash occurred.

* Further information such as stack traces may be useful, but is not
  necessary. If you do send a stack trace, and the error is an X error,
  it will be more useful if the stack trace is produced running the test
  program with the --sync command line option.


Patches
=======

Patches should also be submitted to github.com/mate-desktop/xedit. If the patch
fixes an existing bug, add the patch as an attachment to that bug
report.

Otherwise, enter a new bug report that describes the patch, and attach
the patch to that bug report.

Patches should be in unified diff form. (The -u option to GNU diff.)

If you are interested in helping us to develop xedit, please see the
file 'AUTHOR' for contact information and/or send a message to the xedit
mailing list. See also the file 'HACKING' for more detailed information.


  The xedit team.