...
 
Commits (831)
AUTHORS
GNOME LaTeX authors
===================
Main author and maintainer
--------------------------
Maintainer
==========
Sébastien Wilmet <swilmet@gnome.org>
Patches
=======
Code contributions
------------------
Matthieu Baerts
Arnaud Blouin
Erwan Bousse
Simon Claessens
Ting-Wei Lan
Kalev Lember
Tanguy Ortolo
Pieter Pareit
Matias De la Puente
Stéphane Roy
Nathan Samson
Translations
============
Andika Triwidada
Aron Xu
Átila Camurça
Bruno Brouard
Christian Kirbach
Claude Paroz
Daniel Mustieles
Daniel Nylander
Fran Dieguez
Frederik Hahne
Johannes Wilde
Jorge González
Kjartan Maraas
Kristjan SCHMIDT
Marek Černocký
Mario Blättermann
Martin Srebotnjak
Matej Urbančič
Miguel Rodriguez
Piotr Drąg
Rudolfs Mazurs
Vito Fasano
Мирослав Николић
Graphic Design
==============
Éric Forgeot (logo, icon and web site)
Graphic design
--------------
Éric Forgeot (logo, icon and first web page)
Ann Melnichuk (a previous icon)
Other
-----
Translators, packagers, bug reporters, ...
See the 'NEWS' file or the version control system's log.
Guidelines for LaTeXila
=======================
LaTeXila source code is maintained using the Git version control system and is
available at the following location:
git://git.gnome.org/latexila
A web interface is available at:
http://git.gnome.org/browse/latexila
You can download the source code from the Git repository by doing:
$ git clone git://git.gnome.org/latexila
Later, to take the new commits you just have to do:
$ git pull
An easy way to build LaTeXila and its dependencies is to use jhbuild
(gnome-world moduleset). Example of a jhbuildrc file for LaTeXila:
https://people.gnome.org/~swilmet/latexila/jhbuildrc
Commits
=======
To create a patch, make first one or several commits (in another branch) and
then use the 'git format-patch' command. You can submit your patch to the
GNOME bugzilla.
A GitHub repository is available, so you can fork it easily:
https://github.com/GNOME/latexila
Git commits should have maximum 72 characters for the first line, followed by a
blank line and then a longer description.
How to not contribute to GNOME LaTeX
====================================
Contributions are no longer welcomed and will not be reviewed or accepted. If
you want to work on gnome-latex, please fork the project. The reason is
because, from my experience, new maintainers want to add features that don't
follow the gnome-latex principles for the user experience [1], and I would
still like to use my application the way I've developed it. And in case I want
to come back and maintain again gnome-latex in the future, I would like it to
be in the same state that I've left it, to avoid the need to fork my own
project.
[1] https://blogs.gnome.org/swilmet/2012/08/19/latexila-some-principles-for-the-user-experience/
Notes to potential developers who want to fork gnome-latex
or for developers wanting to implement a LaTeX editor.
----------------------------------------------------------
I wrote the Vala code when I was a beginner, so some parts may be ugly and not
well implemented. The liblatexila, written in C, is much better implemented.
For the build tools, parsing the commands output is quite fragile, especially
the output of latexmk. And the latex post-processor is full of heuristics, some
warning/error messages are not extracted correctly. With retrospection, it was
a bad idea to implement it like that. To have a more robust implementation, it
would have been better to parse the log file and have a log viewer, see:
https://gitlab.gnome.org/GNOME/gnome-latex/issues/30
In general for my other projects I now try to avoid implementing features that
have a fragile implementation (i.e. something not based on stable APIs, or with
heuristics, etc).
For gnome-latex, if the build tools break in the future, a solution is to
create a container with an older version of TeX Live bundled (or at least an
older version of latexmk bundled).
For the file structure in the side panel, a better implementation would be to
maintain an AST (Abstract Syntax Tree) attached to the GtkSourceBuffer, and by
using GtkSourceRegion. Then this AST can serve for other features, especially
for the auto-completion, or for text folding. For a project with multiple *.tex
files, the AST can be created for files not yet opened in the application; this
would be useful to provide completion for the \ref, \pageref and \cite
commands. See also the Proposal 2 at:
https://wiki.gnome.org/Projects/GtkSourceView/CodeFolding
Previous content of this file:
==============================
GNOME LaTeX is hosted on the GNOME GitLab instance, you can fork the repository
and then do a merge request:
https://gitlab.gnome.org/GNOME/gnome-latex
Read the following wiki page to know the conventions for the commit messages:
https://wiki.gnome.org/Git/CommitMessages
Code conventions
================
----------------
For consistency, there are some conventions to follow when coding.
For consistency, there are some conventions to follow for the code.
For Vala and C:
- no trailing spaces
- use blank lines to space out blocks of code (only one blank line is enough)
- as a general rule of thumb, when modifying a file use the same coding
- No trailing spaces.
- Use blank lines to space out blocks of code (only one blank line is enough).
- Space out each case in a switch, i.e. have a blank line after each 'break;'.
- As a general rule of thumb, when modifying a file use the same coding
style of that file.
For Vala:
- indentation: 4 spaces
- lines: 90 characters maximum (in some cases it can be a little more)
- /* ... */ comments for delimiting code sections
- // ... comments otherwise (e.g. for explaining just one line)
- some spaces almost everywhere:
- function (blah); // not function(blah);
- int num = 5; // not int num=5;
- if (! foo) // not if (!foo)
- for (int i = 0 ; i < max ; i++) // not for(int i=0;i<max;i++)
- Indentation: 4 spaces.
- Lines: 90 characters maximum (in some cases it can be a little more).
- /* ... */ comments for delimiting code sections.
- // ... comments otherwise (e.g. for explaining just one line).
- Curly braces are always on a separate line.
- For one-line blocks (if, for, while, etc), no curly braces.
- Some spaces almost everywhere:
- function (blah); // not function(blah);
- int num = 5; // not int num=5;
- if (!foo) // not if(!foo)
- for (int i = 0; i < max; i++) // not for(int i=0;i<max;i++)
- etc...
- do not use 'var' for declaring variables, unless the type is very long.
The type of a variable is a form of auto-documentation.
- Do not use 'var' for declaring variables, unless the type is very long.
The type of a variable is useful to understand the code, it is a form of
self-documentation.
- Functions with a lot of parameters: when exceeding 90 characters, add a
newline + one indentation level (the same for function declarations and
function calls):
function_call (a_long_parameter1, a_long_parameter2, a_long_parameter3,
a_long_parameter4, a_long_parameter5, a_long_parameter6,
a_long_parameter7, a_long_parameter8);
For C:
- follow the GLib/GTK+ conventions:
https://wiki.gnome.org/Projects/GTK%2B/BestPractices
- indentation: GNU style
- no maximum line length (but short lines are better)
- only /* ... */ comments (for C89 compatibility)
- spacing differences with Vala:
- if (!foo)
- for (int i = 0; i < max; i++)
Debug
=====
How to debug LaTeXila with gdb?
Build LaTeXila with the option -g in the CFLAGS.
Here is how you can get the backtrace after a crash:
$ gdb latexila
> run
[segmentation fault]
> backtrace
> quit
- Follow the same coding style as GtkSourceView:
https://git.gnome.org/browse/gtksourceview/tree/HACKING
- No maximum line length (but short lines are better).
- Function declarations: follow the same style as what the
gcu-lineup-parameters script does, see:
https://github.com/swilmet/gnome-c-utils
- Function calls with a lot of parameters: one parameter per line, aligned
on the opening parenthesis:
function_call (a_long_parameter1,
a_long_parameter2,
a_long_parameter3);
In some cases, groups of parameters can be on the same line, when the
parameters are related (typically a string + value). For example with
g_object_new() to set properties:
return g_object_new (NAMESPACE_TYPE_CLASSNAME,
"property1", value1,
"property2", value2,
NULL);
- Note that the GNU coding style was previously used, all the *.c files
have been converted to the GtkSourceView coding style with the uncrustify
config file (see the scripts/ directory in the GtkSourceView git
repository). The uncrustify config file is maybe not perfect, if you see
a problem the config file can be improved and re-run on all *.c files.
The *.h files have *not* been adapted, because there is no script
available to correctly format function prototypes with the GNOME
conventions, so here is the rule: when you *modify* a *.h file, please
convert it first to the GtkSourceView coding style (mainly to change the
indentation to use tabs), thanks! That way, all the *.h files will be
converted over time. And in the future there will maybe be a script to do
it.
History of LaTeXila/GNOME LaTeX
===============================
I (Sébastien Wilmet) started LaTeXila because I wanted to work on a programming
project during the summer (I was a student at that time). I didn't know which
subject to choose, and I've chosen LaTeX because there was a lack of a good
LaTeX editor based on GTK (i.e. well integrated to GNOME).
The development started in August 2009, in the C language. In the following
months a few versions were released (0.0.1, 0.0.2, 0.1 and 0.2). It had all the
major basic features, and worked quite well. On the other hand, the code
architecture was a disaster, due to a lack of experience and a lack of a good
and recent GLib/GTK introduction for the C language (something that I've now
fixed by writing
[this guide](https://people.gnome.org/~swilmet/glib-gtk-book/)).
Since I like statistics: at the time of the 0.2 version there was 200 Git
commits and 10k lines of C code. The project was hosted entirely on
SourceForge.
In June 2010 I started the rewrite of LaTeXila in Vala. Vala seemed easier,
with a good tutorial and the ability to write Object-Oriented code easily.
LaTeXila 2.0 was released in November 2010. It had all the features of the 0.2
version, plus many improvements. The Git repository was hosted on GitHub, but
the project homepage and downloads were still on SourceForge. The 0.2 -> 2.0
transition reflects the rewrite in Vala. Numbering that version “1.0” was not
suitable, because it would have been seen as an achievement of the 0.x series.
Also, with the 2.0 version number, the GNOME version numbering scheme has been
adopted (even/odd minor version for stable/unstable releases). So the 2.0
version was the achievement of the Vala rewrite, but at the same time a new
beginning for the future of LaTeXila.
In February-June 2011, I worked on LaTeXila as part of a project for my studies
(for my end of bachelor studies project, for which I've had a good grade,
20/20 :p). In the summer 2011, the project was moved to gnome.org, after
reading [this series of articles](http://blogs.gnome.org/johannes/2010/06/04/why-gnome-org/).
GitHub was not convenient for handling translations. During
that period I've also read the book Code Complete
([blog post](http://blogs.gnome.org/swilmet/2012/08/01/about-code-quality-and-maintainability/)),
which improved a lot my programming skills. That's why there has been a lot of
code cleanups during that summer and the next summer.
With time LaTeXila has seen more and more features. During the summer 2012,
another notable change is the switch from CMake to Autotools for the build
system ([blog post](http://blogs.gnome.org/swilmet/2012/09/05/switch-from-cmake-to-autotools/)).
In 2012 I also started to contribute to GtkSourceView, because there were some
bugs in the completion system. And with LaTeXila in good shape, I wanted to
work on something else. I've done a Google Summer of Code in 2013 for
GtkSourceView. Since I was more or less the only developer of LaTeXila, there
was less activity in LaTeXila. But the work in GtkSourceView is of course
beneficial for LaTeXila.
In September 2014, LaTeXila has made a jump from the 2.12 version to 3.14, to
finally have the same versions as GNOME. It is easier to know with which GNOME
version a certain LaTeXila version was developed against.
For the 3.16 version, in March 2015, the build tools engine has been completely
re-written in C, to have more robust and modern code, with a better code
architecture. By contributing to GtkSourceView, I've learned how to write
Object-Oriented code in C with the GObject library. And over time I was less
and less happy with Vala, I prefer C/GObject for developing a GTK application
or library. So I've started a rewrite of LaTeXila in C, but not a complete
rewrite like it was the case for the 2.0 version in Vala, since from the Vala
code it is possible to use features developed in C. So starting with the 3.16
version some chunks of code have been progressively rewritten in C/GObject,
fully documented with GTK-Doc comments and GObject Introspection annotations.
In March 2015, a first fundraiser has been launched. More than €1000 has been
raised, which permitted me to improve the spell-checking and to start the
development of the gspell library. (I was no longer a student at that time).
In September 2016, a second fundraiser has been launched in parallel with a
gspell fundraiser.
TODO: continue history with the creation of the Tepl and Amtk libraries, the
rename of LaTeXila to GNOME LaTeX, and the upcoming 10 years anniversary.
That's the end for now. I hope there will be other important events to relate.
And *you* can be part of this history!
Thanks to all contributors of GNOME LaTeX: developers, translators, packagers,
designers, donors and everybody else!
Installation Instructions
*************************
Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation,
Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved. This file is offered as-is,
without warranty of any kind.
Basic Installation
==================
Briefly, the shell commands `./configure; make; make install' should
configure, build, and install this package. The following
more-detailed instructions are generic; see the `README' file for
instructions specific to this package. Some packages provide this
`INSTALL' file but do not implement all of the features documented
below. The lack of an optional feature in a given package is not
necessarily a bug. More recommendations for GNU packages can be found
in *note Makefile Conventions: (standards)Makefile Conventions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. Caching is
disabled by default to prevent problems with accidental use of stale
cache files.
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'. You need `configure.ac' if
you want to change it or regenerate `configure' using a newer version
of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system.
Running `configure' might take a while. While running, it prints
some messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package, generally using the just-built uninstalled binaries.
4. Type `make install' to install the programs and any data files and
documentation. When installing into a prefix owned by root, it is
recommended that the package be configured and built as a regular
user, and only the `make install' phase executed with root
privileges.
5. Optionally, type `make installcheck' to repeat any self-tests, but
this time using the binaries in their final installed location.
This target does not install anything. Running this target as a
regular user, particularly if the prior `make install' required
root privileges, verifies that the installation completed
correctly.
6. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
7. Often, you can also type `make uninstall' to remove the installed
files again. In practice, not all packages have tested that
uninstallation works correctly, even though it is required by the
GNU Coding Standards.
8. Some packages, particularly those that use Automake, provide `make
distcheck', which can by used by developers to test that all other
targets like `make install' and `make uninstall' work correctly.
This target is generally not run by end users.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that
the `configure' script does not know about. Run `./configure --help'
for details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c99 CFLAGS=-g LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you can use GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'. This
is known as a "VPATH" build.
With a non-GNU `make', it is safer to compile the package for one
architecture at a time in the source code directory. After you have
installed the package for one architecture, use `make distclean' before
reconfiguring for another architecture.
On MacOS X 10.5 and later systems, you can create libraries and
executables that work on multiple system types--known as "fat" or
"universal" binaries--by specifying multiple `-arch' options to the
compiler but only a single `-arch' option to the preprocessor. Like
this:
./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
CPP="gcc -E" CXXCPP="g++ -E"
This is not guaranteed to produce working output in all cases, you
may have to build one architecture at a time and combine the results
using the `lipo' tool if you have problems.
Installation Names
==================
By default, `make install' installs the package's commands under
`/usr/local/bin', include files under `/usr/local/include', etc. You
can specify an installation prefix other than `/usr/local' by giving
`configure' the option `--prefix=PREFIX', where PREFIX must be an
absolute file name.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=DIR' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them. In general, the
default for these options is expressed in terms of `${prefix}', so that
specifying just `--prefix' will affect all of the other directory
specifications that were not explicitly provided.
The most portable way to affect installation locations is to pass the
correct locations to `configure'; however, many packages provide one or
both of the following shortcuts of passing variable assignments to the
`make install' command line to change installation locations without
having to reconfigure or recompile.
The first method involves providing an override variable for each
affected directory. For example, `make install
prefix=/alternate/directory' will choose an alternate location for all
directory configuration variables that were expressed in terms of
`${prefix}'. Any directories that were specified during `configure',
but not in terms of `${prefix}', must each be overridden at install
time for the entire installation to be relocated. The approach of
makefile variable overrides for each directory variable is required by
the GNU Coding Standards, and ideally causes no recompilation.
However, some platforms have known limitations with the semantics of
shared libraries that end up requiring recompilation when using this
method, particularly noticeable in packages that use GNU Libtool.
The second method involves providing the `DESTDIR' variable. For
example, `make install DESTDIR=/alternate/directory' will prepend
`/alternate/directory' before all installation names. The approach of
`DESTDIR' overrides is not required by the GNU Coding Standards, and
does not work on platforms that have drive letters. On the other hand,
it does better at avoiding recompilation issues, and works well even
when some directory options were not specified in terms of `${prefix}'
at `configure' time.
Optional Features
=================
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Some packages offer the ability to configure how verbose the
execution of `make' will be. For these packages, running `./configure
--enable-silent-rules' sets the default to minimal output, which can be
overridden with `make V=1'; while running `./configure
--disable-silent-rules' sets the default to verbose, which can be
overridden with `make V=0'.
Particular systems
==================
On HP-UX, the default C compiler is not ANSI C compatible. If GNU
CC is not installed, it is recommended to use the following options in
order to use an ANSI C compiler:
./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
and if that doesn't work, install pre-built binaries of GCC for HP-UX.
HP-UX `make' updates targets which have the same time stamps as
their prerequisites, which makes it generally unusable when shipped
generated files such as `configure' are involved. Use GNU `make'
instead.
On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
parse its `<wchar.h>' header file. The option `-nodtk' can be used as
a workaround. If GNU CC is not installed, it is therefore recommended
to try
./configure CC="cc"
and if that doesn't work, try
./configure CC="cc -nodtk"
On Solaris, don't put `/usr/ucb' early in your `PATH'. This
directory contains several dysfunctional programs; working variants of
these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
in your `PATH', put it _after_ `/usr/bin'.
On Haiku, software installed for all users goes in `/boot/common',
not `/usr/local'. It is recommended to use the following options:
./configure --prefix=/boot/common
Specifying the System Type
==========================
There may be some features `configure' cannot figure out
automatically, but needs to determine by the type of machine the package
will run on. Usually, assuming the package is built to be run on the
_same_ architectures, `configure' can figure that out, but if it prints
a message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS
KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the option `--target=TYPE' to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script).
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
an Autoconf bug. Until the bug is fixed you can use this workaround:
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
`configure' Invocation
======================
`configure' recognizes the following options to control how it
operates.
`--help'
`-h'
Print a summary of all of the options to `configure', and exit.
`--help=short'
`--help=recursive'
Print a summary of the options unique to this package's
`configure', and exit. The `short' variant lists options used
only in the top level, while the `recursive' variant lists options
also present in any nested packages.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`--prefix=DIR'
Use DIR as the installation prefix. *note Installation Names::
for more details, including other options available for fine-tuning
the installation locations.
`--no-create'
`-n'
Run the configure checks, but stop before creating any output
files.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
Sébastien Wilmet
E-mail: swilmet@gnome.org
Userid: swilmet
ACLOCAL_AMFLAGS = -I m4
SUBDIRS = data man po help src tests docs
DISTCHECK_CONFIGURE_FLAGS = --enable-introspection
@CODE_COVERAGE_RULES@
AM_DISTCHECK_CONFIGURE_FLAGS = \
--enable-gtk-doc \
--enable-introspection \
--enable-vala \
--enable-appstream-util
EXTRA_DIST = \
README \
gnome-latex.doap \
HACKING \
MAINTAINERS \
latexila.doap \
HISTORY.md \
intltool-extract.in \
intltool-merge.in \
intltool-update.in
......@@ -19,68 +22,10 @@ DISTCLEANFILES = \
intltool-update
MAINTAINERCLEANFILES = \
ABOUT-NLS \
aclocal.m4 \
autoscan.log \
compile \
config.guess \
config.h.in \
config.rpath \
config.sub \
configure.scan \
depcomp \
gtk-doc.make \
install-sh \
ltmain.sh \
m4/codeset.m4 \
m4/gettext.m4 \
m4/glibc21.m4 \
m4/glibc2.m4 \
m4/gtk-doc.m4 \
m4/iconv.m4 \
m4/intdiv0.m4 \
m4/intldir.m4 \
m4/intl.m4 \
m4/intlmacosx.m4 \
m4/intltool.m4 \
m4/intmax.m4 \
m4/inttypes_h.m4 \
m4/inttypes-pri.m4 \
m4/lcmessage.m4 \
m4/lib-ld.m4 \
m4/lib-link.m4 \
m4/lib-prefix.m4 \
m4/libtool.m4 \
m4/lock.m4 \
m4/longlong.m4 \
m4/lt~obsolete.m4 \
m4/ltoptions.m4 \
m4/ltsugar.m4 \
m4/ltversion.m4 \
m4/nls.m4 \
m4/po.m4 \
m4/printf-posix.m4 \
m4/progtest.m4 \
m4/size_max.m4 \
m4/stdint_h.m4 \
m4/uintmax_t.m4 \
m4/visibility.m4 \
m4/wchar_t.m4 \
m4/wint_t.m4 \
m4/xsize.m4 \
missing \
mkinstalldirs \
po/Makevars.template \
po/Rules-quot \
po/boldquot.sed \
po/en@boldquot.header \
po/en@quot.header \
po/insert-header.sin \
po/quot.sed \
po/remove-potcdate.sin \
test-driver \
`find "$(srcdir)" -type f -name Makefile.in -print`
@GNOME_CODE_COVERAGE_RULES@
$(GITIGNORE_MAINTAINERCLEANFILES_TOPLEVEL) \
$(GITIGNORE_MAINTAINERCLEANFILES_MAKEFILE_IN) \
$(GITIGNORE_MAINTAINERCLEANFILES_M4_LIBTOOL) \
gtk-doc.make \
INSTALL
-include $(top_srcdir)/git.mk
This diff is collapsed.
GNOME LaTeX
===========
This is the version 3.32.0 of GNOME LaTeX.
GNOME LaTeX is a LaTeX editor for the GNOME desktop.
GNOME LaTeX was previously named LaTeXila. The application has been renamed in
December 2017.
GNOME LaTeX is released under the GNU General Public License (GPL) version 3 or
later, see the file 'COPYING' for more information.
The web site:
https://wiki.gnome.org/Apps/GNOME-LaTeX
Dependencies
------------
* GLib >= 2.56
* GTK+ >= 3.22
* GtkSourceView >= 4.0
* Tepl >= 4.2 - https://wiki.gnome.org/Projects/Tepl
* gspell >= 1.8
* gee-0.8 >= 0.10
* gsettings-desktop-schemas
* dconf (optional, recommended on Linux, can be disabled with
--disable-dconf-migration)
* Latexmk >= 4.31 (optional, but strongly recommended)
And for building the sources:
* Vala = 0.40 (may be optional), attention GNOME LaTeX cannot be built with Vala >= 0.42.
* yelp-tools
If you are installing GNOME LaTeX from a tarball, you don't have to install
Vala because the C code is already generated.
Installation
------------
Simple install procedure from a tarball:
$ ./configure
$ make
[ Become root if necessary ]
$ make install
See the file 'INSTALL' for more detailed information.
From the Git repository, the 'configure' script and the 'INSTALL' file are not
yet generated, so you need to run 'autogen.sh' instead, which takes the same
arguments as 'configure'.
To build the latest version of gnome-latex plus its dependencies from Git,
Jhbuild is recommended. gnome-latex is in the gnome-world moduleset. An example
of a jhbuildrc file is provided:
https://wiki.gnome.org/Projects/Jhbuild
https://people.gnome.org/~swilmet/gnome-latex/jhbuildrc
How to not contribute
---------------------
See the file 'HACKING'.
General Information
===================
This is the version @PACKAGE_VERSION@ of LaTeXila.
LaTeXila is an Integrated LaTeX Environment for the GNOME desktop.
LaTeXila is released under the GNU General Public License (GPL) version 3 or
later, see the file "COPYING" for more information.
The web site:
https://wiki.gnome.org/Apps/LaTeXila
Requirements
============
GLib >= @GLIB_REQUIRED_VERSION@
GTK+ >= @GTK_REQUIRED_VERSION@
GtkSourceView >= @GTKSOURCEVIEW_REQUIRED_VERSION@
GtkSpell >= @GTKSPELL_REQUIRED_VERSION@
gee-0.8 >= @GEE_REQUIRED_VERSION@
gettext
gsettings-desktop-schemas
Latexmk >= 4.31 (optional, but strongly recommended)
And for building the sources:
Vala >= @VALA_REQUIRED_VERSION@ (may be optional)
yelp-tools
If you are installing LaTeXila from a tarball, you don't have to install Vala
because the C code is already generated.
Installation
============
From a tarball:
$ ./configure
From a git repository:
$ ./autogen.sh
Then build the sources:
$ make
And install everything:
[ Become root if necessary ]
$ make install
To uninstall:
$ make uninstall
See the file "INSTALL" for more details.
Where to report bugs
====================
Bugs should be reported on the GNOME bugzilla:
https://bugzilla.gnome.org/browse.cgi?product=latexila
Translations
============
Here is a summary page about the translation status of LaTeXila:
https://l10n.gnome.org/module/latexila/
If you want to help, see:
https://wiki.gnome.org/TranslationProject
README for the GitHub mirror of LaTeXila
========================================
The LaTeXila repository at GitHub is a **read-only mirror**! Do *not* create
pull requests there. The purpose is just to ease the creation of clones, so you
can host your branches.
See the [homepage of LaTeXila](https://wiki.gnome.org/Apps/LaTeXila) to know
how to contribute.
#!/bin/sh
# Run this to generate all the initial makefiles, etc.
test -n "$srcdir" || srcdir=$(dirname "$0")
test -n "$srcdir" || srcdir=.
srcdir=`dirname $0`
[ -z "$srcdir" ] && srcdir=.
olddir=$(pwd)
PKG_NAME=latexila
REQUIRED_AUTOMAKE_VERSION=1.7
cd $srcdir
if [ ! -f "$srcdir/configure.ac" ]; then
echo "$srcdir doesn't look like source directory for $PKG_NAME" >&2
exit 1
(test -f configure.ac) || {
echo "*** ERROR: Directory '$srcdir' does not look like the top-level project directory ***"
exit 1
}
# shellcheck disable=SC2016
PKG_NAME=$(autoconf --trace 'AC_INIT:$1' configure.ac)
if [ "$#" = 0 -a "x$NOCONFIGURE" = "x" ]; then
echo "*** WARNING: I am going to run 'configure' with no arguments." >&2
echo "*** If you wish to pass any to it, please specify them on the" >&2
echo "*** '$0' command line." >&2
echo "" >&2
fi
which gnome-autogen.sh || {
echo "You need to install gnome-common from GNOME Git"
exit 1
}
aclocal --install || exit 1
gtkdocize --copy || exit 1
intltoolize --force --copy --automake || exit 1
autoreconf --verbose --force --install || exit 1
cd "$olddir"
if [ "$NOCONFIGURE" = "" ]; then
$srcdir/configure "$@" || exit 1
. gnome-autogen.sh "$@"
if [ "$1" = "--help" ]; then exit 0 else
echo "Now type 'make' to compile $PKG_NAME" || exit 1
fi
else
echo "Skipping configure process."
fi
......@@ -4,18 +4,22 @@
# Init Autoconf
AC_PREREQ([2.64])
AC_INIT([LaTeXila],
[3.16.0],
[https://bugzilla.gnome.org/enter_bug.cgi?product=latexila],
[latexila],
[https://wiki.gnome.org/Apps/LaTeXila])
AC_INIT([GNOME LaTeX],
[3.32.0],
[https://gitlab.gnome.org/GNOME/gnome-latex/issues],
[gnome-latex],
[https://wiki.gnome.org/Apps/GNOME-LaTeX])
AX_REQUIRE_DEFINED([AX_IS_RELEASE])
AX_IS_RELEASE([git-directory])
AC_CONFIG_SRCDIR([src/liblatexila/latexila.h])
AC_CONFIG_HEADERS([config.h])
AC_CONFIG_MACRO_DIR([m4])
# Init Automake
AM_INIT_AUTOMAKE([1.12.5 foreign tar-ustar no-dist-gzip dist-xz -Wno-portability])
# gnu strictness to generate the INSTALL file.
AM_INIT_AUTOMAKE([1.14 gnu tar-ustar no-dist-gzip dist-xz -Wno-portability])
AM_MAINTAINER_MODE([enable])
AM_SILENT_RULES([yes])
......@@ -24,20 +28,15 @@ LT_PREREQ([2.2])
LT_INIT
# Required dependencies versions
# Update also the --target-glib option in src/Makefile.am.
GLIB_REQUIRED_VERSION="2.40"
GTK_REQUIRED_VERSION="3.14"
GTKSOURCEVIEW_REQUIRED_VERSION="3.16"
GTKSPELL_REQUIRED_VERSION="3.0.4"
VALA_REQUIRED_VERSION="0.26"
GLIB_REQUIRED_VERSION="2.56"
GTK_REQUIRED_VERSION="3.22"
GTKSOURCEVIEW_REQUIRED_VERSION="4.0"
TEPL_REQUIRED_VERSION="4.2"
GSPELL_REQUIRED_VERSION="1.8"
VALA_REQUIRED_VERSION="0.34"
GEE_REQUIRED_VERSION="0.10"
AC_SUBST([GLIB_REQUIRED_VERSION])
AC_SUBST([GTK_REQUIRED_VERSION])
AC_SUBST([GTKSOURCEVIEW_REQUIRED_VERSION])
AC_SUBST([GTKSPELL_REQUIRED_VERSION])
AC_SUBST([VALA_REQUIRED_VERSION])
AC_SUBST([GEE_REQUIRED_VERSION])
# Some directories
......@@ -48,6 +47,17 @@ AC_SUBST([GEE_REQUIRED_VERSION])
# WARNING: It's easy to get an infinite loop with some unsane input.
# For example ${datadir} becomes ${datarootdir}, and then ${prefix}/share, and
# finally ${prefix} is replaced by the prefix.
#
# Why is it used in GNOME LaTeX?
# TL;DR: Vala.
#
# If the variable is needed only in C code, it is possible to pass the value
# with -D in the CPPFLAGS in the Makefile.am, and the value will correctly be
# interpolated.
# This macro is used in GNOME LaTeX because the variables are needed in Vala,
# the variables are accessed through vapi/config.vapi, so they need to be
# present in the config.h (the variables are added to the config.h with
# AC_DEFINE_UNQUOTED).
AC_DEFUN([adl_RECURSIVE_EVAL],
[_lcl_receval="$1"
$2=`(test "x$prefix" = xNONE && prefix="$ac_default_prefix"
......@@ -59,10 +69,10 @@ $2=`(test "x$prefix" = xNONE && prefix="$ac_default_prefix"
done
echo "[$]_lcl_receval")`])
adl_RECURSIVE_EVAL(["${datadir}/latexila"], [DATA_DIR])
adl_RECURSIVE_EVAL(["${datadir}/gnome-latex"], [DATA_DIR])
AC_DEFINE_UNQUOTED([DATA_DIR],
["${DATA_DIR}"],
[latexila data directory])
[gnome-latex data directory])
adl_RECURSIVE_EVAL(["${datadir}/icons/hicolor"], [ICONS_DIR])
AC_DEFINE_UNQUOTED([ICONS_DIR],
......@@ -72,117 +82,121 @@ AC_DEFINE_UNQUOTED([ICONS_DIR],
# Checks for programs
AC_PROG_CC
AC_PROG_INSTALL
AM_PROG_CC_C_O
AC_PATH_PROG([GLIB_COMPILE_RESOURCES], [glib-compile-resources])
AC_PATH_PROG([GLIB_MKENUMS], [glib-mkenums])
AC_PATH_PROG([GDBUS_CODEGEN], [gdbus-codegen])
AM_PROG_VALAC([${VALA_REQUIRED_VERSION}],
[found_vala=true]
[found_vala=true]
[found_vala=false])
# Checks for dependencies
if ! pkg-config --atleast-version=${GLIB_REQUIRED_VERSION} glib-2.0; then
AC_MSG_ERROR([glib-2.0 >= ${GLIB_REQUIRED_VERSION} required.])
fi
if ! pkg-config --atleast-version=${GLIB_REQUIRED_VERSION} gio-2.0; then
AC_MSG_ERROR([gio-2.0 >= ${GLIB_REQUIRED_VERSION} required.])
fi
if ! pkg-config --atleast-version=${GTK_REQUIRED_VERSION} gtk+-3.0; then
AC_MSG_ERROR([gtk+-3.0 >= ${GTK_REQUIRED_VERSION} required.])
fi
if ! pkg-config --atleast-version=${GTKSOURCEVIEW_REQUIRED_VERSION} gtksourceview-3.0; then
AC_MSG_ERROR([gtksourceview-3.0 >= ${GTKSOURCEVIEW_REQUIRED_VERSION} required.])
fi
if ! pkg-config --atleast-version=${GTKSPELL_REQUIRED_VERSION} gtkspell3-3.0; then
AC_MSG_ERROR([gtkspell3-3.0 >= ${GTKSPELL_REQUIRED_VERSION} required.])
fi
if ! pkg-config gsettings-desktop-schemas; then
AC_MSG_ERROR([gsettings-desktop-schemas required.])
fi
if ! pkg-config --atleast-version=${GEE_REQUIRED_VERSION} gee-0.8; then
AC_MSG_ERROR([gee-0.8 >= ${GEE_REQUIRED_VERSION} required.])
fi
AX_REQUIRE_DEFINED([PKG_PROG_PKG_CONFIG])
PKG_PROG_PKG_CONFIG
dependencies="
glib-2.0
gio-2.0
gtk+-3.0
gtksourceview-3.0
gtkspell3-3.0
# Checks for dependencies
AX_REQUIRE_DEFINED([PKG_CHECK_MODULES])
PKG_CHECK_MODULES([DEP], [
glib-2.0 >= ${GLIB_REQUIRED_VERSION}
gio-2.0 >= ${GLIB_REQUIRED_VERSION}
gtk+-3.0 >= ${GTK_REQUIRED_VERSION}
gtksourceview-4 >= ${GTKSOURCEVIEW_REQUIRED_VERSION}
tepl-4 >= ${TEPL_REQUIRED_VERSION}
gspell-1 >= ${GSPELL_REQUIRED_VERSION}
gee-0.8 >= ${GEE_REQUIRED_VERSION}
gsettings-desktop-schemas
gee-0.8"
])
# dconf migration option
AC_ARG_ENABLE([dconf_migration],
[AS_HELP_STRING([--disable-dconf-migration],
[do not add support for latexila to gnome-latex dconf migration])],
[enable_dconf_migration=$enableval],
[enable_dconf_migration=yes])
if test x$enable_dconf_migration = xyes; then
PKG_CHECK_MODULES([DCONF_DEP], [dconf])
AC_DEFINE_UNQUOTED([HAVE_DCONF_MIGRATION], [1], [Whether dconf migration is supported])
else
AC_DEFINE_UNQUOTED([HAVE_DCONF_MIGRATION], [0], [Whether dconf migration is supported])
fi
CFLAGS="$CFLAGS `pkg-config --cflags ${dependencies}`"
LIBS="$LIBS `pkg-config --libs ${dependencies}`"
AM_CONDITIONAL([DCONF_MIGRATION_BUILD], [test x$enable_dconf_migration = xyes])
# Native Language Support
AX_REQUIRE_DEFINED([IT_PROG_INTLTOOL])
IT_PROG_INTLTOOL([0.50.1])
GETTEXT_PACKAGE=${PACKAGE_TARNAME}
AC_SUBST([GETTEXT_PACKAGE])
AC_DEFINE_UNQUOTED([GETTEXT_PACKAGE],
["${GETTEXT_PACKAGE}"],
[The domain to use with gettext])
["${GETTEXT_PACKAGE}"],
[The domain to use with gettext])
adl_RECURSIVE_EVAL(["${localedir}"], [LOCALE_DIR])
AC_DEFINE_UNQUOTED([LOCALE_DIR],
["${LOCALE_DIR}"],
["${LOCALE_DIR}"],
[locale directory])
# Compile warnings. There can be deprecation warnings at any time, so disable
# -Werror by default with the [yes] argument.
AX_REQUIRE_DEFINED([AX_COMPILER_FLAGS])
AX_COMPILER_FLAGS([WARN_CFLAGS], [WARN_LDFLAGS], [yes])
# Misc
AX_REQUIRE_DEFINED([YELP_HELP_INIT])
YELP_HELP_INIT
AX_REQUIRE_DEFINED([GLIB_GSETTINGS])
GLIB_GSETTINGS
GNOME_COMPILE_WARNINGS([maximum])
AX_REQUIRE_DEFINED([GOBJECT_INTROSPECTION_CHECK])
GOBJECT_INTROSPECTION_CHECK([1.30.0])
AX_REQUIRE_DEFINED([VAPIGEN_CHECK])
VAPIGEN_CHECK
AX_REQUIRE_DEFINED([GTK_DOC_CHECK])
GTK_DOC_CHECK([1.14], [--flavour no-tmpl])
GNOME_CODE_COVERAGE
AX_REQUIRE_DEFINED([AX_CODE_COVERAGE])
AX_CODE_COVERAGE
AX_REQUIRE_DEFINED([APPSTREAM_XML])
APPSTREAM_XML
# Generate files
AC_CONFIG_FILES([Makefile
data/Makefile
data/build_tools/Makefile
data/latexila.desktop.in
data/icons/Makefile
data/icons/16x16/Makefile
data/icons/16x16/apps/Makefile
data/icons/22x22/Makefile
data/icons/22x22/apps/Makefile
data/icons/24x24/Makefile
data/icons/24x24/apps/Makefile
data/icons/32x32/Makefile
data/icons/32x32/apps/Makefile
data/icons/48x48/Makefile
data/icons/48x48/apps/Makefile
data/icons/128x128/Makefile
data/icons/128x128/apps/Makefile
data/icons/256x256/Makefile
data/icons/256x256/apps/Makefile
data/icons/scalable/Makefile
data/icons/scalable/apps/Makefile
data/images/Makefile
data/images/app/Makefile
data/org.gnome.latexila.gschema.xml
data/templates/Makefile
docs/Makefile
docs/reference/Makefile
help/Makefile
man/Makefile
po/Makefile.in
src/Makefile
src/evince/Makefile
src/gedit/Makefile
src/liblatexila/Makefile
src/ui/Makefile
tests/Makefile
README])
AC_CONFIG_FILES([
Makefile
data/Makefile
data/org.gnome.gnome-latex.gschema.xml
data/build_tools/Makefile
data/icons/Makefile
data/icons/16x16/Makefile
data/icons/16x16/apps/Makefile
data/icons/22x22/Makefile
data/icons/22x22/apps/Makefile
data/icons/24x24/Makefile
data/icons/24x24/apps/Makefile
data/icons/32x32/Makefile
data/icons/32x32/apps/Makefile
data/icons/48x48/Makefile
data/icons/48x48/apps/Makefile
data/icons/256x256/Makefile
data/icons/256x256/apps/Makefile
data/icons/symbolic/Makefile
data/icons/symbolic/apps/Makefile
data/images/Makefile
data/templates/Makefile
docs/Makefile
docs/reference/Makefile
help/Makefile
man/Makefile
po/Makefile.in
src/Makefile
src/evince/Makefile
src/liblatexila/Makefile
src/ui/Makefile
tests/Makefile
])
AC_OUTPUT
......@@ -195,14 +209,17 @@ fi
# Print a summary of the configuration
echo "
Configuration:
${PACKAGE_NAME} version ${PACKAGE_VERSION}
Prefix: ${prefix}
Vala Compiler: ${vala_compiler}
C Compiler: ${CC}
GObject introspection: ${found_introspection}
Generate latexila.vapi: ${enable_vala}
${PACKAGE_NAME} version ${PACKAGE_VERSION}
Source code location: ${srcdir}
Prefix: ${prefix}
C compiler: ${CC}
Vala compiler: ${vala_compiler}
Dev documentation: ${enable_gtk_doc}
GObject introspection: ${found_introspection}
Generate latexila.vapi: ${enable_vala}
Code coverage: ${enable_code_coverage}
dconf migration: ${enable_dconf_migration}
"
......@@ -5,25 +5,37 @@ dist_pkgdata_DATA = \
latexhelp.html
desktopdir = $(datadir)/applications
desktop_DATA = latexila.desktop
desktop_DATA = org.gnome.gnome-latex.desktop
@INTLTOOL_DESKTOP_RULE@
@INTLTOOL_XML_RULE@
appdatadir = $(datadir)/appdata
appdata_in_files = latexila.appdata.xml.in
appdata_DATA = $(appdata_in_files:.xml.in=.xml)
gsettings_SCHEMAS = org.gnome.latexila.gschema.xml
appstream_XML = org.gnome.gnome-latex.appdata.xml
@APPSTREAM_XML_RULES@
gsettings_SCHEMAS = org.gnome.gnome-latex.gschema.xml
@GSETTINGS_RULES@
dbusservicedir = $(datadir)/dbus-1/services
dbusservice_DATA = org.gnome.gnome-latex.service
org.gnome.gnome-latex.service: Makefile
$(AM_V_GEN) (echo '[D-BUS Service]'; \
echo 'Name=org.gnome.gnome-latex'; \
echo 'Exec=${bindir}/gnome-latex --gapplication-service') > $@.tmp && \
mv $@.tmp $@
EXTRA_DIST = \
latexila.desktop.in \
org.gnome.latexila.gschema.xml.in \
$(appdata_in_files)
CLEANFILES = \
latexila.desktop \
org.gnome.latexila.gschema.xml \
$(appdata_DATA)
org.gnome.gnome-latex.appdata.xml.in \
org.gnome.gnome-latex.desktop.in \
org.gnome.gnome-latex.gschema.xml.in
DISTCLEANFILES = \
org.gnome.gnome-latex.gschema.xml
CLEANFILES = \
org.gnome.gnome-latex.appdata.xml \
org.gnome.gnome-latex.desktop \
org.gnome.gnome-latex.service
-include $(top_srcdir)/git.mk
<its:rules
xmlns:its="http://www.w3.org/2005/11/its"
its:version="1.0">
version="1.0">
<its:translateRule translate="no" selector="//job" />
<its:translateRule translate="no" selector="//open" />
......
......@@ -61,13 +61,13 @@
<tool id="12" enabled="false" extensions=".tex" icon="compile_pdf">
<label its:translate="no">LaTeX → PDF (pdflatex)</label>
<description>Create a PDF file from LaTeX sources with the "pdflatex" command</description>
<description>Create a PDF file from LaTeX sources with the “pdflatex” command</description>
<job postProcessor="latex">pdflatex -interaction=nonstopmode -synctex=1 $filename</job>
</tool>
<tool id="13" enabled="false" extensions=".tex" icon="compile_dvi">
<label its:translate="no">LaTeX → DVI (latex)</label>
<description>Create a DVI file from LaTeX sources with the "latex" command</description>