Re: Question about entities in Mallard

[Jim Campbell <jwcampbell gmail com>]

Hi All,

2009/11/24 Shaun McCance <shaunm gnome org>

Jim, this technique works fine for me.  I've attached a Mallard
page that defines and uses an entity for the title.  This shows
fine in Yelp, and it validates.

The trickier question is how to include the standard character
entities.  There are similar DOCTYPE tricks, but you'll need
to have them installed on your system.  It turns out that you
do have them installed as part of the DocBook package, but do
we want to rely on that?  Should we encourage people to use
DocBook's character entity definitions?  Should we ship our
own character entity definitions?

/me thinks the standard character entities should have just
been part of the XML standard.

--
Shaun

Based on what Shaun provided, I was able to get the following to work:

<!DOCTYPE page [

<!ENTITY % entities-xfce SYSTEM "../../doc-libs/entities-xfce.ent">

%entities-xfce;

<!ENTITY % entities-xfce-app SYSTEM "../../doc-libs/entities-xfce-app.ent">

%entities-xfce-app;

]>

<page xmlns="http://projectmallard.org/1.0/"

      type="topic"

      id="introduction">

. . . 

-----------

As for now, I have all of my actual documentation in a "docs" folder, but have a separate doc-libs and images folder, too.  Yelp properly displays both the external entities and the images that I placed in a folder separate from the documents.

This is the desired behavior for me, but I wanted to check in and make sure that I'm not breaking any Mallard rules, or if any of what I've done actually only works because I have some docbook files installed on my system.

Any input?

Thanks, all,

Jim