Tags:

documentation 1Add my vote for this tag skin 1Add my vote for this tag template_system 1Add my vote for this tag tag this topic create new tag

view all tags

Documentation of the default skin templates

General purpose
When I started writing a skin, it took me quite some time to find out the interrelations of templates and modules (also definitions), which templates needed to be overridden and which did not. It seems there isn't a general documentation of this. So to help new skin developers, and ourselves, I would like to fill this gap. On this page I would like to get the description of the general purpose/functions of each template and also which modules are defined where.

Keep in mind that most of this architecture is simply the way the default skin does it. Just because the default skin uses twiki.tmpl to define all of its common code doesn't mean a new skin would have to do the same, or use the same template-macro names. In fact, I think that in creating a new default skin it would be a good idea to try and rethink just which elements need to be stored in a common include template. -- WalterMundt - 02 Sep 2003

Page summary:

---

Twiki

template twiki

twiki.tmpl is included in: attach.tmpl, changeform.tmpl, changes.tmpl, edit.iejs.tmpl, edit.tmpl, moveattachment.tmpl, oopsaccesschange.tmpl, oopsaccesscreateweb.tmpl, oopsaccessgroup.tmpl, oopsaccessrename.tmpl, oopsaccessview.tmpl, oopsauth.tmpl, oopsbadpwformat.tmpl, oopschangepasswd.tmpl, oopsempty.tmpl, oopslocked.tmpl, oopslockedrename.tmpl, oopsmanage.tmpl, oopsmissing.tmpl, oopsmngcreateweb.tmpl, oopsmore.tmpl, oopsmoveerr.tmpl, oopsnoformdef.tmpl, oopsnotwikiuser.tmpl, oopsnoweb.tmpl, oopspreview.tmpl, oopsregemail.tmpl, oopsregexist.tmpl, oopsregpasswd.tmpl, oopsregrequ.tmpl, oopsregthanks.tmpl, oopsregwiki.tmpl, oopsrenameerr.tmpl, oopsrenamenotwikiword.tmpl, oopsresetpasswd.tmpl, oopsrev.tmpl, oopssave.tmpl, oopssaveerr.tmpl, oopssendmailerr.tmpl, oopstopicexists.tmpl, oopsupload.tmpl, oopswrongpassword.tmpl, preview.tmpl, rdiff.tmpl, renamebase.tmpl, search.tmpl, searchbookview.tmpl, searchformat.tmpl, searchrenameview.tmpl, view.plain.tmpl, view.print.tmpl, view.tmpl

(or better: included in all except for: attachagain.tmpl, attachnew.tmpl, mailnotify.tmpl, registernotify.tmpl, rename.tmpl, renameconfirm.tmpl, renamerefs.tmpl, searchmeta.tmpl, (twiki.tmpl), view.rss.tmpl).

Defines modules:

• sep
• htmldoctype
• standardheader
• simpleheader
• standardfooter
• oops It seems confusing to me to have the oops template defined in twiki.tmpl. Better in separate oops.tmpl file?

---

sep

pipe character

---

htmldoctype

XHTML 1.0 Transitional

Used in templates:

• attach.tmpl
• changeform.tmpl
• changes.tmpl
• edit.iejs.tmpl
• edit.tmpl
• moveattachment.tmpl
• preview.tmpl
• rdiff.tmpl
• renamebase.tmpl
• search.tmpl
• searchbookview.tmpl
• searchformat.tmpl
• searchrenameview.tmpl
• twiki.tmpl
• view.plain.tmpl
• view.print.tmpl
• view.tmpl

---

standardheader

Contains TWikiPreferences variables:

• WEBBGCOLOR
• WIKILOGOIMG
• WIKILOGOURL
• WIKILOGOALT
• WIKITOOLNAME
• WIKIWEBLIST

Calls modules:

• webaction (defined in view.tmpl) Could be defined in twiki.tmpl?
• titleaction (defined in view.tmpl) Could be defined in twiki.tmpl?
  • Probably not - the reason these are used in twiki.tmpl is so that the individual template pages can define them; then, when they include the common twiki.tmpl, it will use these definitions to customize the stardard header and footer elements. -- WalterMundt

Uses other elements:

• breadcrumb Should be put into new module

Used in templates:

• changes.tmpl
• rdiff.tmpl
• search.tmpl
• searchbookview.tmpl
• searchformat.tmpl
• searchrenameview.tmpl
• view.tmpl

---

simpleheader

Used on form pages as simple header with less links to not distract user.

Contains TWikiPreferences variables:

• WEBBGCOLOR
• WIKILOGOIMG
• WIKILOGOURL
• WIKILOGOALT
• WIKITOOLNAME

Calls modules:

• titleaction (defined in view.tmpl)
• webaction (defined in view.tmpl)
• headerhelp Not sure why this is here. headerhelp is defined in several places: preview.tmpl, attachnew.tmpl and attachagain.tmpl.
  • This is used to provide specific help for each of those pages within the header. Since the header is defined in the common file, there has to be a macro from the individual files that allows them to set what help to place there. This is a similar principle to webaction and topicaction above. -- WalterMundt

Used in templates:

• attach.tmpl
• changeform.tmpl
• edit.iejs.tmpl
• edit.tmpl
• moveattachment.tmpl
• preview.tmpl
• renamebase.tmpl
• twiki.tmpl (oops def)

---

standardfooter

Contains TWikiPreferences variables:

• WEBBGCOLOR

Calls modules:

• topicaction (defined in view.tmpl) Could be defined in twiki.tmpl?

Used in templates:

• attach.tmpl
• changeform.tmpl
• changes.tmpl
• edit.iejs.tmpl
• edit.tmpl
• moveattachment.tmpl
• preview.tmpl
• rdiff.tmpl
• renamebase.tmpl
• search.tmpl
• searchbookview.tmpl
• searchformat.tmpl
• searchrenameview.tmpl
• twiki.tmpl
• view.tmpl

---

oops

Used on all oops pages (see below).

Calls modules:

• htmldoctype (defined in twiki.tmpl)
• simpleheader (defined in twiki.tmpl)
• heading (defined in each oops template - this is the main heading
• message (defined in each oops template) - this is the error message
• standardfooter (defined in twiki.tmpl)

Contains TWikiPreferences variables:

• WIKITOOLNAME
• HTTP_EQUIV_ON_VIEW (default empty variable)

Uses other elements:

• a new < head > section
• < meta name="robots" content="noindex" / >

---

View

template view

Defines modules:

• titleaction
• webaction
• topicaction

Uses other elements:

• CHARSET (defined as $siteLocale in TWiki.cfg)
• TEXT (the topic txt file)
• META{"form"}
• META{"attachments"}
• A closing line with revision information (REVINFO)
• META{"moved"} (if the topic was moved (renamed) and link to put it back)

Contains TWikiPreferences variables:

• WEBCOPYRIGHT

---

titleaction

Uses other elements:

• REVTITLE

---

webaction

Contains TWikiPreferences variables:

• WEBTOPICLIST

---

topicaction

The area with action links (Edit, Attach, Ref-by, etc.).

Contains TWikiPreferences variables:

Calls modules:

• standardfooter

Uses other elements:

• EDITTOPIC
• REVISIONS

---

template view.plain

Contains TWikiPreferences variables:

• WIKITOOLNAME
• HTTP_EQUIV_ON_VIEW (default empty variable)

Calls modules:

• htmldoctype

Uses other elements:

• TEXT
• META{"form"}
• META{"attachments"}

---

template view.print

template view.rss

---

Edit

template edit

template edit.iejs

Preview

template preview

Attach

template attach

template attachagain

template attachnew

template moveattachment

Rename

template rename

template renamebase

template renameconfirm

template renamerefs

Search

template search

template searchbookview

template searchformat

template searchmeta

template searchrenameview

Oops

template oopsaccesschange

template oopsaccesscreateweb

template oopsaccessgroup

template oopsaccessrename

template oopsaccessview

template oopsauth

template oopsbadpwformat

template oopschangepasswd

template oopsempty

template oopslocked

template oopslockedrename

template oopsmanage

template oopsmissing

template oopsmngcreateweb

template oopsmore

template oopsmoveerr

template oopsnoformdef

template oopsnotwikiuser

template oopsnoweb

template oopsnoweb

template oopspreview

template oopsregemail

template oopsregexist

template oopsregpasswd

template oopsregrequ

template oopsregthanks

template oopsregwiki

template oopsrenameerr

template oopsrenamenotwikiword

template oopsresetpasswd

template oopsrev

template oopssave

template oopssaveerr

template oopssendmailerr

template oopstopicexists

template oopsupload

template oopswrongpassword

Other

template changeform

template changes

template mailnotify

template rdiff

template registernotify

Discussion

Thank You! I've been printing out the template files and marking them all up in five different highlighter colors trying to figure everything out on my own before finding this. Unfortunately this doc is nearly three years old, does anyone know offhand of any major updates we should add? I'll add any updates or suggestions I find as I go through this process myself.

-- AmandaSmith - 16 Jan 2006

WebForm
TopicClassification	Select one...
TopicSummary
InterestedParties
AssignedTo
AssignedToCore
ScheduledFor
RelatedTopics
SpecProgress
ImplProgress
DocProgress

Topic revision: r10 - 2006年01月16日 - AmandaSmith