Click or drag to resize
Sandcastle Help File BuilderProject Properties and Shared Content

The help file builder will resolve references to project properties and to items in the SharedBuilderContent.xml and shared_content.xml files. To substitute project properties in the additional content files, place them in a tag as in the following example.

Caution note Caution

Deprecated

The additional content model of adding extra content to a help file has been deprecated. While it will continue to be supported and will not be removed, it will not receive any more features or updates. Going forward, conceptual content is the preferred method of adding non-reference content to the help file. The additional content feature can still be used to override stock content and add supporting files to the help file.

Copy
<@CopyrightInfo/>
<@FeedbackEMailAddress/>

Full Build Date: <@BuildDate/>
Formatted Build Date: <@BuildDate:MMMM d, yyyy a\t hh:mm tt/>

In this help file, these are rendered as:

  • [v2014.4.22.0] Copyright © 2006-2014, Eric Woodruff, All rights reserved (http://SHFB.CodePlex.com)

  • Eric@EWoodruff.us

  • Full Build Date: 11/24/2014 11:58:11 AM

  • Formatted Build Date: November 24, 2014 at 11:58 AM

Any of the values defined in the Customizing the Build Process topic can be used. The only difference is that you must use angle brackets rather than curly braces in the additional content files.

To include shared content items such as the header, preliminary message, comments, copyright, or footer, use an include item as in this example:

Copy
<include item="header"/>
<include item="preliminary"/>
<include item="footer"/>
<include item="comments"/>
<include item="copyright"/>

Note that for some items such as footer, the comments and copyright items are nested within it so there is no need to specify them separately unless you are customizing the footer area. Another benefit to this feature is that the items will appear in the language selected in the project as well.

See Also