You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by "Pablo Barrera (JIRA)" <ji...@apache.org> on 2008/09/12 14:33:44 UTC

[jira] Created: (FOR-1106) Dispachter quickguide documentation hard to follow

Dispachter quickguide documentation hard to follow
--------------------------------------------------

                 Key: FOR-1106
                 URL: https://issues.apache.org/jira/browse/FOR-1106
             Project: Forrest
          Issue Type: Bug
          Components: Documentation and website
            Reporter: Pablo Barrera
         Attachments: 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch

I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html

I was looking for something in plugins_0_90-dev but all links pointed to 0_80.

I think this guide is hard to follow. For example, if you follow it directly you reach this point:
Use another theme
    * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
    * Re-start 'forrest run'
    * localhost:8888/index.html ... See the new view.

But in the rest of the document the pelt theme is used. For example, the line:
# Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 

will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.


After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.

The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.

It can be also interesting mention that the url
http://localhost:8888/resolve.structurer.index

shows you the structurer in use. Any change to your pelt.fv file will be shown here.

The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml


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


Re: [jira] Created: (FOR-1106) Dispachter quickguide documentation hard to follow

Posted by Pablo Barrera <ba...@gsyc.es>.
On 12/09/2008, at 14:25:54, David Crossley wrote:

> Pablo Barrera (JIRA) wrote:
>> Dispachter quickguide documentation hard to follow
>> --------------------------------------------------
>>
>>                Key: FOR-1106
>>                URL: https://issues.apache.org/jira/browse/FOR-1106
>>            Project: Forrest
>>         Issue Type: Bug
>>         Components: Documentation and website
>>           Reporter: Pablo Barrera
>>        Attachments: 0003-Change-theme-and-added-notes-to-dispatcher- 
>> quickguid.patch
>>
>> I am trying to use the dispatcher again. I have looking in the  
>> documentation and I was only able to find this quickstart guide:
>> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
>>
>> I was looking for something in plugins_0_90-dev but all links  
>> pointed to 0_80.
>
> That might be because the dispatcher plugin has not been
> deployed since the 0.8 release. Its version numbers needs
> to be incremented in the whiteboard/plugins/whiteboard-plugins.xml
>
> Anyway with such stuff in development, you are better
> to view your local set of current docs.
>
> ]$ cd $FORREST_HOME/whiteboard/plugins/ 
> org.apache.forrest.plugin.internal.dispatcher
> ]$ forrest run
> etc.



I was looking to that file as well. The patch I sent is against the  
documentation on the svn.

Pablo

--
Pablo Barrera
http://gsyc.es/~barrera/


Re: [jira] Created: (FOR-1106) Dispachter quickguide documentation hard to follow

Posted by David Crossley <cr...@apache.org>.
Pablo Barrera (JIRA) wrote:
> Dispachter quickguide documentation hard to follow
> --------------------------------------------------
> 
>                  Key: FOR-1106
>                  URL: https://issues.apache.org/jira/browse/FOR-1106
>              Project: Forrest
>           Issue Type: Bug
>           Components: Documentation and website
>             Reporter: Pablo Barrera
>          Attachments: 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch
> 
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> 
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.

That might be because the dispatcher plugin has not been
deployed since the 0.8 release. Its version numbers needs
to be incremented in the whiteboard/plugins/whiteboard-plugins.xml

Anyway with such stuff in development, you are better
to view your local set of current docs.

]$ cd $FORREST_HOME/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher
]$ forrest run
etc.

-David

[jira] Updated: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "Pablo Barrera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Pablo Barrera updated FOR-1106:
-------------------------------

    Attachment: 0004-Added-cache-warning-to-dispatcher-quickstart-guide.patch

Added cache warning to dispatcher quickstart guide. The code and the solution have been posted by Thorsten Scherler to the mailing list.

I didn't know where to place this information so I just added a warning near the sentence: "From here on there is no need to re-start 'forrest run'". Right now it's not working like that, unless you turn off the cache, as explained in the patch.

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch, 0003-Update-forrest-bar-reference.patch, 0004-Added-cache-warning-to-dispatcher-quickstart-guide.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Updated: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "Pablo Barrera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Pablo Barrera updated FOR-1106:
-------------------------------

    Attachment: 0005-Added-Decide-how-to-manage-your-contracts-using-Ro.patch

Added "Decide how to manage your contracts" using Ross' discussion as suggested

This section contained a link to http://marc.theaimsgroup.com/?l=forrest-dev&amp;m=113748831226697

I have resumed this email and place it in the section, more user friendly ;-)


> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch, 0003-Update-forrest-bar-reference.patch, 0004-Added-cache-warning-to-dispatcher-quickstart-guide.patch, 0005-Added-Decide-how-to-manage-your-contracts-using-Ro.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Assigned: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "David Crossley (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Crossley reassigned FOR-1106:
-----------------------------------

    Assignee:     (was: David Crossley)

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch, 0003-Update-forrest-bar-reference.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Updated: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "Pablo Barrera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Pablo Barrera updated FOR-1106:
-------------------------------

    Attachment: 0006-Change-directory-folder-to-directory.-Change-also.patch

Change "directory folder" to directory. Change also "folder" to directory, just one word for concept.

I think the concept "directory folder" is a mistake.

Mixing directories and folders is just a little bit confusing. I prefer to use just one word per concept in a documentation file.

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch, 0003-Update-forrest-bar-reference.patch, 0004-Added-cache-warning-to-dispatcher-quickstart-guide.patch, 0005-Added-Decide-how-to-manage-your-contracts-using-Ro.patch, 0006-Change-directory-folder-to-directory.-Change-also.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Commented: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "David Crossley (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12631621#action_12631621 ] 

