Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Update RSS widget documentation #620

Merged
merged 2 commits into from
Apr 24, 2017
Merged

Update RSS widget documentation #620

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c244303
Update RSS widget documentation
thevoiceofzeke Apr 24, 2017
0e13d01
Update date format info
thevoiceofzeke Apr 24, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/widgets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,14 +225,21 @@ This provides a more usable click surface, a simpler and cleaner user experience
<value>
<![CDATA[{
"lim": 4,
"titleLim": 30,
"showdate": true,
"dateFormat": "MM-dd-yyyy",
"showShowing": true
}]]>
</value>
</portlet-preference>
```

#### About entity file values

* **lim**: The number of items to show. Any number greater than 6 will default to 6 (due to space limitations). Use a smaller number for feeds that are infrequently updated.
* **titleLim**: Limit the length (in characters, including spaces) of feed titles. This number should be between 30 and 60 (depending on whether you're showing dates or not).
* **showdate**: T/F show each feed item's published date. The date format is "M/d" due to space consideration.
* **showShowing**: T/F Show the "Showing [x] out of [y]" message (to communicate that there is more to see). Set this to true if your feed has frequent updates.

#### Additional information

Note the addition required value in the entity file:
Expand Down