org.jboss.jdocbook.render.format
Interface StandardDocBookFormatDescriptor


public interface StandardDocBookFormatDescriptor

Contract for descriptors about standard DocBook formats.

Author:
Steve Ebersole

Method Summary
 java.lang.String getName()
          The name of this format.
 java.lang.String getProfiledStylesheetResource()
          The standard DocBook stylesheet for this format for 'profiling' (as a classpath-relative resource name).
 java.lang.String getStandardFileExtension()
          The standard file extension used for this format.
 java.lang.String getStylesheetResource()
          The standard DocBook stylesheet for this format (as a classpath-relative resource name).
 boolean isDoingChunking()
          Is this format doing chunking?
 boolean isImageCopyingRequired()
          Does this format require copying the images over to the target directory?
 boolean isImagePathSettingRequired()
          Does this format require setting the 'img.src.path' DocBook XSLT parameter?
 

Method Detail

getName

java.lang.String getName()
The name of this format.

Returns:
The format name.

getStandardFileExtension

java.lang.String getStandardFileExtension()
The standard file extension used for this format.

Returns:
The file extension

getStylesheetResource

java.lang.String getStylesheetResource()
The standard DocBook stylesheet for this format (as a classpath-relative resource name).

Returns:
The DocBook stylesheet resource name

getProfiledStylesheetResource

java.lang.String getProfiledStylesheetResource()
The standard DocBook stylesheet for this format for 'profiling' (as a classpath-relative resource name).

Returns:
The DocBook 'profiling' stylesheet resource name

isImagePathSettingRequired

boolean isImagePathSettingRequired()
Does this format require setting the 'img.src.path' DocBook XSLT parameter?

Returns:
Is setting 'img.src.path' required?

isImageCopyingRequired

boolean isImageCopyingRequired()
Does this format require copying the images over to the target directory?

Returns:
Is copying images to the target directory required?

isDoingChunking

boolean isDoingChunking()
Is this format doing chunking?

Returns:
Doing chunking?


Copyright © 2007-2011 JBoss, a division of Red Hat, Inc. All Rights Reserved.