View source for Template:CD nav series/doc

{{Documentation subpage}}
__NOTOC__

This is a partner template of the {{tl|CD nav}} template. It is to be placed in the second parameter of that template. This template is very specialized in that is adds preformatted list of links for series that have four or more cds. The templates were created to make updating links for the list of titles in a series in the navigation panel easier. New series will need to be added to this collection of templates before they will work. There are up to 3 parameters. The first parameter is the first letter of the series name. The second is the name of the series. The third is for when a series has subcategories.

== Syntax ==
* {{tji|CD nav series|Series Name|Subcategory Name}}

== Parameters ==
* {{para|1}} is the serie's name. Do not include the word '''Series'''. An error will be displayed if any other value is entered.

* {{para|2}} is where any subcategory name will go if a series is broken into subcategories. See the Danshi Koukousei, Hajimete no example below. An error will be displayed if any other value is entered.

== Usage ==
* {{tlc|CD nav series|25-ji, Akasaka de}}
{{bi|Displays as:}}
{{CD nav series|25-ji, Akasaka de}}

* {{tlc|CD nav series|Danshi Koukousei、Hajimete no|Season 01}}
{{bi|Displays as:}}
{{CD nav series|Danshi Koukousei、Hajimete no|Season 01}}

== Sub Templates ==
Below is the list of helper templates for this template. To add a series visist the appropriate page for the first letter of the series name. Further instructions will be included on the helper templates document page.

* {{tl|CD nav series A to D}}
** Includes series that start with a number
* {{tl|CD nav series E to I}}
* {{tl|CD nav series J to N}}
* {{tl|CD nav series O to T}}
* {{tl|CD nav series U to Z}}

== TemplateData ==
<templatedata>
{
	"description": "This template is to add series titles to the CD navigation panel. It should be used in the second parameter of the CD nav template.",
	"format": "inline",
	"params": {
		"1": {
			"label": "Series Name",
			"description": "The series name without the word series.",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Subcategory Name",
			"description": "The name of the subcategory, if one exists.",
			"type": "string",
			"required": false
		}
	}
}
</templatedata>

<includeonly>{{sandbox other||{{testcases other||

<!-- Categories below this line, please -->
[[Category:CD nav templates]]
}}}}</includeonly>