Internal links from article to article
Docmint can parse each article and link it
to other articles in the tree structure. It does this automatically if you set
the switch to do so to "true" in the configuration file. The logic of
this link system is very straight forward: on one side Docmint has the document
tree in the user language, on the other side the content of the article. If
there is a substring in the article that matches any of the article titles in
the table of content, Docmint creates a link.
Docmint first searches for the longest
titles, then the shorter one down to the shortest to avoid links inside links.
Otherwise this could mean that a subset of the already long article title is
also linked. This won't happen.
But what might happen is this: an article
is called "Installation". A sensible article title. Docmint will now
link each instance of "Installation" in the text in upper and lower
case to this article in the document tree. Now you have to make a decision. You
can rename the article title and where you want to have a link, you use the new
article title in the body of the text.
Alternatively, in the Docmint configuration
you can set 'link_internal_chars' to a character or character sequence (like
" or ***) which you manually add to the article body before and after each
instance that you want potentially linked. Docmint will then only link
instances in the body of the text embraced by these tags. If no link can be
generated, Docmint simply swallows the character(s). So in the "Installation"
example you might write ***Installation*** in all instances in the article body
that you want to have linked. This will be parsed and linked. ***Unstallation***
will not be linked, but *** will not be displayed either. In fact, all *** in
the text are swallowed (not erased in the database), so choose your character
sequence wisely.
add a note
User Contributed Notes
Internal links from article to article
There are no user contributed notes for this page.
Adding images to the article