You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@xalan.apache.org by "Brian Minchau (JIRA)" <xa...@xml.apache.org> on 2005/06/09 00:03:17 UTC

[jira] Created: (XALANJ-2143) TransformerImpl.setOuputProperty(name,value) not well documented for Xalan-J interpretive

TransformerImpl.setOuputProperty(name,value) not well documented for Xalan-J interpretive
-----------------------------------------------------------------------------------------

         Key: XALANJ-2143
         URL: http://issues.apache.org/jira/browse/XALANJ-2143
     Project: XalanJ2
        Type: Bug
  Components: Documentation  
    Versions: CurrentCVS    
    Reporter: Brian Minchau


The javadoc for TransformerImpl does a poor job of documenting the output properties that can be set via its setOutputProperty(name,value) method.

http://xml.apache.org/xalan-j/apidocs/org/apache/xalan/transformer/TransformerImpl.html

It says this:
<<
Set the value of a property. Recognized properties are: 
"http://xml.apache.org/xslt/sourcebase" - the base URL for the source, which is needed when pure SAX ContentHandler transformation is to be done.

Parameters:
name - The property name, which is a fully-qualified URI.
value - The requested value for the property.
>>

It should probably say this:
<<
This method is used to set or override stylesheet xsl:output attributes.

The recognized standard output properties are:
 cdata-section-elements
 doctype-system
 doctype-public
 indent
 media-type
 method
 omit-xml-declaration
 standalone 
 version

For example, tran.setOutputProperty("standalone", "yes");

In the case of the cdata-section-elements property, the value should be a whitespace separated list of
element names and each name is just the local name of  the element, if it is no namespace, or the
URI in braces followed immediately by the local name if the element is in that namespace. For example:
 tran.setOutputProperty("cdata-section-elements", "elem1  {http://example.uri}elem2  elem3");

The recognized Xalan extension elements  are:
 content-handler
 entities
 indent-amount
 line-separator
 omit-meta-tag
 use-url-escaping

These must be in the extension namespace of "http://xml.apache.org/xalan", and this is done by putting the namespace URI in
braces before the property name, for example:
  tran.setOutputProperty("{http://xml.apache.org/xalan}line-separator" , "\n");




 
 

>>

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-dev-help@xml.apache.org


[jira] Resolved: (XALANJ-2143) TransformerImpl.setOuputProperty(name,value) not well documented for Xalan-J interpretive

