User:JL-Bot/Project content/documentation: Difference between revisions

Revision as of 12:14, 26 September 2020

Revision as of 13:45, 26 September 2020

Line 93:

The following optional parameters are supported:

; <code><nowiki>|compact</nowiki></code> : specifies compact layout instead of column layout (ex: article1 · article2). The <code>compact</code> option overrides the <code>columns</code> and <code>icons</code> options.

; {{para|maximum|<var>number</var>}} : specifies the maximum articles to list in <code>compact</code> mode. The <code>maximum</code> option only applies when the <code>compact</code> option is set.

; <code><nowiki>|small</nowiki></code> : specifies using a reduced text size in <code>compact</code> mode. The <code>small</code> option only applies when the <code>compact</code> option is set.

; {{para|columns|#em}} : specifies column size in default column layout

; <code><nowiki>|icons</nowiki></code> : specifies the use of content type icons before page names

; <code><nowiki>|icons-heading</nowiki></code> : specifies the use of content type icons before the headings

; {{para|heading|<var>number</var>}} : defines the heading level (number of "="s) to use; the default is level 2. The <code>heading</code> option allows for 0 and 2-6. A value of 2-6 defines the heading level (i.e. the number of "="s to use). A value of 0 means to not use a formal heading level, but instead use the ";Title" syntax.

; <code><nowiki>|noheading</nowiki></code> : specifies that headings are not to be displayed. The <code>noheading</code> option overrides the <code>heading</code> option.

; <code><nowiki>|pictures-list</nowiki></code> : specifies pictures should be listed (obeying the columns, icons, and compact options). Pictures will use the <code><nowiki><gallery></gallery></nowiki></code> syntax if the <code>pictures-list</code> option is not set.

; <code><nowiki>|dates</nowiki></code> : specifies including in the output the date the content was on the Main Page (where applicable)

; {{para|sorting|<var>value</var>}} : specifies the sorting to use. The <code>sorting</code> option may be set to <code>default</code> (sort by DEFAULTSORT key), <code>alpha</code> (sort alphabetically), <code>date-default</code> (sort Main Page content by date, remainder by DEFAULTSORT key), and <code>date-alpha</code> (sort Main Page content by date, remainder alphabetically). The default is <code>default</code> if not specified.

; {{para|date-order|<var>value</var>}} : specifies the sorting order for dates. The <code>date-order</code> option may be set to <code>increasing</code> or <code>decreasing</code>. This option only applies when the <code>sorting</code> option is set to <code>date-default</code> or <code>date-alpha</code>. The default is <code>increasing</code> if not specified.

; <code><nowiki>|display-total</nowiki></code> : specifies that a count of the number of pages in the content type is displayed

; {{para|overflow-FA|<var>page name</var>}}

; {{para|overflow-GA|<var>page name</var>}}

Line 118:

; {{para|overflow-vital-5|<var>page name</var>}}

: specifies an overflow page for corresponding kind of article when using <code>maximum</code>. These options only apply when the <code>maximum</code> option is set. They allow a page name to be specified that will be added as a link after the maximum number of articles are outputted. This is designed to allow linking to a page that contains a full listing of the content type. See [[Wikipedia:WikiProject National Register of Historic Places/Recognized content|this page]] for an usage example.

; <code><nowiki>|dyk-blurb</nowiki></code> or {{para|dyk-blurb|<var>N</var>}} : specifies displaying DYK blurbs instead of page names. The <code>dyk-blurb</code> option displays the DYK blurb (if available) instead of the page name. If a number is specified, then the first <code><var>N</var></code> blurbs will be displayed normally and the remaining blurbs will be wrapped in <code><nowiki><include></noinclude></nowiki></code>. This can be used to limited the number of blurbs that are transcluded onto another page.

; <code><nowiki>|italics</nowiki></code>: specifies displaying {{tl|italic title}} in italics. The <code>italics</code> option will display pages marked as {{tl|italic title}}s in italics. If the page title ends in a parenthesized text, only the part before the parenthesizes will be italicized. However, it does not support the <code><nowiki>|string</nowiki></code> parameter (allowing a subset of the title to be in italics) or other italic templates that require parsing the page content to determine what portion of the title is to be italicized. This option should only be utilized if those limitations are suitable for the recognized content being displayed.

; {{para|type|<var>text</var>}} : replace text "recognized content" with <code><var>text</var></code> in the wikitext output.