Document Properties
Kbid25996T
Last Modified04-Feb-2020
Added to KB01-Oct-2014
Public AccessEveryone
StatusOnline
Doc TypeGuidelines, Concepts & Cookbooks
Product
  • ICM 7.6
  • Intershop Studio 4.5
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

Guide - API Documentation

Product Version

7.0

Product To Version

 

Status

final

1 Introduction

The  API Documentation (APIDoc) is an HTML-based report of all Intershop 7 artifacts of a given version. It closes the gap between the existing Javadoc and the undocumented Intershop artifacts.

2 Layout and Usage

Main objective was to provide the same experience as using a regular Javadoc.

2.1 Usage

As the report closely resembles a Javadoc it can be navigated the same way. However, there are some differences to consider when using the APIDoc:

The APIDoc does not create details pages for Java types, instead it embeds their corresponding Javadoc pages. The following Javadoc sources are considered:

  • For types from IS7 cartridges: the Javadoc of the corresponding cartridge
  • For standard Java types: the official Java 7 SE documentation

It might be possible to consider third party libraries. If no Javadoc exists a "page not found" message will be displayed in the right pane.

3 Creation

In order to create APIDoc for Intershop 7 artifacts you have to use Intershop Studio 4.5 or later.

3.1 Intershop Studio UI

To create an APIDoc in Intershop Studio:

option #1
  1. Select the cartridges in the Cartridge Explorer.
  2. Invoke context menu.
  3. Select Export | Cartridge API...
option #2
  1. Navigate to  File | Export...
 
  1. Select Cartridge API model, Documentation ...
 
 
  1. Select/deselect cartridges.
  2. Click  Next >.
 
  1. Select Generate API HTML Documentation.
  2. Click Next >.
 
  1. Enter an output location.
  2. Click Finish.
 

either:

  • Navigate to the output location and open index.html.
  • Open the Progress view and click on the link.

3.2 Command-line Application

use ID: api.export.doc

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets