Commit 84cd94cf authored by Jeremy Bicha's avatar Jeremy Bicha

New upstream version 2+0.9

parents 4ac74b0f aabd4b27

Too many changes to show.

To preserve performance only 1000 of 1000+ files are displayed.

......@@ -8,6 +8,8 @@ content writers:
* Oliver Ellis (Red Haze) :: Filter Pack.
* Roman Joost (romanofski) :: German content.
* Markus Reinhardt :: German content.
* Axel Wernicke :: German content.
* Alexander Weiher :: German content
* Raymond Ostertag :: English and French content.
* Julien Hardelin :: English and French content.
* Cédric Gémy :: English and French content.
......@@ -17,14 +19,23 @@ content writers:
* William Skaggs :: English content.
* Cai Qian (蔡芊):: Chinese content.
* Yang Hong (杨红):: Chinese screenshots.
* Xceals :: Chinese screenshots and content.
* Eric Lamarque :: French content.
* Jakub Friedl :: Czech content.
* Jakub Friedl :: Czech and English content.
* Robert van Drunen :: Dutch content.
* Marco Ciampa :: Italian content.
* Marco Marega :: Italian content.
* Mike Vargas :: Italian content.
* Andrea Zito :: Italian content.
* Karine Delvare :: French content.
* David 'Ilicz' Klementa :: Czech content.
grafics, stylesheets:
---------------------
* Jakub Steiner (jimmac) :: Docbook Icons.
* Roman Joost :: CSS stylesheets.
* Daniel Egger :: XSLT stylesheets.
* Øyvind Kolås :: CSS stylesheets.
buildsystem, technical contributors:
------------------------------------
......@@ -33,7 +44,8 @@ buildsystem, technical contributors:
* Henrik Brix Andersen (brix) :: Makefile stuff.
* Daniel Egger :: Makefile stuff and initial project setup.
* Thomas Schraitle :: Technical consultancy.
* Chris Hbsch :: Technical consultancy.
* Chris Hbsch :: Technical consultancy.
* Axel Wernicke :: Formatting styleguide.
proof reading:
--------------
......
This diff is collapsed.
1. Introduction
The GIMP documentation project is mainly working with docbook xml files
to create the GIMP manual / online help. Since there are different
approaches how to create and edit such files as well as different tools
involved, there is a strong need for the xml files being well formated.
Additionally there are a couple of technical reasons (diff, cvs) that
suggest a general styleguide for the xml files. This is a recommendation
for such a styleguide. Its mainly based on the styles that can be found
in xml files that build the current documentation, as well as on the
discussion on the gimp-doc mailing list.
2. XML styleguide by rules
§1. General
§1.1. All docbook files for the documentation need to be well formed and
have to comply validation against
http://www.docbook.org/xml/4.3/docbookx.dtd.
§1.2. All docbook files use UTF-8 character encoding.
§2. Length of lines
§2.1. The length of line should not exceed 78 characters. Exceptions
might be made for text that is technically not able to be wrapped
(chinese text does rarely contain space characters, so it can't be
wrapped without introducing unwanted whitespaces) and attributes of
elements.
§3. Elements and new lines
§3.1. Element tagnames are written lowercase completely
§3.2. All tags (opening and closing) are starting a new line. For
exceptions see §3.3
§3.3. Elements listed in Appendix I (inline elements) do not have the
opening and closing tags on new lines, as long as their content does not
exceed 78 characters.
§4. Element attributes
§4.1. Element attributes are written completely lowercase
§4.2. Element attributes values are enclosed in double quotes ( " )
§4.3. The languages encoded in the lang attributes appear in alphabetical
order of the language codes
§5. Indention
§5.1. As character used to create indention space or tab characters can
be used, but it is higly recommended not to mix space and tab character
usage in one single xml file.
§5.2. Indention width is two spaces (0x20). One tab (0x09) is equivalent
to 8 spaces (0x20).
§5.3. Indention is done for the content of all tags that start a new line
2 XML styleguide by example
Example for §1 General
Following the rules in §1 each xml file of the GIMP manual starts with:
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE abcd
PUBLIC '-//OASIS//DTD DocBook XML V4.3//EN'
'http://www.docbook.org/xml/4.3/docbookx.dtd'>
where abcd is the root element of the file (usually book, sect1 of sect2).
Example for §2. Length of lines
// to be done
Example for §3. Elements and new lines
// to be done
Example for §4. Element attributes
// to be done
Example for §5. Indention
// to be done
Appendix I Inline elements
<abbrev>
<accel>
<acronym>
<action>
<anchor>
<application>
<citation>
<citerefentry>
<citetitle>
<classname>
<command>
<computeroutput>
<constant>
<database>
<email>
<emphasis>
<envar>
<errorcode>
<errorname>
<filename>
<firstterm>
<footnote>
<forignphrase>
<function>
<guibutton>
<guiicon>
<guilabel>
<guimenu>
<guimenuitem>
<guisubmenu>
<glossterm>
<hardware>
<inlineequation>
<inlinegraphic>
<interface>
<interfacedefinition>
<keycap>
<keycode>
<keycombo>
<keysym>
<link>
<literal>
<markup>
<medialabel>
<menuchoice>
<mousebutton>
<msgtext>
<olink>
<option>
<optional>
<parameter>
<phrase>
<prompt>
<property>
<quote>
<replacable>
<returnvalue>
<shortcut>
<structfield>
<structname>
<subsrcipt>
<superscript>
<symbol>
<systemitem>
<token>
<trademark>
<type>
<ulink>
<userinput>
<varname>
<wordasword>
<xref>
This diff is collapsed.
This diff is collapsed.
GIMP-Help NEWS
--------------
[GIMP Help 2 release 0.9]
* spelling fixes and new content for german, italian, english,
chinese and french
* XML validation fixes
* CSS cleanups
* lower depth for PNGs for the online version of the manual
* small changes to the build system
contributions from Sven Neumann, Marco Ciampa, Mike Vargas, Marco
Marega, Jakub Friedl, Cai Quian, Axel Wernicke, Julien Hardelin, Manfred
Gather, Bill Skaggs, Niklas M, Roman Joost, Karine Delvare, Alexander
Weiher, Xceals
[GIMP Help 2 release 0.8]
* spelling fixes for almost every translation
* Beginning of Italian and Dutch translation
* stylesheet fixes: CSS, HTML and DB2LaTeX driver files
* XML validity fixes for french and swedish
* Makefile overhaul
* new Hacking styleguide
contributions from Sven Neumann, Cai Quian, Daniel Egger, Julien
Hardelin, Jakub Friedl, Robert van Drunen, Karine Delvare, David
Klementa, Xceals, Axel Wernicke, Roman Joost, Øyvind Kolås
[GIMP Help 2 release 0.7]
* A few error-corrections.
......
......@@ -73,6 +73,15 @@ to date information of the current GIMP development.
languages)
OMF Files
---------
The directory omf holds documentation metadata that describes the user
manual and its localized versions. The format is described by the
Open Source Metadata Framework (OMF). A good resource on this subject
is the ScrollKeeper website: http://scrollkeeper.sourceforge.net/
Known Bugs
----------
- some links are not working
......
This diff is collapsed.
This diff is collapsed.
dnl This the autoconf script for the gimp-help-2 project.
dnl The GPL version 2 applies to it which you may get from
dnl http://www.gnu.org/.
# This the autoconf script for the gimp-help-2 project.
# The GPL version 2 applies to it which you may get from
# http://www.gnu.org/.
AC_PREREQ(2.54)
m4_define([help_major_version], [0])
m4_define([help_minor_version], [7])
m4_define([help_minor_version], [9])
m4_define([help_version], [help_major_version.help_minor_version])
......@@ -21,34 +21,53 @@ AC_PROG_LN_S
AC_PROG_MAKE_SET
dnl You can set the ALL_LINGUAS environment variable to
dnl control what languages are build.
# You can set the ALL_LINGUAS environment variable to
# control what languages are build.
if test "x$ALL_LINGUAS" != "x"; then
ALL_LINGUAS=$ALL_LINGUAS
else
ALL_LINGUAS="cs de en fr sv zh_CN"
ALL_LINGUAS="cs de en fr it nl sv zh_CN"
fi
AC_SUBST(ALL_LINGUAS)
dnl The build of the HTML files is optional
# The build of the HTML files is optional.
AC_ARG_ENABLE(build,
[ --enable-build build the help files from XML (needs xsltproc)],, enable_build=no)
AM_CONDITIONAL(GIMP_HELP_BUILD, test "x$enable_build" = "xyes")
dnl Using convert for optimizing screenshots for the html version is
dnl optional
# Using convert for optimizing screenshots for the html version is optional.
AC_ARG_ENABLE(convert,
[ --enable-convert optimize the PNGs for the Web in file size (needs convert)],, enable_convert=no)
AM_CONDITIONAL(USE_CONVERT, test "x$enable_convert" = "xyes")
dnl Search the XSLT processor
# Check for GNU make.
AC_MSG_CHECKING([whether ${MAKE-make} is GNU make])
if (${MAKE-make} --version) < /dev/null > /dev/null 2>&1; then
if (${MAKE-make} --version) 2> /dev/null | grep GNU 2>&1 > /dev/null; then
AC_MSG_RESULT(yes)
else
AC_MSG_RESULT(no)
AC_MSG_WARN([
** It seems that the make utility is not GNU make. Since this project
** makes use of GNU make extensions, you may run into build problems.
** Please use GNU make if possible.
])
fi
else