You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by "Dan Adams (JIRA)" <ji...@apache.org> on 2010/12/21 00:47:02 UTC

[jira] Closed: (TAP5-742) Add optional component tracing comments to rendered output

     [ https://issues.apache.org/jira/browse/TAP5-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dan Adams closed TAP5-742.
--------------------------

    Resolution: Fixed

> Add optional component tracing comments to rendered output
> ----------------------------------------------------------
>
>                 Key: TAP5-742
>                 URL: https://issues.apache.org/jira/browse/TAP5-742
>             Project: Tapestry 5
>          Issue Type: New Feature
>          Components: tapestry-core
>    Affects Versions: 5.2.4
>            Reporter: Howard M. Lewis Ship
>            Assignee: Dan Adams
>            Priority: Minor
>             Fix For: 5.2.5
>
>
> In complex pages, it can be hard to work backwards from a bit of output HTML in the browser, back to the component that originated the markup.
> This feature adds rendering of comments that provide trace output of which component is currently currently:
> <!--BEGIN Index:loop (context:Index.tml, line 15)--><li>
>       <!--BEGIN Index:pagelink (context:Index.tml, line 16)--><a href="/abstractcomponentdemo">Abstract Component Demo</a><!--END Index:pagelink-->
> Note that the BEGIN comment includes both the complete component id in the page and the location of that in the template. With just the component id it can still be unclear which component is being referenced without the line number.
> For security purposes, this feature cannot be enabled in production mode. In non-production mode it can be enabled two ways:
>  - Setting the symbol "tapestry.component-render-tracing-enabled" to "true" (default: false)
>  - Setting the request query parameter "t:component-trace" on the URL to "true". This allows enabling for a specific request when you need it in development rather than having it on all the time.
> Note that rendering comments are based on the component lifecycle. Thus in some case where post-render DOM manipulation is performed the markup my not longer be in the correct rendering comments.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Re: [jira] Closed: (TAP5-742) Add optional component tracing comments to rendered output

Posted by Ulrich Stärk <ul...@spielviel.de>.
We've got the {since} macro to document when a feature was introduced. So documentation can and should be written immediately.

Uli

Am 21.12.2010 um 02:22 schrieb Josh Canfield <jo...@gmail.com>:

> When should things like this start showing up in the documentation?
> Should we wait until a snapshot release?
> 
> On Mon, Dec 20, 2010 at 5:20 PM, Josh Canfield <jo...@gmail.com> wrote:
>> This is cool.
>> 
>> It would be nice to be able to set a "debug level" so that you can get
>> extra information such as what the passed parameters were etc.
>> 
>> Josh
>> 
>> On Mon, Dec 20, 2010 at 3:47 PM, Dan Adams (JIRA) <ji...@apache.org> wrote:
>>> 
>>>     [ https://issues.apache.org/jira/browse/TAP5-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
>>> 
>>> Dan Adams closed TAP5-742.
>>> --------------------------
>>> 
>>>    Resolution: Fixed
>>> 
>>>> Add optional component tracing comments to rendered output
>>>> ----------------------------------------------------------
>>>> 
>>>>                 Key: TAP5-742
>>>>                 URL: https://issues.apache.org/jira/browse/TAP5-742
>>>>             Project: Tapestry 5
>>>>          Issue Type: New Feature
>>>>          Components: tapestry-core
>>>>    Affects Versions: 5.2.4
>>>>            Reporter: Howard M. Lewis Ship
>>>>            Assignee: Dan Adams
>>>>            Priority: Minor
>>>>             Fix For: 5.2.5
>>>> 
>>>> 
>>>> In complex pages, it can be hard to work backwards from a bit of output HTML in the browser, back to the component that originated the markup.
>>>> This feature adds rendering of comments that provide trace output of which component is currently currently:
>>>> <!--BEGIN Index:loop (context:Index.tml, line 15)--><li>
>>>>       <!--BEGIN Index:pagelink (context:Index.tml, line 16)--><a href="/abstractcomponentdemo">Abstract Component Demo</a><!--END Index:pagelink-->
>>>> Note that the BEGIN comment includes both the complete component id in the page and the location of that in the template. With just the component id it can still be unclear which component is being referenced without the line number.
>>>> For security purposes, this feature cannot be enabled in production mode. In non-production mode it can be enabled two ways:
>>>>  - Setting the symbol "tapestry.component-render-tracing-enabled" to "true" (default: false)
>>>>  - Setting the request query parameter "t:component-trace" on the URL to "true". This allows enabling for a specific request when you need it in development rather than having it on all the time.
>>>> Note that rendering comments are based on the component lifecycle. Thus in some case where post-render DOM manipulation is performed the markup my not longer be in the correct rendering comments.
>>> 
>>> --
>>> This message is automatically generated by JIRA.
>>> -
>>> You can reply to this email to add a comment to the issue online.
>>> 
>>> 
>> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: dev-help@tapestry.apache.org
> 

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


Re: [jira] Closed: (TAP5-742) Add optional component tracing comments to rendered output

Posted by Josh Canfield <jo...@gmail.com>.
When should things like this start showing up in the documentation?
Should we wait until a snapshot release?

On Mon, Dec 20, 2010 at 5:20 PM, Josh Canfield <jo...@gmail.com> wrote:
> This is cool.
>
> It would be nice to be able to set a "debug level" so that you can get
> extra information such as what the passed parameters were etc.
>
> Josh
>
> On Mon, Dec 20, 2010 at 3:47 PM, Dan Adams (JIRA) <ji...@apache.org> wrote:
>>
>>     [ https://issues.apache.org/jira/browse/TAP5-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
>>
>> Dan Adams closed TAP5-742.
>> --------------------------
>>
>>    Resolution: Fixed
>>
>>> Add optional component tracing comments to rendered output
>>> ----------------------------------------------------------
>>>
>>>                 Key: TAP5-742
>>>                 URL: https://issues.apache.org/jira/browse/TAP5-742
>>>             Project: Tapestry 5
>>>          Issue Type: New Feature
>>>          Components: tapestry-core
>>>    Affects Versions: 5.2.4
>>>            Reporter: Howard M. Lewis Ship
>>>            Assignee: Dan Adams
>>>            Priority: Minor
>>>             Fix For: 5.2.5
>>>
>>>
>>> In complex pages, it can be hard to work backwards from a bit of output HTML in the browser, back to the component that originated the markup.
>>> This feature adds rendering of comments that provide trace output of which component is currently currently:
>>> <!--BEGIN Index:loop (context:Index.tml, line 15)--><li>
>>>       <!--BEGIN Index:pagelink (context:Index.tml, line 16)--><a href="/abstractcomponentdemo">Abstract Component Demo</a><!--END Index:pagelink-->
>>> Note that the BEGIN comment includes both the complete component id in the page and the location of that in the template. With just the component id it can still be unclear which component is being referenced without the line number.
>>> For security purposes, this feature cannot be enabled in production mode. In non-production mode it can be enabled two ways:
>>>  - Setting the symbol "tapestry.component-render-tracing-enabled" to "true" (default: false)
>>>  - Setting the request query parameter "t:component-trace" on the URL to "true". This allows enabling for a specific request when you need it in development rather than having it on all the time.
>>> Note that rendering comments are based on the component lifecycle. Thus in some case where post-render DOM manipulation is performed the markup my not longer be in the correct rendering comments.
>>
>> --
>> This message is automatically generated by JIRA.
>> -
>> You can reply to this email to add a comment to the issue online.
>>
>>
>

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


Re: [jira] Closed: (TAP5-742) Add optional component tracing comments to rendered output

Posted by Dan Adams <mr...@gmail.com>.
Thanks. I've been using it for a while (as a separate component) and it's
super useful. Yeah, I thought about including parameter info but thought it
would be too much but doing it in a debug mode is a good idea.

On Mon, Dec 20, 2010 at 8:20 PM, Josh Canfield <jo...@gmail.com>wrote:

> This is cool.
>
> It would be nice to be able to set a "debug level" so that you can get
> extra information such as what the passed parameters were etc.
>
> Josh
>
> On Mon, Dec 20, 2010 at 3:47 PM, Dan Adams (JIRA) <ji...@apache.org> wrote:
> >
> >     [
> https://issues.apache.org/jira/browse/TAP5-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel]
> >
> > Dan Adams closed TAP5-742.
> > --------------------------
> >
> >    Resolution: Fixed
> >
> >> Add optional component tracing comments to rendered output
> >> ----------------------------------------------------------
> >>
> >>                 Key: TAP5-742
> >>                 URL: https://issues.apache.org/jira/browse/TAP5-742
> >>             Project: Tapestry 5
> >>          Issue Type: New Feature
> >>          Components: tapestry-core
> >>    Affects Versions: 5.2.4
> >>            Reporter: Howard M. Lewis Ship
> >>            Assignee: Dan Adams
> >>            Priority: Minor
> >>             Fix For: 5.2.5
> >>
> >>
> >> In complex pages, it can be hard to work backwards from a bit of output
> HTML in the browser, back to the component that originated the markup.
> >> This feature adds rendering of comments that provide trace output of
> which component is currently currently:
> >> <!--BEGIN Index:loop (context:Index.tml, line 15)--><li>
> >>       <!--BEGIN Index:pagelink (context:Index.tml, line 16)--><a
> href="/abstractcomponentdemo">Abstract Component Demo</a><!--END
> Index:pagelink-->
> >> Note that the BEGIN comment includes both the complete component id in
> the page and the location of that in the template. With just the component
> id it can still be unclear which component is being referenced without the
> line number.
> >> For security purposes, this feature cannot be enabled in production
> mode. In non-production mode it can be enabled two ways:
> >>  - Setting the symbol "tapestry.component-render-tracing-enabled" to
> "true" (default: false)
> >>  - Setting the request query parameter "t:component-trace" on the URL to
> "true". This allows enabling for a specific request when you need it in
> development rather than having it on all the time.
> >> Note that rendering comments are based on the component lifecycle. Thus
> in some case where post-render DOM manipulation is performed the markup my
> not longer be in the correct rendering comments.
> >
> > --
> > This message is automatically generated by JIRA.
> > -
> > You can reply to this email to add a comment to the issue online.
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: dev-help@tapestry.apache.org
>
>

Re: [jira] Closed: (TAP5-742) Add optional component tracing comments to rendered output

Posted by Josh Canfield <jo...@gmail.com>.
This is cool.

It would be nice to be able to set a "debug level" so that you can get
extra information such as what the passed parameters were etc.

Josh

On Mon, Dec 20, 2010 at 3:47 PM, Dan Adams (JIRA) <ji...@apache.org> wrote:
>
>     [ https://issues.apache.org/jira/browse/TAP5-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
>
> Dan Adams closed TAP5-742.
> --------------------------
>
>    Resolution: Fixed
>
>> Add optional component tracing comments to rendered output
>> ----------------------------------------------------------
>>
>>                 Key: TAP5-742
>>                 URL: https://issues.apache.org/jira/browse/TAP5-742
>>             Project: Tapestry 5
>>          Issue Type: New Feature
>>          Components: tapestry-core
>>    Affects Versions: 5.2.4
>>            Reporter: Howard M. Lewis Ship
>>            Assignee: Dan Adams
>>            Priority: Minor
>>             Fix For: 5.2.5
>>
>>
>> In complex pages, it can be hard to work backwards from a bit of output HTML in the browser, back to the component that originated the markup.
>> This feature adds rendering of comments that provide trace output of which component is currently currently:
>> <!--BEGIN Index:loop (context:Index.tml, line 15)--><li>
>>       <!--BEGIN Index:pagelink (context:Index.tml, line 16)--><a href="/abstractcomponentdemo">Abstract Component Demo</a><!--END Index:pagelink-->
>> Note that the BEGIN comment includes both the complete component id in the page and the location of that in the template. With just the component id it can still be unclear which component is being referenced without the line number.
>> For security purposes, this feature cannot be enabled in production mode. In non-production mode it can be enabled two ways:
>>  - Setting the symbol "tapestry.component-render-tracing-enabled" to "true" (default: false)
>>  - Setting the request query parameter "t:component-trace" on the URL to "true". This allows enabling for a specific request when you need it in development rather than having it on all the time.
>> Note that rendering comments are based on the component lifecycle. Thus in some case where post-render DOM manipulation is performed the markup my not longer be in the correct rendering comments.
>
> --
> This message is automatically generated by JIRA.
> -
> You can reply to this email to add a comment to the issue online.
>
>

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