| 1 | <?xml version="1.0" encoding="utf-8" ?>
|
|---|
| 2 | <!--
|
|---|
| 3 | This document specifies ID-to-URL mappings for external links in both conceptual and
|
|---|
| 4 | auto-generated reference documentation.
|
|---|
| 5 |
|
|---|
| 6 | ResolveExternalLinksComponent
|
|---|
| 7 | http://www.codeplex.com/DocProject/Wiki/View.aspx?title=ResolveExternalLinksComponent
|
|---|
| 8 |
|
|---|
| 9 | Add url elements to this document to create mappings, as in the following examples.
|
|---|
| 10 |
|
|---|
| 11 | <url id="home" href="http://example.com/home.aspx" />
|
|---|
| 12 | <url id="contact" href="http://example.com/contact_us.aspx" />
|
|---|
| 13 | <url id="help" href="http://example.com/help.aspx" />
|
|---|
| 14 |
|
|---|
| 15 | Mappings are used in XML documentation comments by specifying see or seealso elements
|
|---|
| 16 | with xref attributes, as in the following examples.
|
|---|
| 17 |
|
|---|
| 18 | <remarks>
|
|---|
| 19 | <para>Visit our <see xref="home"/> page.</para>
|
|---|
| 20 | <para>You may <see xref="contact">contact us</see> for more information.</para>
|
|---|
| 21 | </remarks>
|
|---|
| 22 | <seealso xref="help">Online Assistance</seealso>
|
|---|
| 23 |
|
|---|
| 24 | Mappings are used in MAML topics by specifying a link element with an xref attribute,
|
|---|
| 25 | as in the following examples.
|
|---|
| 26 |
|
|---|
| 27 | <section>
|
|---|
| 28 | <title/>
|
|---|
| 29 | <content>
|
|---|
| 30 | <para>Visit our <link xref="home"/> page.</para>
|
|---|
| 31 | <para>You may <link xref="contact">contact us</link> for more information.</para>
|
|---|
| 32 | </content>
|
|---|
| 33 | </section>
|
|---|
| 34 | <relatedTopics>
|
|---|
| 35 | <link xref="help">Online Assistance</link>
|
|---|
| 36 | </relatedTopics>
|
|---|
| 37 |
|
|---|
| 38 | - The id attribute is not case-sensitive.
|
|---|
| 39 | - The mappings in this file do not use a base URL by default (unless one is set on
|
|---|
| 40 | the component level in the configuration file, which it's not by default).
|
|---|
| 41 | - Hyperlinks open in a new browser window or tab by default.
|
|---|
| 42 | - The default settings for these mappings may be changed by first expanding an
|
|---|
| 43 | appropriate build component stack in the DocProject Properties window. Then find
|
|---|
| 44 | the "Resolve external links" component and invoke its editor. Click the Mappings
|
|---|
| 45 | tab, select the appropriate mappings group from the list of mappings in the left
|
|---|
| 46 | pane and then adjust the settings in the pane on the right. You know you've
|
|---|
| 47 | selected the appropriate mappings group if the File field is set to this file.
|
|---|
| 48 | - Additional mappings groups that are separate from this file may be added using the
|
|---|
| 49 | editor (see the previous note). For example, you can add a group that resolves
|
|---|
| 50 | IDs to URLs that are stored in a relational database table.
|
|---|
| 51 | -->
|
|---|
| 52 | <config>
|
|---|
| 53 | <!-- add <url> mappings here -->
|
|---|
| 54 | </config>
|
|---|
