DocumentIt formatting and features

[KTaskov]

Hi,

I am using DocumentIt to document my SystemBuild model by using provided mswgp.tpl and mswgp.wrd templates. However, the provided templates do not preserve formatting of the comments entered to the level of formatting as simple as line returns. The comments are just given out as one big paragraph. They do come out fine when using a template example given in the documentation itself in Example 1-1, but that one is not suited for Word. Can you fix this bug?

Another problem I have found out is that if a SuperBlock contains an output from a DataStore, the comments given in the Documentation tab related to the output variables are not reflected when documenting the output of the SuperBlock whereas they are presented ok for outputs
of the DataStore itself. So it seems that in case of DataStores, the documentation of the outputs does not propagate through to the SuperBlock level as with Algebraic Expression for example.

Third thing I would like to bring up is more of a feature request for perhaps future versions. The problem right now I have is when trying to document output variable properties coming from a procedure that is used in producing two different types of variables; for example, a simple, general vector manipulation that is used across the model for different type of vector variables that have different units. At this time, to document units for these vectors, I have to go down to the block level inside a procedure and whatever unit I document there will be reflected on all of the vectors that are generated by all instances of the procedure in the model which would be incorrect. So what I would like to be able to do is to have option to propagate or not to propagate the documentation tab values assoc
iated with the output of procedures the same way that the variable names are managed now.

Thanks for your assistance

[Carl L.]

Thank your for letting us know about the labels of the DataStore block. The comments entered on the documentation tab should behave just the same as on other blocks. The unit label does not show in the list either. I have reported this problem to R&D.

I can also see the problem with not being able to give different labels and units when a block is used in different places. Perhaps allowing for a documentation tab on the superblock reference dialog, or as you said an option to propogate labels or to have local labels.

The missing line returns comes from the way DocumentIt works. DocumentIt generates text documents, which in the case of generating a Word file is a rich-text file. In rich-text files the line feeds do not mean a new paragraph. Instead \par
is used. The line feeds that are in the comments show up in the output file if it is opened in a pure text editor such as notepad, but when it is read by Word or any other rich-text editor then you will not see the returns. If the comment is:
one
line
then it will show up on just one line. Where as:
two \par lines
will show up on two lines when interpreted by a rich-text editor. When entering comments add a \par at the end of each line.
two \par
lines

Carl L
National Instruments

[KTaskov]

That worked. Thanks!

PS I also wanted to let you know that this is not mentioned in the documentation and should be added next time around. There is only mention of adding \n for FrameMaker.