Additional Content and the Build components

Topics: Developer Forum, User Forum
May 17, 2007 at 8:38 AM
Hi

First of all I am really enjoing this great gui.

I am currently working on a big documentation project, and so I'm learning this tool and creating my own components.

I would like to maintain the look and feel of my additional content, same as any other generated documentation.

I was wondering why not include the additional content in the manifest.xml file, and then using normal BuildComponents to manipulate it?

Tnx
Noam
Coordinator
May 17, 2007 at 4:10 PM
BuildAssembler pulls various information from the reflection information and the XML files and runs it all through a set of XSLT transformations. It's doubtful that you could structure the additional content in such a way to make this possible.

Eric
May 19, 2007 at 4:43 PM

is there any other way to keep the files with the same look and feel?

Tnx
Noam



EWoodruff wrote:
BuildAssembler pulls various information from the reflection information and the XML files and runs it all through a set of XSLT transformations. It's doubtful that you could structure the additional content in such a way to make this possible.

Eric


Coordinator
May 19, 2007 at 11:12 PM
All I did for my own projects was create a template like the following. Simply clone it and replace the title and content.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
 
<head>
<link rel="stylesheet" href="styles/presentation.css">
<title>!!! YOUR TITLE HERE !!!</title>
</head>
 
<body>
 
<div id="control">
<table border="0" width="100%" cellpadding="0" cellspacing="0">
  <tr>
    <td align="center" valign="top" style="padding-right: 10px"><img src="OPTIONALIMAGE.bmp" alt="!!! OPTIONAL IMAGE !!!" /></td>
    <td valign="top" width="100%"><span class="productTitle">!!! PRODUCT TITLE Namespace Documentation !!!</span><br />
    <span class="topicTitle">!!! YOUR TOPIC TITLE !!!</span></td>
  </tr>
</table>
</div>
 
<div id="main">
 
!!! YOUR CONTENT !!!
 
<include item="footer"/>
</div>
 
</body>
</html>

Replace stuff indicated by "!!!" to fill it in. If it's in a sub-folder, add relative path indicators ("../" as many as needed) to let it find the style sheet.

Eric

May 20, 2007 at 8:19 PM

EWoodruff wrote:

Replace stuff indicated by "!!!" to fill it in. If it's in a sub-folder, add relative path indicators ("../" as many as needed) to let it find the style sheet.

Eric




I'm trying your suggestion but am not quite sure how I should form the link tag's href attribute. Is the href referring to the styles/presentation.css file that lives in the Program Files/Sandcastle/Presentation/Prototype or VS2005 directory? And if so, should the path be relative to the location of the additional content file, the project file or some other location?

Thanks,
John
May 20, 2007 at 9:36 PM

JohnCannata wrote:

EWoodruff wrote:

Replace stuff indicated by "!!!" to fill it in. If it's in a sub-folder, add relative path indicators ("../" as many as needed) to let it find the style sheet.

Eric




I'm trying your suggestion but am not quite sure how I should form the link tag's href attribute. Is the href referring to the styles/presentation.css file that lives in the Program Files/Sandcastle/Presentation/Prototype or VS2005 directory? And if so, should the path be relative to the location of the additional content file, the project file or some other location?

Thanks,
John



After looking at the Output directory during a build I now understand how to form the href attribute.
Now I have a different question. How do I include additional content information in the keyword Index?

Thanks,
John
Coordinator
May 21, 2007 at 6:07 AM
If you are linking to other namespace content, just use the <see> tag. The help file builder will resolve those automatically. This is covered in the help file. See the FAQ for info on linking to other additional content pages with anchor tags. As for the index stuff, I'm not sure. Including the <mshelp> tags or whatever they are might do it.

Eric