Commit 9ef179ea authored by Julien Hardelin's avatar Julien Hardelin

Restore .gitignore

parent ea0098a8
[Dolphin]
Timestamp=2019,5,12,15,18,7
Timestamp=2019,5,12,18,34,46
Version=3
[Settings]
HiddenFilesShown=true
......@@ -17,7 +17,7 @@ build-system.*
AUTHORS
xml
log
html
pdf
odf
*.tar.gz
......
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>2. Workflow</title>
<link rel="stylesheet" href="gimp-help-plain.css" type="text/css" />
<link rel="stylesheet" href="gimp-help-screen.css" type="text/css" />
<link rel="stylesheet" href="gimp-help-custom.css" type="text/css" />
<link rel="alternate stylesheet" href="gimp22.css" type="text/css" title="gimp22" />
<meta name="generator" content="DocBook XSL Stylesheets V1.78.0" />
<link rel="home" href="index.html" title="GNU Image Manipulation Program" />
<link rel="up" href="gimp-contributing.html" title="Appendix C. How to Contribute" />
<link rel="prev" href="gimp-contributing.html" title="Appendix C. How to Contribute" />
<link rel="next" href="apcs02s02.html" title="2.2. Validating" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">2. Workflow</th>
</tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="gimp-contributing.html">
<img src="images/prev.png" alt="Prev" />
</a>
</td>
<th width="60%" align="center">Appendix C. How to Contribute</th>
<td width="20%" align="right"> <a accesskey="n" href="apcs02s02.html"><img src="images/next.png" alt="Next" /></a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="idm139754638440752"></a>2. Workflow</h2>
</div>
</div>
</div>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139754638440016"></a>2.1. Writing</h3>
</div>
</div>
</div>
<p>
The language is English (USA).
</p>
<p>
To edit XML files, use your preferred text editor (this guide's
author prefers the free editor Kate). You must set the editor for:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>
English-US language.
</p>
</li>
<li class="listitem">
<p>
Indent with 2 spaces (the <span class="keycap"><strong>Tab</strong></span> key must move
pointer by two spaces).
</p>
</li>
<li class="listitem">
<p>
Replace tabs with spaces (for compatibility with all text
editors and web browsers).
</p>
</li>
<li class="listitem">
<p>
80 characters per line.
</p>
</li>
<li class="listitem">
<p>
Automatic spell checking with English (USA) for default
language.
</p>
</li>
</ul>
</div>
<p>
</p>
<p>
Source files are written in the XML language according to the DocBook
DTD. DocBook specifications can be found at
<a class="ulink" href="http://tdg.docbook.org/tdg/4.5/docbook.html" target="_top">http://tdg.docbook.org/tdg/4.5/docbook.html</a>.
</p>
<p>
Don't be afraid. We don't use all these items and you will learn XML
progressively reading existing XML files. For new files, please use
the templates you can find in the gimp-help/docs/templates folder.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25">
<img alt="[Note]" src="images/note.png" />
</td>
<th align="left">Note</th>
</tr>
<tr>
<td align="left" valign="top">
<p>
If you write a new file, you must add it in the src/gimp.xml file,
or in the XML file that calls it (for example, the
src/menus/edit.xml file calls undo.xml, redo.xml, fade.xml... and so
on).
</p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="gimp-contributing.html"><img src="images/prev.png" alt="Prev" /></a> </td>
<td width="20%" align="center">
<a accesskey="u" href="gimp-contributing.html">
<img src="images/up.png" alt="Up" />
</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="apcs02s02.html"><img src="images/next.png" alt="Next" /></a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top"><a accesskey="p" href="gimp-contributing.html">Appendix C. How to Contribute</a> </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">
<img src="images/home.png" alt="Home" />
</a>
</td>
<td width="40%" align="right" valign="top"> <a accesskey="n" href="apcs02s02.html">2.2. Validating</a></td>
</tr>
</table>
<a href="https://gitlab.gnome.org/GNOME/gimp-help/issues" class="reportbug">
Report an error in the bug tracker
</a>
</div>
</body>
</html>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>2.2. Validating</title>
<link rel="stylesheet" href="gimp-help-plain.css" type="text/css" />
<link rel="stylesheet" href="gimp-help-screen.css" type="text/css" />
<link rel="stylesheet" href="gimp-help-custom.css" type="text/css" />
<link rel="alternate stylesheet" href="gimp22.css" type="text/css" title="gimp22" />
<meta name="generator" content="DocBook XSL Stylesheets V1.78.0" />
<link rel="home" href="index.html" title="GNU Image Manipulation Program" />
<link rel="up" href="apcs02.html" title="2. Workflow" />
<link rel="prev" href="apcs02.html" title="2. Workflow" />
<link rel="next" href="apcs02s03.html" title="2.3. Images" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">2.2. Validating</th>
</tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="apcs02.html">
<img src="images/prev.png" alt="Prev" />
</a>
</td>
<th width="60%" align="center">2. Workflow</th>
<td width="20%" align="right"> <a accesskey="n" href="apcs02s03.html"><img src="images/next.png" alt="Next" /></a></td>
</tr>
</table>
<hr />
</div>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139754638341152"></a>2.2. Validating</h3>
</div>
</div>
</div>
<p>
When you have finished writing, you must validate your work:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>
In command line, for a single file, you can use:
<span class="command"><strong>xmllint --noout your-file.xml</strong></span>. This command
displays nothing if your file is OK. Else it indicates where the
error is. This command is for quickly sorting an xml file out; it
can miss or may not find some errors.
</p>
<p>
(The Kate editor has an option (a plug-in) to validate the active
xml file.)
</p>
</li>
<li class="listitem">
<p>
Else just run: <span class="command"><strong>make validate-en</strong></span>. You must
get a <span class="quote"><span class="quote">No error</span></span> message.
</p>
<p>
Else, a list of validity errors is displayed with line numbers
referring to the en.xml log file that you can find in the /log
folder.
</p>
<p>
Open this en.xml file in a text editor, type the editor
<span class="quote"><span class="quote">jump to line</span></span> command (the Kate editor command is
<span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>G</strong></span>)
and enter the line number to jump to the concerned line in the
en.xml file. There, you will find the error.
</p>
<p>
If you have worked on several XML files, look above in the en.xml
file to find (in the <span class="quote"><span class="quote">xml:base</span></span> field of the
<span class="quote"><span class="quote">id</span></span> tag), in which xml file the error is.
</p>
<p>
Fix the error. Don't forget to save the file and run
<span class="command"><strong>make validate-en</strong></span> again.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25">
<img alt="[Note]" src="images/note.png" />
</td>
<th align="left">Note</th>
</tr>
<tr>
<td align="left" valign="top">
<p>
A frequent foolish mistake is editing the en.xml log file
instead of the XML file.
</p>
</td>
</tr>
</table>
</div>
</li>
</ul>
</div>
<p>
</p>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="apcs02.html"><img src="images/prev.png" alt="Prev" /></a> </td>
<td width="20%" align="center">
<a accesskey="u" href="apcs02.html">
<img src="images/up.png" alt="Up" />
</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="apcs02s03.html"><img src="images/next.png" alt="Next" /></a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top"><a accesskey="p" href="apcs02.html">2. Workflow</a> </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">
<img src="images/home.png" alt="Home" />
</a>
</td>
<td width="40%" align="right" valign="top"> <a accesskey="n" href="apcs02s03.html">2.3. Images</a></td>
</tr>
</table>
<a href="https://gitlab.gnome.org/GNOME/gimp-help/issues" class="reportbug">
Report an error in the bug tracker
</a>
</div>
</body>
</html>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>2.3. Images</title>
<link rel="stylesheet" href="gimp-help-plain.css" type="text/css" />
<link rel="stylesheet" href="gimp-help-screen.css" type="text/css" />
<link rel="stylesheet" href="gimp-help-custom.css" type="text/css" />
<link rel="alternate stylesheet" href="gimp22.css" type="text/css" title="gimp22" />
<meta name="generator" content="DocBook XSL Stylesheets V1.78.0" />
<link rel="home" href="index.html" title="GNU Image Manipulation Program" />
<link rel="up" href="apcs02.html" title="2. Workflow" />
<link rel="prev" href="apcs02s02.html" title="2.2. Validating" />
<link rel="next" href="apcs02s04.html" title="2.4. Create HTML Files" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">2.3. Images</th>
</tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="apcs02s02.html">
<img src="images/prev.png" alt="Prev" />
</a>
</td>
<th width="60%" align="center">2. Workflow</th>
<td width="20%" align="right"> <a accesskey="n" href="apcs02s04.html"><img src="images/next.png" alt="Next" /></a></td>
</tr>
</table>
<hr />
</div>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139754638510352"></a>2.3. Images</h3>
</div>
</div>
</div>
<p>
You also have to manage screenshots. Here are some hints for
making good screenshots:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>
reduce screenshot area as much as possible cropping the window
manager borders and disabling the help button (you can do it
in the preference dialog),
</p>
</li>
<li class="listitem">
<p>
set the image mode to indexed 255 colors
<span class="guimenu">Image</span><span class="guisubmenu">Mode</span><span class="guimenuitem">Indexed</span>
</p>
<p>
This is not necessary for icons and if your image has only few
colors. In these cases, indexed images are bigger than
non-indexed.
</p>
</li>
<li class="listitem">
<p>
set print resolution to 144 ppi (not for small images like
icons). You can do this easily with GIMP from
<span class="guimenu">Image</span><span class="guisubmenu">Print Size...</span>
</p>
</li>
<li class="listitem">
<p>
Export images in the PNG format.
</p>
</li>
</ul>
</div>
<p>
</p>
<p>
Don't include English text in images. Translators can't translate it
and many users don't like that. Use XML captions instead, or provide a
.xcf file in the
<span class="guimenu">Docs</span><span class="guisubmenu">xcf images</span>
folder, indicating it by a comment in the XML file:
</p>
<div class="mediaobject">
<img src="images/contribute/to-translators.png" />
</div>
<p>
</p>
<p>
Icons for GIMP are in usr/share/gimp/2.0/icons. GTK icons are in
usr/share/gtk-doc/html/gtk2.
</p>
<p>
To include an icon in the text:
</p>
<div class="mediaobject">
<img src="images/contribute/guiicon.png" />
</div>
<p>
</p>
<p>
Three commands to manage your images:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>
<span class="command"><strong>make check-image-resolutions-en</strong></span>: gives the
references of images whose resolution is not 144 ppi.
</p>
</li>
<li class="listitem">
<p>
<span class="command"><strong>make check-images-en</strong></span>: give references of
missing or orphaned images.