Book a Demo

Author Topic: custom documentation questions  (Read 3609 times)

Scott Lindner

  • EA User
  • **
  • Posts: 20
  • Karma: +0/-0
    • View Profile
custom documentation questions
« on: May 25, 2006, 10:43:01 am »
I'm trying to create a custom document template and am using the virtual document capability.  Which is cool by the way.

I have a bunch of questions that will probably go all over the place.

I've created an template RTF with some formatting and other standard company junk that's supposed to be in it.  I have it loaded into EA as a new template.  There are some items of data that our company applies to all documents that are essentially unique metadata that we use on every document.  I'd like to express this in the EA class object, and have to template peel out these attributes.  I have more questions than just this... but this is where I'll start.

I was about to add attributes to the documentation class object for each of these and set the initial value for each attribute for this specific document.  Then I started thinking I should create a class for the company's standard documnent attributes and include this, but I don't see how to set the specific values for this document in the class object.  Then I started thinking maybe this is more appropriate to a tagged values.  Then I realized I really don't have a clue what the appropriate was is to do this and here I am looking for pointers.

I know I could easily manually enter in this information after each time I generate the document.  But that doesn't have as much coolness factor.   8)

Scott Lindner

  • EA User
  • **
  • Posts: 20
  • Karma: +0/-0
    • View Profile
Re: custom documentation questions
« Reply #1 on: May 25, 2006, 12:19:25 pm »
Another short round of questions.

Is it possible to specify the order of packages, order of diagrams, and order of elements for the documentation?  I'm guessing this needs to be done in the packages, diagrams and elements and not in the documentation template.

Also, is it possible to specify a specific package, diagram or element by name, GUID, or other reference for a specific section in the template?

I tried searching the forums for other posts like this but didn't any.

ciske

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
  • Out out!!! You demons of stupidity!
    • View Profile
Re: custom documentation questions
« Reply #2 on: May 26, 2006, 01:12:24 pm »
"Is it possible to specify the order of packages, order of diagrams, and order of elements for the documentation?"

Ordering the items within the tree structure can be done by drag&drop and using the "up/down element" symbol in the tree views toolbar.  You may have to check the "Allow Free Sorting" box in the General Options to do that.

To keep this order when generating the RTF document make sure you have to selected "Tree Order" in the "Generate Options" dialog.

Hope that helps.

ciske

Real stupidity beats artificial intelligence everytime!

pab

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: custom documentation questions
« Reply #3 on: May 27, 2006, 04:36:22 pm »
"To keep this order when generating the RTF document make sure you have to selected "Tree Order" in the "Generate Options" dialog. "

This works---once.  Why aren't the Generate Options settings retained within the resource document?  I haven't yet had a situation where I wanted anything other than tree-order, and I have to re-enable it every time I generate a document.

«Midnight»

  • EA Guru
  • *****
  • Posts: 5651
  • Karma: +0/-0
  • That nice Mister Grey
    • View Profile
Re: custom documentation questions
« Reply #4 on: May 27, 2006, 04:50:43 pm »
Pab,

Try submitting this (making the tree order option 'sticky') as a feature request. Do it from EA, via Help / On-line Resources / Request-a-Feature.

David
No, you can't have it!

ciske

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
  • Out out!!! You demons of stupidity!
    • View Profile
Re: custom documentation questions
« Reply #5 on: May 28, 2006, 10:54:04 pm »
Quote
This works---once.  Why aren't the Generate Options settings retained within the resource document?


Open your template in the RTF Document Editor and change the settings under File=>Document Options. This way at least the settings for your current template will be saved.

Cheers,
ciske
Real stupidity beats artificial intelligence everytime!