Module: Id (TmDoc::Transformer::DocumentIntoDocBook)
Prev Chapter 3.  User Defined Modules and Classes  Next

Module: Id (TmDoc::Transformer::DocumentIntoDocBook)

Overview
Module Structure
Constants
Id::SEP
Id::PREFIX
Id::DIV_PREFIX
Id::SRC_PREFIX
Id::DEF_PREFIX
Id::HOME
Id::INDEX
Id::DIV_OVERVIEW
Id::DIV_UNKNOWN_M_AND_C
Id::DIV_BUILTIN_M_AND_C
Id::DIV_USER_M_AND_C
Id::DIV_SOURCES
Id::DIV_OV_M_STRUCTURE
Id::DIV_OV_C_HIERARCHY
Id::DIV_OV_S_STRUCTURE
Id::DIV_NAME_OF_M_STRUCTURE
Id::DIV_NAME_OF_C_HIERARCHY
Id::DIV_NAME_OF_S_STRUCTURE
Id::DIV_NAME_OF_CODE
Id::NODE_FOCUS
Id::PROP_PREFIX
Module Functions
Id.transform_line / 2
Id.transform_file / 1
Id.transform_module / 2
Id.transform_module_section / 2
Id.transform_focus / 1
Id.transform_property / 3
is a submodule of
module: DocumentIntoDocBook ( TmDoc::Transformer )
has modular siblings
module: Overview   
module: Module   
module: Source   
module: Node   
module: Link   
has properties
constant: SEP   
constant: PREFIX   
constant: DIV_PREFIX   
constant: SRC_PREFIX   
constant: DEF_PREFIX   
constant: HOME   
constant: INDEX   
constant: DIV_OVERVIEW   
constant: DIV_UNKNOWN_M_AND_C   
constant: DIV_BUILTIN_M_AND_C   
constant: DIV_USER_M_AND_C   
constant: DIV_SOURCES   
constant: DIV_OV_M_STRUCTURE   
constant: DIV_OV_C_HIERARCHY   
constant: DIV_OV_S_STRUCTURE   
constant: DIV_NAME_OF_M_STRUCTURE   
constant: DIV_NAME_OF_C_HIERARCHY   
constant: DIV_NAME_OF_S_STRUCTURE   
constant: DIV_NAME_OF_CODE   
constant: NODE_FOCUS   
constant: PROP_PREFIX   
function: transform_line / 2   
function: transform_file / 1   
function: transform_module / 2   
function: transform_module_section / 2   
function: transform_focus / 1   
function: transform_property / 3   
is defined at
#14 in transformer/document-into-docbook/id.rb  

Overview

Module Structure

Module Structure

  module: <Toplevel Module>
  module: TmDoc
  module: Transformer
  module: DocumentIntoDocBook
  module: Overview     
  module: Module     
  module: Source     
  module: Node     
  module: Link     
✗ module: Id     

Constants

Id::SEP
Id::PREFIX
Id::DIV_PREFIX
Id::SRC_PREFIX
Id::DEF_PREFIX
Id::HOME
Id::INDEX
Id::DIV_OVERVIEW
Id::DIV_UNKNOWN_M_AND_C
Id::DIV_BUILTIN_M_AND_C
Id::DIV_USER_M_AND_C
Id::DIV_SOURCES
Id::DIV_OV_M_STRUCTURE
Id::DIV_OV_C_HIERARCHY
Id::DIV_OV_S_STRUCTURE
Id::DIV_NAME_OF_M_STRUCTURE
Id::DIV_NAME_OF_C_HIERARCHY
Id::DIV_NAME_OF_S_STRUCTURE
Id::DIV_NAME_OF_CODE
Id::NODE_FOCUS
Id::PROP_PREFIX

Id::SEP

#15 in transformer/document-into-docbook/id.rb

SEP = '.'   

Id::PREFIX

#17 in transformer/document-into-docbook/id.rb

PREFIX = 'tmdoc'   

Id::DIV_PREFIX

#18 in transformer/document-into-docbook/id.rb

DIV_PREFIX = PREFIX + SEP + 'div'   

Id::SRC_PREFIX

#19 in transformer/document-into-docbook/id.rb

