Loading...
 

1. Definitions

An external link is a reference to a location outside this website, for example: the ARRL website, or a Contest rules page. Those sites are external to this TikiWIki platform and its server. An internal link is a reference to a location within the website program and its documents, for example: the Users Guide or the FAQ. An anchor is the object of those references - the placed linked to by those references.

Q: All of this material - the external sites and the internal wiki pages - have URLs: http://www.someplace.com/details. Wouldn't it be easier to simply use an external link for EVERYTHING?
Well, not really. It is not a good practice within the website to use an external link to refer to an internal location. Why? There are actually three images of this wiki website: a test site for testing new versions of software, a pilot site for creating/editing new content for the manual, and a "live" site which the users see. If we use an external link to refer to content while developing/editing in the pilot or test locations, the link will break when the content is eventually transferred to the URL of the live website. An internal link will work properly regardless of the URL of the website.

Wiki References ((page)) or ((page|description)) for wiki references , ((page|#anchor)) or ((page|#anchor|desc)) for wiki heading/anchor references. Double open parens "((", the page name, a pipe "|", a pound sign "#", the section name, a pipe "|", and the blue prompt text "click here"

For example:
If you insist, look back at this discussion.


Links to the Gallery must be listed as external links, but they can be abbreviated links that do not contain the principle URL. For example:

Directory reference: <THIS DIRECTORY>
[tiki-list_file_gallery.php?galleryId=5|__<THIS DIRECTORY>__]

File reference: <THIS FILE>
[tiki-download_file.php?fileId=19|__<THIS FILE>__]

Avoid using a fully qualified domain name because that type of link will break when/if the URL changes. For example, DO NOT use:

<THIS FILE>
[http://www.n1mm/com/tiki-download_file.php?fileId=19|__<THIS FILE>__]

The wiki syntax for an external link is quite simple: square brackets surround the HTTP URL, followed by a vertical bar "|", followed by the text that appears on a user's screen. Example: [http://www.arrl.org|The ARRL website] creates The ARRL website.

To make adding links easier for you, the wiki editor will create a sample external link in your document when you press the <link> button on its toolbar

The website automatically creates an anchor for every Chapter, Section, and Subsection in the documentation. You can refer to those anchors in your content by either manually typing a link into your text, or by using the Author's Help tool built into the software.

Manually editing an internal link to an anchor

The syntax for an internal link includes the exact (upper/lower case must match!) name of the heading, the exact name of the page, and the visible on-screen text. The following is an example of an internal link to the Screenshot section of this document.
This text: {ALINK(aname="Screen Capture Techniques" pagename="Adding Images and Screenshots")}Click here for more info about Screenshots{ALINK}

Creates this on-screen link: Click here for more info about Screenshots

This example refers to a wiki Section Title as the name of the anchor (aname= ). You can also add anchors to the site - see below.

Using the Author's Help tool to create an internal link to an anchor

In Edit mode, position your cursor on the line where you would like the link inserted. Click the <Help> button in the upper-right corner of your browser. Scroll through the Author Help until you reach the Plugins section, and then click the tool icon adjacent to the title "Anchor Link."
Image

An Anchor Link dialogue window will appear. Type the exact (upper/lower case must match!) heading name, page name, and the on-screen text. See example below
Image

Upon pressing <Submit Query> the properly formatted link syntax will appear in your content. If you press <Preview>, the link text will be blue on your screen and will become underlined when you mouse-over the link. If it does not, then you have incorrectly named either the Heading or the Page reference for the anchor.

6. Adding an Anchor to a Page

It's possible that a link to a Page, or a Table of Contents item, or a Section will not get your users close enough to the material that you want them to find. In those instances, you can add an anchor to a wiki page. On the wiki page, in edit mode, use the following anchor syntax: {ANAME()}anchorname{ANAME}
Example of an anchor named ''rs232protocol'': {ANAME()}rs232protocol{ANAME} Keep the anchorname simple: short, no spaces, all lower case. Put the anchor on its own line (add an extra line between paragraphs) or as part of in-line text. When you save the page, users will NOT be able to see the anchor on the page (anchors are invisible).

6.1. Linking to the New Internal Anchor from Outside the Website

To refer to your new anchor from outside the website in a url, use: the full website URL, plus a ?, plus the page name, plus a # delimiter, plus the anchor name: External Link to an Internal Anchor examples:
http://n1mm.hamdocs.com/tiki-index.php?page_ref_id=16#rs232protocol
http://n1mm.hamdocs.com/tiki-index.php?page=Interfacing#rs232protocol
Last Modification: 16 May 2011 11:14:19 EDT by K8UT.