Skip Navigation

Sign up

If you sign up for an account on this web site you can customise elements of this site and subscribe to an email newsletter.

If you have an account on this web site you may login.

If you have an account on this site but have forgotten your user name and / or your password then you can request an account reminder email.

Magic linking coverage

When an MKDoc document has child documents, the titles of those child documents are magically linked within the text of the parent document.

This is a very useful feature, but it should be configurable to increase the range of covered documents:

  • The default range should be increased to include the parent of the current document by default

  • Optionally siblings can be magically hyperlinked

  • Optionally uncle/aunt documents can be magically hyperlinked (perhaps in the future?)

  • Optionally all documents can be magically hyperlinked (perhaps in the future?)

This would make an MKDoc document much more similar to a wiki document, something else we can do to make MKDoc more wiki-like would be to automatically link to any document on the site when the text [[has double-brackets]] like so.

Ideally there should be a web interface for configuring this.

At the moment if there are two child documents with the same title the first one is linked to, this same method should be used where by the closest document is linked to.

The order to link when titles are the same:

  1. Grandparent

  2. Parent document

  3. Sibling documents

  4. Child document

  5. Grandchildren documents

These should all be able to be turned on and off with env vars, eg the MKDoc 1.6 default:

SetEnv LINK_GRANDPARENTS    false
SetEnv LINK_PARENTS         false
SetEnv LINK_SIBLINGS        false
SetEnv LINK_CHILDREN        true
SetEnv LINK_GRANDCHILDREN   false
SetEnv LINK_PARENTS         false

Up

This document was last modified by Chris Croome on 2005-04-07 03:04:00
MKDoc Ltd., 31 Psalter Lane, Sheffield, S11 8YL, UK.
Copyright © 2001-2005 MKDoc Ltd.