[jira] [Updated] (ROL-1689) Documentation omissions

["Glen Mazza (JIRA)" <ji...@apache.org>]

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

Glen Mazza updated ROL-1689:
----------------------------

    Component/s: Website and Documentation

> Documentation omissions
> -----------------------
>
>                 Key: ROL-1689
>                 URL: https://issues.apache.org/jira/browse/ROL-1689
>             Project: Apache Roller
>          Issue Type: Bug
>          Components: Website and Documentation
>    Affects Versions: 4.0
>         Environment: Glassfish 2ur1, opensolaris
>            Reporter: peter evans
>            Assignee: Roller Unassigned
>            Priority: Minor
>
> roller-template-guide.pdf is dated August 2007, comparing this documentation with the example "frontpage" theme, there are numerous omissions.
> 1 - *Pinned* anything are undocumented.
> 2 - some bits of USER objects may or may not exist, eg: $entry.creator.screenName
> 3 - some bits of ENTRY objects may or may not contain what is expected: 
>       $entry.permalink   in _entry.vm  (when used by planet objects.
> $model.permalink appears boolean, PLANET ENTRY has a .permalink, but at any particular time, it is
> not clear which object I have. To illustrate:
> this is _site.vm (a homebrew based on frontpage)
> #set($ps = $site.getWeblogEntriesPager($since, $maxResults))
>  #foreach($entry in $ps.items)
>   #set($e=$entry)
>   #if($velocityCount <= $maxResults)
>    #includeTemplate($model.weblog "_entry")
>   #end
>  #end
> (the silliness with $e is because it won't pass $entry down, that may be another bug ...)
> this is _planet.vm
> #set($pp = $planet.getAggregationPager($since, $maxResults))
>  #foreach($entry in $pp.items)
>   #set($e=$entry)
>   #if($velocityCount <= $maxResults)
>    #includeTemplate($model.weblog "_entry")
>   #end
>  #end
> _entry.vm consists of some nonsense vaguely like the frontpage one.
> $e.permalink            site gives correct url /roller/front/entry/blah
>                                     planet gives only the top site page!
> $e.creator.screenName   site gives correct one,
>                                               planet has no such animal



--
This message was sent by Atlassian JIRA
(v6.2#6252)