473,800 Members | 2,365 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

HTML in the XML Documentation

BlankDoes anyone know what all HTML tags are allowed in the XML doc tags? Example, I know by experience that <h1> tags are allowed. What other tags are allowed? The MSDN is not clear about this.

--
John Mark Howell

Nov 16 '05 #1
6 1989
BlankBeing XML, any tag is allowed as long as you close it, it is all a
matter of what your tool will process. Are you using anyting specific to
process your xml into a displayable format?
FOr what its worth, I think VS just ignores tags, so I wouldn't worry about
it there.

"John Mark Howell" <jm*********@ho tmail.com> wrote in message
news:%2******** ********@TK2MSF TNGP09.phx.gbl. ..
Does anyone know what all HTML tags are allowed in the XML doc tags?
Example, I know by experience that <h1> tags are allowed. What other tags
are allowed? The MSDN is not clear about this.

--
John Mark Howell
Nov 16 '05 #2
OK, is anyone from MS listening? I thought that the XML code doc was a
significant feature in C#. I am aware that it is extensable, but what about
FULL support within Visual Studio? What about replacable XSL/CSS files?
What about full HTML and/or formatting support (again within VS)?

"Daniel O'Connell [C# MVP]" <onyxkirx@--NOSPAM--comcast.net> wrote in
message news:OZ******** ********@TK2MSF TNGP10.phx.gbl. ..
BlankBeing XML, any tag is allowed as long as you close it, it is all a
matter of what your tool will process. Are you using anyting specific to
process your xml into a displayable format?
FOr what its worth, I think VS just ignores tags, so I wouldn't worry about it there.

Nov 16 '05 #3
Why don't you take a look at the NDoc opensource project? It should exactly
what you're asking for!

http://ndoc.sourceforge.net/

--
venlig hilsen / with regards
anders borum
--
Nov 16 '05 #4
Thanks Anders, but I'm already using NDOC. For anyone else out there
listening, if you develop in C# and you do any kind of XML code commenting,
you MUST HAVE THIS TOOL! The HTML2Help doc that it generates it very
professional. It is the best and (as far as I'm aware of) the only tool you
can use to generate code doc this well.

That being said, the reason for my rant, is that when you are working on the
documentation for a system that has hundreds of classes and you're embedding
HTML formatting tags, it is a real hassle to edit the XML comments, run NDOC
to generate the VS HTML solution, build the solution, then view the
resulting HTML help to see how the formatting looks. We need a truly visual
solution within VS to help. If you can see how it looks as you're editing
it, then you can save a great deal of "clean-up".
"Anders Borum" <a@b.dk> wrote in message
news:%2******** ********@tk2msf tngp13.phx.gbl. ..
Why don't you take a look at the NDoc opensource project? It should exactly what you're asking for!
http://ndoc.sourceforge.net/
venlig hilsen / with regards
anders borum

Nov 16 '05 #5
Hello John

I completely agree that the NDoc tool is a must have. The output is very (if
not completely) close to the original MSDN format, which I find quite good.

Regarding a visual realtime feedback on the commenting, I'm not sure this is
something we could expect from the VS .NET developers for the Whidbey
release, but given enough request, I'm sure they will investigate ways of
providing a richer environment.

The already rich commenting is a great step forward (even though java has
had this for a long time I have been told), and works quite well for our
developers here.

--
venlig hilsen / with regards
anders borum
--
Nov 16 '05 #6

"John Mark Howell" <jm*********@ho tmail.com> wrote in message
news:Oi******** ******@TK2MSFTN GP11.phx.gbl...
OK, is anyone from MS listening? I thought that the XML code doc was a
significant feature in C#. I am aware that it is extensable, but what
about
FULL support within Visual Studio? What about replacable XSL/CSS files?
What about full HTML and/or formatting support (again within VS)?
I don't think XML docs are specifically meant to provide that level of
access through VS itself. I'd rather see a seperate editor(or a seperate
editing mode) over implementing this type of thing into the code editor.
"Daniel O'Connell [C# MVP]" <onyxkirx@--NOSPAM--comcast.net> wrote in
message news:OZ******** ********@TK2MSF TNGP10.phx.gbl. ..
BlankBeing XML, any tag is allowed as long as you close it, it is all a
matter of what your tool will process. Are you using anyting specific to
process your xml into a displayable format?
FOr what its worth, I think VS just ignores tags, so I wouldn't worry

