User's Guide
Reference Manual
Release Notes
PDF
Top

EDoc
Reference Manual
Version 0.7.6.5

Expand All
Contract All

Table of Contents

- edoc
  - Top of manual page
  - application/1
  - application/2
  - application/3
  - file/1
  - file/2
  - files/2
  - files/3
  - get_doc/1
  - get_doc/2
  - get_doc/3
  - layout/1
  - layout/2
  - packages/1
  - packages/2
  - read/1
  - read/2
  - read_comments/1
  - read_comments/2
  - read_source/1
  - read_source/2
  - run/4
- edoc_doclet
  - Top of manual page
  - run/2
- edoc_extract
  - Top of manual page
  - file/4
  - header/3
  - header/4
  - header/5
  - source/3
  - source/4
  - source/5
  - text/4
- edoc_layout
  - Top of manual page
  - module/2
  - overview/2
  - package/2
  - type/1
- edoc_lib
  - Top of manual page
  - copy_file/2
  - count/2
  - datestr/1
  - escape_uri/1
  - filename/1
  - find_doc_dirs/0
  - find_file/3
  - find_sources/2
  - find_sources/3
  - get_doc_env/1
  - get_doc_env/4
  - get_first_sentence/1
  - is_name/1
  - is_relative_uri/1
  - is_space/1
  - join_uri/2
  - lines/1
  - parse_contact/2
  - parse_expr/2
  - read_info_file/1
  - run_doclet/2
  - run_layout/2
  - segment/2
  - simplify_path/1
  - split_at/2
  - split_at_space/1
  - split_at_stop/1
  - strip_space/1
  - timestr/1
  - to_label/1
  - transpose/1
  - try_subdir/2
  - unique/1
  - uri_get/1
  - write_file/3
  - write_file/4
  - write_info_file/4
- edoc_run
  - Top of manual page
  - application/1
  - file/1
  - files/1
  - packages/1

# edoc_layout

### MODULE

edoc_layout

### MODULE SUMMARY

The standard HTML layout module for EDoc.

### DESCRIPTION

The standard HTML layout module for EDoc. See the edoc module for details on usage.

### EXPORTS

module(Element, Options) -> term()

The layout function.

Options to the standard layout:

{index_columns, integer()}

  Specifies the number of column pairs used for the function index tables. The default value is 1.

{stylesheet, string()}

  Specifies the URI used for referencing the stylesheet. The default value is "stylesheet.css". If an empty string is specified, no stylesheet reference will be generated.

{sort_functions, bool()}

  If true, the detailed function descriptions are listed by name, otherwise they are listed in the order of occurrence in the source file. The default value is true.

{xml_export, Module::atom()}

  Specifies an xmerl callback module to be used for exporting the documentation. See xmerl:export_simple/3 for details.

See also: edoc:layout/2.

overview(E, Options) -> term()

package(E, Options) -> term()

type(E) -> term()

### See also

edoc

Richard Carlsson richardc@it.uu.se