(, Replaced: [[Image: → [[File: (2),) |
(help page cleanup) |
||
| Line 1: | Line 1: | ||
| + | #REDIRECT [[Help:Contents]] |
||
| − | {{beta}} |
||
| − | |||
| − | [[File:ListPages1.png|thumb|ListPages in action]] |
||
| − | |||
| − | '''“ListPages”''' is a function which dynamically outputs page titles and optionally content from pages in a certain category. It shares some similar functions with Dynamic Page List, but is much more efficient. |
||
| − | |||
| − | ==Required elements== |
||
| − | <pre> |
||
| − | <ListPages> |
||
| − | category= name |
||
| − | count= number |
||
| − | order= type |
||
| − | </ListPages> |
||
| − | </pre> |
||
| − | |||
| − | * The category, count, and order elements are '''mandatory'''. Omitting any of the three will cause the function to fail. |
||
| − | * ListPages can only be used for '''main namespace pages and Blog: namespace pages'''. |
||
| − | |||
| − | ===<code>category=name</code>=== |
||
| − | Replace ''name'' with the name of the category (e.g. '''<code>category=People</code>''' will display a list of pages in the People category.) |
||
| − | |||
| − | ===<code>count=number</code>=== |
||
| − | Replace ''number'' with the number of page titles you wish displayed (e.g. '''<code>count=6</code>''' will display 6 pages from the category you choose from). |
||
| − | |||
| − | By default, there will be next/prev navigation buttons on the bottom of the list. This allows the user to see more links. To disable the navigation button, add another element: '''<code>nav=off</code>''' |
||
| − | |||
| − | ===<code>order=ordering</code>=== |
||
| − | Using this element a user can sort articles in a specified manner. |
||
| − | |||
| − | There are several types of ''ordering'': |
||
| − | |||
| − | ;<code>order=PublishedDate</code> |
||
| − | : This sorts pages by when they reach “published” status, reverse chronologically. A page is “published” when it receives a score of 9 or higher, where votes are worth one point and unique commentors are worth 0.25 points. |
||
| − | : For this field to work, you must also have added '''<code>published=Yes</code>''' as an element. |
||
| − | |||
| − | ; <code>order=New</code> |
||
| − | : This sorts the pages in reverse chronological order by creation date (the most recently created articles in that category appear first). |
||
| − | : If you want to include only unpublished pages, add '''<code>published=No</code>''' as an element. |
||
| − | |||
| − | ; <code>order=Vote Average</code> |
||
| − | : This sorts pages by their rating, with the highest rated pages on top. This can only be used for pages that have ratings boxes on them. |
||
| − | : If you want to order them with lowest pages on top, add another element: '''<code>sort=ascending</code>'''. |
||
| − | |||
| − | ; <code>order=LastEdit</code> |
||
| − | : This sorts pages by when they were last edited |
||
| − | |||
| − | ==5-star rating elements== |
||
| − | Note: Do '''not''' use these if the pages in the category have non-5-star voting boxes (typically Blog: pages) – they are mutually exclusive. |
||
| − | |||
| − | ;<code>Ratings=Yes</code> |
||
| − | :This will show the 5 star rating box and average rating directly on the page, allowing the user to rate the page by clicking on the stars. |
||
| − | |||
| − | ;<code>Rating Minimum=Number</code> |
||
| − | :This will only show those pages where at least Number users have rated it. |
||
| − | |||
| − | ==Other formatting== |
||
| − | |||
| − | ===Showing an image from the article=== |
||
| − | By default, a listpage will not display an image. It will only display if: |
||
| − | |||
| − | * The '''<code>ShowPicture=Yes</code>''' element is included, '''and''' |
||
| − | * The page has a '''<code><nowiki>[[File:ImageName.ext]]</nowiki></code>''' in it. |
||
| − | |||
| − | If these are included, the listpage will display a thumbnail picture of the image next to the title of the page (if there is more than one image, it will display the image highest alphabetically). |
||
| − | |||
| − | ===Showing text from the article=== |
||
| − | By default, a listpage will not display text from any of the pages (it will only display the title). To display text, use: '''<code>showblurb=Number</code>''' |
||
| − | |||
| − | * Number should be the number of characters from the article you want to display |
||
| − | * Adding the element '''<code>BlurbFontSize=Small</code>''' will make the font size of the blurb smaller. |
||
| − | |||
| − | ===Hiding the Date=== |
||
| − | By default, a listpage will show how many days ago the article was created. To hide the date, use: '''<code>ShowDate=No</code>''' |
||
| − | |||
| − | ===Hiding the Stats=== |
||
| − | By default, a listpage will show how many votes and comments an article has, as a line of text under the article’s name. |
||
| − | |||
| − | * To hide this data, use: '''<code>ShowStats=No</code>''' |
||
| − | * To put an icon to the left of the article name showing the number of comments, use: '''<code>commentbox=Yes</code>''' |
||
| − | * To put an icon to the left of the article name showing the number of votes, use: '''<code>votebox=Yes</code>''' |
||
| − | |||
| − | ==ListPages in action== |
||
| − | * [[armchair:Memorable Sports Moments|Memorable Sports Moments on ArmchairGM]] |
||
| − | * [[w:c:halo:Special:ArticlesHome|Special:ArticlesHome - blog lists on Halopedia]] |
||
| − | |||
| − | [[Category:Help|{{PAGENAME}}]] |
||
Latest revision as of 17:45, 30 September 2010
Redirect to: