|
|
|
|
|
Features of TechWriter for Web Services
|
|
Supported Web Services
- Any web service that is defined by a Web Service Definition Language (WSDL) file
or can produce a WSDL.
- WSDL can be accessed as either a local file or through an HTTP or HTTPS web
request.
Web Service Objects Documented
- Services, Methods and Parameters.
- Elements, Attributes and Types used to define the method parameters.
- Cross References.
Supported Output Formats
- PDF (Portable Document Format)
- Compiled Help / HTML Help 1.x File (CHM)
- Word/RTF (DOC)
- HTML Page (single-page HTML)
- Web Site (multi-page HTML)
Advanced Filtering
- Filter the methods, elements, attributes and types that you want to include
or exclude through an easy-to-use checkbox interface.
- Filter based on wildcard patterns that match the names of your web service objects.
Annotations
- WYSIWYG annotation editor for adding and revising web service descriptions and remarks.
- Rich content model that supports formatting of paragraphs, lists, hyperlinks and more.
- Import and export annotations to and from comma-delimited and XML files.
Customizations
- Custom language file allows over 100 alternate values for output headings and text.
Can be used to support other languages or produce highly customized output.
- Control the level of detail included in the topic page for each web service object by
selecting from over 30 sections of conditional content.
Optional Command Line Interface
- Can be called from build tools (e. g. MSBuild, Ant, NAnt).
- Parameters allow you to specify the project file, output type and a refresh
switch.
PDF Output Features
- Printable table of contents with page numbers and hyperlinks
- Bookmarks for navigation
- Printable index with page numbers and hyperlinks
- Page headers and footers
Compiled Help Output Features
- Table of contents for navigation
- Search tab for full-text searching
- Index tab containing generated index terms
- Page headers and footers
Web Site/HTML Page Output Features
- Template-driven output
- Configurable top-level page name
- Configurable table of contents
Word/RTF Output Features
- Table of contents
- Page headers and footers
|
|