Nabble - Gnome - Documentation

Use gnome-doc-tool on Mallard documents

2009-12-04T16:31:00Z

Hi all,

I've just committed changed to gnome-doc-utils to allow you
to use gnome-doc-tool to generate HTML for Mallard documents.
This will be in the next unstable release.

If you don't want to wait, I'm attaching a built copy of
gnome-doc-tool. As long as gnome-doc-utils is installed
in /usr on your system, this should work fine.

Quack,
Shaun

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

gnome-doc-tool (17K) Download Attachment

Re: Question about entities in Mallard

2009-12-03T19:14:17Z

On Thu, 2009-12-03 at 18:47 -0600, Jim Campbell wrote:

> 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,

Not at all. This is all standard (if advanced) XML stuff.
I don't discuss any of this in the Mallard spec in part
because it's not Mallard-specific, and in part because I
don't want to confuse people.

> or if any of what I've done actually only works because I have some
> docbook files installed on my system.

You haven't directly done anything DocBook-specific, but
I don't know what's in those entity files you reference.
If those are including DocBook files, then you've got a
DocBook dependency. Otherwise, no.

What you might consider doing is installing these files
on the system somewhere and registering them with the
system-wide XML catalog. Then you could reference them
with a canonical URI and have them automatically looked]
up by libxml2.
>
The only caveat is that Yelp passes XML_PARSE_NONET to
libxml2, which means it won't hit the network to resolve
entity references. So if you use a canonical http URI,
and you don't have a system-installed file registered
with the XML catalog, your entities won't be resolved.

--
Shaun

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Question about entities in Mallard

2009-12-03T16:47:57Z

Hi All,

2009/11/24 Shaun McCance <shaunm@...>

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

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[dasher] Created branch gnome-2-28

2009-12-01T06:55:10Z

The branch 'gnome-2-28' was created pointing to:

d1903b0... Updated German help translation

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Rebranding stuff under the Yelp umbrella

2009-11-30T21:34:32Z

Hi Shawn,
How are you? Please pardon me if I am starting this discussion in a
wrong place, I wrote some page-templates for mallard that users can use
to easily convert documentation. What do you say about that? I talked to
Milo about this and he was very helpful, but he referred to ask you
about this. Thanks for your time.

--
Regards,
Vikram Dhillon

On Tue, 2009-12-01 at 00:26 +0100, dsegan@... wrote:

> Hi Shaun,
>
> > yelp-tools would contain the build utilities and yelp-tool,
> > which would comprise the functionality currently found in
> > gnome-doc-tool and gnome-doc-prepare, plus some.
>
> I'd definitely like to move out xml2po out of gnome-doc-utils, and I think this would work well with the split you propose.
>
> > yelp would be the help viewer we use in Gnome.
> >
> > My hope is that we can get more widespread adoption of our
> > documentation tools.
> >
> > Thoughts?
>
> In general, I believe it sounds pretty good. It'd be especially interesting to make XSL stylesheets more customizable and usable outside GNOME per-se.
>
> Cheers,
> Danilo
>

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

signature.asc (204 bytes) Download Attachment

Re: Rebranding stuff under the Yelp umbrella

2009-11-30T15:26:19Z

Hi Shaun,

> yelp-tools would contain the build utilities and yelp-tool,
> which would comprise the functionality currently found in
> gnome-doc-tool and gnome-doc-prepare, plus some.

I'd definitely like to move out xml2po out of gnome-doc-utils, and I think this would work well with the split you propose.

> yelp would be the help viewer we use in Gnome.
>
> My hope is that we can get more widespread adoption of our
> documentation tools.
>
> Thoughts?

In general, I believe it sounds pretty good. It'd be especially interesting to make XSL stylesheets more customizable and usable outside GNOME per-se.

Cheers,
Danilo

--
Jetzt kostenlos herunterladen: Internet Explorer 8 und Mozilla Firefox 3.5 -
sicherer, schneller und einfacher! http://portal.gmx.net/de/go/atbrowser
_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[libgnome] Created branch gnome-2-28

2009-11-30T05:07:18Z

The branch 'gnome-2-28' was created pointing to:

149e9e6... Added LowGerman translation

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Processing problem with code block in Mallard page

2009-11-29T10:21:08Z

On Sun, 2009-11-29 at 18:28 +0100, Mario Blättermann wrote:

> Am Sonntag, den 29.11.2009, 17:12 +0100 schrieb Matteo Settenvini:
> > Il giorno dom, 29/11/2009 alle 16.42 +0100, Mario Blättermann ha
> > scritto:
> > > Hi,
> > > I'm currently working on an upcoming manual for Kupfer. I have tried to
> > > use a code block with the following content:
> > >
> > > <code>
> > > [Kupfer]
> > > keybinding = <Control>space
> > > magickeybinding = <Ctrl><Alt>space
> > > </code>
> > >
> > > But Mallard doesn't accept this construction, I get the following error message:
> >
> > AFAIK it's not a Mallard problem, but a XML one. You've to escape the
> > '<' and '>' entities when you use them literally, that is when you use
> > them outside of the scope of opening and closing tags.
> >
> > http://www.htmlescape.net/escape_common.html
> >
> > Else, the parser thinks you're opening a <Control> tag, and thus checks
> > for a </Control> closing tag before the </code> tag. Since it's not
> > there, it bails out because that XML is malformed.
> >
> Thanks for pointing this out. Now it works fine, with the < and >
> in place of the < and >.
>
> But I remember of DocBook, there we have a <![CDATA[<control><shift>]]>
> construct to prevent DocBook from detecting this as native XML tags.
> Shouldn't Mallard handle this similarly? Mallard aimed to be more simple
> than DocBook, and should't require any HTML based stuff. The < and >
> inside a code block should be correctly processed by the XSLT
> stylesheet.

It doesn't require any HTML stuff. All of this is standard
XML stuff. You can escape with < and >, or you can use
<![CDATA[...]]>. Both are mechanisms common to XML, and both
are handled by the XML parser (libxml2) before any Mallard
tools even see the page contents.

--
Shaun

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Processing problem with code block in Mallard page

2009-11-29T09:28:24Z

Am Sonntag, den 29.11.2009, 17:12 +0100 schrieb Matteo Settenvini:

> Il giorno dom, 29/11/2009 alle 16.42 +0100, Mario Blättermann ha
> scritto:
> > Hi,
> > I'm currently working on an upcoming manual for Kupfer. I have tried to
> > use a code block with the following content:
> >
> > <code>
> > [Kupfer]
> > keybinding = <Control>space
> > magickeybinding = <Ctrl><Alt>space
> > </code>
> >
> > But Mallard doesn't accept this construction, I get the following error message:
>
> AFAIK it's not a Mallard problem, but a XML one. You've to escape the
> '<' and '>' entities when you use them literally, that is when you use
> them outside of the scope of opening and closing tags.
>
> http://www.htmlescape.net/escape_common.html
>
> Else, the parser thinks you're opening a <Control> tag, and thus checks
> for a </Control> closing tag before the </code> tag. Since it's not
> there, it bails out because that XML is malformed.
>

Thanks for pointing this out. Now it works fine, with the < and >
in place of the < and >.

But I remember of DocBook, there we have a <![CDATA[<control><shift>]]>
construct to prevent DocBook from detecting this as native XML tags.
Shouldn't Mallard handle this similarly? Mallard aimed to be more simple
than DocBook, and should't require any HTML based stuff. The < and >
inside a code block should be correctly processed by the XSLT
stylesheet.

Cheers,
Mario

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Processing problem with code block in Mallard page

2009-11-29T08:14:05Z

Il giorno dom, 29/11/2009 alle 16.42 +0100, Mario Blättermann ha
scritto:

> Hi,
> I'm currently working on an upcoming manual for Kupfer. I have tried to
> use a code block with the following content:
>
> <code>
> [Kupfer]
> keybinding = <Control>space
> magickeybinding = <Ctrl><Alt>space
> </code>
>
> But Mallard doesn't accept this construction, I get the following error message:

AFAIK it's not a Mallard problem, but a XML one. You've to escape the
'<' and '>' entities when you use them literally, that is when you use
them outside of the scope of opening and closing tags.

http://www.htmlescape.net/escape_common.html

Else, the parser thinks you're opening a <Control> tag, and thus checks
for a </Control> closing tag before the </code> tag. Since it's not
there, it bails out because that XML is malformed.

Cheers,
Matteo

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Processing problem with code block in Mallard page

2009-11-29T07:42:52Z

Hi,
I'm currently working on an upcoming manual for Kupfer. I have tried to
use a code block with the following content:

<code>
[Kupfer]
keybinding = <Control>space
magickeybinding = <Ctrl><Alt>space
</code>

But Mallard doesn't accept this construction, I get the following error message:

plugins.page:51: parser error : Opening and ending tag mismatch: Alt line 50 and code
</code>
^
plugins.page:66: parser error : Opening and ending tag mismatch: Ctrl line 50 and section
</section>
^
plugins.page:179: parser error : Opening and ending tag mismatch: Control line 49 and page
</page>
^
plugins.page:180: parser error : Premature end of data in tag code line 47

^
plugins.page:180: parser error : Premature end of data in tag section line 40

^
plugins.page:180: parser error : Premature end of data in tag page line 1

^
unable to parse plugins.page

Normally it should accept any characters within <code></code>. What's the
problem here? I tried to mask the < and > with backslashes, no success.

Cheers,
Mario

Using Kupfer plugins. Plugins

You can install custom plugins into ~/.local/share/kupfer/plugins; adding to Kupfer's object knowledge can be surprisingly easy, just look at the default plugins if you want to create new.

Search the Web Search Engines

The Search the Web plugin uses Firefox' search engines, so you can add Search Engines directly in Firefox and Kupfer will find them later.

You can also install custom search plugins directly, only for Kupfer, in the folder: ~/.local/share/kupfer/searchplugins/

Open Terminal Here

Open terminal first calls xdg-terminal, then gnome-terminal. xdg-terminal is a script to find the user's configured terminal program for his/her Desktop Environment. Install xdg-terminal if you need this (or install a symlink called xdg-terminal).

Grab current selection

To use Kupfer like a pro, you can configure a "Magic Keybinding" for Kupfer. GUI configuration is not yet supported, but edit the configuration file ~/.config/kupfer/kupfer.cfg to include the following:


[Kupfer]
keybinding = space
magickeybinding = space

Now, pressing CtrlAltSpace will summon kupfer with the current selection in focus. Make sure you have installed kupfer's nautilus plugin, then both the currently selected file in Nautilus, or the currently selected text in the front application will be selected.

Now you can select a word in, say, a web browser, use CtrlAltSpace, and select action "Look Up" to look up the selected word. Or select an image file, use CtrlAltSpace, select action "Scale" with object "1000" to scale the image to 1000 pixels wide!

Adding your actions and scripts

If you want to add a custom application, or an application called with special options, you can create a new launcher for it and place it in one of the standard places for applications, for example ~/.local/share/applications, where Kupfer will find it.

If you have a collection of scripts that you want to call from kupfer, you can add the scripts folder as a catalog directory to Kupfer in the preferences. Scripts that you add to kupfer's catalog this way can be run directly or in the terminal as long as they are executable.

An example useful script is here which changes the rating of Rhythmbox's currently playing song; I have added five scriptlets calling 'rhrating.py' with numbers from 0 to 5 to my catalog to quickly rate tracks. (This is something that might be integrated into Kupfer later)

Calculator Plugin

The calculator plugin lets you calculate expressions quickly. It can evaluate expressions entered as text starting with "=". Entering = from command mode will start text mode directly with = prefixed for quick access.

The Calculator uses python's math and complex math modules, and parses expressions as Python expressions. You may use common mathematical functions, such as sqrt, sin, exp and log; the command =help will show a list of all defined functions and constants.

Notice that the power operator in Python is double stars, for example =3**3 will evaluate to 27.

To calculate trig functions for angles, convert to radians first: sin(radians(30)) -> 0.5

The last result is stored as the name _ (an underscore, just like in the Python console).

Command line connection

Kupfer is its own remote control. When kupfer is already running, kupfer on the command-line will focus its window, but there is more you can do: If you invoke kupfer QUERY where QUERY is a text string or a filename, kupfer will focus, and select this item. This way, you can quickly invoke kupfer actions even on objects from a shell-based context.

For example, if you are using the shell in a directory where you have a file called "report.pdf", you can focus this file in kupfer by running kupfer report.pdf.

You can also pipe the output of a command into kupfer to send text to the already running instance of Kupfer.

Managing Context and Current Selection

If you find the object you want to use, then invoke an action, Kupfer goes away to perform the action (for example start a program or play a song). When you come back to Kupfer, it will still keep the same object and action selected. Some actions make sense to be repeated (like skipping to the next song) and it can be useful to perform different actions on the same object.

However, you always have the top level catalog reachable when you "come back" to Kupfer -- say you went into the subcatalog "Albums" to browse your albums only; you select and album to play, and play it. You come back with the album selected -- but your next search will still go over the top level catalog, not just albums.

How to come back into the subcatalog you were in? You do that by simply browsing, not searching the first thing you do when you focus Kupfer again. A quick way is to press down-arrow or space to open the browse window; think of it as saying "I want to stay in this subfolder". With the browse window open, your next query will search the current subcatalog.

This way you can work both ways -- you can quickly drill down into folders to find a file, and when you come back for the next action with Kupfer you can either summon any normal toplevel object (just start typing), or stay around where you were, deep in that folder (press space, then type a query).

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Rebranding stuff under the Yelp umbrella

2009-11-28T15:42:49Z

Hey folks,

With libyelp coming along, I've been giving some thought to
rebranding the stuff in gnome-doc-utils. The idea is that
the "Yelp" name would be an umbrella for all packages that
deal with our help system.

This would be the package breakdown:

yelp-xsl would contain all the XSLT from gnome-doc-utils.

libyelp would contain a C library for easily transforming
and displaying documents.

yelp-tools would contain the build utilities and yelp-tool,
which would comprise the functionality currently found in
gnome-doc-tool and gnome-doc-prepare, plus some.

yelp would be the help viewer we use in Gnome.

