Some XML typesetting questions

Some XML typesetting questions

[Jaroslav Snajdr]

Hello,

I've started playing with XML support in Context and have a couple of problems:

1. My XML document is divided into several files. The DOCTYPE declaration looks like this:

<!DOCTYPE book PUBLIC ...docbook stuff... [
  <!ENTITY ch1 SYSTEM "chapter1.xml">
  <!ENTITY ch2 SYSTEM "chapter2.xml">
]>
<book>
..
&ch1;
&ch2;
..
</book>

How can I process this document in Context? I can define the entities &chx;, but that means to define the mapping to file at two places.

2. How to convert Docbook style chapters

<chapter>
  <title>Title</title>
  <para>...</para>
  ...
</chapter>

into

\chapter{Title}

..\par

?

Pushing and popping cannot cope with chapter content. Now I do this:

\defineXMLcommand[chapter]{\let\DBtitle=\chapter}
\defineXMLargument[title]{\DBtitle}

But I'm a bit afraid what will happen when I come to support tag arguments or other things.

Thanks for now,
-jns

Re: Some XML typesetting questions

[Berend de Boer]

Jaroslav Snajdr <jarda@tinysoftware.cz> writes:

> Pushing and popping cannot cope with chapter content. Now I do this:
> 
> \defineXMLcommand[chapter]{\let\DBtitle=\chapter}
> \defineXMLargument[title]{\DBtitle}
> 
> But I'm a bit afraid what will happen when I come to support tag
> arguments or other things.

Perhaps do something like this:

\defineXMLcommand[chapter]
        {\global\defineXMLcommand[title]{..}{..}}

So you redefine the action for title based on
chapter/section/etc. Title can be defined more or less according to
the code in the manual I assume.

(not sure if the global is needed)

-- 
Groetjes,