SRC_PREFIX = PREFIX + SEP + 'src'   

Id::DEF_PREFIX

#20 in transformer/document-into-docbook/id.rb

DEF_PREFIX = PREFIX + SEP + 'def'   

Id::HOME

#22 in transformer/document-into-docbook/id.rb

HOME = PREFIX + SEP + 'home'   

Id::INDEX

#23 in transformer/document-into-docbook/id.rb

INDEX = PREFIX + SEP + 'index'   

Id::DIV_OVERVIEW

#25 in transformer/document-into-docbook/id.rb

DIV_OVERVIEW = DIV_PREFIX + SEP + 'overview'   

Id::DIV_UNKNOWN_M_AND_C

#26 in transformer/document-into-docbook/id.rb

DIV_UNKNOWN_M_AND_C = DIV_PREFIX + SEP + 'unknown-modules'   

Id::DIV_BUILTIN_M_AND_C

#27 in transformer/document-into-docbook/id.rb

DIV_BUILTIN_M_AND_C = DIV_PREFIX + SEP + 'builtin-modules'   

Id::DIV_USER_M_AND_C

#28 in transformer/document-into-docbook/id.rb

DIV_USER_M_AND_C = DIV_PREFIX + SEP + 'user-modules'   

Id::DIV_SOURCES

#29 in transformer/document-into-docbook/id.rb

DIV_SOURCES = DIV_PREFIX + SEP + 'sources'   

Id::DIV_OV_M_STRUCTURE

#31 in transformer/document-into-docbook/id.rb

DIV_OV_M_STRUCTURE = DIV_PREFIX + SEP + 'ov-m-structure'   

Id::DIV_OV_C_HIERARCHY

#32 in transformer/document-into-docbook/id.rb

DIV_OV_C_HIERARCHY = DIV_PREFIX + SEP + 'ov-c-hierarchy'   

Id::DIV_OV_S_STRUCTURE

#33 in transformer/document-into-docbook/id.rb

DIV_OV_S_STRUCTURE = DIV_PREFIX + SEP + 'ov-s-structure'   

Id::DIV_NAME_OF_M_STRUCTURE

#35 in transformer/document-into-docbook/id.rb

DIV_NAME_OF_M_STRUCTURE = 'm-structure'   

Id::DIV_NAME_OF_C_HIERARCHY

#36 in transformer/document-into-docbook/id.rb

DIV_NAME_OF_C_HIERARCHY = 'c-hierarchy'   

Id::DIV_NAME_OF_S_STRUCTURE

#37 in transformer/document-into-docbook/id.rb

DIV_NAME_OF_S_STRUCTURE = 's-structure'   

Id::DIV_NAME_OF_CODE

#38 in transformer/document-into-docbook/id.rb

DIV_NAME_OF_CODE = 'code'   

Id::NODE_FOCUS

#40 in transformer/document-into-docbook/id.rb

NODE_FOCUS = 'focus'   

Id::PROP_PREFIX

#42 in transformer/document-into-docbook/id.rb

PROP_PREFIX = '+'   

Module Functions

Id.transform_line / 2
Id.transform_file / 1
Id.transform_module / 2
Id.transform_module_section / 2
Id.transform_focus / 1
Id.transform_property / 3

Id.transform_line / 2

#47 in transformer/document-into-docbook/id.rb

transform_line ( file_name ,
  line_num )

Id.transform_file / 1

#56 in transformer/document-into-docbook/id.rb

transform_file ( name )

Id.transform_module / 2

#65 in transformer/document-into-docbook/id.rb

transform_module ( above_path ,
  name )

Id.transform_module_section / 2

#85 in transformer/document-into-docbook/id.rb

transform_module_section ( module_id ,
  section_name )

Id.transform_focus / 1

#95 in transformer/document-into-docbook/id.rb

transform_focus ( section_id )

Id.transform_property / 3

#104 in transformer/document-into-docbook/id.rb

transform_property ( module_id ,
  name ,
  uniq_num = 0 )

Prev Up Next
Class: CacheManager (TmDoc::Transformer::DocumentIntoDocBook::Link)  Home  Class: FileItem (TmDoc::Reader)