TemplateLayouts < Main

You are here: Foswiki>Main Web>WikiUsers>JeffGreen>TemplateLayouts (17 Aug 2009, JeffGreen)Edit Attach

As I stumble my way through the foswiki code, I find that keeping everything in mind is a bit of a challenge, especially since I usually am pulled off of my explorations, resulting in me forgetting much of what I've discovered. The templates are key to how pages display and so having a quick way to see what they are is helpful. I'm creating these layouts on a local system and then copying them over as I work my way through the templates. Hopefully "my" system and system of symbols can be figured out. I've opened up the page although I've not yet transferred all of the pattern templates. Perhaps at some point a tool to parse the files and automatically generate these layouts can be written.

Legend
   Full words with underscores = TMPL:DEF objects (TDobj)
   Indented items = composition of definition
  *TDobj = directly included or instantiated object, used object.
   [TDobj] = a conditional object, occurs depending upon a condition.
   TDobj1 | TDobj2 = alternation between two objects, e.g. if-then-else situation.
   italicized text = abstracted terminal text that occurs in the definition.
           n.b.: repeated occurrences of text are not noted, only if it does occur and where it starts.
   ← tmpl_file = included definitions from a template file
   defn ← = definition that occurrs outside the immediate tmpl file, i.e. is included.
   # = start of a comment, extending to the end of line.

bottom of page

attach - for attachments
attachagain - for more attachments
attachnew - for new attachments
attachtables - for table attachments
backlinks - for backlinks.
backlinksallwebs - for backlinks (all webs).
backlinksweb - for backlinks to a web(?).
changeform - for changes
changes - for changes
comments - for comments.
css - the css style information.
cssmediatypes - style for media types.
edit - for edits
editform - for form edits
edittext - for text edits
form - for forms
formtables - for table forms
foswiki - the primary foswiki template.
foswiki (pattern) - the primary foswiki template with the pattern skin.
login - for logins
login (sudo) - for logins (via sudo?)
mailnotify - for mail notification.
mailresetpassword - for resetting mail password.
messages - a bunch of messages.
moveattachment - for an attachment move.
oops - for oops messages.
oopsaccessdenied - for access denied oops
oopsalertsnohtml - for oops alert with no html
oopsalerts - for oops alerts
oopsattention - for oops attention.
oopschangelanguage - for change language oops.
oopsgeneric - for generic oops
oopslanguagechanged - for lanuguage changed oops
oopsleaseconflict - for lease conflict oops
oopsmore - for more oops
oopssaveerr - for save error oops
preview - for previews.
rdiff - for rdiffs.
rdiff (pattern) - for rdiffs with the pattern skin.
registerconfirm - for register confirmations.
registerfailednotremoved - for failed register without removal.
registerfailedremoved - for failed register with removal (of user).
registernotify - for register notification to the user.
registernotifyadmin - for register notification to the admin.
rename - for renames.
renameattachmentdelete - for rename with attachments delete.
renamebase - for rename base.
renameconfirm - for rename confirm.
renamedelete - for rename deletes.
renameweb - for web renames.
renamewebbase - for web renames base.
renamewebconfirm - for web renames confirms.
renamewebdelete - only includes renamewebbase.
search - for searching.
searchbookview - for search book view.
searchformat - for search format.
searchmeta - for search (meta).
settings - for settings.
twiki - only includes foswiki
twistyplugin - for Twisty Plugin.
validate - for validations.
view - for views.
view (pattern) - for views with the pattern skin.
view (plain) - for views with the plain skin.
viewplain - for viewplain.
viewprint - for viewprint.
viewtopicactionbuttons - for view topic action buttons.

The templates:

attach.tmpl

    ← foswiki
    notes
         html text
    existingattachments
         html text
    attachform
         attachformstart
         newfile
         comment
         properties
         hiddenfields
         attachformend
    attachformstart
         html text
    attachformend
         html text
    newfile
         html text
    comment
         html text
    properties
         createlink
         hidefile
    createlink
         html text
    hidefile
         html text
    hiddenfields
         nothing
    content
         html text
         previousdetails ←
         attachform
         notes
         extranotes ←
         topicinfo ←
         existingattachments

attachnew.tmpl

    ← attach
    titleaction
        html text
    headerhelp
        nothing
    webaction
        html text
    previousdetails
        html text
    previous
        html text
    action
        html text
    topicactionbuttons
        html text
        sep ←
        canceltopicaction ←
    *attach ←

