Template:ASSTDOCLINK/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

This template returns a link to the main documentation page of the interactive assistant to which the page it's used on belongs, assuming certain naming conventions.

Usage[edit source]

Simply place {{ASSTDOCLINK}} on a page to get the output. By default, when called from any subsidiary page of the assistant, the link is to the section about that subsidiary page on the main documentation page, while when called from the main page of the assistant the link is to the main documentation page as a whole.

Optional parameters:

  • unnamed — page name to use instead of the name of the transcluding page. Alternatively, name of a global assistant, or parent and name of a local assistant (cf. {{ASST}}).
  • bold — if non-blank, puts the assistant name (but not the parent) in boldface.
  • anchor — anchor when linking to the main documentation page for the assistant, overriding the default behavior. See {{ASSTDOCHEADING}}.
  • label — label for the link instead of the name of the assistant (name being the field after Assistant:).
  • editintro — used for page-creation list if the main documentation page for the assistant does not exist.
  • preload — used for page-creation list if the main documentation page for the assistant does not exist.
  • sec — if non-blank, and no label is specified, the part of the page name after the assistant name is used for the label; see {{ASSTSUB}}.

If label is non-blank, the parent (as provided by {{ASST}}) is omitted.

If editintro or preload is non-blank, and the target doesn't exist, the label has create  pefixed to it.

This template can be substituted (via subst:) as well as transcluded.

Examples[edit source]

page where called result

Wikibooks:Assistant:Context

[[Wikibooks:Assistant:Context/doc|Context]]

Wikibooks:Assistant:Context/test

[[Wikibooks:Assistant:Context/doc#Wikibooks:Assistant:Context/test|Context]]

Template:Assistant:Context

[[Wikibooks:Assistant:Context/doc|Context]]

Wikibooks:Reference desk/Assistant:Request/commit

''Wikibooks:Reference desk'' ‍[[Wikibooks:Reference desk/Assistant:Request/doc#Wikibooks:Reference_desk/Assistant:Request/commit|Request]]

Template:Wikibooks:Reference desk/Assistant:Request/commit

''Wikibooks:Reference desk'' ‍[[Wikibooks:Reference desk/Assistant:Request/doc#Template:Wikibooks:Reference_desk/Assistant:Request/commit|Request]]

Category:Wikibooks:Reference desk/Assistant:Request/Templates

''Wikibooks:Reference desk'' ‍[[Wikibooks:Reference desk/Assistant:Request/doc#Category:Wikibooks:Reference_desk/Assistant:Request/Templates|Request]]

Category:Wikibooks:Reference desk/Assistant:Request

''Wikibooks:Reference desk'' ‍[[Wikibooks:Reference desk/Assistant:Request/doc|Request]]

Category:Assistant:Context/Templates

[[Wikibooks:Assistant:Context/doc#Category:Assistant:Context/Templates|Context]]

Category:Assistant:Context

[[Wikibooks:Assistant:Context/doc|Context]]

User:Pi zero/Assistant:Context/button

''User:Pi zero'' ‍[[User:Pi zero/Assistant:Context/doc#User:Pi_zero/Assistant:Context/button|Context]]

User:Pi zero/Assistant:Context/button/doc

''User:Pi zero'' ‍[[User:Pi zero/Assistant:Context/doc#User:Pi_zero/Assistant:Context/button/doc|Context]]

User:Pi zero/Context/doc

<span style="color:red;">'''<not an assistant page>'''</span>

Wikibooks:Assistant:Context
anchor = whitelist
bold = x

'''[[Wikibooks:Assistant:Context/doc#whitelist|Context]]'''

Wikibooks:Reference desk/Assistant:Request
label = assistant

[[Wikibooks:Reference desk/Assistant:Request/doc|assistant]]

Wikibooks:Reference desk/Assistant:Request/start
bold = x
sec = commit

'''[[Wikibooks:Reference desk/Assistant:Request/doc#Wikibooks:Reference_desk/Assistant:Request/start|start]]'''

Garthok/Assistant:Narful
preload = Template:Garthok/Assistant:Narful/preload
editintro = Template:Garthok/Assistant/Narful/editintro
bold = x

''Garthok'' ‍'''<span class="plainlinks">[//en.wikibooks.org/w/index.php?title=Garthok/Assistant:Narful/doc&action=edit&editintro=Template:Garthok/Assistant/Narful/editintro&preload=Template:Garthok/Assistant:Narful/preload&summary=create create Narful]</span>'''

Internals[edit source]

Calls {{ASST}} with ASSTDOCLINK/t.

See also[edit source]