Mailinglist Archive: opensuse-doc (23 mails)

< Previous Next >
Re: [opensuse-doc] LfL question: how-to subdivide very big articles ?
  • From: Thomas Schraitle <thomas.schraitle@xxxxxxx>
  • Date: Sat, 28 Jul 2007 10:56:11 +0200
  • Message-id: <200707281056.12150.thomas.schraitle@xxxxxxx>
Hi Alexey,

On Samstag, 28. Juli 2007, Alexey Eremenko wrote:
>
> I have LfL question: how-to subdivide very big articles ?
> That is: I have "VirtualBox" article - a big guide actually.
>
> I want to have it's chapters to be available as links at the top of the
> article.
>
> Thomas once told me about using chapter IDs, but I didn't understood
> then. I will try now...
>
> So, can you help with example XML code ?

Sure. You will see, it's pretty easy after you get the idea behind.

For example, you want to link from a paragraph to a chapter. These are the 
steps that you need:

1. Determine the ID value of the chapter that you want to link to. You can 
also link to sections, figures, tables, appendices, etc. the method is 
the same. It should look like this:

  <chapter id="chap.foo">
     <!--      ^^^^^^^^_____ Your ID value -->
     <title>Something about Foo</title>
  ...


2. If you do not find an ID value, "define" your own ID value. Insert an 
attribute "id" with your ID value in the respective element. The ID value 
should be legible so that any writer have at least some idea what is this 
chapter about. :) Look for other examples.
Be careful, the definied ID value must be unique (appears only once in the 
whole document), otherwise you get validation errors. 


3. Go back to your paragraph and insert a xref element. This is the cross 
reference to your ID and looks like this:

  <para>... 
    See <xref linkend="chap.foo"/> for more information ...
  </para>

You can insert as many xrefs to your chapter as you like.


That's all! The stylesheets take care of how the xref appears in your 
text. Usually you get something like this:

  See Chapter 1, »Something about Foo« for more information.


Does it help?


Have fun,
Tom

-- 
----------------------------------------------------------------------
SUSE LINUX Products GmbH   >o)   
Maxfeldstrasse 5           /\\   Documentation Specialist
90409 Nuernberg, Germany  _\_v   http://en.opensuse.org/Documentation_Team
SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG Nürnberg)
---------------------------------------------------------------------
To unsubscribe, e-mail: opensuse-doc+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: opensuse-doc+help@xxxxxxxxxxxx

< Previous Next >
List Navigation
Follow Ups
References