---

Class ::xowiki::includelet::html-file

::xowiki::includelet::html-file create ... \
           [ -parameter_declaration (default "
          {-title ""}
          {-extra_css ""}
          {-levels 0}
          {-file:required}
        ") ]

Include the specified HTML file

Documented Parameters:

file

file to be included

title

extra_css

Defined in packages/xowiki/tcl/includelet-procs.tcl

Class Relations

• class: ::xowiki::IncludeletClass
• superclass: ::xowiki::Includelet

::xowiki::IncludeletClass create ::xowiki::includelet::html-file \
     -superclass ::xowiki::Includelet

Methods (to be applied on instances)

• href (scripted)

  if {$book_mode} {
    set href [::xo::cc url]#[toc anchor $name]
  } else {
    set href [::${:package_id} pretty_link -parent_id [${:__including_page} parent_id] $name]
  }
  return $href

• page_number (scripted)

  #:log "o: $page_order"
  set displayed_page_order $page_order
  for {set i 0} {$i < $remove_levels} {incr i} {
    regsub {^[^.]+[.]} $displayed_page_order "" displayed_page_order
  }
  #return $displayed_page_order
  return ""

• parameter_declaration (setter)

• render (scripted)

  :get_parameters
  
  if {$title eq ""} {set title $file}
  set parent_id [${:__including_page} parent_id]
  set page [::$package_id get_page_from_item_ref -parent_id $parent_id $file]
  if {$page eq ""} {
    error "could not resolve page from item ref $file"
  }
  if {$extra_css ne ""} {foreach css $extra_css {::xo::Page requireCSS $css}}
  return [$page html_content -add_sections_to_folder_tree $levels -owner [self]]

---