attachagain.tmpl

    ← attach
    titleaction
        html text
    headerhelp
        nothing
    webaction
        html text
    previousdetails
        html text
    previous
        html text
        fileuser
    extranotes
        html text
    topicactionbuttons
        html text
        sep ←
        sep ←
        canceltopicaction ←
    fileuser
        html text
    *attach ←

attachtables.tmpl

    ATTACH:files:header(toprow)
        html text
    ATTACH:files:header(basic)
        ATTACH:files:header(toprow)
    ATTACH:files:row(basic)
        html text
    ATTACH:files:header
        ATTACH:files:header(basic)
    ATTACH:files:row
        ATTACH:files:row(basic)
    ATTACH:files:footer
        html text
    ATTACH:files:header:A
        ATTACH:files:header(basic)
        html text
    ATTACH:files:row:A
        ATTACH:files:row(basic)
        html text
    ATTACH:files:footer:A
        html text
    ATTACH:versions:header
        html text
    ATTACH:versions:row
        html text
    ATTACH:versions:footer
        html text

backlinks.tmpl

    ← search
    searchweb
        html text
    searchallwebs
        html text
    topicinfo
        nothing
    topicaction
        nothing

backlinksallwebs.tmpl

    ← backlinks
    titleaction
        html text
    resultsheader
        html text
    content
        resultsheader
        searchweb ←
        searchallwebs ←

backlinksweb.tmpl

    ← backlinks
    titleaction
        html text
    resultsheader
        html text
    content
        resultsheader
        searchweb ←

changeform.tmpl

    ← foswiki
    titleaction
         html text
    pagetitle
         html text
    webaction
         html text
    topicactionbuttons
         html text
         gobacktopicaction ←
    formstart
         html text
    formend
         html text
    hiddenformfields
         html text
    notes
         html text
    content
         notes
         formstart
         html text
         hiddenformfields
         topicinfo ←
         formend

changes.tmpl

    ← foswiki
    ← search
    titleaction
         html text
    topicactionbuttons
         html text
    searchbody
         html text
         repeatedsearchblock ←
    content
         searchbody
         topicinfo ←

comments.tmpl

    ← CommentPlugin

css.tmpl

    defaultstyle
         styles:base
             import stmt
         styles:default
             import stmt
         styles:iespecific
             html text
         styles:javascript_affected
             nothing

cssmediatypes.tmpl

    *html text

edit.tmpl

    ← foswiki
    titleaction
         html text
    webaction
         html text
    pagetitle
         html text
    help
         html text
    textarea
         html text
    form
         html text
    formtop
         nothing
    formbottom
         form
    formstart
         html text
         formend
         formparameters
    formend
         formparameters
         html text
    formparameters
         formparameters:edit
    formparameters:edit
         html text
    sig
         html text
    footernote
         help
    topicactionbuttons
         html text
         sep ←
         sep ←
    content
         formstart         
         formtop
         textarea
         html text
         sig
         formbottom
         topicinfo ←
         formend

editform.tmpl

    ← edit
    focus
        nothing
    titleaction
        html text
    pagetitle
        html text
    footernote
        nothing
    content
        formstart ←
        formbottom ←
        topicinfo ←
        html text
        formend ←

edittext.tmpl

    ← edit
    titleaction
        html text
    pagetitle
        html text
    form
        html text

form.tmpl

    *html text
    *changeform
        html text
    mandatory
        html text
    *repeatedformrows
        html text
    *formtail
        [mandatory]

formtables.tmpl

    FORM:display:header
        html text
        FORM:display:titlename | FORM:display:titlelink
    FORM:display:row
        html text
    FORM:display:footer
        html text
    FORM:display:titlelink
        html text
        FORM:display:editlink
    FORM:display:titlename
        html text
    FORM:display:editlink
        html text

nb: the starred(*) TMPL:DEFs in foswiki.tmpl below are used in the order presented.

foswiki.tmpl

    ← css
    *htmldoctype
        html text
    *head
        windowtitle
        html text
        script
        defaultstyle
    *bodystart
        html text
        bodyclassname
    *main
        simpleheader
        pagetitlestylewrapper
        contentwrapper
        standardfooter
    *bodyend
        html text
    sep
        html text
    titlesep
        html text
    LOG_IN
        html text
    LOG_OUT
        html text
    nonwikiwordwarning
        html text
        nonwikiwordhelp
    nonwikiwordhelp
        html text
    nonwikiwordallowed
        html text
    nonwikiword
        nonwikiwordwarning | nonwikiwordallowed
    script
        script:skinbase
        script:skintemplate
        script:topictemplate
    script:skinbase
        nothing
    script:skintemplate
        nothing
    script:topictemplate
        nothing
    windowtitle
        html text
        titleaction
        titlesep
    titleaction
        nothing
    webaction
        nothing
    bodyclassname
        nothing
    broadcastmessage
        [broadcastmessage:contents]
    broadcastmessage:contents
        html text
    attachments
        nothing
    standardheader
        html text
        titleaction
        login
        webaction
    simpleheader
        html text
        titleaction
        headerhelp
    copyright
        html text
    footernote
        nothing
    content
        nothing
    contentwrapper
        content
    standardfooter
        footernote
        copyright
    canceltopicaction
        html text
    oktopicaction
        html text
    gobacktopicaction
        html text
    topicaction
        topicactionbuttons
    topicactionbuttons
        canceltopicaction
    topicinfo
        html text
    topicaction
        html text
    contentheader
        nothing
    contentheaderstylewrapper
        html text
        contentheader
    contentfooter
        nothing
    contentfooterstylewrapper
        html text
        contentfooter
    revisions
        html text
    login
        [login_actions]
    login_actions
        html text
    pagetitle
        webaction
    pagetitlestylewrapper
        html text
        pagetitle

foswiki.pattern.tmpl

    ← foswiki
    ← viewtopicactionbuttons
    ← viewbottombar
    sep
        html text
    LOG_IN
        html text
    LOG_OUT
        html text
    logo
        html text
    canceltopicaction
        html text
    bodyclassname
        html text
    simpleheader
        nothing
    pagetitlestylewrapper
        html text
        pagetitle ←
    patterntopiccontents
        pagetitlestylewrapper
        content ←
    printaction
        nothing
    topicaction
        html text
        topicactionbuttons ←
    topicinfo
        topicaction
    htmldoctype
        html text
    head
        html text
        windowtitle ←
        script ←
        defaultstyle ←
    script:skinbase
        html text
    bodystart
        html text
        bodyclassname ←
    main
        html text
        startsidebarwrapper ←
        logo
        patterntopiccontents
        endsidebarwrapper ←
        topbar ←
        bottombar ←
    bodyend
        html text
    textareabuttons
        html text

    ← foswiki
    webaction
         html text
    titleaction
         html text
    LOG_IN_BANNER
         nothing
    LOGGED_IN_BANNER
         html text
    NEW_USER_NOTE
         html text
    UNRECOGNISED_USER
         html text
    pagetitle
         nothing
    titleaction
         html text
    title
         html text
    titlestep
         title
         notestep
         errorstep
    notestep
         html text
    errorstep
         html text
         error
    error
         html text
    authrealm
         html text
    formstart
         html text
    formend
         html text
    usernamefield
         html text
         [autocomplete_off]
    usernamestep
         html text
         usernamefield
         usernamefieldhelp
    usernamenote
         authrealm ←
    usernamefieldhelp
         html text
         usernamenote
    passwordfield
         html text
         [autocomplete_off]
    autocomplete_off
         html text
    passwordfieldnoteremember
         passwordfield
         passwordnote
         [rememberbox]
    passwordstep
         html text
         passwordfieldnoteremember
    passwordnote
         html text
    rememberbox
         html text
    submitstep
         submit
    submit
         html text
    seealsostep
         seealsonote
    seealsonote
         html text
    form
         formstart
         titlestep
         usernamestep
         passwordstep
         submitstep
         formend
         seealsostep
    content
         form

    ← login
    webaction
        html text
    LOGGED_IN_BANNER
        html text
    UNRECOGNISED_USER
        html text
    title
        html text
    usernamefield
        html text
        [autocomplete_off] ←
    usernamenote
        authrealm
    passwordnote
        nothing
    loginasadministratorform
        nothing
    authrealm
        html text

mailnotify.tmpl

    HTML:before
        html text
    HTML:middle
        html text
    HTML:after
        html text
    PLAIN:before
        nothing/i>
    PLAIN:middle
        html text
    PLAIN:after
        nothing
    MailNotifyBody
        html text

Topic revision: r10 - 17 Aug 2009, JeffGreen

Main

Log In

Register

User Web

Welcome

Users

Groups

Password

Tools

Create New Topic

Index

Search

Changes

Notifications

RSS Feed

Statistics

Preferences

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Legal Imprint Privacy Policy