My hope is that we can get more widespread adoption of our
documentation tools.

Thoughts?

--
Shaun

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[gnome-python-desktop] Created branch gnome-2-28

2009-11-28T09:55:48Z

The branch 'gnome-2-28' was created pointing to:

fa2af1b... Fix crash when parsing "bug-buddy --version"

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: [gnome-games] (22 commits) Created branch gnome-2-28

2009-11-26T21:45:23Z

Somehow--we don't know how--Adi deleted and create a new HEAD based on master in place of the old gnome-2-28 HEAD. This latest branch creation message is the GNOME Games maintainers helping him restore the stable branch back in to its original state which was 5a9fabb63a20fcdde4c166cda5160b2fadefc2ba ... I also had him restore the branch with the commit that he was trying to make which is 2bc6d46c7cbf7290fead48e54aabde31fb0387a7. At this point everything should be back to a sane state and all these messages can be ignored. Please let me know if you notice anything odd.

For other maintainers who find themselves in this situation, the commit hashes in the svn-commits-list are invaluable since we do not have access to the ref log stored on the server when a branch is deleted (and you may not be quite up-to-date enough to have the now unreachable latest commits in a branch). From this list, you can get the last sane commit hash, have the person who caused the problem delete the remote afflicted branch (git push origin :bad-branch), and then have them reset a working branch to the correct hash (git reset --hard GOODHASH) and then push the corrected working branch to the remote using the branch name (git push origin fixedlocal:newremotebranch).

As for how Adi did this in the first place, I don't know.

On Thu, Nov 26, 2009 at 11:32 PM, Adi Roiban <adiroiban@...> wrote:

The branch 'gnome-2-28' was created.

Summary of new commits:

708e54c... Post-release version bump to 2.28.1
a0adeff... Updated Czech help translation by Marek Cernocky
c9eb6fc... Updated Spanish translation
489caee... Updated German doc translation
d37ef8f... aisleriot: partial fix for z-order of empty slots; handles
4464ced... aisleriot: resolve z-order for empty slots; handles selecti
2688e62... aisleriot: remove usless region invalidation with Clutter;
4a51d7b... Updated Russian translation by Andrew Grigorev <andrew@ei-g
3189708... Fixed misspelling, fixes bug #598311
fbb4dd3... Update NEWS for Gnome Games 2.28.1
2810bbc... Post-release bump to 2.28.2
d01fb5a... Updated Lithuanian translation.
4d708af... Updated Spanish translation, fixes bug #599409
39454a7... Updated Thai translation.
792be0d... Fix navigation icon (Leszek Koltunski, Bug #600930)
91d8ae9... Added da to list of languages
48e110a... Added Danish translation
10c5097... Updated Catalan translation
b7a5ff5... Relicensed Aisleriot manpage as GPL2+ to be consistent with
d539846... Translate GtkBuilder UIs (Bug #602934)
5a9fabb... Import defaults in sudoku file as this sets the translation
2bc6d46... Update Romanian translations
_______________________________________________
gnome-i18n mailing list
gnome-i18n@...
http://mail.gnome.org/mailman/listinfo/gnome-i18n

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[gnome-games] (22 commits) Created branch gnome-2-28

2009-11-26T21:32:42Z

The branch 'gnome-2-28' was created.

Summary of new commits:

708e54c... Post-release version bump to 2.28.1
a0adeff... Updated Czech help translation by Marek Cernocky
c9eb6fc... Updated Spanish translation
489caee... Updated German doc translation
d37ef8f... aisleriot: partial fix for z-order of empty slots; handles
4464ced... aisleriot: resolve z-order for empty slots; handles selecti
2688e62... aisleriot: remove usless region invalidation with Clutter;
4a51d7b... Updated Russian translation by Andrew Grigorev <andrew@ei-g
3189708... Fixed misspelling, fixes bug #598311
fbb4dd3... Update NEWS for Gnome Games 2.28.1
2810bbc... Post-release bump to 2.28.2
d01fb5a... Updated Lithuanian translation.
4d708af... Updated Spanish translation, fixes bug #599409
39454a7... Updated Thai translation.
792be0d... Fix navigation icon (Leszek Koltunski, Bug #600930)
91d8ae9... Added da to list of languages
48e110a... Added Danish translation
10c5097... Updated Catalan translation
b7a5ff5... Relicensed Aisleriot manpage as GPL2+ to be consistent with
d539846... Translate GtkBuilder UIs (Bug #602934)
5a9fabb... Import defaults in sudoku file as this sets the translation
2bc6d46... Update Romanian translations
_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[gnome-games] Created branch gnome-2-28

2009-11-26T19:19:54Z

The branch 'gnome-2-28' was created pointing to:

fb40dda... Update Romanian translations

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Question about entities in Mallard

2009-11-24T09:41:42Z

Hi all,

2009/11/24 Shaun McCance <shaunm@...>:
>
> 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?

I'm all in favor for shipping a gnome-doc characters entity definition.
Would it be a good idea to set as a goal for 3.0?

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

Agree.

--
Milo Casagrande <milo@...>
_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Question about entities in Mallard

2009-11-24T08:19:31Z

On Mon, 2009-11-23 at 21:03 -0600, Jim Campbell wrote:

> Hi All,
>
> Docbook has switched to a RelaxNG schema with the release of Docbook
> 5. RelaxNG schemas cannot natively handle entities in the same way
> that DTD's can, but the Docbook documentation provides an example of
> how you can still declare a separate entities file in Docbook 5
> documents [1].
>
> I have tried (but failed!) to declare an entity via a similar method
> in a Mallard document. I didn't really expect it to work, but I
> thought I would give it a try before sending a note to the mailing
> list.
>
>
> Is there some special RelaxNG-foo that would need to be in place to
> enable similar functionality in Mallard? Will my referencing
> docbook's implementation help Shaun with this?
>
>
> I hope so. If anyone has any recommendations, please let me know.
> Thanks!
>
> Jim
>
> [1] http://www.sagehill.net/docbookxsl/Db5Entities.html

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

]> &title;

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ultrices pellentesque augue, vel aliquam ante dapibus ut. Vestibulum ligula nisi.

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Question about entities in Mallard

2009-11-23T19:03:46Z

Hi All,

Docbook has switched to a RelaxNG schema with the release of Docbook 5. RelaxNG schemas cannot natively handle entities in the same way that DTD's can, but the Docbook documentation provides an example of how you can still declare a separate entities file in Docbook 5 documents [1].

I have tried (but failed!) to declare an entity via a similar method in a Mallard document. I didn't really expect it to work, but I thought I would give it a try before sending a note to the mailing list.

Is there some special RelaxNG-foo that would need to be in place to enable similar functionality in Mallard? Will my referencing docbook's implementation help Shaun with this?

I hope so. If anyone has any recommendations, please let me know. Thanks!

Jim

[1] http://www.sagehill.net/docbookxsl/Db5Entities.html

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[libsoup] Created branch gnome-2-28

2009-11-21T16:30:44Z

The branch 'gnome-2-28' was created pointing to:

d45a4b1... Fix Request-Line in https over proxy

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Self Introduction -

2009-11-21T06:46:45Z

Hello ppl,
The below is a short Self-Intro, you can go through it and any '
Comments would be Appreciated '

Who am i ?
Well my name is Shayon and i have recently added my self to the list.But
i have been using Gnome as my desktop since i am with openSUSE 11.1 and
no doubt it really serves great.

So why i am here and my background(Wiki) ?
I am here to contribute my my some part to the Gnome Documentation/Wiki
. As i am very much interested in these stuffs.I am not much of a
technical guy but i am having experience on how to work on a Wiki.As i
am simultaneously working over the openSUSE Wiki as its Team Member .And
now would love to contribute to the Gnome Wiki :)

What all things i can do ?
Right now i am a bit busy with my classes (studies) :) . But i am able
to perform almost all activities in the Wiki starting from a ' minor to
major ' edit.And apart from this i am involved in sorting and indexing
out the templates / Articles . And more over i try to enhance the look/
feel of the Docs present :)

Well this all about me :)

Hope to have a good start towards Gnome Doc contribution !

--
Regards,
Shayon Mukherjee
http://en.opensuse.org/User:Wwarlock
Email: hkwarlock@...
Twitter: ShayonM

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[gnome-devel-docs] Created branch gnome-2-28

2009-11-19T13:02:51Z

The branch 'gnome-2-28' was created pointing to:

f095e9b... Version 2.28.1

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[gnome-user-docs] Created branch gnome-2-28

2009-11-19T11:09:16Z

The branch 'gnome-2-28' was created pointing to:

8b6911b... Version 2.28.1

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[yelp] Created branch gnome-2-28

2009-11-19T09:57:36Z

The branch 'gnome-2-28' was created pointing to:

6d0dcf7... Version 2.28.1

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: [Fwd: Evolution Contacts Advanced Search parsing]

2009-11-16T16:10:17Z

Am Montag, den 16.11.2009, 14:10 -0600 schrieb Shaun McCance:

> -------- Forwarded Message --------
> > From: Paul D. Mirowsky <p_mirowsky@...>
> > Reply-to: p_mirowsky@...
> > To: gnome-list@...
> > Subject: Evolution Contacts Advanced Search parsing
> > Date: Mon, 16 Nov 2009 11:10:22 -0500
> >
> > Hello
> >
> > Evolution Contacts Advanced Search has the ability to use an
> > 'expression' but I cannot find a definition to use this function.

In Evolution, "expression" either refers to Scheme or to regex.
Not sure in this case. :-/