Berend. (-:

Re: Some XML typesetting questions

[Berend de Boer]

Jaroslav Snajdr <jarda@tinysoftware.cz> writes:

> Hello,
> 
> I've started playing with XML support in Context and have a couple of problems:
> 
> 1. My XML document is divided into several files. The DOCTYPE declaration looks like this:
> 
> <!DOCTYPE book PUBLIC ...docbook stuff... [
>   <!ENTITY ch1 SYSTEM "chapter1.xml">
>   <!ENTITY ch2 SYSTEM "chapter2.xml">
> ]>
> <book>
> ..
> &ch1;
> &ch2;
> ..
> </book>
> 
> How can I process this document in Context? I can define the
> entities &chx;, but that means to define the mapping to file at two
> places.

I think Hans should give you a call back for ENTITY. There you can do
your own parsing and define the entities based on the particular
entity definition.

AFAIK this is not yet possible.

-- 
Groetjes,

Berend. (-:

Re: Some XML typesetting questions

[Hans Hagen]

At 09:10 AM 10/8/2001 +0200, Berend de Boer wrote:
>Jaroslav Snajdr <jarda@tinysoftware.cz> writes:
>
> > Hello,
> >
> > I've started playing with XML support in Context and have a couple of 
> problems:
> >
> > 1. My XML document is divided into several files. The DOCTYPE 
> declaration looks like this:
> >
> > <!DOCTYPE book PUBLIC ...docbook stuff... [
> >   <!ENTITY ch1 SYSTEM "chapter1.xml">
> >   <!ENTITY ch2 SYSTEM "chapter2.xml">
> > ]>
> > <book>
> > ..
> > &ch1;
> > &ch2;
> > ..
> > </book>
> >
> > How can I process this document in Context? I can define the
> > entities &chx;, but that means to define the mapping to file at two
> > places.
>
>
>I think Hans should give you a call back for ENTITY. There you can do
>your own parsing and define the entities based on the particular
>entity definition.
>
>AFAIK this is not yet possible.

You're right! Say that you have:

\unprotect

\def\@@XMLescape {\@@XML esc}

\def\defineXMLescape[#1]#2{\long\setvalue{\@@XMLescape:#1}{#2}}

\defineXMLescape [--]         {\gobbleuntil{-->}}
\defineXMLescape [CDATA]      {\skipfirstverbatimlinefalse
                                \processtaggeddisplayverbatim{]]>}}
\defineXMLescape [\s!default] {\gobbleuntil{>}}

\def\executeXMLescape#1%
   {\executeifdefined{\@@XMLescape:#1}{\getvalue{\@@XMLescape:\s!default}}}

\protect

\long\def\xdoXMLelement !#1 % !-- --> or !xyz >
   {\endgroup\executeXMLescape{#1}}

Now, given that you have a </hello/> <world/> file, and a ! handler like:

\defineXMLescape [DOCTYPE] {\handleXMLescapeDOCTYPE}
\defineXMLescape [ENTITY]  {\handleXMLescapeENTITY}

\def\handleXMLescapeDOCTYPE#1[#2]>%
   {#2}

\def\handleXMLescapeENTITY#1 #2 "#3"#4>%
   {\doif{#2}{SYSTEM}{\defineXMLentity[#1]{\readfile{#3}{}{}}}}

then:

\defineXMLsingular [test] {WHOW}
\defineXMLsingular [hello] {Hello}
\defineXMLsingular [world] {World}

\startXMLdata
<!DOCTYPE some unreadable crap
   [ <!ENTITY wellwell SYSTEM "test.xml"> ]>
test <test/>
<!-- hellup -->
test <test/>
&wellwell;
\stopXMLdata

will do what you want. But i suppose that the DOCTYPE syntax is richer that 
this example and i praise myself lucky that i don;t have a copy of the 
specs here -)

Hans
-------------------------------------------------------------------------
                                   Hans Hagen | PRAGMA ADE | pragma@wxs.nl
                       Ridderstraat 27 | 8061 GH Hasselt | The Netherlands
  tel: +31 (0)38 477 53 69 | fax: +31 (0)38 477 53 74 | www.pragma-ade.com
-------------------------------------------------------------------------

Re: Some XML typesetting questions

[Berend de Boer]

Hans Hagen <pragma@wxs.nl> writes:

> will do what you want. But i suppose that the DOCTYPE syntax is richer
> that this example and i praise myself lucky that i don;t have a copy
> of the specs here -)

Do I here an excuse not to implement the full thing? :-)

        http://www.w3.org/TR/REC-xml

-- 
Groetjes,

Berend. (-:

Re: Some XML typesetting questions

[Hans Hagen]

At 12:00 PM 10/8/2001 +0200, Berend de Boer wrote:
>http://www.w3.org/TR/REC-xml

hm, but i wonder if it makes sense to start interpreting this 
dtd-inside-a-doc thing completely; maybe only those things that make sense, 
so the question is; what makes sense

Hans
-------------------------------------------------------------------------
                                   Hans Hagen | PRAGMA ADE | pragma@wxs.nl
                       Ridderstraat 27 | 8061 GH Hasselt | The Netherlands
  tel: +31 (0)38 477 53 69 | fax: +31 (0)38 477 53 74 | www.pragma-ade.com
-------------------------------------------------------------------------

Re: Some XML typesetting questions

[Berend de Boer]

Hans Hagen <pragma@wxs.nl> writes:

> hm, but i wonder if it makes sense to start interpreting this
> dtd-inside-a-doc thing completely; maybe only those things that make
> sense, so the question is; what makes sense

Good question... Support for the include thing is ok. For all else
give people the raw stuff or so and wait until people start to ask
support for specific things.

-- 
Groetjes,

Berend. (-:

Re: Some XML typesetting questions

[Simon Pepping]

Hans,

Interesting, this looks like your API for XML programming. How do I go
about to understand this? Is there documentation, or should I just
work my way through the expansions produced by \tracingcommands=1? Or
should I not try to understand this?

Simon

On Mon, Oct 08, 2001 at 11:25:50AM +0200, Hans Hagen wrote:
> \unprotect
> 
> \def\@@XMLescape {\@@XML esc}
> 
> \def\defineXMLescape[#1]#2{\long\setvalue{\@@XMLescape:#1}{#2}}
> 
> \defineXMLescape [--]         {\gobbleuntil{-->}}
> \defineXMLescape [CDATA]      {\skipfirstverbatimlinefalse
>                                 \processtaggeddisplayverbatim{]]>}}
> \defineXMLescape [\s!default] {\gobbleuntil{>}}
> 
> \def\executeXMLescape#1%
>    {\executeifdefined{\@@XMLescape:#1}{\getvalue{\@@XMLescape:\s!default}}}
> 
> \protect
> 
> \long\def\xdoXMLelement !#1 % !-- --> or !xyz >
>    {\endgroup\executeXMLescape{#1}}
> 
> Now, given that you have a </hello/> <world/> file, and a ! handler like:
> 
> \defineXMLescape [DOCTYPE] {\handleXMLescapeDOCTYPE}
> \defineXMLescape [ENTITY]  {\handleXMLescapeENTITY}
> 
> \def\handleXMLescapeDOCTYPE#1[#2]>%
>    {#2}
> 
> \def\handleXMLescapeENTITY#1 #2 "#3"#4>%
>    {\doif{#2}{SYSTEM}{\defineXMLentity[#1]{\readfile{#3}{}{}}}}
> 
> then:
> 
> \defineXMLsingular [test] {WHOW}
> \defineXMLsingular [hello] {Hello}
> \defineXMLsingular [world] {World}
> 

-- 
Simon Pepping
email: spepping@scaprea.hobby.nl

Re: Some XML typesetting questions

[Hans Hagen]

At 07:16 PM 10/8/2001 +0200, Berend de Boer wrote:
>Hans Hagen <pragma@wxs.nl> writes:
>
> > hm, but i wonder if it makes sense to start interpreting this
> > dtd-inside-a-doc thing completely; maybe only those things that make
> > sense, so the question is; what makes sense
>
>Good question... Support for the include thing is ok. For all else
>give people the raw stuff or so and wait until people start to ask
>support for specific things.

then, is this

ENTITY bla SYSTEM "filename"

the pattern to support?

Hans

-------------------------------------------------------------------------
                                   Hans Hagen | PRAGMA ADE | pragma@wxs.nl
                       Ridderstraat 27 | 8061 GH Hasselt | The Netherlands
  tel: +31 (0)38 477 53 69 | fax: +31 (0)38 477 53 74 | www.pragma-ade.com
-------------------------------------------------------------------------

Re: Some XML typesetting questions

[Hans Hagen]

At 10:33 PM 10/8/2001 +0200, Simon Pepping wrote:

>Interesting, this looks like your API for XML programming. How do I go
>about to understand this? Is there documentation, or should I just
>work my way through the expansions produced by \tracingcommands=1? Or
>should I not try to understand this?

in a couple of days i will release the new xtag modules, most of the 
interfac eis described in eXaMpLe.pdf but not yet this 'written in 5 
minutes' api.

>Simon
>
>On Mon, Oct 08, 2001 at 11:25:50AM +0200, Hans Hagen wrote:
> > \unprotect
> >
> > \def\@@XMLescape {\@@XML esc}

everything xml has a namespace, this is the prefix, not for users

> > \def\defineXMLescape[#1]#2{\long\setvalue{\@@XMLescape:#1}{#2}}
> >
> > \defineXMLescape [--]         {\gobbleuntil{-->}}
> > \defineXMLescape [CDATA]      {\skipfirstverbatimlinefalse
> >                                 \processtaggeddisplayverbatim{]]>}}
> > \defineXMLescape [\s!default] {\gobbleuntil{>}}

these are default def's, using a couple of context system macros, described 
in syst-*.tex (it may be worth printing the documentation for syst-gen.tex 
and alike: texexec --pdf --modu syst-tex.tex

> > \def\executeXMLescape#1%
> >    {\executeifdefined{\@@XMLescape:#1}{\getvalue{\@@XMLescape:\s!default}}}

again, something not for the user, this hooks into the element handler 
(which captures ? ! and the rest)

> > \protect
> >
> > \long\def\xdoXMLelement !#1 % !-- --> or !xyz >
> >    {\endgroup\executeXMLescape{#1}}
> >
> > Now, given that you have a </hello/> <world/> file, and a ! handler like:
> >
> > \defineXMLescape [DOCTYPE] {\handleXMLescapeDOCTYPE}
> > \defineXMLescape [ENTITY]  {\handleXMLescapeENTITY}
> >
> > \def\handleXMLescapeDOCTYPE#1[#2]>%
> >    {#2}
> >
> > \def\handleXMLescapeENTITY#1 #2 "#3"#4>%
> >    {\doif{#2}{SYSTEM}{\defineXMLentity[#1]{\readfile{#3}{}{}}}}

this is the kind of stuff that users can write to extend the parser, btu i 
will probably add reasonable thinsg to the kernel

what happens here is that (since <! can end up in anything) you need to 
grab eveything till the end sequence, for instance being --> or ]> ior 
whatever. Here a little knowledge of tex and xml helps -)

> > then:
> >
> > \defineXMLsingular [test] {WHOW}
> > \defineXMLsingular [hello] {Hello}
> > \defineXMLsingular [world] {World}

this is described in example.pdf

Hans
-------------------------------------------------------------------------
                                   Hans Hagen | PRAGMA ADE | pragma@wxs.nl
                       Ridderstraat 27 | 8061 GH Hasselt | The Netherlands
  tel: +31 (0)38 477 53 69 | fax: +31 (0)38 477 53 74 | www.pragma-ade.com
-------------------------------------------------------------------------

Re: Some XML typesetting questions

[Berend de Boer]

Hans Hagen <pragma@wxs.nl> writes:

> then, is this
> 
> ENTITY bla SYSTEM "filename"
> 
> the pattern to support?

Exactly.

It's often used in things like this:

-----------------------
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE document [
  <!ENTITY body SYSTEM "body.xml">
  <!ENTITY sidebar SYSTEM "sidebar.xml">
]>
<document>
<title>Eiffel</title>
<meta name="Description" content="Berend's Eiffel page"/>
<meta name="keywords" content="eiffel"/>
<body>
&body;
</body>
<sidebar>
&sidebar;
</sidebar>
</document>
-----------------------

-- 
Groetjes,

Berend. (-:

Re: Some XML typesetting questions

[Hans Hagen]

At 11:53 AM 10/9/2001 +0200, Berend de Boer wrote:
>Hans Hagen <pragma@wxs.nl> writes:
>
> > then, is this
> >
> > ENTITY bla SYSTEM "filename"
> >
> > the pattern to support?
>
>Exactly.
>
>It's often used in things like this:
>
>-----------------------
><?xml version="1.0" encoding="ISO-8859-1" ?>
><!DOCTYPE document [
>   <!ENTITY body SYSTEM "body.xml">
>   <!ENTITY sidebar SYSTEM "sidebar.xml">

yes, but according to bradley there can also be "yetanother.dtd" there so i 
assume that the inclusion should be limited to xml ?

taco: what was this about graphics? Should &whatamess; then expand to 
\externalfigure[whatamess] ? How does one know what is a figure?

Hans

-------------------------------------------------------------------------
                                   Hans Hagen | PRAGMA ADE | pragma@wxs.nl
                       Ridderstraat 27 | 8061 GH Hasselt | The Netherlands
  tel: +31 (0)38 477 53 69 | fax: +31 (0)38 477 53 74 | www.pragma-ade.com
-------------------------------------------------------------------------

Re: Some XML typesetting questions

[Simon Pepping]

On Tue, Oct 09, 2001 at 05:38:34PM +0200, Hans Hagen wrote:
> At 11:53 AM 10/9/2001 +0200, Berend de Boer wrote:
> >Hans Hagen <pragma@wxs.nl> writes:
> >
> > > then, is this
> > >
> > > ENTITY bla SYSTEM "filename"
> > >
> > > the pattern to support?
> >
> >Exactly.
> >
> >It's often used in things like this:
> >
> >-----------------------
> ><?xml version="1.0" encoding="ISO-8859-1" ?>
> ><!DOCTYPE document [
> >   <!ENTITY body SYSTEM "body.xml">
> >   <!ENTITY sidebar SYSTEM "sidebar.xml">
> 
> yes, but according to bradley there can also be "yetanother.dtd" there so i 
> assume that the inclusion should be limited to xml ?
> 
> taco: what was this about graphics? Should &whatamess; then expand to 
> \externalfigure[whatamess] ? How does one know what is a figure?

I do not have the spec at hand, but I think these patterns occur:

<!DOCTYPE rootelement [
  <!ENTITY name SYSTEM "filename.xml">
  <!ENTITY name PUBLIC "PubId" "filename.xml">
  <!ENTITY figname SYSTEM "figname.gif" NOTATION gifimage>
]>

The notation marks it as a non-parsed entity, i.e., a non-xml
file. The notation must have been declared in the DTD or in the
internal part of the DTD.

<!NOTATION GIF		SYSTEM "GIF">
<!NOTATION GIF87a   PUBLIC
"-//CompuServe//NOTATION Graphics Interchange Format 87a//EN">

I do not think you can include a figure by just using an entity
&figname;. The entity should be the value of an attribute, e.g.
<!ENTITY eiffeltower SYSTEM "figures/eiffeltower.gif" NOTATION gifimage>
<imagedata entityref="eiffeltower" format="gif"/>.
But more direct approaches also occur:
<imagedata fileref="figures/eiffeltower.gif" format="gif"/>
(from docbook).

All entities may be parameter entities: <!ENTITY % name ..., but then
they can only contain pieces of DTD or ENTITIES.

Each public ID must be followed by a system ID. Public IDs are rarely
used for non-dtd files.

Public IDs and system IDs can be mapped to actual paths via an entity
resolver mechanism. In SGML that was the catalog; I am not sure how it
is done in XML. I guess you should only support unmapped system IDs.

So basically, you should indeed only support this pattern:

   ENTITY bla SYSTEM "filename"

Simon

-- 
Simon Pepping
email: spepping@scaprea.hobby.nl

Re: Some XML typesetting questions

[Hans Hagen]

At 07:05 PM 10/9/2001 +0200, Berend de Boer wrote:

><?xml version="1.0" encoding="ISO-8859-1" ?>
><!DOCTYPE document [
>    <!ENTITY yes SYSTEM "http://www.oops.com/yes.xml">

well, at eurotex fabrice p demonstrated me a tex that could really suck 
such files in from the web , so never say that tex cannot do it -)

Hans

-------------------------------------------------------------------------
                                   Hans Hagen | PRAGMA ADE | pragma@wxs.nl
                       Ridderstraat 27 | 8061 GH Hasselt | The Netherlands
  tel: +31 (0)38 477 53 69 | fax: +31 (0)38 477 53 74 | www.pragma-ade.com
-------------------------------------------------------------------------

Re: Some XML typesetting questions

[Hans Hagen]

At 07:05 PM 10/9/2001 +0200, Berend de Boer wrote:
>Hans Hagen <pragma@wxs.nl> writes:
>
> > yes, but according to bradley there can also be "yetanother.dtd" there
> > so i assume that the inclusion should be limited to xml ?
>
>And so forth. It would indeed by nice if you could just load/parse
>xml/dtd in these cases as if it was included right there, just doing an
>\input and continuing is fine.
>
>I think you can do that for any file mentioned in that way, whether it
>has the .dtd or .xml or extension or something else. Parsers also just
>load the stuff.
>
>Something I forgot: I think this is also valid:
>
><?xml version="1.0" encoding="ISO-8859-1" ?>
><!DOCTYPE document [
>    <!ENTITY yes SYSTEM "http://www.oops.com/yes.xml">

the next release supports some of the stuff that makes sense; apart from 
generally being faster, the next context release will no integrate xml in 
such a way that no special settings are needed for tui/buffer/whatever 
files, i.e. it kind of adapts itself.

Hans
-------------------------------------------------------------------------
                                   Hans Hagen | PRAGMA ADE | pragma@wxs.nl
                       Ridderstraat 27 | 8061 GH Hasselt | The Netherlands
  tel: +31 (0)38 477 53 69 | fax: +31 (0)38 477 53 74 | www.pragma-ade.com
-------------------------------------------------------------------------