doc/plugins/write/names.mdwn

   1 *This page is work in progress and can not be considered to be part of the
   2 documentation so far.*
   3
   4 This page describes the various forms the name of a page can take.
   5
   6 [[!table data="""
   7 concept          | example
   8 -----------------|-----------------------------------------------------------------------------
   9 title            | '`dir A/page B`' unless a meta title is defined
  10 link             | '`dir_A/page_B`' or '`dir A/page B`' or '`page_B`' / '`page B`' when inside dirA
  11 page name        | '`dir_A/page_B`'
  12 source file      | '`/dir_A/page_B/index.mdwn`' or '`/dir_A/page_B.mdwn`' depending on indexpages
  13 rendered file    | '`/dir_A/page_B/`' or '`/dir_A/page_B.html`' depending on usedirs
  14 """]]
  15
  16
  17 functions:
  18
  19 * `pagename`: source file to page name
  20 * `pagetitle`: page name to title but not considering meta title
  21 * `titlepage`: title to page name but not considering meta title
  22 * `linkpage`: link to page name
  23 * `htmllink`: page name to html link to rendered file
  24 * `bestlink`: link to page name
  25 * `htmlpage`: page name to rendered file