EDoc API
Overview Cluster Class Classes Index          Top Features

edoc.html_output

Class EDOC_HTML_CONTEXT


Direct ancestors

EDOC_SHARED_ACCESS, KL_IMPORTED_STRING_ROUTINES, KL_IMPORTED_CHARACTER_ROUTINES

Features

Invariants

indexing

description

HTML specific context information

copyright

Copyright (c) 2005, Julian Tschannen

license

Eiffel Forum License v2 (see forum.txt)

class EDOC_HTML_CONTEXT

inherit

EDOC_SHARED_ACCESS
KL_IMPORTED_CHARACTER_ROUTINES

feature -- Access

Class_sorter: DS_QUICK_SORTER[ET_CLASS]

-- Shared class sorter
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

Cluster_sorter: DS_QUICK_SORTER[ET_CLUSTER]

-- Shared cluster sorter
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

Feature_clause_sorter: DS_QUICK_SORTER[PAIR[ET_FEATURE_CLAUSE, PAIR[INTEGER, STRING]]]

-- Shared feature sorter.
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

Feature_sorter: DS_QUICK_SORTER[ET_FEATURE]

-- Shared feature sorter.
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

Index_sorter: DS_QUICK_SORTER[EDOC_INDEX_ENTRY]

-- Shared index sorter
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

CHARACTER_: KL_CHARACTER_ROUTINES

-- Routines that ought to be in class CHARACTER
-- (From KL_IMPORTED_CHARACTER_ROUTINES)

ensure

character_routines_not_void: Result /= Void

feature -- Filenames

class_file_name (a_class: ET_CLASS): STRING

-- Filename of a_class

require

a_class_not_void: a_class /= Void

ensure

class_file_name_not_void: Result /= Void

classes_file_name: STRING

-- Filename of classes file

cluster_file_name (a_cluster: ET_CLUSTER): STRING

-- Filename of a_cluster

require

a_cluster_not_void: a_cluster /= Void

ensure

cluster_file_name_not_void: Result /= Void

css_file_name: STRING

-- Filename of css file

index_file_name (a_character: CHARACTER): STRING

-- Filename of index file of a_character

require

a_character_valid: a_character.is_upper or a_character.is_lower

ensure

index_file_name_not_void: Result /= Void

overview_file_name: STRING

-- Filename of overview

usage_file_name (a_class: ET_CLASS): STRING

-- Filename of usage file of a_class

require

a_class_not_void: a_class /= Void

ensure

usage_file_name_not_void: Result /= Void

feature -- Header buttons

Active_page_link: STRING

-- Link denoting active link

class_page_link: STRING

-- Link to class page

classes_page_link: STRING

-- Link to classes page

cluster_page_link: STRING

-- Link to cluster page

index_page_link: STRING

-- Link to index page

overview_page_link: STRING

-- Link to overview page

setup_class_page_links (a_class: ET_CLASS)

-- Setup button links for class page of a_class.

setup_classes_page_links

-- Setup button links for classes page.

setup_cluster_page_links (a_cluster: ET_CLUSTER)

-- Setup button links for cluster page of a_cluster.

setup_index_page_links

-- Setup button links for index page.

setup_overview_page_links

-- Setup button links for overview page.

setup_usage_page_links (a_class: ET_CLASS)

-- Setup button links for usage page of a_class.

usage_page_link: STRING

-- Link to usage page

feature -- Links

class_link_by_class (a_class: ET_CLASS): STRING

-- Generate link to a_class.

require

a_class_not_void: a_class /= Void

ensure

link_to_included_class_not_void: Context.documented_classes.has (a_class) implies Result /= Void

class_link_by_name (a_class_name: ET_CLASS_NAME): STRING

-- Generate link to a_class_name.
-- Return Void if a_class_name is not part of universe.

require

a_class_name_not_void: a_class_name /= Void

ensure

link_to_included_class_not_void: Context.universe.has_class (a_class_name) and then Context.documented_classes.has (Context.universe.class_by_name (a_class_name.name)) implies Result /= Void

cluster_link_by_cluster (a_cluster: ET_CLUSTER): STRING

-- Generate link to a_cluster.

require

a_cluster_not_vod: a_cluster /= Void

ensure

link_to_included_cluster_not_void: Context.documented_clusters.has (a_cluster) implies Result /= Void

creator_anchor_by_feature (a_feature: ET_FEATURE): STRING

-- Generate anchor to a_feature as a creator.

require

a_featuren_not_void: a_feature /= Void

ensure

anchor_not_void: Result /= Void

creator_link_by_feature (a_feature: ET_FEATURE; a_class: ET_CLASS): STRING

-- Generate link to a_feature in a_class as creator.
-- If a_class is Void create a relative link

require

a_feature_not_void: a_feature /= Void

ensure

relative_link_not_void: a_class = Void implies Result /= Void

feature_anchor_by_feature (a_feature: ET_FEATURE): STRING

-- Generate anchor to a_feature.

require

a_featuren_not_void: a_feature /= Void

ensure

anchor_not_void: Result /= Void

feature_link_by_feature (a_feature: ET_FEATURE; a_class: ET_CLASS): STRING

-- Generate link to a_feature in a_class.
-- If a_class is Void create a relative link

require

a_feature_not_void: a_feature /= Void

ensure

relative_link_not_void: a_class = Void implies Result /= Void

relative_classes_link: STRING

-- Link to classes page

ensure

relative_classes_link_not_void: Result /= Void

relative_css_link: STRING

-- Link to css file

ensure

relative_css_link_not_void: Result /= Void

relative_index_link (a_character: CHARACTER): STRING

-- Link to index page of a_character

require

a_character_valid: a_character.is_upper or a_character.is_lower

ensure

relative_index_link_not_void: Result /= Void

relative_overview_link: STRING

-- Link to overview page

ensure

relative_overview_link_not_void: Result /= Void

usage_link_by_class (a_class: ET_CLASS): STRING

-- Generate link to usage page of a_class.

require

a_class_not_void: a_class /= Void

ensure

link_to_included_class_not_void: Context.documented_classes.has (a_class) implies Result /= Void

feature -- Support

xhtml_compatible_anchor (a_string: STRING): STRING

-- XHTML conform anchor for 'a_string'

require

a_string_not_void: a_string /= Void

ensure

result_not_void: Result /= Void

xhtml_escaped_string (a_string: STRING): STRING

-- XHTML conform string without spaces

require

a_string_not_void: a_string /= Void

ensure

result_not_void: Result /= Void

invariant


-- From ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)