about
it there.


Nov 16 '05 #7

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

3
1833
by: Mikey At Work | last post by:
I'm looking for opinions on the several HTML documentation generators available for Python. We're trying to standardize the documentaion used for an upcoming project. Specifically, I'm looking for something very similar to Javadoc in both output and syntax (because most of our team members are very familiar with Javadoc). I've pretty much narrowed it to either PythonDoc or epydoc, but wanted to ask the newsgroup's opinion before making...
7
2203
by: Jacek Generowicz | last post by:
:::Title::: A simple text markup utility :::/Title::: :::Section Introduction ::: I'm looking for something to help developers wirte documentation for bits of software they are writing. The main (initially only) presentation format will be HTML. The idea is to allow the author to write a plain text file containing the text he wishes to present, annotated with minimally intrusive markup which describes the :::emph::: meaning...
3
3502
by: Mitchua | last post by:
When I run the well quoted line: my $ascii = HTML::FormatText->new->format(HTML::Parse::parse_html($html)); to remove HTML tags from an html document, it replaces all tables with "". Is there a quick and easy way to get the table content parsed too? Thanks a lot, Mitchua
8
2062
by: Marc Rochkind | last post by:
Nearly everything written about HTML falls into one of two categories: 1. Material written for HTML authors, or 2. Material written for user-agent implementors about standard HTML However, programmers writing a browser need to know about invalid, obsolete, and non-standard HTML also, because that's what shows up on the web. For example, on the Yahoo site alone I see: -- use of hex numbers for color attributes without the #
7
1595
by: egoebel | last post by:
Hi, I would like to have a decent set of HTML docs for the entire Standard C++ Library, as opposed to STL-only docs like the pages at SGI. I've been using the MSDN docs but,...ugh...I'm sure I don't have to explain why they stink. Does this exist?
40
5619
by: VK | last post by:
Hi, After the response on my request from W3C I'm still unclear about Tidy vs. Validator discrepansies. That started with <IFRAME> issue, but there is more as I know. Anyway, this very basic HTML page: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN" "http://www.w3.org/TR/html401/strict.dtd"> <html> <head>
1
1564
by: Ryan Ginstrom | last post by:
I have been maintaining a body of documentation in plain HTML files. I would now like to automate the generation of the HTML files. Maintaining the HTML files now is tedious and error prone, because every time I move/remove/add a section, I have to renumber the following sections and update my internal links. I have looked at some of the HTML-generation frameworks, but the selection is somewhat bewildering, and most also seem geared to...
5
1393
by: mySpamB8 | last post by:
I'd like to output an HTML fragment from an XSL UDF, but the HTML tags aren't being output (just non-html values show up in the output). As a noob, I'm probably missing some fundamental piece of info. For instance, the following yields simply "hello" in my HTML output: <xsl:function name="jj:test"> <td>hello</td> </xsl:function>
6
10170
by: clintonG | last post by:
Can anybody make sense of this crazy and inconsistent results? // IE7 Feed Reading View disabled displays this raw XML <?xml version="1.0" encoding="utf-8" ?> <!-- AT&T HTML entities & XML <elementsare displayed --> <rss version="2.0"> <channel> <title>AT&T HTML entities & XML <elementsare displayed</title> .... <description>
14
5417
by: asdf | last post by:
I have a python script whose output i want to dynamically display on a webpage which will be hosted using Apache. How do I do that? thanks
0
9697
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
0
9555
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
10515
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
0
10291
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...
0
10049
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
9100
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
1
7589
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
5479
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
2
3771
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.