☰ Menu
+1 866.606.7247
Registration is live for the 2024 Contiem Content Conference to be held May 14-16 in Annapolis, MD. For more information and to reserve a spot, please visit
2024 Contiem Content Conference Registration
×

Popular Searches

Technical Writing Documentation Services Training Methods User Documentation Consulting Services

JavaScript Documentation
Generator Customer Login Contiem Store

Document! X delivers the best of both worlds by seamlessly combining automated JavaScript files (plain JavaScript or jQuery plugins / widgets) documentation generation with a full WYSIWYG authoring environment. The generated output is an accurate and comprehensive documentation set for your JavaScript library covering classes, structures, interfaces, enumerations, constructors, methods, properties, events, and fields.

Document! X uses a unique approach to analyzing your JavaScript that ensures an accurate documentation set regardless of the framework or inheritance pattern you have chosen to use.

Document! X will use any existing JSDoc or XML format source code comments and you can extend the source descriptions using the rich authoring environment provided by the Document! X Content File Editor.

Content Authoring Options

If you have JSDoc comments or XML format comments in your JavaScript source code, Document! X can use them automatically; you can view the content of the source comments while you are editing in order to easily spot areas that need expansion and to avoid duplication.

You can also choose to author content in your JSDoc or XML format source comments and/or use the rich authoring environment of the Document! X Content File Editor. This flexibility allows you to include basic descriptive documentation in the source code and use the feature-rich Document! X Content File Editor to author extended content.

Content File Editor
Leverage JSDoc Source Comments
Leverage XML Source Comments
Example Code Designer
Automatically Generated Syntax
PlayPause
previous arrow
next arrow
 
Shadow

Object Model Diagrams

Document! X automatically generates object relationship diagrams for your classes. Specific relationships can be ignored where necessary (e.g. a relationship back to a parent object). Collection objects are automatically recognized and appropriately represented.

javascript object model

Single-Source Build and Publish

Your JavaScript documentation projects can be generated to cross-platform Web Help, automatically responsive for tablet and mobile. The specific requirements for the different output formats are handled automatically and you can build all outputs from a single project. Automatic publishing makes it quick and simple to deploy the generated output to your website, FTP server, or network location.

Responsive Output
Automatic Publishing
Web Help
Community Features
PlayPause
previous arrow
next arrow
 
Shadow

Sample Outputs

These sample outputs illustrate output which 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.

Method Page
Field / Option Page
Library Overview Page
jQuery Plugin Page
Type Members Page
PlayPause
previous arrow
next arrow
 
Shadow

Template-Based Customization

  • Create new comment types for use in source code comments.
  • Adapt existing templates to match your existing corporate style and color scheme.
  • Customize Table of Contents definitions according to your requirements.
  • Fine tune the standard phrases and terminology used by Document! X to match your standards.

Authoring Examples

The easy-to-use Example Code Designer included in the Content Editors makes adding multi-language examples a breeze. In-line or linked examples can be created and example code is automatically colorized in the generated output.

Localization

Document! X supports several different languages (English, French, German, Dutch, Italian, and Russian) for the phrases used in the generated output. All of the phrases and terminology in the generated output can be configured according to preference.

Document! X allows you to author content for multiple languages within a single project, showing you an embedded tip for the primary locale content when you are authoring in the Content File Editor for a secondary locale. If you use the Document! X and HelpStudio bundle you can export and import your localized content in XLIFF format; the industry standard for sharing content with translation providers.

Questions?

Contact Us

Try Document! X and HelpStudio

Trials

Purchase or Upgrade Document! X and HelpStudio

Contiem Store