andre
--
mailto:ak-47@... | failed
http://www.iomc.de/ | http://blogs.gnome.org/aklapper

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Question about organizing mallard docs

2009-11-16T13:11:26Z

On Mon, 2009-11-16 at 14:28 -0600, Jim Campbell wrote:

> Hi All,
>
> This might be a naive question, but in looking at the documentation
> for Empathy, all of the .page files are located in the same directory.
> Does anything special need to be done when using documents from
> multiple directories. For example:
> empathy/help/C/gettingstarted/[bunch of pages] and
> empathy/help/C/advanced-topics/[bunchofpages].
>
> I've found it a bit difficult to find particular topics within the
> Empathy help xml files, and it seems like things would get awfully
> cumbersome once you got past more than about 20 .page files.

Hey Jim,

This is something I decided not to support, for performance
reasons. Mallard takes enough of a seek penalty as it is.
Digging into subdirectories didn't seem like a good idea.

I do have plans to support multiple pages in a single file.
I'm tentatively calling them stack files. Instead of putting
related pages in a directory together, you could just have
them all in one file. I think this addresses the "look at
all these files!" problem pretty nicely. If you think it's
crap, though, please let me know.

(Stack files also help address some localization problems.)

--
Shaun

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Question about organizing mallard docs

2009-11-16T12:28:48Z

Hi All,

This might be a naive question, but in looking at the documentation for Empathy, all of the .page files are located in the same directory. Does anything special need to be done when using documents from multiple directories. For example: empathy/help/C/gettingstarted/[bunch of pages] and empathy/help/C/advanced-topics/[bunchofpages].

I've found it a bit difficult to find particular topics within the Empathy help xml files, and it seems like things would get awfully cumbersome once you got past more than about 20 .page files.

Jim

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[Fwd: Evolution Contacts Advanced Search parsing]

2009-11-16T12:10:52Z

Anybody want to take a crack at writing a help topic for this?

Feel free to just write a Mallard topic. We can look at upstreaming
this into the DocBook document. But if we get a significant number
of Mallard topics, it could be a chance to convert the Evolution
help over.

--
Shaun

-------- Forwarded Message --------

> From: Paul D. Mirowsky <p_mirowsky@...>
> Reply-to: p_mirowsky@...
> To: gnome-list@...
> Subject: Evolution Contacts Advanced Search parsing
> Date: Mon, 16 Nov 2009 11:10:22 -0500
>
> Hello
>
> Evolution Contacts Advanced Search has the ability to use an
> 'expression' but I cannot find a definition to use this function.
>
> I am hoping that this will give me a way to either count out or select a
> certain number of "Contact" records.
>
> Verizon, as an e-mail service restricts each e-mail to no more than 99
> contacts per an e-mail and no more than 500 maximum during one hour.
> The penalty for breaking these rules is 24 hour loss of e-mail
> privileges.
>
> I am having a bit of difficulty finding a way to parse a contact list to
> meet this criteria.
>
> As some of us do actually have to do mailings to quite a few people,
> this is a bit of a pain
>
> Any and all suggestions welcome.
>
> Thanks
> Paul
>
>
>
> _______________________________________________
> gnome-list mailing list
> gnome-list@...
> http://mail.gnome.org/mailman/listinfo/gnome-list

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Feedback about Yelp

2009-11-16T10:39:30Z

On Mon, 2009-11-16 at 11:12 -0500, Luis Felipe López Acevedo wrote:

> El dom, 15-11-2009 a las 12:55 -0600, Shaun McCance escribió:
> > The style has to depend on the current theme. People who
> > use dark themes for accessibility reasons may find it very
> > difficult to read white-on-black. The problem is that the
> > colors got screwed up somewhere in the last few releases.
> > I'll be working on generating colors that are suitable for
> > all themes for 3.0.
> >
>
> Sorry for my ignorance but why does it have to depend on the desktop
> theme? why not use a style sheet that looks the same with every desktop
> theme?

People who use High Contrast Inverse or Low Contrast use them
for a reason: they have a difficult time reading black-on-white
text. If the help is always displayed black-on-white, it fails
to meet their accessibility needs.

> > > 3. I'd like the content and the contents bar to the right to have
> > > independent scrolling. The reason for this is that when you write a
> > > DocBook document that uses images with widths different to the
> > > recommended in GNOME-STYLE[1], and these images are at the same level of
> > > the navigation bar to the right, this bar will overlap the image.
> >
> > I'm thinking of moving the contents back into a separate
> > sidebar for 3.0. That's how it used to be, but we changed
> > it to try to de-emphasize the linear structure and make it
> > feel more topic-oriented.
> >
>
> Nice. But is it going to be located on the right side? Because I'd like
> it that way; I find it more comfortable. But you could give the option
> to move it to the left for people who like it that way.

Maybe. I've thought about it. I certainly prefer right
sidebars on the web. For Yelp, a right sidebar would make
it easier to pop it on and off and resize the window with
less stuff getting shifted about.

I'm mildly concerned about user confusion. I don't think
it's a big deal, but I'd like to run it by some people
first.

> > We're now doing topic-oriented help in Mallard, leaving
> > DocBook for documents which really are linear books and
> > articles. So I don't see much point in treating DocBook
> > as something it's not anymore.
> >
>
> But Yelp will continue to support DocBook, right?

Yes, definitely.

> > > I'd also like to ask if the start page that you see when you open Yelp
> > > is writen in DocBook and where can I find it. I was trying to use the
> > > "set" element in DocBook hoping to get something similar but didn't get
> > > what I wanted.
> >
> > The start page is currently generated inside Yelp. It
> > scans your system for all installed documentation and
> > generated a set of TOC pages.
> >
> > In 3.0, the start page will be the index page of the
> > Desktop Help, which will replace the User Guide. This
> > will be a Mallard document, and downstream distributors
> > will be able to plug into it in the same ways they can
> > plug into other Mallard documents.
> >
>
> But is it possible to use the «set» element in DocBook documents to
> generate a page that lists the books in the set with short descriptions
> about them?

It's not out of the question to add this feature. I'd
need to see some real use cases to make sure that I'm
correctly solving a real problem.

--
Shaun

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Feedback about Yelp

2009-11-16T08:12:28Z

El dom, 15-11-2009 a las 12:55 -0600, Shaun McCance escribió:

> Hi Luis,
>
> Thanks for your feedback.
>
> On Sun, 2009-11-15 at 13:37 -0500, Luis Felipe López Acevedo wrote:
> > Hello all.
> >
> > I'm using GNOME 2.22.1 on gNewSense 2.3 and I'd like to give some
> > feedback about Yelp.
> >
> > 1. I don't like that when you search for something you get results from
> > all help documents in the help system. I'd prefer to get results from
> > the document or manual I'm reading. For example, if I'm reading Ekiga's
> > manual I'd like to get results related to Ekiga only and not Gedit. In
> > my opinion, the current behavior would be good as an option, not as the
> > only way to search.
>
> Searching within the current document will be the default
> behavior in Yelp 3.0.
>

Nice.

> > 2. I don't like that the style of the documents depends on the colors of
> > the desktop theme. With dark themes, the documentation looks really bad.
>
> The style has to depend on the current theme. People who
> use dark themes for accessibility reasons may find it very
> difficult to read white-on-black. The problem is that the
> colors got screwed up somewhere in the last few releases.
> I'll be working on generating colors that are suitable for
> all themes for 3.0.
>

Sorry for my ignorance but why does it have to depend on the desktop
theme? why not use a style sheet that looks the same with every desktop
theme?

> > 3. I'd like the content and the contents bar to the right to have
> > independent scrolling. The reason for this is that when you write a
> > DocBook document that uses images with widths different to the
> > recommended in GNOME-STYLE[1], and these images are at the same level of
> > the navigation bar to the right, this bar will overlap the image.
>
> I'm thinking of moving the contents back into a separate
> sidebar for 3.0. That's how it used to be, but we changed
> it to try to de-emphasize the linear structure and make it
> feel more topic-oriented.
>

Nice. But is it going to be located on the right side? Because I'd like
it that way; I find it more comfortable. But you could give the option
to move it to the left for people who like it that way.

> We're now doing topic-oriented help in Mallard, leaving
> DocBook for documents which really are linear books and
> articles. So I don't see much point in treating DocBook
> as something it's not anymore.
>

But Yelp will continue to support DocBook, right?

> > I'd also like to ask if the start page that you see when you open Yelp
> > is writen in DocBook and where can I find it. I was trying to use the
> > "set" element in DocBook hoping to get something similar but didn't get
> > what I wanted.
>
> The start page is currently generated inside Yelp. It
> scans your system for all installed documentation and
> generated a set of TOC pages.
>
> In 3.0, the start page will be the index page of the
> Desktop Help, which will replace the User Guide. This
> will be a Mallard document, and downstream distributors
> will be able to plug into it in the same ways they can
> plug into other Mallard documents.
>

But is it possible to use the «set» element in DocBook documents to
generate a page that lists the books in the set with short descriptions
about them?

> If you're interested in what we're doing or would like
> to help out, you could join us on IRC. We're on the
> #docs channel on irc.gnome.org. There's instructions
> here:
>
> http://live.gnome.org/DocumentationProject/Contact
>

I'm reading the Documentation Project info, thanks.

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Re: Feedback about Yelp

2009-11-15T10:55:42Z

Hi Luis,

Thanks for your feedback.

On Sun, 2009-11-15 at 13:37 -0500, Luis Felipe López Acevedo wrote:

> Hello all.
>
> I'm using GNOME 2.22.1 on gNewSense 2.3 and I'd like to give some
> feedback about Yelp.
>
> 1. I don't like that when you search for something you get results from
> all help documents in the help system. I'd prefer to get results from
> the document or manual I'm reading. For example, if I'm reading Ekiga's
> manual I'd like to get results related to Ekiga only and not Gedit. In
> my opinion, the current behavior would be good as an option, not as the
> only way to search.

Searching within the current document will be the default
behavior in Yelp 3.0.

> 2. I don't like that the style of the documents depends on the colors of
> the desktop theme. With dark themes, the documentation looks really bad.

The style has to depend on the current theme. People who
use dark themes for accessibility reasons may find it very
difficult to read white-on-black. The problem is that the
colors got screwed up somewhere in the last few releases.
I'll be working on generating colors that are suitable for
all themes for 3.0.

> 3. I'd like the content and the contents bar to the right to have
> independent scrolling. The reason for this is that when you write a
> DocBook document that uses images with widths different to the
> recommended in GNOME-STYLE[1], and these images are at the same level of
> the navigation bar to the right, this bar will overlap the image.

I'm thinking of moving the contents back into a separate
sidebar for 3.0. That's how it used to be, but we changed
it to try to de-emphasize the linear structure and make it
feel more topic-oriented.

We're now doing topic-oriented help in Mallard, leaving
DocBook for documents which really are linear books and
articles. So I don't see much point in treating DocBook
as something it's not anymore.

> I'd also like to ask if the start page that you see when you open Yelp
> is writen in DocBook and where can I find it. I was trying to use the
> "set" element in DocBook hoping to get something similar but didn't get
> what I wanted.

The start page is currently generated inside Yelp. It
scans your system for all installed documentation and
generated a set of TOC pages.

In 3.0, the start page will be the index page of the
Desktop Help, which will replace the User Guide. This
will be a Mallard document, and downstream distributors
will be able to plug into it in the same ways they can
plug into other Mallard documents.

If you're interested in what we're doing or would like
to help out, you could join us on IRC. We're on the
#docs channel on irc.gnome.org. There's instructions
here:

http://live.gnome.org/DocumentationProject/Contact

Thanks,
Shaun

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Feedback about Yelp

2009-11-15T10:37:50Z

Hello all.

I'm using GNOME 2.22.1 on gNewSense 2.3 and I'd like to give some
feedback about Yelp.

1. I don't like that when you search for something you get results from
all help documents in the help system. I'd prefer to get results from
the document or manual I'm reading. For example, if I'm reading Ekiga's
manual I'd like to get results related to Ekiga only and not Gedit. In
my opinion, the current behavior would be good as an option, not as the
only way to search.

2. I don't like that the style of the documents depends on the colors of
the desktop theme. With dark themes, the documentation looks really bad.

3. I'd like the content and the contents bar to the right to have
independent scrolling. The reason for this is that when you write a
DocBook document that uses images with widths different to the
recommended in GNOME-STYLE[1], and these images are at the same level of
the navigation bar to the right, this bar will overlap the image.

I'd also like to ask if the start page that you see when you open Yelp
is writen in DocBook and where can I find it. I was trying to use the
"set" element in DocBook hoping to get something similar but didn't get
what I wanted.

Finally, thank you all for your work.

Respectfully,

Luis Felipe López Acevedo

1.http://library.gnome.org/devel/gdp-style-guide/stable/screenshot-4.html.en

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

Feedback about Yelp

2009-11-15T08:18:02Z

Re: In the chapter II.V. I, "wrong" way

2009-11-15T08:03:02Z

Hi,

Am Samstag, den 14.11.2009, 17:56 +0100 schrieb Geneviève:
> Hello,
> In the chapter II.V. I, the way to go to "menus et barre d'outils" is
> not : Panneau de préférences / menus et barre d'outils, but Panneau de
> préférences / Apparence / Interface / menus et barre d'outils. As I am
> very very new, I put a long time to find it. Thank you for the "nest new
> people".
> Excuse my poor english. Have a good day !

I don't have any idea what document you refer to. :-)

Please file a bug in bugzilla.gnome.org in the product "L10N", component
"French" and provide the exact steps to reproduce.

Thanks,
andre
--
mailto:ak-47@... | failed
http://www.iomc.de/ | http://blogs.gnome.org/aklapper

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list

[anjuta-extras] Created branch gnome-2-28

2009-11-14T10:54:14Z

The branch 'gnome-2-28' was created pointing to:

3d36954... bgo #600923 - anjuta-extras: ANJUTA_PLUGIN_LDFLAGS not def

_______________________________________________
gnome-doc-list mailing list
gnome-doc-list@...
http://mail.gnome.org/mailman/listinfo/gnome-doc-list