Template:RecentlyEdited/doc: Difference between revisions

Revision as of 01:38, 10 September 2024

Description

This template has DPL code that shows a list of recently edited pages in selected categories using a packed gallery.

Syntax

On a category page of either locations or characters:

{{RecentlyEdited}}

On other pages:

{{RecentlyEdited|category=}}

Usage

The template places a collapsible section of articles with images. The images are taken from templates used on the article pages. The template is recommended to be used directly on a category page, which will have it display pages from that category.

This template can only show pages that use the following templates:

From this it's obvious that only pages of locations and characters really work, hence it's best to use a category with those pages as the input.

The limitations in page selection restrict the use of the template, so any help in making it more general is appreciated.

Parameters

Displays a packed gallery of recently edited pages in a category.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Category/Categories	`category`	Input one or more category names to display recently edited articles from those categories. Separate multiple with the magic word {{!}}. Example Yume Nikki Locations{{!}}Yume Nikki Characters Auto value `{{PAGENAME}}`	Line	optional
Number of Articles	`count`	The number of articles to display (from most recently edited to least recent). Default 8	Number	optional

Sample

The following input:

{{RecentlyEdited|category=Qxy{{!}}Spelude, Noildoof{{!}}Autumn|count=14}}

Produces:

@@ Line 1: / Line 1: @@
 ==Description==
-This template has DPL code that shows a list of recently edited pages in selected categories. It is in the format of images with link captions underneath.
+This template has DPL code that shows a list of recently edited pages in selected categories using a packed gallery.
 ==Syntax==
 On a category page of either locations or characters:
 <pre>{{RecentlyEdited}}</pre>
-Manual input and with a higher number of pages listed:
-<pre>{{RecentlyEdited|category=Yume Nikki Locations, Yume Nikki Characters, Yume 2kki Characters|count=16}}</pre>
+On other pages:
+<pre>{{RecentlyEdited|category=}}</pre>
 ==Usage==
-The template places a collapsible section containing a selected number of images in a row. The articles to use in the list are those found in inputted categories. The images are taken from templates used on the article pages.
+The template places a collapsible section of articles with images. The images are taken from templates used on the article pages. The template is recommended to be used directly on a category page, which will have it display pages from that category.
 This template can only show pages that use the following templates:
-*Template:ListChar
+*[[Template:ListChar]]
-*Template:Locationbox
+*[[Template:Locationbox]]
-*Template:NPCBox
+*[[Template:NPCBox]]
-*Template:Listloc
+*[[Template:Listloc]]
-*Template:Characterbox
+*[[Template:Characterbox]]
-From this it's obvious that only pages of locations and characters really work with this, hence it's best to use those kinds of pages as inputs.<br>
+From this it's obvious that only pages of locations and characters really work, hence it's best to use a category with those pages as the input.
-The template is meant to show pages with recent activity as editors may be inclined to follow up on those edits. New pages which would be recieving more edits will appear which similarly attracts more attention. The limitations in page selection are annoying and restrict the use of the template, so any help in making it easier to use is appreciated.
+The limitations in page selection restrict the use of the template, so any help in making it more general is appreciated.
 ==Parameters==
-	<templatedata>{"description": "","params": {
+<templatedata>{
+	"description": "Displays a packed gallery of recently edited pages in a category.",
+	"format": "inline",
+	"params": {
 		"category": {
 			"label": "Category/Categories",
 			"type": "line",
-			"description": "Choose category pages to find the recently edited articles from those categories. Separate multiple with commas.",
+			"description": "Input one or more category names to display recently edited articles from those categories. Separate multiple with the magic word {{!}}.",
-			"example": "Yume Nikki Locations, Yume 2kki Characters, Wataru",
+			"example": "Yume Nikki Locations{{!}}Yume Nikki Characters",
 			"autovalue": "{{PAGENAME}}"
-	},
+		},
 		"count": {
 			"label": "Number of Articles",
 			"type": "number",
-			"description": "The number of articles to present (from most recently edited to least recent).",
+			"description": "The number of articles to display (from most recently edited to least recent).",
-			"example": "12",
+			"default": "8"
-			"default": "8",
+		}
-			"suggested": true
+	}
-	},
+}</templatedata>
-		"align": {
-			"label": "Article Alignment",
-			"type": "line",
-			"description": "How the image and caption underneath are aligned with the rest of the row. As they are grouped together, text spanning multiple lines will mess with the alignment in the same way different image heights would.",
-			"suggestedvalues": ["bottom","top","middle"],
-			"default": "top",
-			"suggested": true
-	}}}</templatedata>
 ==Sample==
 The following input:
-<pre>{{RecentlyEdited|category=Qxy, Spelude, Noildoof, Autumn|count=14|align=middle}}</pre>
+<pre>
+{{RecentlyEdited|category=Qxy{{!}}Spelude, Noildoof{{!}}Autumn|count=14}}
+</pre>
 Produces:
-{{RecentlyEdited|category=Qxy, Spelude, Noildoof, Autumn|count=14|align=top}}
+{{RecentlyEdited|category=Qxy{{!}}Spelude, Noildoof{{!}}Autumn|count=14}}
 <noinclude>__NOTOC__ [[Category:Template documentation]]</noinclude>
-<includeonly>__NOEDITSECTION__</includeonly>
+<includeonly>
+[[Category:Templates]]
+__NOEDITSECTION__</includeonly>