Posted by "Brian Minchau (JIRA)" <xa...@xml.apache.org>.
     [ http://issues.apache.org/jira/browse/XALANJ-2143?page=all ]
     
Brian Minchau resolved XALANJ-2143:
-----------------------------------

    Resolution: Duplicate

Resolving as duplicate of XALANJ-2170, and I'm attaching the patch there.

> TransformerImpl.setOuputProperty(name,value) not well documented for Xalan-J interpretive
> -----------------------------------------------------------------------------------------
>
>          Key: XALANJ-2143
>          URL: http://issues.apache.org/jira/browse/XALANJ-2143
>      Project: XalanJ2
>         Type: Bug
>   Components: Documentation
>     Versions: CurrentCVS
>     Reporter: Brian Minchau
>     Priority: Minor

>
> The javadoc for TransformerImpl does a poor job of documenting the output properties that can be set via its setOutputProperty(name,value) method.
> http://xml.apache.org/xalan-j/apidocs/org/apache/xalan/transformer/TransformerImpl.html
> It says this:
> <<
> Set the value of a property. Recognized properties are: 
> "http://xml.apache.org/xslt/sourcebase" - the base URL for the source, which is needed when pure SAX ContentHandler transformation is to be done.
> Parameters:
> name - The property name, which is a fully-qualified URI.
> value - The requested value for the property.
> >>
> It should probably say this:
> <<
> This method is used to set or override stylesheet xsl:output attributes.
> The recognized standard output properties are:
>  cdata-section-elements
>  doctype-system
>  doctype-public
>  indent
>  media-type
>  method
>  omit-xml-declaration
>  standalone 
>  version
> For example, tran.setOutputProperty("standalone", "yes");
> In the case of the cdata-section-elements property, the value should be a whitespace separated list of
> element names and each name is just the local name of  the element, if it is no namespace, or the
> URI in braces followed immediately by the local name if the element is in that namespace. For example:
>  tran.setOutputProperty("cdata-section-elements", "elem1  {http://example.uri}elem2  elem3");
> The recognized Xalan extension elements  are:
>  content-handler
>  entities
>  indent-amount
>  line-separator
>  omit-meta-tag
>  use-url-escaping
> These must be in the extension namespace of "http://xml.apache.org/xalan", and this is done by putting the namespace URI in
> braces before the property name, for example:
>   tran.setOutputProperty("{http://xml.apache.org/xalan}line-separator" , "\n");
>  
>  
> >>

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-dev-help@xml.apache.org


[jira] Updated: (XALANJ-2143) TransformerImpl.setOuputProperty(name,value) not well documented for Xalan-J interpretive

Posted by "Brian Minchau (JIRA)" <xa...@xml.apache.org>.
     [ http://issues.apache.org/jira/browse/XALANJ-2143?page=all ]

Brian Minchau updated XALANJ-2143:
----------------------------------

    Component: Documentation
      Version: CurrentCVS
     Priority: Minor  (was: Major)

> TransformerImpl.setOuputProperty(name,value) not well documented for Xalan-J interpretive
> -----------------------------------------------------------------------------------------
>
>          Key: XALANJ-2143
>          URL: http://issues.apache.org/jira/browse/XALANJ-2143
>      Project: XalanJ2
>         Type: Bug
>   Components: Documentation
>     Versions: CurrentCVS
>     Reporter: Brian Minchau
>     Priority: Minor

>
> The javadoc for TransformerImpl does a poor job of documenting the output properties that can be set via its setOutputProperty(name,value) method.
> http://xml.apache.org/xalan-j/apidocs/org/apache/xalan/transformer/TransformerImpl.html
> It says this:
> <<
> Set the value of a property. Recognized properties are: 
> "http://xml.apache.org/xslt/sourcebase" - the base URL for the source, which is needed when pure SAX ContentHandler transformation is to be done.
> Parameters:
> name - The property name, which is a fully-qualified URI.
> value - The requested value for the property.
> >>
> It should probably say this:
> <<
> This method is used to set or override stylesheet xsl:output attributes.
> The recognized standard output properties are:
>  cdata-section-elements
>  doctype-system
>  doctype-public
>  indent
>  media-type
>  method
>  omit-xml-declaration
>  standalone 
>  version
> For example, tran.setOutputProperty("standalone", "yes");
> In the case of the cdata-section-elements property, the value should be a whitespace separated list of
> element names and each name is just the local name of  the element, if it is no namespace, or the
> URI in braces followed immediately by the local name if the element is in that namespace. For example:
>  tran.setOutputProperty("cdata-section-elements", "elem1  {http://example.uri}elem2  elem3");
> The recognized Xalan extension elements  are:
>  content-handler
>  entities
>  indent-amount
>  line-separator
>  omit-meta-tag
>  use-url-escaping
> These must be in the extension namespace of "http://xml.apache.org/xalan", and this is done by putting the namespace URI in
> braces before the property name, for example:
>   tran.setOutputProperty("{http://xml.apache.org/xalan}line-separator" , "\n");
>  
>  
> >>

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-dev-help@xml.apache.org


[jira] Closed: (XALANJ-2143) TransformerImpl.setOuputProperty(name,value) not well documented for Xalan-J interpretive

Posted by "Brian Minchau (JIRA)" <xa...@xml.apache.org>.
     [ http://issues.apache.org/jira/browse/XALANJ-2143?page=all ]
     
Brian Minchau closed XALANJ-2143:
---------------------------------


Closing issue, the webpage is updated as suggested.

> TransformerImpl.setOuputProperty(name,value) not well documented for Xalan-J interpretive
> -----------------------------------------------------------------------------------------
>
>          Key: XALANJ-2143
>          URL: http://issues.apache.org/jira/browse/XALANJ-2143
>      Project: XalanJ2
>         Type: Bug
>   Components: Documentation
>     Versions: CurrentCVS
>     Reporter: Brian Minchau
>     Priority: Minor

>
> The javadoc for TransformerImpl does a poor job of documenting the output properties that can be set via its setOutputProperty(name,value) method.
> http://xml.apache.org/xalan-j/apidocs/org/apache/xalan/transformer/TransformerImpl.html
> It says this:
> <<
> Set the value of a property. Recognized properties are: 
> "http://xml.apache.org/xslt/sourcebase" - the base URL for the source, which is needed when pure SAX ContentHandler transformation is to be done.
> Parameters:
> name - The property name, which is a fully-qualified URI.
> value - The requested value for the property.
> >>
> It should probably say this:
> <<
> This method is used to set or override stylesheet xsl:output attributes.
> The recognized standard output properties are:
>  cdata-section-elements
>  doctype-system
>  doctype-public
>  indent
>  media-type
>  method
>  omit-xml-declaration
>  standalone 
>  version
> For example, tran.setOutputProperty("standalone", "yes");
> In the case of the cdata-section-elements property, the value should be a whitespace separated list of
> element names and each name is just the local name of  the element, if it is no namespace, or the
> URI in braces followed immediately by the local name if the element is in that namespace. For example:
>  tran.setOutputProperty("cdata-section-elements", "elem1  {http://example.uri}elem2  elem3");
> The recognized Xalan extension elements  are:
>  content-handler
>  entities
>  indent-amount
>  line-separator
>  omit-meta-tag
>  use-url-escaping
> These must be in the extension namespace of "http://xml.apache.org/xalan", and this is done by putting the namespace URI in
> braces before the property name, for example:
>   tran.setOutputProperty("{http://xml.apache.org/xalan}line-separator" , "\n");
>  
>  
> >>

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-dev-help@xml.apache.org