LazDE: Links to topics in other files
lazarus / 8-Other

----------------------------------------------------------------------
lt.col.blair · 2011-06-01 14:36

Hi,
I've just started to make some documentation for my first Lazarus
package. LazDe and FPDocUpdater are great tools to get started with
that!
But...
the first questions arise about what the best way is to make such
documentation.
Is it best to put all help in one documentation file?
- like that:

Packages
 |- My Package
    |- MyUnit1
    |- MyUnit2 (etc)
 - if so, how, if ever, can I get the FPDocUpdater to put the
generated xml for all units into one file instead of multiple files,
one for each unit?

... or should I use the "standard" way, one file for each unit (like
all of the LCL documentation)?
In this case, how can I add links from one unit/xml file to a
component or property in another unit/xml file?
- like that:
The component TMyGrid which is located in unit MyGrid uses function
MySpecialFunc which is in unit MyFuncLib.
How can I add a link to the description of TMyGrid that jumps directly
to the description of MySpecialFunc?


TIA
Lutz

----------------------------------------------------------------------
marcov · 2011-06-02 11:14

Like e.g. <link id="#rtl.strings.StrAlloc">StrAlloc</link>

where "rtl" is the name of the package, "strings" the unit, and
"stralloc" the symbol you want to link to.