added short notes about all the top-level directories.

2003-03-15  Sven Neumann  <sven@gimp.org>

	* structure.xml: added short notes about all the top-level
	directories.
This commit is contained in:
Sven Neumann 2003-03-15 00:30:58 +00:00 committed by Sven Neumann
parent 1657c4d62b
commit 5a55754532
2 changed files with 191 additions and 6 deletions

View File

@ -1,8 +1,14 @@
2003-03-15 Sven Neumann <sven@gimp.org>
* structure.xml: added short notes about all the top-level
directories.
2003-03-14 Sven Neumann <sven@gimp.org>
* libgimpwidgets/libgimpwidgets-sections.txt
* tmpl/gimpcolorarea.sgml: updated.
* libgimpwidgets/tmpl/gimpstock.sgml
* ibgimpwidgets/tmpl/gimpcolorarea.sgml: updated.
2003-03-06 Sven Neumann <sven@gimp.org>
* libgimpwidgets/Makefile.am
@ -12,8 +18,8 @@
2003-03-02 Manish Singh <yosh@gimp.org>
* libgimpwidgets/tmpl/gimpcolordisplay.sgml
* libgimpwidgets/tmpl/gimpcolorselector.sgml: fix typo. "definitiions"
should be "definitions"
* libgimpwidgets/tmpl/gimpcolorselector.sgml: fix typo.
"definitiions" should be "definitions"
2003-03-02 Sven Neumann <sven@gimp.org>

View File

@ -11,7 +11,7 @@
<firstname>Sven</firstname>
<surname>Neumann</surname>
</author>
<date>February 2003</date>
<date>2003</date>
<abstract>
<para>
This document outlines the directory structure of the
@ -33,7 +33,186 @@
<tbody>
<row>
<entry><filename>app</filename></entry>
<entry>the application</entry>
<entry>
The source code of the core GIMP application.
</entry>
</row>
<row>
<entry><filename>build</filename></entry>
<entry>
This is a virtual CVS module that is only here to assist in
building <application>GIMP</application> for Windows.
</entry>
</row>
<row>
<entry><filename>cursors</filename></entry>
<entry>
Bitmaps that are used to construct cursors used by the various
<application>GIMP</application> tools.
</entry>
</row>
<row>
<entry><filename>data</filename></entry>
<entry>
All sorts of data files like brushes, gradients, patterns as well
as the splash image and files to integrate
<application>GIMP</application> into the GNOME desktop.
</entry>
</row>
<row>
<entry><filename>devel-docs</filename></entry>
<entry>
The developers documentation. The file you are looking at (or at
least the source that was used to generate it) is located here.
</entry>
</row>
<row>
<entry><filename>docs</filename></entry>
<entry>
Documentation for users. The man-pages which get installed with
the <application>GIMP</application> as well as reference sheets
for keybindings and other stuff.
</entry>
</row>
<row>
<entry><filename>etc</filename></entry>
<entry>
Configuration files that get installed with the
<application>GIMP</application>.
</entry>
</row>
<row>
<entry><filename>etc</filename></entry>
<entry>
Configuration files that get installed with the
<application>GIMP</application>.
</entry>
</row>
<row>
<entry><filename>libgimp</filename></entry>
<entry>
The main <application>GIMP</application> library. It provides the
API to write plug-ins in the C programming
language. <application>GIMP</application> itself does not link
against this library.
</entry>
</row>
<row>
<entry><filename>libgimpbase</filename></entry>
<entry>
Basic functions that are shared by the
<application>GIMP</application> application and its plug-ins.
</entry>
</row>
<row>
<entry><filename>libgimpcolor</filename></entry>
<entry>
Color-related functionality that is shared by the
<application>GIMP</application> application and its plug-ins.
</entry>
</row>
<row>
<entry><filename>libgimpmath</filename></entry>
<entry>
A basic set of mathematic operations useful for the the
<application>GIMP</application> application and its plug-ins.
</entry>
</row>
<row>
<entry><filename>libgimpmodule</filename></entry>
<entry>
A small library that abstracts dynamic loading of modules. This is
used to implement loadable color selectors and display filters.
</entry>
</row>
<row>
<entry><filename>libgimpwidgets</filename></entry>
<entry>
User interface elements (widgets) and utility functions that are
shared by the <application>GIMP</application> application and its
plug-ins.
</entry>
</row>
<row>
<entry><filename>m4macros</filename></entry>
<entry>
m4 macros (well, actually just one) which get installed to help
automake to detect a GIMP installation. Useful for plug-in
developers.
</entry>
</row>
<row>
<entry><filename>modules</filename></entry>
<entry>
Color selectors and display filters that can be loaded at
run-time.
</entry>
</row>
<row>
<entry><filename>plug-ins</filename></entry>
<entry>
This directory and its sub-directories hold all the
<application>GIMP</application> plug-ins that are part of the main
<application>GIMP</application> distribution.
</entry>
</row>
<row>
<entry><filename>po</filename></entry>
<entry>
Translations of strings used in the main
<application>GIMP</application> application.
</entry>
</row>
<row>
<entry><filename>po-libgimp</filename></entry>
<entry>
Translations of strings used in libgimp.
</entry>
</row>
<row>
<entry><filename>po-plug-ins</filename></entry>
<entry>
Translations of strings used in <application>GIMP</application>
plug-ins.
</entry>
</row>
<row>
<entry><filename>po-script-fu</filename></entry>
<entry>
Translations of strings used in Script-Fu scripts.
</entry>
</row>
<row>
<entry><filename>regexrepl</filename></entry>
<entry>
Code to handle regular expressions in case your C library does not
suport them. These files will not be used for most builds since
modern libc implementation have offer support for regular
expressions.
</entry>
</row>
<row>
<entry><filename>themes</filename></entry>
<entry>
The look of <application>GIMP</application> is themeable to some
extent. This directory at the moment only holds the default theme
but more themes might be added in the future.
</entry>
</row>
<row>
<entry><filename>tips</filename></entry>
<entry>
The helpful tips shown at startup are located here together with
their translations.
</entry>
</row>
<row>
<entry><filename>tools</filename></entry>
<entry>
The source code for some <application>GIMP</application>-related
tools as well as tools used to build the
<application>GIMP</application> application.
</entry>
</row>
</tbody>
</tgroup>