Author Topic: Include linked documents in HTML documentation  (Read 3310 times)

trevreeves

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Include linked documents in HTML documentation
« on: June 21, 2006, 12:42:11 am »
Hello,

Being able to create an RTF linked document for each class is a great idea for providing extra model documentation that isn't really suitable to include in the class itself, and being able to export these RTF documents from EA individually is useful.

But, it would be very handy if a linked document could be published in the HTML documentation feature.  So for example, a link is provided on the web page for a class, to a HTML version of the linked document.  Currently, I can't find a way to achieve this.

Regards

Trevor.

mlandmann

  • EA Novice
  • *
  • Posts: 1
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Include linked documents in HTML documentation
« Reply #1 on: June 22, 2006, 03:45:22 pm »
I agree this is need.  The ability to put additional documentation in a RTF document is great.  

In addition, a better way to see the RTF document that is linked in is needed.  

Dave_Bullet

  • EA User
  • **
  • Posts: 295
  • Karma: +0/-0
    • View Profile
Re: Include linked documents in HTML documentation
« Reply #2 on: June 25, 2006, 09:03:13 pm »
"I know I'm close to a good design, but it's like the balloon animals, squeeze in one spot and the problem moves down the line"

Dave_Bullet

  • EA User
  • **
  • Posts: 295
  • Karma: +0/-0
    • View Profile
Re: Include linked documents in HTML documentation
« Reply #3 on: June 25, 2006, 09:04:37 pm »
For example - here is my Object Detail HTML template with linked doc included:

<table cellPadding=2 cellSpacing=2 width="100%">
 <tbody>
<tr>
<td class=ObjectTitle>
#STEREOTYPE# : #NAME#
</td>
</tr>
<tr>
<td>
<table class=ObjectDetails cellPadding=2 cellSpacing=2 width="100%">

 <tbody>
<tr>
<td width="15%" class=ObjectDetailsTopic>Author:</td>
<td width="85%" class=ObjectDetailsValue>#AUTHOR#</td>
</tr>
<tr>
<td width="15%" class=ObjectDetailsTopic>Dates:</td>
<td width="85%" class=ObjectDetailsValue>Created: #CREATEDATE#; Modified: #MODDATE#;</td>
</tr>
<tr>
<td width="15%" class=ObjectDetailsTopic>Linked Document:</td>
<td width="85%" class=ObjectDetailsValue>#LINKDOC#</td>
</tr>  
<tr>
<td valign="top" width="15%" class=ObjectDetailsTopic>Notes:</td>
<td colspan="2" width="100%" class=ObjectDetailsValue>#NOTE#</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>&nbsp;</td>
</tr>
</tbody>
</table>

"I know I'm close to a good design, but it's like the balloon animals, squeeze in one spot and the problem moves down the line"

trevreeves

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Include linked documents in HTML documentation
« Reply #4 on: June 26, 2006, 01:25:56 am »
thanks for that - should have searched the forum before posting!  :-[  :)