Template:See guide/doc

This subpage provides documentation for Template:See guide.

Use this template to refer the reader to a guide on a topic.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Guide to be linked to	article page 1	The name of the article to be linked to. You can include an explicit namespace. If you don't, the link will be to Guide:(article) if that page exists, or to the main namespace (article) otherwise. Example Guide: Managing the Atlas	Page name	required
Description	description explanation	If present, this text is displayed before the link to the guide. Example For a guide discussing how to manage the Atlas, see:	String	optional
Topic	topic	A human-readable name of the topic being discussed. Example managing the Atlas	String	optional

Examples

{{See guide|Managing the Atlas}}

{{See guide|description=For a guide discussing how to manage the Atlas, see:|topic=managing the Atlas|article=Guide:Managing the Atlas}}

{{See guide|topic=managing the Atlas|article=:Managing the Atlas}}