David Crossley commented on FOR-1106:
-------------------------------------

Thanks, applied your latest patches 2 and 3.

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>            Assignee: David Crossley
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch, 0003-Update-forrest-bar-reference.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Updated: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "Gavin (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gavin updated FOR-1106:
-----------------------

    Other Info:   (was: [Patch available])

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch, 0003-Update-forrest-bar-reference.patch, 0004-Added-cache-warning-to-dispatcher-quickstart-guide.patch, 0005-Added-Decide-how-to-manage-your-contracts-using-Ro.patch, 0006-Change-directory-folder-to-directory.-Change-also.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Updated: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "David Crossley (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Crossley updated FOR-1106:
--------------------------------

    Component/s: Plugin: internal.dispatcher
        Summary: Dispatcher quickstart documentation hard to follow  (was: Dispachter quickguide documentation hard to follow)

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>         Attachments: 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Assigned: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "David Crossley (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Crossley reassigned FOR-1106:
-----------------------------------

    Assignee: David Crossley

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>            Assignee: David Crossley
>         Attachments: 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Updated: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "Pablo Barrera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Pablo Barrera updated FOR-1106:
-------------------------------

    Attachment: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch

This patch changes the references to pelt-html.panel.xml for pelt-html.header.panel.xml that seems to be the correct file.

It also change a reference to forrest bar (I am using forrest bar 0.8 and the information was not accurate)


> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>            Assignee: David Crossley
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Updated: (FOR-1106) Dispachter quickguide documentation hard to follow

Posted by "Pablo Barrera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Pablo Barrera updated FOR-1106:
-------------------------------

    Attachment: 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch

Patch

> Dispachter quickguide documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website
>            Reporter: Pablo Barrera
>         Attachments: 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Commented: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "Ross Gardler (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12632830#action_12632830 ] 

Ross Gardler commented on FOR-1106:
-----------------------------------

Applied patches 4, 5 and 6 - thanks for your contribution.

Patch 4 was invalid XML and needed changes as a result (please validate all XML before submitting a patch, if you don't use a valiating editor then you can fo "forrest validate" from the command line)

Patch 5 had lines that were very long, please stick to a maximum column count of 80 characters. This makes it easier to read in many editors and SVN commit mails. It also ensures that changes to a single word do not cause a whole paragrah to appear in the diffs, thus making it easier to read diffs (as illustrated by patch 6 in fact)

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch, 0003-Update-forrest-bar-reference.patch, 0004-Added-cache-warning-to-dispatcher-quickstart-guide.patch, 0005-Added-Decide-how-to-manage-your-contracts-using-Ro.patch, 0006-Change-directory-folder-to-directory.-Change-also.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Closed: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "Gavin (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gavin closed FOR-1106.
----------------------

    Resolution: Fixed

All patches applied.

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch, 0003-Update-forrest-bar-reference.patch, 0004-Added-cache-warning-to-dispatcher-quickstart-guide.patch, 0005-Added-Decide-how-to-manage-your-contracts-using-Ro.patch, 0006-Change-directory-folder-to-directory.-Change-also.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Updated: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "Pablo Barrera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Pablo Barrera updated FOR-1106:
-------------------------------

    Attachment: 0003-Update-forrest-bar-reference.patch

There is another reference to an old forrest bar menu. Fixed in this patch.

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>            Assignee: David Crossley
>         Attachments: 0002-Added-pelt-html.header.panel.xml-to-dispatcher-docum.patch, 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch, 0003-Update-forrest-bar-reference.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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


[jira] Commented: (FOR-1106) Dispatcher quickstart documentation hard to follow

Posted by "David Crossley (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/FOR-1106?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12630570#action_12630570 ] 

David Crossley commented on FOR-1106:
-------------------------------------

Thanks. It is applied and when svn is back up i will commit it.

Regarding the "panels" stuff, yes things have changed since this doc was created. Search the dev archive for how to use those panels.

More doc fixes are welcome.

> Dispatcher quickstart documentation hard to follow
> --------------------------------------------------
>
>                 Key: FOR-1106
>                 URL: https://issues.apache.org/jira/browse/FOR-1106
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website, Plugin: internal.dispatcher
>            Reporter: Pablo Barrera
>            Assignee: David Crossley
>         Attachments: 0003-Change-theme-and-added-notes-to-dispatcher-quickguid.patch
>
>
> I am trying to use the dispatcher again. I have looking in the documentation and I was only able to find this quickstart guide:
> http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/how/howto-dispatcher-quickstart.html
> I was looking for something in plugins_0_90-dev but all links pointed to 0_80.
> I think this guide is hard to follow. For example, if you follow it directly you reach this point:
> Use another theme
>     * Add <property name="dispatcher.theme" value="common"/> to your forrest.properties.xml
>     * Re-start 'forrest run'
>     * localhost:8888/index.html ... See the new view.
> But in the rest of the document the pelt theme is used. For example, the line:
> # Copy THEMER_PLUGIN/themes/pelt.fv into your project at ${themer.project.dir}/pelt.fv 
> will be of no use if the user has changed the theme to the common one. Forrest will ignore these changes.
> After that, in the section "Create our own structurer by copy-and-customise" there are several problems. It's not straight forward to know where the THEMER_PLUGIN is. A note with the default localisation will help.
> The file used in this example is pelt/panels/pelt-html.panel.xml, but according to my logs locationmap is not looking for that file at all. Maybe the example is outdated. Changing the file to other one could be enough.
> It can be also interesting mention that the url
> http://localhost:8888/resolve.structurer.index
> shows you the structurer in use. Any change to your pelt.fv file will be shown here.
> The patch adds some comments about this problems but does not provide an alternative file in for pelt/panels/pelt-html.panel.xml

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