I am looking for documentation on the XML parser in ItextSharp, I heard there was a dtd years ago but this seems to be defunt. Does anyone know where I can find out all the valid tags and references?
I am using ItextSharp with Spark
Thanks
When in doubt, use the source. Poking around in my copy of the current iText source, I see that the only SimpleXMLDocHandler available is HTMLWorker.
And if you look at the source for HtmlTags.cs, you'll see all the tag and attribute constants HTMLWorker uses.
It's not exactly comprehensive, but is going to be getting some Enhancement in the immediate future.
I don't see a 4.1.2 tag, but there's one for 4.1.6 in the iTextSharp project on SF. It shows ITextHandler using a bunch of constants from ElementTag in HandleStartingTags(). It also uses ElementFactory to build the various supported tags. Looking at the source for each function will tell you which attributes it supports.
Related
For Spring versions 5.x I cannot find any epub or pdf version of the reference documentation. Former versions were available e.g. at https://docs.spring.io/spring/docs/4.3.9.RELEASE/spring-framework-reference/epub/. Are they available any more? epubs are perfect to be read with an ebook reader.
My guess is that it will get published in time.
Meanwhile - this is the 5.0.4.RELEASE docs in pdf:
https://docs.spring.io/spring/docs/current/spring-framework-reference/pdf/
which you can convert to epub if you wish to do so.
The only officially available and latest epub is the 5.0.0.M5: https://docs.spring.io/autorepo/docs/spring-framework/5.0.0.M5/spring-framework-reference/epub/
The epub for the latest version is not available.
but, I would recommend you to try to convert the html documentation directly to epub.
as converting pdf to epub does not result in very good result [as tools like calibre convert the pdf to html and then epub]
I tried a online converter to convert the https://docs.spring.io/spring/docs/current/spring-framework-reference/
and works pretty good.. [especially the code blocks seem better than the official epub]
hope you find this helpful.
Say there's a QTP Function Library that contains many procedures. Each procedure contains documentation written in an XML node format that describes the purpose, return values and other information about the procedure.
Is there a way to parse these XML documentation that is embedded in the source code just like how it is possible to generate documentation based on XML documentation in .NET?
Microsoft's own XML parser should do the job. I've used it in a couple of projects. The SO posting MSXML2.ServerXMLHTTP.4.0 Source? shows how to find out which version is installed on your machine. Microsoft, naturally, has a lot of documentation. You could probably start here.
There are many libraries for transforming markups like reStructuredText and markdown to HTML. I have some users who are familiar with the markup used in Atlassian's Confluence wiki product, which is unfortunately proprietary -- is there any open source compiler for the confluence wiki markup format, or possibly something that would transform it to an intermediate format?
I think Confluence uses the Textile markup format. I have used over the last few years a rails application that used the gem RedCloth to do the transformation, and I could switch between the 2 formats. I never checked if it is complete interchangeable, however.
You could check for yourself if it is sufficient at Try RedCloth.
We have a very old application dating back to ASP era which we are gradually refactoring to ASP.NET + VB.NET codebase.
It contains a lots of files with the below types:
aspx, asmx, ascx, vb, js (JavaScript), html, vbs (VBScript).
The backend database is SQL Server 2005 with lots of sprocs.
We would like to create a code documentation automatically generated from the comments in the code files. I liked Doxygen very much but seems like it does not support the above technologies. Can you please suggest some document generator tools, preferably a single tool or a group of tools?
Thanks a lot.
Ajit.
You can take a look at Microsoft's Sandcastle tool. I've used it many times, and it generates documentation based on the comments provided in your .NET code. If I remember correctly, it can also generate documentation for JavaScript libraries.
There are some out there:
SandCastle
NDOC
i've used SandCastle and it works too good if you have xml comments in your code.
You first enable xml documentation in your project by setting it in Project Properties -> Compile -> Generate XML Documentation.
Once done you may have to set treat warnings as errors, so that the studio can point out to you where and all the XML comments are missing.
To add an XML Comment, you place your cursor before a class definition or a function definition and type
///
This will automatically generate xml tags for documentation and then once you are done, you can import the project and start to build the documentation.
The good part is, if you have documented your classes well, when you use those functions in your application upon mouse over you can find the description which you wrote, much like how intellisense documentation works.
Let me know if you run into any other issues.
My last suggestion, make a hello world project and xml document it and get used to sandcastle with it.
Is it possible to generate a set of wiki pages from XML comment file generated by Visual Studio?
I'm talking about something like Sandcastle, but for wiki format instead of compiled CHM.
Edit: I'm using MediaWiki which can import/export articles in XML. So I hope that it is possible to write a transformation converting XML comments to MediaWiki XML.
I'd recommend a bit different solution:
Use Help Server to publish .CHM/.HxS on the web
Use special MediaWiki templates to link reference from Wiki like here.
Use <see href="..."> to link Wiki pages from XML comments
See also: FiXml
This is not exactly what you wanted, but I hope this will be helpful.
If the items mentioned above do not suffice, have you tried to simply build your own XSLT transform into the wiki markup of your choice?
You can write a simple application in .NET (or pick your platform of choice) to transform the doc XML format to wiki XML format. You'd still have to keep the wiki updated with the output files manually.