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

["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.