<?xml version="1.0" encoding="ISO-8859-1"?>
<sect1 id="intro-vocabulary-sect1">
<sect1info>
<!-- Please, do NOT edit the following revision history by hand. Use the
"make <module_name>.revision" target instead. -->
<revhistory><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>write</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>translate</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>tproof</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>pproof</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>ispell</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>lproof</revremark> </revision>
<revision>
<revnumber>1.en.lproof</revnumber>
<date>YYYY-MM-DD</date>
<authorinitials>tbn</authorinitials>
</revision>
<revision>
<revnumber>1.en.ispell</revnumber>
<date>YYYY-MM-DD</date>
<authorinitials>tbn</authorinitials>
</revision>
<revision>
<revnumber>1.en.pproof</revnumber>
<date>2002-07-22</date>
<authorinitials>jp</authorinitials>
</revision>
<revision>
<revnumber>1.en.tproof</revnumber>
<date>2002-07-02</date>
<authorinitials>cb</authorinitials>
</revision>
<revision>
<revnumber>1.en.write</revnumber>
<date>2002-06-25</date>
<authorinitials>fm</authorinitials>
</revision>
</revhistory>
</sect1info>
<title id="intro-vocabulary-sect1-ti1">Some Vocabulary</title>
<abstract>
<para id="intro-vocabulary-sect1-pa1">We will explain all terms used in &prog-borges;'
documentation: project, author, author initials, document,
sub-document, module, module status, atom, atom revision,
etc. <!--Links to the relevant sections in the documentation will
be provided.--></para>
</abstract>
<note>
<para id="intro-vocabulary-sect1-pa2">The terms are not presented in any particular order.</para>
</note>
<glosslist>
<glossentry id="term-author">
<glossterm id="intro-vocabulary-sect1-gt1">Author</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it1">
<primary>Author</primary>
</indexterm>
<para id="intro-vocabulary-sect1-pa3">An author can be the redactor, the translator or the
reviewer of a module. Generally speaking, the
<quote>author</quote> concept is bound to the creator (in this
case, writer) of something, but &prog-borges; treats translators
and reviewers as authors.</para>
<glossseealso otherterm="term-author-initials"/>
<glossseealso otherterm="term-module"/>
</glossdef>
</glossentry>
<glossentry id="term-author-initials">
<glossterm id="intro-vocabulary-sect1-gt2">Author Initials</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it2">
<primary>Author</primary>
<secondary>Initials</secondary>
</indexterm>
<para id="intro-vocabulary-sect1-pa4">&prog-borges; identifies the different authors that
participate in a project by their initials. This limits the
initials used by different authors of the same project to be
<emphasis>unique</emphasis>.</para> <para id="intro-vocabulary-sect1-pa5">If your project has a
small group of authors, two-letter initials should be enough, but
more letters can be used as long as they are unique.</para>
<glossseealso otherterm="term-author"/>
<glossseealso otherterm="term-project"/>
</glossdef>
</glossentry>
<glossentry id="term-project">
<glossterm id="intro-vocabulary-sect1-gt3">Project</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it3">
<primary>Project</primary>
</indexterm>
<para id="intro-vocabulary-sect1-pa6">A project is a document or a set of documents you are
managing with &prog-borges;. Usually, a project contains lots of
documents.</para>
<glossseealso otherterm="term-document"/>
</glossdef>
</glossentry>
<glossentry id="term-super-document">
<glossterm id="intro-vocabulary-sect1-gt4">Super-document</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it4">
<primary>Super-document</primary>
</indexterm>
<para id="intro-vocabulary-sect1-pa7">Designates a set of modules, structured together to form a
book, an article, a user manual; any exhaustive information block
about a particular subject.</para>
<para id="intro-vocabulary-sect1-pa8">The super-document is
the <quote>master</quote> from which different documents can be
generated. The super-document structure is defined in the
<filename>master.top.xml</filename> file.</para>
<para id="intro-vocabulary-sect1-pa9">A super-document can
contain mutually exclusive informations that will be sorted out
by specializing the super-documents into various
documents.</para> <glossseealso otherterm="term-document"/>
</glossdef>
</glossentry>
<glossentry id="term-document">
<glossterm id="intro-vocabulary-sect1-gt5">Document</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it5">
<primary>Document</primary>
</indexterm>
<para id="intro-vocabulary-sect1-pa10">A document is a compilation
of a super-document resulting in a &pdf; file or &xhtml;
file(s). You may choose to compile all your super-document, or
parts of it. Documents can be whole books, articles, reference
sheets, letters, manuals, etc.</para> <glossseealso otherterm="term-compilation"/>
<glossseealso otherterm="term-super-document"/>
</glossdef>
</glossentry>
<glossentry id="term-compilation">
<glossterm id="intro-vocabulary-sect1-gt6">Compilation</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it6">
<primary>Compilation</primary>
</indexterm>
<para id="intro-vocabulary-sect1-pa11">Compilation is the process by which a set of source &xml;
files is <quote>transformed</quote> into a &pdf; or &xhtml;
document.</para>
</glossdef>
</glossentry>
<glossentry id="term-structuring-element">
<glossterm id="intro-vocabulary-sect1-gt6a">Structuring element</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it6a">
<primary>element</primary>
<secondary>structuring</secondary>
</indexterm>
<para id="intro-vocabulary-sect1-pa11a">In a super-document, a
structuring element is a DocBook element that contains module
elements. Typical structuring element are <literal>part</literal> or
<literal>chapter</literal>.</para>
<glossseealso otherterm="term-super-document"/>
<glossseealso otherterm="term-module-element"/>
</glossdef>
</glossentry>
<glossentry id="term-module-element">
<glossterm id="intro-vocabulary-sect1-gt6b">Module element</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it6b">
<primary>element</primary>
<secondary>module</secondary>
</indexterm>
<para id="intro-vocabulary-sect1-pa11b">In a super-document, a
module element is a DocBook element that contains the special
<programlisting><para role="module"></programlisting> child
element. A module element will be replaced in the final document
by the module content itself. Typical module element are
<literal>chapter</literal> or <literal>sect1</literal>.</para>
<glossseealso otherterm="term-super-document"/> <glossseealso otherterm="term-module-element"/>
</glossdef>
</glossentry>
<glossentry id="term-module">
<glossterm id="intro-vocabulary-sect1-gt7">Module</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it7">
<primary>Module</primary>
</indexterm>
<para id="intro-vocabulary-sect1-pa12">Modules are the parts that compose documents. Usually, a
super-document is divided into small chunks called modules to
simplify writing, translating, management and content re-use.
Chapters, sections, appendices and glossaries are good candidates
to become modules.</para>
<para id="intro-vocabulary-sect1-pa13">In fact, &prog-borges; requires that any structuring element
be placed in a module to be able to be translated and to take
advantage of the revision management features.</para>
<para id="intro-vocabulary-sect1-pa14">Modules can have some parts flagged, by means of the
<literal>condition=</literal> attribute, in order to be excluded
from certain compilations. This gives you the ability to create
more than one kind of document from <emphasis>a single
set</emphasis> of modules, improving the content re-use features
of &prog-borges;.</para>
<glossseealso otherterm="term-document"/>
<glossseealso otherterm="term-super-document"/>
<glossseealso otherterm="term-project"/>
</glossdef>
</glossentry>
<glossentry id="term-module-original">
<glossterm id="intro-vocabulary-sect1-gt8">Original Module</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it8">
<primary>Module</primary>
<secondary>Original</secondary>
</indexterm>
<para id="intro-vocabulary-sect1-pa15">This is used to specify a module which has been written by
the module redactor. Translators will use this original module as
the base for all translations.</para>
<glossseealso otherterm="term-module"/>
<glossseealso otherterm="term-module-translation"/>
</glossdef>
</glossentry>
<glossentry id="term-module-translation">
<glossterm id="intro-vocabulary-sect1-gt9">Translated Module</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it9">
<primary>Module</primary>
<secondary>Translated</secondary>
</indexterm>
<para id="intro-vocabulary-sect1-pa16">Designates a module which is not the original one, but a
translation of the original module.</para>
<glossseealso otherterm="term-module"/>
<glossseealso otherterm="term-module-original"/>
</glossdef>
</glossentry>
<glossentry id="term-module-status">
<glossterm id="intro-vocabulary-sect1-gt10">Module Status</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it10">
<primary>Module</primary>
<secondary>Status</secondary>
</indexterm>
<para id="intro-vocabulary-sect1-pa17">Modules go through different states during their life cycle.
Each <quote>state</quote> determines the module's status.</para>
<para id="intro-vocabulary-sect1-pa18">In order to go from one state to another, some operation
needs to be performed on the module, for example: writing,
translating, spell checking, proofreading, etc.</para>
<glossseealso otherterm="term-lifecycle"/>
</glossdef>
</glossentry>
<glossentry id="term-atom">
<glossterm id="intro-vocabulary-sect1-gt11">Atom</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it11">
<primary>Atom</primary>
</indexterm>
<para id="intro-vocabulary-sect1-pa19">Atoms are the &xml; elements used for checking modifications
inside a module. They are the most little possible elements that
contain text. Typical DocBook atoms are <title> and
<para>.</para> <glossseealso otherterm="term-atom-revision"/>
</glossdef>
</glossentry>
<glossentry id="term-atom-revision">
<glossterm id="intro-vocabulary-sect1-gt12">Atom Revision</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it12">
<primary>Atom</primary>
<secondary>Revision</secondary>
</indexterm>
<para id="intro-vocabulary-sect1-pa20">Atom's have a revision number used by &prog-borges;
revision management system in order to track changes made into
modules at an <quote>atom scale</quote>.</para>
<glossseealso otherterm="term-atom"/>
</glossdef>
</glossentry>
<glossentry id="term-lifecycle">
<glossterm id="intro-vocabulary-sect1-gt13">Life Cycle</glossterm>
<glossdef>
<indexterm id="intro-vocabulary-sect1-it13">
<primary>Life Cycle</primary>
</indexterm>
<para id="intro-vocabulary-sect1-pa21">The life cycle of a module is composed by several stages
(or states) that a module must go through in order to be
considered ready to be released. Currently, &prog-borges; only
supports a fixed life cycle, which is detailed in <xref linkend="module-life-cycle"/>.</para>
<glossseealso otherterm="term-module"/>
<glossseealso otherterm="term-module-status"/>
</glossdef>
</glossentry>
</glosslist>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: xml
sgml-parent-document: ("../../manuals/Borges-doc/master.top.xml" "sect1")
End:
-->
distrib
>
Mandriva
>
9.1
>
ppc
>
media
>
main
>
by-pkgid
>
6c1629ca18f6adf273e73d0f5069fa8c
>
files
>
349
