Uploaded image for project: 'Apache Roller'
  1. Apache Roller
  2. ROL-1689

Documentation omissions

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Minor
    • Resolution: Abandoned
    • 4.0
    • None
    • None
    • Glassfish 2ur1, opensolaris
    • opera 9.x
    • derby
    • 1.6x
    • Documentation requires people who know what the stuff does to write about it.
    • nv81

    Description

      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

      Attachments

        Activity

          People

            roller_unassigned Roller Unassigned
            bunny peter evans
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: