You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Jeff Jensen <je...@upstairstechnology.com> on 2005/06/11 20:24:18 UTC

Newbie on ""

Apologies in advance for such beginner question, but I just can't find what
plugin runs for "<doc:text-xdoc>".

I am adding some things to the findbugs plugin (upgrade to latest, adding
more params), and learning my way through it.

New findbugs versions have xdoc output.  I have changed the plugin to gen
xdoc, and now I need to learn the way to get xdoc plugin to gen correctly.
It looks like the next step is to change <doc> to gen not text but some
other option.  Then xdoc plugin will take that and gen correctly.

Appreciate a pointer to the docs on <doc>.  TIA!


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


Re: Newbie on ""

Posted by Brett Porter <br...@apache.org>.
Jeff Jensen wrote:

>Thanks Brett.  If I may ask a few more questions to know how to proceed in
>the future...
>
>Is there a way for me to have tracked that down, or is it something "ya just
>have to know"?
>  
>
for this, I knew the doc taglib was in xdoc. I used grep to find it.

>So the "doc" namespace resolves to xdoc tags?  I tried to find out if that
>was true, but could not.  I looked at all the xdoc plugin web page docs, and
>found no tag info on "text-xdoc".
>  
>
<define:taglib="doc"> is in the xdoc plugin - that's how it resolves to 
that.

>Are there web/doc pages for these tags, or is it expected to open the
>plugin.jelly files and read them?
>  
>
No, there is no documentation. I expect they were meant to be used 
internally, and have since been used externally.

It's not a great situation, and once of the reasons Maven2 is moving to 
a more internally consistent plugin architecture.

- Brett


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


RE: Newbie on ""

Posted by Jeff Jensen <je...@upstairstechnology.com>.
Thanks Brett.  If I may ask a few more questions to know how to proceed in
the future...

Is there a way for me to have tracked that down, or is it something "ya just
have to know"?

So the "doc" namespace resolves to xdoc tags?  I tried to find out if that
was true, but could not.  I looked at all the xdoc plugin web page docs, and
found no tag info on "text-xdoc".

Are there web/doc pages for these tags, or is it expected to open the
plugin.jelly files and read them?
 

-----Original Message-----
From: Brett Porter [mailto:brett@apache.org] 
Sent: Saturday, June 11, 2005 8:25 PM
To: Maven Developers List
Subject: Re: Newbie on "<doc:text-xdoc>"

It is in xdoc's plugin.jelly:

    <define:tag name="text-xdoc">
      <!--
        @output - The output file
        @title - Title for page
        @section - Section heading
        @encoding - The XML encoding
        @preamble - Placed in paragraph block prior to text
        @inputText - Will be wrapped in a CDATA, will not escape CDATA tags
(as yet)
        @inputFile - Will be read in and wrapped in CDATA. Overrides
inputText if set
        -->
      <j:set var="inputFile">${inputFile}</j:set>
      <j:if test="${inputFile != ''}">
        <util:file name="${inputFile}" var="inputFileObject"/>
        <util:loadText var="inputText" file="${inputFileObject}"/>
       </j:if>

      <!-- Set default encoding if not set. -->
      <j:if test="${encoding == null}">
        <j:set var="encoding"
          value="${plugin.getVariable('maven.docs.outputencoding')}"/>
      </j:if>

      <j:file name="${output}" prettyPrint="false" encoding="${encoding}">
        <document>
          <properties><title>${title}</title></properties>
          <body>
            <section name="${section}">
              <p>${preamble}</p>
              <source>
                <![CDATA[${inputText}]]>
              </source>
            </section>
          </body>
        </document>
      </j:file>
    </define:tag>

Jeff Jensen wrote:

>Apologies in advance for such beginner question, but I just can't find 
>what plugin runs for "<doc:text-xdoc>".
>
>I am adding some things to the findbugs plugin (upgrade to latest, 
>adding more params), and learning my way through it.
>
>New findbugs versions have xdoc output.  I have changed the plugin to 
>gen xdoc, and now I need to learn the way to get xdoc plugin to gen
correctly.
>It looks like the next step is to change <doc> to gen not text but some 
>other option.  Then xdoc plugin will take that and gen correctly.
>
>Appreciate a pointer to the docs on <doc>.  TIA!
>
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org For additional 
>commands, e-mail: dev-help@maven.apache.org
>
>
>  
>


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


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


Re: Newbie on ""

Posted by Brett Porter <br...@apache.org>.
It is in xdoc's plugin.jelly:

    <define:tag name="text-xdoc">
      <!--
        @output - The output file
        @title - Title for page
        @section - Section heading
        @encoding - The XML encoding
        @preamble - Placed in paragraph block prior to text
        @inputText - Will be wrapped in a CDATA, will not escape CDATA 
tags (as yet)
        @inputFile - Will be read in and wrapped in CDATA. Overrides 
inputText if set
        -->
      <j:set var="inputFile">${inputFile}</j:set>
      <j:if test="${inputFile != ''}">
        <util:file name="${inputFile}" var="inputFileObject"/>
        <util:loadText var="inputText" file="${inputFileObject}"/>
       </j:if>

      <!-- Set default encoding if not set. -->
      <j:if test="${encoding == null}">
        <j:set var="encoding"
          value="${plugin.getVariable('maven.docs.outputencoding')}"/>
      </j:if>

      <j:file name="${output}" prettyPrint="false" encoding="${encoding}">
        <document>
          <properties><title>${title}</title></properties>
          <body>
            <section name="${section}">
              <p>${preamble}</p>
              <source>
                <![CDATA[${inputText}]]>
              </source>
            </section>
          </body>
        </document>
      </j:file>
    </define:tag>

Jeff Jensen wrote:

>Apologies in advance for such beginner question, but I just can't find what
>plugin runs for "<doc:text-xdoc>".
>
>I am adding some things to the findbugs plugin (upgrade to latest, adding
>more params), and learning my way through it.
>
>New findbugs versions have xdoc output.  I have changed the plugin to gen
>xdoc, and now I need to learn the way to get xdoc plugin to gen correctly.
>It looks like the next step is to change <doc> to gen not text but some
>other option.  Then xdoc plugin will take that and gen correctly.
>
>Appreciate a pointer to the docs on <doc>.  TIA!
>
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>For additional commands, e-mail: dev-help@maven.apache.org
>
>
>  
>


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