| 1 | <?xml version="1.0" encoding="utf-8" ?>
|
|---|
| 2 | <!--
|
|---|
| 3 | Warning:
|
|---|
| 4 | The Sandcastle Styles patch must be applied for the bibliography feature
|
|---|
| 5 | to work. Visit http://www.codeplex.com/SandcastleStyles and apply the latest patch
|
|---|
| 6 | -before- creating a new DocProject or DocSite.
|
|---|
| 7 |
|
|---|
| 8 | Auto-Generated Bibliography
|
|---|
| 9 |
|
|---|
| 10 | The bibliography feature looks for <cite>name</cite> elements in XML documentation
|
|---|
| 11 | and <ddue:cite>name</ddue:cite> elements in MAML and automatically generates links
|
|---|
| 12 | to a bibliography section, which is generated at the bottom of each topic.
|
|---|
| 13 |
|
|---|
| 14 | To use this feature in MAML you must also add the <ddue:bibliography/> element
|
|---|
| 15 | somewhere in your topics; preferably, right before the <ddue:relatedTopics> section.
|
|---|
| 16 |
|
|---|
| 17 | This file is used to describe the entries in the bibliographies for every topic
|
|---|
| 18 | that is generated. For example, add a remarks section such as the following to
|
|---|
| 19 | the XML documentation comments in one of your APIs.
|
|---|
| 20 |
|
|---|
| 21 | <remarks>
|
|---|
| 22 | <para>
|
|---|
| 23 | Sandcastle is a popular download<cite>sandcastle activity</cite>.
|
|---|
| 24 | </para>
|
|---|
| 25 | <para>
|
|---|
| 26 | Sandcastle Styles<cite>sandcastle styles</cite> adds even more value.
|
|---|
| 27 | </para>
|
|---|
| 28 | <para>
|
|---|
| 29 | I expect Sandcastle's popularity<cite>sandcastle activity</cite> to increase
|
|---|
| 30 | as more community members become aware of its usefulness, with the help of
|
|---|
| 31 | projects like Sandcastle Styles<cite>sandcastle styles</cite>.
|
|---|
| 32 | </para>
|
|---|
| 33 | </remarks>
|
|---|
| 34 |
|
|---|
| 35 | Then add the following reference elements to this file to describe those citations.
|
|---|
| 36 |
|
|---|
| 37 | <reference name="sandcastle activity">
|
|---|
| 38 | <title>Sandcastle Activity Statistics</title>
|
|---|
| 39 | <author>Microsoft</author>
|
|---|
| 40 | <publisher>CodePlex.com</publisher>
|
|---|
| 41 | <link>http://www.codeplex.com/Sandcastle/stats/view</link>
|
|---|
| 42 | </reference>
|
|---|
| 43 | <reference name="sandcastle styles">
|
|---|
| 44 | <title>Sandcastle Styles</title>
|
|---|
| 45 | <author>Paul Selormey, Eric Woodruff, Dave Sexton</author>
|
|---|
| 46 | <publisher>CodePlex.com</publisher>
|
|---|
| 47 | <link>http://www.codeplex.com/SandcastleStyles</link>
|
|---|
| 48 | </reference>
|
|---|
| 49 |
|
|---|
| 50 | Building documentation now will produce your auto-generated reference topic with a
|
|---|
| 51 | bibliography section near the bottom. Each <cite>name</cite> is replaced in-line
|
|---|
| 52 | with a hyperlink such as [1], [2], [3], [n]..., linking to the corresponding
|
|---|
| 53 | entries in the bibliography section.
|
|---|
| 54 |
|
|---|
| 55 | - The title element is required.
|
|---|
| 56 | - The author element is required.
|
|---|
| 57 | - The publisher element is optional.
|
|---|
| 58 | - The link element is optional.
|
|---|
| 59 | - Reference names are case-sensitive.
|
|---|
| 60 | - If a matching reference is not found, the cite element is processed as regular
|
|---|
| 61 | markup. Currently, the transformations will remove the outer <cite> element but
|
|---|
| 62 | inner text and content may pass through to the topic.
|
|---|
| 63 | -->
|
|---|
| 64 | <bibliography>
|
|---|
| 65 | <!-- Add <reference> elements here -->
|
|---|
| 66 | </bibliography>
|
|---|
