URGENTE:Como especificar SUMMARY tag en el contents editor

TeeGofer general
Locked
Diego
Newbie
Newbie
Posts: 41
Joined: Wed Jun 23, 2004 4:00 am
Location: www.adventurerland.com
Contact:

URGENTE:Como especificar SUMMARY tag en el contents editor

Post by Diego » Mon Jun 28, 2004 10:36 am

Como hago para especificar el SUMMARY tag desde el contents editor.
Todo lo que agrego alli aparece debajo del rectangulo gris con la declaracion del elemento y arriba del see also.

Si importo el XML generado durante la compilación este contenido es agregado primero de todo en los tópicos.

Si bien podría especificarlo en mis códigos fuentes, no quiero incluir texto
de doc en mis fuentes.

Christopher
Site Admin
Site Admin
Posts: 1349
Joined: Thu Jan 01, 1970 12:00 am
Location: Riudellots de la Selva, Catalonia
Contact:

Post by Christopher » Mon Jun 28, 2004 11:36 am

Hi Diego,

Le escribo en Inglés para que los otros lectores de este Forum lo entienden.

The destination of text written into the Contents Editor, that is, where abouts in the Help Topic the text appears, cannot be specified. It is fixed.

In a similar fashion, the position within Help Topics of text written in the summary doc tags cannot be varied either.

How, exactly, would you like your Help Topic to look?
Thank you!

Christopher Ireland (Steema crew)
Please be aware of the newsgroup archives:
http://www.teechart.net/support/search.php
http://groups.google.com
http://codenewsfast.com/

Diego
Newbie
Newbie
Posts: 41
Joined: Wed Jun 23, 2004 4:00 am
Location: www.adventurerland.com
Contact:

Post by Diego » Mon Jun 28, 2004 11:51 am

I'd like the same look that I would obtain if I use the XML file generated by the C# compiler. I'm not using <summary> in my source, because mixing help w/source makes it unreadable and confusing.

If I use the generated xml file, each <summary> value appears as the first line in each topic, but there is no way to change it. The only way is to change my source code, compile it again and apply the new doc XML to my project.

Regards

Christopher
Site Admin
Site Admin
Posts: 1349
Joined: Thu Jan 01, 1970 12:00 am
Location: Riudellots de la Selva, Catalonia
Contact:

Post by Christopher » Mon Jun 28, 2004 12:54 pm

Hello Diego,

OK, I can see what you mean.

The TeeGofer Help topics were based on Microsoft's Help Topics, an example of which can be seen here:
http://msdn.microsoft.com/library/defau ... stopic.asp

As you can see, TeeGofer faithfully reproduces the positioning of virtually all of Visual Studio's XML documentation tags.

The Contents Editor is an exception to this. We wanted the text of the Contents Editor to appear in a unique position so that it elegantly combined with any text in the documentation tags. This means that for all types and members except the Namespace Help Topics, the text of the Contents Editor appears immediately above the automatically generated Required and See Also sections. For Namespaces, given that they don't support summary tags, the text appears at the top of the page.

TeeGofer was designed to create documentation for assemblies documented with "in-line" documentation tags and to create custom HTMLv1/v2 Help Files. The Contents Editor was primarly designed to enable custom Help Topics to be created (the TeeGofer Help file was created using custom help topics) and its output was also integrated into automatically generated Help Topics following the paradigm explained in the paragraph above.

In summary, my best suggestion is that you use the in-line summary tags if you wish your text to appear at the top of each Help Topic page. There's a nice, free, xml documentation tag editor which may be useful to you which you can download from:
http://www.aisto.com/roeder/dotnet/Down ... Documentor
Thank you!

Christopher Ireland (Steema crew)
Please be aware of the newsgroup archives:
http://www.teechart.net/support/search.php
http://groups.google.com
http://codenewsfast.com/

Diego
Newbie
Newbie
Posts: 41
Joined: Wed Jun 23, 2004 4:00 am
Location: www.adventurerland.com
Contact:

Post by Diego » Mon Jun 28, 2004 1:16 pm

Well, I think the best option and unique ;-) is to write summary tags in source code. It would be a cool feature if help writers can write all that stuff within TeeGofer. This way, they can work on help stuff without touching the source code and programmers can work on source code without touching help files.

Best Regards

Locked