Linking

Use markdown notation:

For more [click here](http://example.com) now.

Or HTML notation:

For more <a href="http://example.com">click here</a> now.

For cross linking to other parts of docs use the ID:

[see Foo](package.Class.method)

Use the # + id to link to a method/property on the same page (traditional anchor linking):

[see setWidth](#setWidth)

Website and Page Structure

1. Classes and modules are full HTML pages.
2. Methods, properties, and events (MPE's) are included within a class HTML file.

Documon generates a unique ID for each entity. The ID represents a "dot.path" to the entity based on it's relationship to the package and class structure.

Example:

package.class.entity

… where "entity" is a reference to a method, property or event (MPE) within a class or module.

NOTE: Documon treats modules and classes the same, so for brevity we'll only refer to "class".

The Documon website intercepts links and interprets dot.path ID's.

Interal Method, Property, Event (MPE) links

Each MPE has a standard HTML anchors within the page, therefore to link to an internal MPE within a class, use a normal anchor URL's (#example):

[See foo](#foo)

This makes writing an internal link (within a class file) pretty easy.

You can use the full dot.path, or for simplicity, if you're cross linking within the same class, you can just refernce the MPE. Either or will work because the template should incorporate both #entity adn #package.class.entity

[See foo](#foo)
-- or --
[See foo](#package.class.foo)

External classes and MPE's

To link to an external class or a MPE in some other class, use the full ID:

[Link to My Class](package.MyClass)
[Link to the foo property](package.MyClass.foo)

… in the example above we're targeting the location of the "foo" property in the "MyClass" HTML file. Again, the Documon website intercepts and interprets the ID's for you automatically.

External URL's

And to link to external websites, just use a full URL:

[External Website Link](http://www.example.com)

More Pages

Each "more" page is provided a unique ID that is prefixed with "more". So you can link to these pages using the ID:

[See the About Page](more.about)

Review the "More Docs" page for details on how the ID's are derived.

 
 
 
170906