Bild von DocumentX

DocumentX

von Innovasys

Dokument! X automatisiert die Erstellung und Pflege von Dokumentationen für Microsoft .NET Assemblies, Visual Basic / VBA / VB.NET Quellcode, Datenbanken, kompilierte COM Komponenten und Typbibliotheken. Dokument! X erstellt automatisch komplette und genaue professionelle Dokumentation für Ihre Komponenten, Anwendungen und Datenbanken.

Overview

Documentation Made Easy

Document! X is a combination of an automated documentation tool and a full authoring environment which can be used to create, publish and maintain accurate, professional quality documentation for .NET, Web Services, Databases, XSD Schemas, COM Components and Type Libraries, Java and Javascript.

Document! X is not just an automated documentation build tool - it includes a fully featured documentation authoring environment allowing you to supplement the automatically generated content where required.

Sample Outputs

These sample outputs illustrate how much can be generated by Document! X right out of the box. All of the Document! X Templates are fully customizable and can be easily adapted or extended to meet your specific requirements.

Database Documentation, Table Page

Page generated for a Table, including Properties, Columns, Indexes, Relationships and SQL Source (where available). Also includes dependencies if documenting a Sql Server database.

Web Service Documentation, GET Operation Page

Page generated for a GET Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.

Web Service Documentation, Method Page

Page generated for a SOAP Web Service method. Details the parameters, request/response data types and any fault responses.

Web Service and XSD Schema Documentation, Diagrams

Schema diagrams are automatically generated for web service operations that use XSD Types and XSD documentation pages.

.NET Documentation, Class Overview Page

Overview of a .NET class, including an automatically generated Object Relationship Diagram, Inheritance Hierarchy and Syntax in multiple .NET languages.

.NET Documentation, Constructor Overload Page

Page for a specific .NET constructor overload, including a link to the method summary page listing other overloads.

COM Documentation, Class Overview Page

Overview of the COM class, including an automatically generated Object Relationship Diagram.

XSD Documentation, Complex Type Page

Page generated for an XSD Complex Type, including a type diagram, overview data tree and XSD Source Code.

Javascript Documentation, Method Page

Page generated for a Javascript method, documenting the syntax and parameters.

Visual Studio Integration

Document! X integrates seamlessly with Visual Studio® 2010-2017 . Documentation Projects can be created, opened and built directly from your Visual Studio solution. A Visual Comment Editor is included for creating and maintaining your source code comments in Visual Basic .NET, C#, C++/CLI and F# source code.

Author and maintain your Visual Basic .NET, C#, C++/CLI or F# source code comments directly within a preview of how the generated documentation will look.

Visual Studio Comment Editor

The Document! X Visual Studio Visual Comment Editor provides a unique fully Visual Editor for your VB.NET, C# or C++/CLI source code comments, integrated directly with the Visual Studio IDE. The Visual Comment Editor allows you to create and edit Xml comments in a WYSIWYG preview of the generated documentation.

Standard Xml Source Comments

Even though you can author your content in a fully WYSIWYG editor, comments created or edited with the Visual Comment Editor are written back to your source code in standard XML source comment format.

Your .NET Language of Choice

Document! X can document assemblies created with any Visual Studio language. The Visual Comment Editor supports C#, Visual Basic, C++/CLI and F# projects.

Build from Visual Studio

Build your documentation projects directly from Visual Studio. Integrate Document! X with your team build using the provided command line build .exe, msbuild task or Workflow activity.

What's New in 2017.1

New "Light" Templates

A new set of templates have been introduced inspired by the latest Microsoft Documentation style. These new templates introduce a simplified and fresh layout and typography featuring a frameless design with in-page Table of Contents navigation, a right hand action bar with automatic "In this Topic" support and a page layout that is responsive to the available screen width.

The new Templates are available for every supported documentation type.

Move and Rename Other Files

It is now possible to move and rename Other Files directly on the Project Explorer. References to the moved and renamed Other Files (e.g. images, Widgets and links) are automatically updated. To round off this new functionality, it is now also possible to create new Other Files folders from the Project Explorer. Source Control integrated projects are fully supported.

Visual Studio 2017 Integration

Integration with the release version of Visual Studio 2017 (all versions), including the Visual Comment Editor for authoring C#, Visual Basic and C++/CLI code xml comments.

Microsoft Help Viewer 2.3 Support

Support for Microsoft Help Viewer 2.3, the updated version of Microsoft Help Viewer included with Visual Studio 2017. Output that targets Microsoft Help Viewer will now automatically register with Microsoft Help Viewer 2.3 if it is installed locally, a link to view the generated output will be included in the Build Results and batch files will be generated with the commands necessary to deploy help to Microsoft Help Viewer 2.3 on other machines.

Improved Copy to Clipboard

The support for Copy to Clipboard in Colorized Example Code widgets has been improved and removes the dependency on Adobe Flash. Copying to clipboard now results in a subtle notification that appears beside the "Copy Code" button when clicked.

Detailed Feature Comparison

The comparison table below outlines in detail the functionality present in Document! X, HelpStudio and the Document! X and HelpStudio Bundle so you can pick the product that is right for your requirement.

 Document! XHelpStudioDocument! X & HelpStudio Bundle
Content Authoring
Conceptual Topic Authoring
Create free format topics, e.g. tutorials, procedures, how-to guides etc. You decide the Topic Structure and organize your Topics in the Table of Contents editor.
Automated Reference Documentation
Automate the production of reference documentation for a wide range of technical items including .NET and Silverlight Assemblies, COM Components, Java Projects, Databases, XSD Schemas, Javascript and Web Services.
 
Reference Documentation Authoring
Author additional content for reference documentation items, including colorized examples and see also links as well as descriptive content, using the Content File Editor. Create rules based content that applies to many items automatically using the AutoDoc File Editor.
 
Single Sourcing
Create all of your different outputs from a single project by using Build Flags and Build Profiles.
Style Editing
Style Picker, Style Editor and Stylesheet File Editor make it simple for you to leverage the power of CSS styles in your content.
Widgets
A fully customizable library of content functionality that requires no manual scripting and can be configured for different outputs without any change to content. Standard widgets include dynamic images (click to expand thumbnails), drop down sections, colorized example code sections, tab strips, twitter feeds and more.
Content Snippets
Reduce duplication by creating re-usable snippets of content using drag and drop.
 
PDF Booklets
Generate PDF Booklets.
 
Import from Word, CHM, Help 2.x, RoboHelp
Leverage your existing legacy content by importing directly from a wide range of other content sources.
 
Visual Studio Comment Editor  
A visual comment editor integrated with Visual Studio® 2010-2017 allows you to author Xml format source comments directly within a preview of the generated page. All content is written back to the source as standard Xml comment format.
Outputs
Compiled help (CHM, Help 2.x, Microsoft Help Viewer)
Full support for all the Microsoft platform compiled help formats including the new Visual Studio® 2010-2017 Microsoft Help Viewer.
Web Help
Web ready plain html output for publishing on a intranet or internet web site, or for viewing from a local directory.
PDF Booklets
Generate PDF Booklets, including a Table of Contents and Index, using existing content you have authored for online help. Links, images and widgets are all automatically converted to be suitable for a printable output.
 
Publishing
Automatically publish your generated outputs to a web site (Azure, IIS Web Deploy, Ftp and File System Directory Publishing Targets are supported) or directory path (local or network).
Project Tools
Link and Spell Check, Find and Replace
Validate the Hyperlinks and See Also links throughout your project. Find and Replace, including regular expression support.
Image Tools
Screen capture, image editing, thumbnail and markup tools integrated directly with the application.
 
Glossary Editor
Create a Glossary Page defining commonly used terms and have the definitions appear as hover popups where they are used in your content.
 
Project Index Editor
Work with a project wide view of the index to get a clear view of which index keywords link to which topics. Note that even without the Project Index Editor you can still define custom index keywords in the Topic Editor.
 
Localization
Localization
Author and generated output for multiple locales within a single project.
Localization Export and Import
Export content in XLIFF or XML format in order to use the services of a third party translation provider to assist with your localization. Use the Localization Report to identify content that requires localization.
 
Team and Community
Source Control Integration
Use Team Foundation Server, SourceSafe, SourceGear Vault or Subversion to collaborate with other team members. Fine grained integration allows different individuals to work on different project elements simultaneously.
Community and Discussion Features
Automatically include community and discussion features using Disqus, Facebook, SolidOpinion or Livefyre by simply enabling a single project setting.
Artikelnummer Bezeichnung Upg Mon. Edition Nettopreis Bruttopreis
96483 Document! X subscription renewal 12 €115,13 €137,00
216588 Document! X 2017.1 €343,70 €409,00
216682 Document! X 2017.1 upgrade €171,43 €204,00
216683 Document! X 2017.1 upgrade with subscription 12 €264,71 €315,00
216684 Document! X subscription purchase 12 €171,43 €204,00
216685 Document! X 2017.1 (2-4 Users) €309,24 €368,00
216686 Document! X 2017.1 with subscription (2-4 Users) 12 €392,44 €467,00
216687 Document! X 2017.1 upgrade (2-4 Users) €153,78 €183,00
216688 Document! X 2017.1 upgrade with subscription (2-4 Users) 12 €239,50 €285,00
216689 Document! X subscription renewal (2-4 Users) 12 €102,52 €122,00
216690 Document! X subscription purchase (2-4 Users) 12 €153,78 €183,00
216691 Document! X 2017.1 (5-9 Users) €274,79 €327,00
216692 Document! X 2017.1 with subscription (5-9 Users) 12 €348,74 €415,00
216693 Document! X 2017.1 upgrade (5-9 Users) €139,50 €166,00
216694 Document! X 2017.1 upgrade with subscription (5-9 Users) 12 €215,13 €256,00
216695 Document! X subscription renewal (5-9 Users) 12 €91,04 €108,34
216696 Document! X subscription purchase (5-9 Users) 12 €139,50 €166,00
216697 Document! X 2017.1 (10-19 Users) €240,34 €286,00
216698 Document! X 2017.1 with subscription (10-19 Users) 12 €305,04 €363,00
216699 Document! X 2017.1 upgrade (10-19 Users) €120,17 €143,00
216700 Document! X 2017.1 upgrade with subscription (10-19 Users) 12 €184,03 €219,00
216701 Document! X subscription renewal (10-19 Users) 12 €79,65 €94,78
216702 Document! X subscription purchase (10-19 Users) 12 €120,17 €143,00
216591 Document! X 2017.1 with subscription 12 €435,29 €518,00