[ECOS] CVS docs

[ECOS] CVS docs

[Iztok Zupet]

[-- Attachment #1: Type: text/plain, Size: 566 bytes --]

Hello,

It's possible to edit the SGML's using the Xmetal 2 or 3. To achieve that, You 
must import the docbook 3.1 dtd and accompanying files into the Xmetal's 
Rules directory and modify the catalog inthere like the one in attachment.

Since there's no support for dsssl or xsl styles in the Xmetal editor, You 
must use the docbook.css from the attachment, in order that the preview 
works. Just copy the css from the attachment into the Xmetal's Display 
directory.

Xmetal has a nice TagOn view and nice support for tag editing, besides 
WYSIWYG.

Regards
Iztok

[-- Attachment #2: catalog --]
[-- Type: text/plain, Size: 3182 bytes --]


-- 
 Default Catalog for Template and other files

 W3C DTDs and entity sets
--

PUBLIC "-//W3C//DTD HTML 4.0//EN" "strict.dtd"
PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "loose.dtd"
PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN" "frameset.dtd"
PUBLIC "-//W3C//ENTITIES Latin1//EN//HTML" "entities/HTMLlat1.ent"
PUBLIC "-//W3C//ENTITIES Symbols//EN//HTML" "entities/HTMLsymbol.ent"
PUBLIC "-//W3C//ENTITIES Special//EN//HTML" "entities/HTMLspecial.ent"

-- Entries for journalist DTD --

PUBLIC "-//SoftQuad Software//DTD Journalist v2.0 20000501//EN" "journalist.dtd"
PUBLIC "-//SoftQuad Software//DTD Journalist v1.0 19990409//EN" "journalist.dtd"

-- XML versions of ISO entity sets --

PUBLIC "ISO 8879:1986//ENTITIES Added Latin 1//EN//XML" "entities/ISOlat1.pen"
PUBLIC "ISO 8879:1986//ENTITIES Added Latin 2//EN//XML" "entities/ISOlat2.pen"
PUBLIC "ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN//XML" 	"entities/ISOnum.pen"
PUBLIC "ISO 8879:1986//ENTITIES Publishing//EN//XML" "entities/ISOpub.pen"
PUBLIC "ISO 8879:1986//ENTITIES General Technical//EN//XML" "entities/ISOtech.pen"
-- ...................................................................... --


  -- Catalog data for DocBook V3.1 ........................................ --
  -- File docbook.cat ..................................................... --

  -- Please direct all questions, bug reports, or suggestions for
     changes to the davenport@berkshire.net mailing list. For more
     information, see http://www.oasis-open.org/.
  --

  -- This is the catalog data file for Version 3.1 of the DocBook DTD.
     It is provided as a convenience in building your own catalog files.
     You need not use the filenames listed here, and need not use the
     filename method of identifying storage objects at all.  See the
     documentation for detailed information on the files associated with
     the DocBook DTD.  See SGML Open Technical Resolution 9401 for
     detailed information on supplying and using catalog data.
  --

  -- ...................................................................... --
  -- SGML declaration associated with DocBook ............................. --

SGMLDECL "docbook.dcl"

  -- ...................................................................... --
  -- DocBook driver file .................................................. --

PUBLIC "-//OASIS//DTD DocBook V3.1//EN" "docbook.dtd"

  -- ...................................................................... --
  -- DocBook modules ...................................................... --

PUBLIC "-//USA-DOD//DTD Table Model 951010//EN" "cals-tbl.dtd"
PUBLIC "-//OASIS//ELEMENTS DocBook Information Pool V3.1//EN" "dbpool.mod"
PUBLIC "-//OASIS//ELEMENTS DocBook Document Hierarchy V3.1//EN" "dbhier.mod"
PUBLIC "-//OASIS//ENTITIES DocBook Additional General Entities V3.1//EN" "dbgenent.mod"
PUBLIC "-//OASIS//ENTITIES DocBook Notations V3.1//EN" "dbnotn.mod"
PUBLIC "-//OASIS//ENTITIES DocBook Character Entities V3.1//EN" "dbcent.mod"

  -- End of catalog data for DocBook V3.1 ................................. --
  -- ...................................................................... --

[-- Attachment #3: docbook.css --]
[-- Type: text/css, Size: 12780 bytes --]


/* 
 * Cloned for use with DocBook V3.1 (eCos) by iz@vsr.si. Now has enoug styles 
 * to see the document structure in Xmetal's TagOn an WYSIWYG mode.
 * 
 * Original was:
 * Some CSS styles for DocBook V4.
 * (Not exhaustive. Has enough styles to render the LDP Author Guide.)
 *
 * If you improve it, please send me (hussein@xmlmind.com) a copy.
 */

abstract, ackno{   display: block;
}
address{   display: block;
font-family:Arial;
font-weight:bold;
}
affiliation, alt, answer, appendix, areaspec, arg, article, attribution, audioobject, author, authorblurb, authorgroup, beginpage, bibliodiv, biblioentry, bibliography, bibliomixed, bibliomset, biblioset, blockquote, book, bookbiblio, bridgehead, callout, calloutlist, caption, caution, chapter, city, cmdsynopsis, collab, colophon, comment, confdates, confgroup, confnum, confsponsor, conftitle, contractnum, contractsponsor, contrib, copyright, corpauthor, corpname, country, dedication, edition, editor, epigraph, equation, example, figure, firstname, footnote, formalpara, funcprototype, funcsynopsis, funcsynopsisinfo, glossary, glossdef, glossentry, glosslist, glosssee, glossseealso, graphic, graphicco, group, highlights, holder, honorific, imageobject, imageobjectco, important, index, indexdiv, indexentry, informalequation, informalexample, informalfigure, issuenum, itemizedlist, itermset, jobtitle, keywordset, legalnotice, lineage, listitem, literallayout, lot, lotentry, mediaobject, mediaobjectco, member, msg, msgaud, msgentry, msgexplan, msginfo, msglevel, msgmain, msgorig, msgrel, msgset, msgsub, msgtext, note, orderedlist, otheraddr, othercredit, othername, para, part, partintro, phone, pob, postcode, preface, primaryie, printhistory, procedure, programlisting, programlistingco, publisher, publishername, qandadiv, qandaentry, qandaset, question, refclass, refdescriptor, refentry, refentrytitle, reference, refmiscinfo, refname, refnamediv, refsect1, refsect2, refsect3, refsynopsisdiv, releaseinfo, revhistory, revision, revremark, sbr, screen, screenco, screenshot, secondaryie, sect1, sect2, sect3, sect4, sect5, section, seealsoie, seeie, seglistitem, segmentedlist, set, setindex, shortaffil, sidebar, simpara, simplelist, simplesect, state, step, street, subject, subjectset, subjectterm, substeps, subtitle, surname, synopfragment, synopfragmentref, synopsis, term, tertiaryie, textobject, tip, title, toc, tocback, tocchap, tocentry, tocfront, toclevel1, toclevel2, toclevel3, toclevel4, toclevel5, tocpart, variablelist, varlistentry, videoobject, warning {
  display: block;
}

/* It is not really useful to style meta-information. */
articleinfo, bookinfo, docinfo, objectinfo, refmeta, refsect1info, refsect2info, refsect3info, refsynopsisdivinfo, screeninfo, sect1info, sect2info, sect3info, sect4info, sect5info, sectioninfo, setinfo, titleabbrev, indexterm {
  display: tree;
}

/*
 * Title styles
 */
chapter > title, glossary > title {
  font-size: 2em;
  font-weight: bold;
  color: maroon;
  margin-top: .67ex;
  margin-bottom: .67ex;
}

chapter > title:before {
  content: "Chapter " counter(n-, upper-roman) "\A";
}

article > title, bookinfo > title, legalnotice > title, part >title {
  font-size: 2em;
  margin-top: .67ex;
  margin-bottom: .67ex;
  text-align: center;
}

subtitle {
  font-weight: bold;
  color: maroon;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

article > subtitle {
  text-align: center;
}

sect1 > title, sect2 > title, sect3 > title, sect4 > title, sect5 > title, section > title {
  font-weight: bold;
  color: maroon;
}

sect1 > title, section > title {
  font-size: 1.5em;
  margin-top: .83ex;
  margin-bottom: .83ex;
}

sect2 > title, section section > title {
  font-size: 1.17em;
  margin-top: 1ex;
  margin-bottom: 1ex;
}

sect3 > title, sect4 > title, sect5 > title, section section section > title, section section * section > title {
  font-size: 1em;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

sect1 > title:before, section > title:before {
  content: counter(n-) " ";
}

sect2 > title:before, section section > title:before {
  content: counter(nn-) " ";
}

sect3 > title:before, section section section > title:before {
  content: counter(nnn-) " ";
}

sect4 > title:before, section section section section > title:before {
  content: counter(nnnn-) " ";
}

/* No counters for sect5 and up */
section section section * section > title:before {
  content: "";
}

/*
 * Table style
 */
table, informaltable {
  display: block;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

table > title {
  font-style: italic;
  text-align: center;
  margin-left: 2ex;
  margin-right: 2ex;
  margin-bottom: 2pt;
}

tgroup {
  display: table;
  text-align: eval;
  border-top: 1pt gray outset;
  border-right: 1 gray outset;
  border-bottom: 1 gray outset;
  border-left: 1pt gray outset;
}

colspec, spanspec {
  display: table-column;
}

thead, tbody, tfoot {
  display: table-row-group;
}

row {
  display: table-row;
}

entry {
  display: table-cell;
  text-align: eval;
  padding-top: 2pt;
  padding-left: 2pt;
  padding-right: 2pt;
  padding-bottom: 2pt;
  border-top: 1pt gray inset;
  border-right: 1 gray inset;
  border-bottom: 1 gray inset;
  border-left: 1pt gray inset;
}

entry > *:first-child {
  margin-top: 0pt;
  margin-bottom: 0pt;
}

entrytbl {
  display: table;
  padding-top: 2pt;
  padding-left: 2pt;
  padding-right: 2pt;
  padding-bottom: 2pt;
  border-top: 1pt gray inset;
  border-right: 1 gray inset;
  border-bottom: 1 gray inset;
  border-left: 1pt gray inset;
}

/*
 * Block styles
 */
para, simpara, formalpara {
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

formalpara > * {
  margin-top: 0pt;
  margin-bottom: 0pt;
}

formalpara > title {
  font-weight: bold;
}

listitem > *:first-child {
  margin-top: 0pt;
  margin-bottom: 0pt;
}

itemizedlist {
  margin-left: 2ex;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

itemizedlist > listitem {
  margin-left: 2.5ex;
}

itemizedlist > listitem:before {
  display: marker;
  content: disc;
}

itemizedlist > listitem itemizedlist > listitem:before {
  display: marker;
  content: square;
}

itemizedlist > listitem itemizedlist > listitem itemizedlist > listitem:before {
  display: marker;
  content: icon(diamond);
}

itemizedlist > listitem itemizedlist > listitem itemizedlist > listitem itemizedlist > listitem:before {
  display: marker;
  content: circle;
}

orderedlist {
  margin-left: 2ex;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

orderedlist > listitem {
  margin-left: 6ex;
}

orderedlist > listitem:before {
  display: marker;
  content: counter(n, decimal);
  font-weight: bold;
}

orderedlist[numeration=loweralpha] > listitem:before {
  display: marker;
  content: counter(n, lower-alpha);
}

orderedlist[numeration=upperalpha] > listitem:before {
  display: marker;
  content: counter(n, upper-alpha);
}

orderedlist[numeration=lowerroman] > listitem:before {
  display: marker;
  content: counter(n, lower-roman);
}

orderedlist[numeration=upperroman] > listitem:before {
  display: marker;
  content: counter(n, upper-roman);
}

variablelist {
  margin-left: 2ex;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

varlistentry > term {
  font-weight: bold;
}

varlistentry > listitem {
  margin-left: 4ex;
}

glossentry {
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

glossentry > glossterm {
  display: block;
  font-style: italic;
}

glossdef {
  margin-left: 4ex;
}

glossdef > *:first-child {
  margin-top: 0pt;
  margin-bottom: 0pt;
}

qandaentry {
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

question {
  font-style: italic;
}

question, answer {
  margin-left: 4ex;
}

question:before {
  content: "Q:";
  display: marker;
  color: olive;
  font-weight: bold;
  font-style: normal;
}

answer:before {
  content: "A:";
  display: marker;
  color: olive;
  font-weight: bold;
}

question > *:first-child, answer > *:first-child {
  margin-top: 0pt;
  margin-bottom: 0pt;
}    

simplelist {
  margin-left: 4ex;
}

member {
  margin-left: 2.5ex;
}

note {
  margin-left: 10ex;
}

note:before {
  content: "note ";
  display: marker;
  color: olive;
}

tip {
  margin-left: 10ex;
}

tip:before {
  content: "tip ";
  display: marker;
  color: olive;
}

footnote {
  font-size: .83em;
  margin-left: 15ex;
  margin-right: 5ex;
}

footnote:before {
  content: "footnote ";
  display: marker;
  color: olive;
}

programlisting, screen {
  white-space: pre;
  background-color: #E0E0E0;
  border: thin gray solid;
  font-family: monospace;
  font-size: .83em;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

literallayout, screen {
  white-space: pre;
  border: thin gray solid;
  font-family: monospace;
  font-size: 1.0em;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}
programlistingco {
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
  padding-top: 1ex;
  padding-left: 1ex;
  padding-right: 1ex;
  padding-bottom: 1ex;
  border-top: 1pt gray solid;
  border-right: 1 gray solid;
  border-bottom: 1 gray solid;
  border-left: 1pt gray solid;
}

programlistingco programlisting {
  border: none;
}

areaspec:before {
  content: "areas ";
  color: olive;
}

area, co {
  content: icon(left-half-disc) counter(n) icon(right-half-disc);
  color: olive;
}

callout {
  margin-left: 6ex;
}

callout > *:first-child {
  margin-top: 0pt;
  margin-bottom: 0pt;
}

calloutlist > callout:before {
  display: marker;
  content: icon(left-half-disc) counter(n) icon(right-half-disc);
  color: olive;
}

figure, mediaobject {
  text-align: center;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

figure > title, caption {
  font-style: italic;
}

caption > *:first-child {
  margin-top: 0pt;
  margin-bottom: 0pt;
}

/* 
 *  Showing a 400x200 thumbnail is sufficient. 
 *  If you don't like that, replace the content property by a more traditional:
 *  content: image(attr(fileref));
 */
graphic, imagedata {
  content: image(attr(fileref) -400 -200);
}

blockquote {
  margin-left: 10ex;
  margin-right: 10ex;
  margin-top: 1.33ex;
  margin-bottom: 1.33ex;
}

blockquote > title, attribution {
  font-style: italic;
}

attribution {
  text-align: right;
}

attribution:before {
  content: "-- ";
}

/*
 * Inline styles
 */
emphasis {
  font-style: italic;
}

emphasis[role=bold] {
  font-style: normal;
  font-weight: bold;
}

literal, filename, command, envar, parameter {
  font-family: monospace;
  font-size: .83em;
}

parameter, replaceable {
  font-style: italic;
}

anchor:after {
  content: icon(left-target);
  vertical-align: text-top;
  color: olive;
}

link, ulink, email {
  color: navy;
  text-decoration: underline;
}

xref {
  content: icon(right-link);
  vertical-align: text-top;
  color: navy;
}

foreignphrase {
  font-style: italic;
}

sgmltag {
  color: red;
}

sgmltag[class="starttag"]:before {
  content: "<";
}

sgmltag[class="endtag"]:before {
  content: "</";
}

sgmltag[class="starttag"]:after, sgmltag[class="endtag"]:after {
  content: ">";
}

quote:before {
  content: open-quote;
}

quote:after {
  content: close-quote;
}

@media print {
    articleinfo, bookinfo, docinfo, objectinfo, refmeta, refsect1info, refsect2info, refsect3info, refsynopsisdivinfo, screeninfo, sect1info, sect2info, sect3info, sect4info, sect5info, sectioninfo, setinfo, titleabbrev, indexterm {
        display: none;
    }

    colspec, spanspec {
        display: none;
    }

    * {
	background-color: transparent;
        line-height: 1.2;
    }

    programlisting, screen {
        background-color: #FFFFE0;
        border: 1 solid #E0E0A0;
    }

    graphic, imagedata {
        content: image(attr(fileref), -500, -700, smooth);
    }
}
YEAR:after{
content:", ";
}





[-- Attachment #4: Type: text/plain, Size: 146 bytes --]

-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss

Re: [ECOS] CVS docs

[Bart Veer]

>>>>> "Iztok" == Iztok Zupet <iztok.zupet@vsr.si> writes:

    Iztok> Hello,

    Iztok> It's possible to edit the SGML's using the Xmetal 2 or 3.
    Iztok> To achieve that, You must import the docbook 3.1 dtd and
    Iztok> accompanying files into the Xmetal's Rules directory and
    Iztok> modify the catalog inthere like the one in attachment.

    Iztok> Since there's no support for dsssl or xsl styles in the
    Iztok> Xmetal editor, You must use the docbook.css from the
    Iztok> attachment, in order that the preview works. Just copy the
    Iztok> css from the attachment into the Xmetal's Display
    Iztok> directory.

    Iztok> Xmetal has a nice TagOn view and nice support for tag
    Iztok> editing, besides WYSIWYG.

I am not familiar with Xmetal, but there is an important issue about
such tools generally. They may not mess about with the SGML contents
of a document. However when outputting the savefile most tools will
completely change the structure. For example tags may be indented
differently, whitespace may get removed or added, paragraphs may get
wrapped using a different number of columns, etc. This will not be
noticeable if you only use a single tool, but other people using e.g.
emacs may be badly affected.

As an example, compare the raw text of e.g.
kernel/current/doc/kernel.sgml and
compat/uitron/current/doc/uitron.sgml. The former was written in
emacs, and I would be rather unhappy if the structure changed
completely because somebody edited the document in a WYSIWYG tool.

Worse, if people start using different tools and the structure is
changed then CVS diffs and histories can become completely useless: as
far as CVS can tell the whole file has been changed. This also makes
it difficult to generate a simple patch. Possibly tools like osgmlnorm
could be used, but I don't know how effective they are.

Bart

-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss

Re: [ECOS] CVS docs

[Iztok Zupet]

On Tuesday 29 October 2002 23:01, Bart Veer wrote:
> I am not familiar with Xmetal, but there is an important issue about
> such tools generally. They may not mess about with the SGML contents
> of a document. However when outputting the savefile most tools will
> completely change the structure. For example tags may be indented
> differently, whitespace may get removed or added, paragraphs may get
> wrapped using a different number of columns, etc. This will not be
> noticeable if you only use a single tool, but other people using e.g.
> emacs may be badly affected.

In fact, Xmetal preserves the structure of the file, with an exception: If You 
edit the file in one of WYSIWYG modes, it invents some structure of it's own 
for the edited or inserted part. But You can correct that in plain edit mode.

But that still doesn't mean I'm buying it, since it does not support the 
latin2 entity, which is defacto standard in our country.

iz

-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss

Re: [ECOS] CVS docs

[Iztok Zupet]

On Wednesday 30 October 2002 09:17, Koeller, T. wrote:
> Being completely ignorant of this topic, I wonder if there isn't some
> post-processing tool to rectify the document structure after changes
> have been made. Or if it's only about whitespace usage, couldn't
> such a tool be written easily? I think of something like 'indent'.
>
> This could at least solve the CVS problem.

I've heard of such tools for HTML but not for SGML. I think one of them could 
be easily modified to support DocBook style. 

But:
there are portions of text in the file which the tool shouldn't touch, for 
instance <LITERALLAYOUT> and <PROGRAMLISTING>.

Regards
iz

-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss

RE: [ECOS] CVS docs

[Koeller, T.]

Being completly ignorant of this topic, I wonder if there isn't some
post-processing tool to rectify the document structure after changes
have been made. Or if it's only about whitespace usage, couldn't
such a tool be written easily? I think of something like 'indent'.

This could at least solve the CVS problem.

tk
----------------------------------------------- 
Thomas Koeller, Software Development 

Basler Vision Technologies 
An der Strusbek 60-62 
22926 Ahrensburg 
Germany 

Tel +49 (4102) 463-390 
Fax +49 (4102) 463-46390

mailto:Thomas.Koeller@baslerweb.com 
http://www.baslerweb.com 




> -----Original Message-----
> From: Iztok Zupet [mailto:iztok.zupet@vsr.si]
> Sent: Wednesday, October 30, 2002 1:00 AM
> To: Bart Veer
> Cc: ecos-discuss@sources.redhat.com
> Subject: Re: [ECOS] CVS docs
> 
> 
> On Tuesday 29 October 2002 23:01, Bart Veer wrote:
> > I am not familiar with Xmetal, but there is an important issue about
> > such tools generally. They may not mess about with the SGML contents
> > of a document. However when outputting the savefile most tools will
> > completely change the structure. For example tags may be indented
> > differently, whitespace may get removed or added, paragraphs may get
> > wrapped using a different number of columns, etc. This will not be
> > noticeable if you only use a single tool, but other people 
> using e.g.
> > emacs may be badly affected.
> 
> In fact, Xmetal preserves the structure of the file, with an 
> exception: If You 
> edit the file in one of WYSIWYG modes, it invents some 
> structure of it's own 
> for the edited or inserted part. But You can correct that in 
> plain edit mode.
> 
> But that still doesn't mean I'm buying it, since it does not 
> support the 
> latin2 entity, which is defacto standard in our country.
> 
> iz
> 
> -- 
> Before posting, please read the FAQ: 
> http://sources.redhat.com/fom/ecos
> and search the list archive: http://sources.redhat.com/ml/ecos-discuss
> 

-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss

[ECOS] CVS docs

[Iztok Zupet]

According to CVS repository changes, the docs on
<http://www.vsr.si/ecos> were just updated.

Please check and update.

Regards
iz





-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss