Internal docbook links

Sean Wheller sean at inwords.co.za
Fri Dec 31 07:10:46 UTC 2004


On Friday 31 December 2004 07:07, Nick Loeve wrote:
> I am just about to start getting back into doing the 'more info'
> section of the userguide.
> Since my last commit i see that someone marked an internal docbook link
> i made as non-existent and i supposed to it was out of date, but i am
> not so sure...
>
> In moreinfo/chap-applicationmigration.xml on line 53 i made a link (see
> below)
>
> <!-- PROBLEM NOT IN USER GUIDE <link
>                  linkend="software-installremove"
> endterm="title-software-installremove"/>-->
>
> That link should go through to the chapter located in
> software/chap-installremove.xml
>
> Is that not the way to make internal links? It worked in Yelp at the
> time, so i assumed it was...
>
> Is that section linked to not going to be continued?

Hello Nick,

The section may well be continued. It was I who commented this xref and many 
like it since they make it impossible to validate the documents.

You may have noticed a number of structure changes in svn, both in terms of 
directories and the semantic structure of the Docbook XML. When I first got 
the files none of them were valid and a large number were not well-formed. As 
you know these are basic requirements of XML. So I fixed all documents and 
made them valid against the Docbook DTD and ensured they were well-formed.

There were many problem, so as I went through the files, instead of deleting I 
commented in places. Some of these places may be in order to validate the 
document part, each file can be validated, and others to validate the whole 
document.

Hope this is clear. I will take a look at this problem for you and patch.

I took a look at your patch. Thanks for that.

I notice a number of validation problems. We are now trying to get people to 
commit valid and well-formed xml instances. I list the problems below:

W Include operation failed, reverting to fallback. Resource error reading file 
as XML (href='chap-boot.xml'). 
Reason: /home/sean/projects/ubuntu-docs/faq/trunk/userguide/systemconfig/chap-boot.xml 
(No such file or directory)	main.xml	
file:/home/sean/projects/ubuntu-docs/faq/trunk/userguide/systemconfig/main.xml	
36:1

E The content of element type "sect1" is incomplete, it must match 
"(sect1info?,(title,subtitle?,titleabbrev?),(toc|lot|index|glossary|
bibliography)*,(((calloutlist|glosslist|itemizedlist|orderedlist|
segmentedlist|simplelist|variablelist|caution|important|note|tip|warning|
literallayout|programlisting|programlistingco|screen|screenco|screenshot|
synopsis|cmdsynopsis|funcsynopsis|classsynopsis|fieldsynopsis|
constructorsynopsis|destructorsynopsis|methodsynopsis|formalpara|para|
simpara|address|blockquote|graphic|graphicco|mediaobject|mediaobjectco|
informalequation|informalexample|informalfigure|informaltable|equation|
example|figure|table|msgset|procedure|sidebar|qandaset|task|anchor|
bridgehead|remark|highlights|abstract|authorblurb|epigraph|indexterm|
beginpage|xi:include)+,(refentry*|sect2*|simplesect*))|refentry+|sect2+|
simplesect+),(toc|lot|index|glossary|bibliography)*)".	chap-loginscreen.xml	
file:/home/sean/projects/ubuntu-docs/faq/trunk/userguide/systemconfig/chap-loginscreen.xml	
45:1

E Unexpected element "para". The content of the parent element type must match 
"(beginpage?,chapterinfo?,(title,subtitle?,titleabbrev?),(toc|lot|index|
glossary|bibliography)*,tocchap?,(((calloutlist|glosslist|itemizedlist|
orderedlist|segmentedlist|simplelist|variablelist|caution|important|note|tip|
warning|literallayout|programlisting|programlistingco|screen|screenco|
screenshot|synopsis|cmdsynopsis|funcsynopsis|classsynopsis|fieldsynopsis|
constructorsynopsis|destructorsynopsis|methodsynopsis|formalpara|para|
simpara|address|blockquote|graphic|graphicco|mediaobject|mediaobjectco|
informalequation|informalexample|informalfigure|informaltable|equation|
example|figure|table|msgset|procedure|sidebar|qandaset|task|anchor|
bridgehead|remark|highlights|abstract|authorblurb|epigraph|indexterm|
beginpage|xi:include)+,(sect1*|refentry*|simplesect*|section*))|(sect1+|
refentry+|simplesect+|section+)),(toc|lot|index|glossary|bibliography)*)".	
chap-loginscreen.xml	
file:/home/sean/projects/ubuntu-docs/faq/trunk/userguide/systemconfig/chap-loginscreen.xml	
57:1

E The content of element type "sect1" is incomplete, it must match 
"(sect1info?,(title,subtitle?,titleabbrev?),(toc|lot|index|glossary|
bibliography)*,(((calloutlist|glosslist|itemizedlist|orderedlist|
segmentedlist|simplelist|variablelist|caution|important|note|tip|warning|
literallayout|programlisting|programlistingco|screen|screenco|screenshot|
synopsis|cmdsynopsis|funcsynopsis|classsynopsis|fieldsynopsis|
constructorsynopsis|destructorsynopsis|methodsynopsis|formalpara|para|
simpara|address|blockquote|graphic|graphicco|mediaobject|mediaobjectco|
informalequation|informalexample|informalfigure|informaltable|equation|
example|figure|table|msgset|procedure|sidebar|qandaset|task|anchor|
bridgehead|remark|highlights|abstract|authorblurb|epigraph|indexterm|
beginpage|xi:include)+,(refentry*|sect2*|simplesect*))|refentry+|sect2+|
simplesect+),(toc|lot|index|glossary|bibliography)*)".	chap-loginscreen.xml	
file:/home/sean/projects/ubuntu-docs/faq/trunk/userguide/systemconfig/chap-loginscreen.xml	
87:1

E The content of element type "sect1" is incomplete, it must match 
"(sect1info?,(title,subtitle?,titleabbrev?),(toc|lot|index|glossary|
bibliography)*,(((calloutlist|glosslist|itemizedlist|orderedlist|
segmentedlist|simplelist|variablelist|caution|important|note|tip|warning|
literallayout|programlisting|programlistingco|screen|screenco|screenshot|
synopsis|cmdsynopsis|funcsynopsis|classsynopsis|fieldsynopsis|
constructorsynopsis|destructorsynopsis|methodsynopsis|formalpara|para|
simpara|address|blockquote|graphic|graphicco|mediaobject|mediaobjectco|
informalequation|informalexample|informalfigure|informaltable|equation|
example|figure|table|msgset|procedure|sidebar|qandaset|task|anchor|
bridgehead|remark|highlights|abstract|authorblurb|epigraph|indexterm|
beginpage|xi:include)+,(refentry*|sect2*|simplesect*))|refentry+|sect2+|
simplesect+),(toc|lot|index|glossary|bibliography)*)".	chap-loginscreen.xml	
file:/home/sean/projects/ubuntu-docs/faq/trunk/userguide/systemconfig/chap-loginscreen.xml	
114:1

E The content of element type "chapter" must match "(beginpage?,chapterinfo?,
(title,subtitle?,titleabbrev?),(toc|lot|index|glossary|
bibliography)*,tocchap?,(((calloutlist|glosslist|itemizedlist|orderedlist|
segmentedlist|simplelist|variablelist|caution|important|note|tip|warning|
literallayout|programlisting|programlistingco|screen|screenco|screenshot|
synopsis|cmdsynopsis|funcsynopsis|classsynopsis|fieldsynopsis|
constructorsynopsis|destructorsynopsis|methodsynopsis|formalpara|para|
simpara|address|blockquote|graphic|graphicco|mediaobject|mediaobjectco|
informalequation|informalexample|informalfigure|informaltable|equation|
example|figure|table|msgset|procedure|sidebar|qandaset|task|anchor|
bridgehead|remark|highlights|abstract|authorblurb|epigraph|indexterm|
beginpage|xi:include)+,(sect1*|refentry*|simplesect*|section*))|(sect1+|
refentry+|simplesect+|section+)),(toc|lot|index|glossary|bibliography)*)".	
chap-loginscreen.xml	
file:/home/sean/projects/ubuntu-docs/faq/trunk/userguide/systemconfig/chap-loginscreen.xml	
119:1


I will fix these problems for you. Take a look at my patch once it is 
complete.

However, the file chap-boot.xml in not in the repos yet.



-- 
Sean Wheller
Technical Author
sean at inwords.co.za
http://www.inwords.co.za
Registered Linux User #375355
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20041231/ff93ed31/attachment.pgp>


More information about the ubuntu-doc mailing list