"The Guide" should be "The Developer's Guide", sometimes called the "Dguide".

It referes to this document:

http://www.openlaszlo.org/lps/docs/guide/index.html

The word "Reference" is intended to refer to this document:

http://www.openlaszlo.org/lps/docs/reference/index.html

Unfortunately, there are various permutations of the names of these documents that appear in lots of places. I, and others, have not always be consistent. However, the terms
"Guide" and "Reference" are significant identifiers.

As to the best syntax for internal linking, it might be good to ask Jim. We have used two or three variants. Within the Guide, I use the syntax <xref linkend="ID"/>. Between the Guide and the Reference, there are two or more variants of the <a href=""> syntax in use, for historical reasons.

Over time the plan is to have both the Guide and Reference be built using DocBook, in which case the <xref linkend=""/> syntax should work between and within each document. But that is not the case for 4.0, when we still have a bit of a hodge-podge.

jrs

On Mar 1, 2007, at 11:05 AM, Phillip George Apley wrote:

Throughout the documentation there are many broken references to 'the Guide' such as:

For details on how this component is constructed see the <a target="laszlo-dguide" href="../guide/using-components.html#using- components.edittext">edittext</a>
section of the Guide.

It looks to me like these should be converted to references to 'the Developer's Reference' e.g. "docs/component-design/combobox.html".

I want to confirm I'm referencing the right document. Yes?

Reply via email to