Template:Template list/doc

From Wikipedia, the free encyclopedia

Part of: Template:Template list (edit talk links history) 

Template:Catlst (edit talk links history)

Template list/doc--->

Similar templates at English sister projects [edit]
	mta	Meta-wiki	Template list/doc
	wpd	Wikipedia	Template list/doc
	cms	Commons	Template list/doc
	wbk	Wikibooks	Template list/doc
	wsp	Wikispecies	Template list/doc
	wvy	Wikiversity	Template list/doc

Note

(suppressed display)

The 'no argument given' form of this template generates an error message'
and that is suppressed when viewing the template page directly
See the talk page for a display of its appearance.

[edit] Purpose

reference

W:Wikipedia:WikiProject template sharing.

{{Template list}} is used for small lists of Templates for Administrative tasks and notifications, such as telling a sister project on it's Village Pump equivalent (names vary) a new batch of tools templates is available and ready to import, if they so desire.

   It takes a parameter SISTER= to change the character of the generated links from the local wiki template pages to the full URL form of an interwiki link (the resultant expansion difference within Mediawiki software.

   

It was adapted from {{catlst}} which takes similar paramters allowing a flexible 'lead in description of the list' Using the same title parameter '|LABEL=some descriptive phrase about the list to follow|', and catlst (will soon be) retrofitted to take the same parameter '|SISTER=local abbreviation prefix' such as {{The set of: 'B:', 'W:', 'Wikt:', 'S:', 'Q:', 'V:' }} etcetera.

   

1. A perameter 'SISTER=' may be optionally set which changes the internal links generated (default case) to a sisterproject's Template space, in effect providing a list of URL's to equivalent names inside the list.
        This use is likely to be extensive in matters before the Meta project (TBDL) and locally introduced and administered as Wikipedia:WikiProject template sharing.
   1. Hence the template has a very powerful 'Interwiki scope' thereby allowing one to list Template links to other sister projects.
2. The template will take up to forty template names, as {{catlst}} allows up to forty category names with the same interwiki reach.
3. Either kind of list can be easily built in a few moments using a decent text editor and cut N paste from a category page of interest or 'What links here list' (Special pages).

[edit] Usage

     {{LABEL or This list of Templates: (default)|Template Name_1|optionalTemplate Name_2|optionalTemplate Name_NN|...|optionalTemplate Name_NN (up to 40)}}

• Up to 40 parameters are permitted: only one, the first is mandatory.
  
     
• The list is dynamically generated so that the word " and "is always placed between the final two entries listed.
  
     
• If more than 40 entries are supplied, a message will be displayed pointing out the run-over problem with the occurrence of the 41st input parameter, while still processing the entry up to that limit.
  
     
• No newlines are permitted else the page links will be broken. (That means the command line must wrap, excepting the parameters (|SISTER=abbrev|LABEL=whatever, and the terminal '}}' can all be on independent lines. From the preceding pipe parsing to | {{{ 1 }}} | {{{ 2 }}} | {{{ 3 }}} | ... | {{{ 40 }}} , the whole aggregation must wrap.
      (TIP: In Notepad, turn 'Format --> Word Wrap' OFF before cutting text back to the wiki text editing page and previewing it. The latter will catch any unintentionally enclosed newlines.)

Usage hint

1. Drag and copy a template category list to a text editor having [[W:GSAR|Global and conditional Search and Replace capability like MS Windows Notepad.
2. Cut the leading padded spaces etcetera (w:garbage characters) from in front of any category name to the left hand margin.
   1. Use that as a GSAR search string.
   2. Use w:pipe character [[w:space character] and globally search and unconditionally replace the page.
3. Working bottom to top:
   1. Place a terminal '}}' pair after the last category name listed.
   2. By a succession of [Jump to Line Beginning] (Usually Keys: [CTRL] + [HOME]] followed by [BACKSPACE], joint that line to the one above.
   3. repeat [[Jump to line Beginning], and repeat as needed until all 'naked page names' are separated just by pipes.
4. Where there are category titles, add sufficient additional [Backspace] key strokes to also back past any additional garbage characters (Category Alphabetized Titles such as (A, B, C... Z) and their leading and trailing spaces.
      A good rhythm works fine for this with an eye on the aggregating unwrapped screen.
   1. If there are a lot of Category Section titles, consider a second unconditional GSAR to truncate the common garbage charaters before the letter of that sub-title.
   2. Repeat as needed until you have one big string of bare page names.
5. Now eliminate any undesired pages from the list you just built. This step can be performed before building the list, depending on how selective and narrow the list you are building. (i.e. If taking a small sub-set of the category page scattered across many alphabetical group headings, delete whole lines before aggregating the pipe delimited list.
6. With a little practice, it takes only a minute or so to build such a list.

[edit] See also

• List of text editors
• Comparison of text editors