note
	description: "Constants for Help generation"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

class
	HELP_SETTING_CONSTANTS

inherit
	APPLICATION_CONSTANTS

feature -- Access

	is_html_help: BOOLEAN
			-- Is Microsoft HTML Help 1.x?
			
	is_vsip_help: BOOLEAN
			-- Visual Studio .NET Integration help?
			
	is_web_help: BOOLEAN
			-- Help for web page content?
			
	is_tree_web_help: BOOLEAN
			-- Is web help for a tree toc?
			
	toc: TABLE_OF_CONTENTS
			-- Table of Contents
			
	help_project_name: STRING
			-- Name chosen for help project

	toc_is_physical: BOOLEAN
			-- Table of Contents is generated from a physical location on 
			-- disk rather than other structure such as tree widget or XML file

	compile: BOOLEAN
			-- Should HTML Help be compiled?

feature -- Path Locations
		
	help_compiler_location: FILE_NAME
			-- Location of HTML Help 1.x compiler executable
		do
		end		
		
	help_compiler_name: STRING
			-- Name of HTML Help 1.x compiler executable
		once
		end		
		
feature -- XML Tags

	directory_tag: STRING = "working_directory"

	help_project_tag: STRING = "help_project"
	
	name_tag: STRING = "name"
	
	title_tag: STRING = "title"
	
	files_tag: STRING = "files"
	
	project_file_tag: STRING = "project_file"
	
	compiled_file_tag: STRING = "compiled_file"
	
	toc_file_tag: STRING = "table_of_contents"
	
	log_file_tag: STRING = "log_file"

feature -- Status Setting
	
	set_help_toc (a_toc: like toc)
			-- Set Table of Contents
		do
			toc := a_toc
		end
		
	set_compile (a_flag: BOOLEAN)
			-- Set compile option
		do
			compile := a_flag
		end	
		
	set_help_project_name (a_name: STRING)
			-- Set name for help project
		do
			help_project_name := a_name
		end	
		
	set_help_type (a_type: INTEGER)
			-- Set chosen help generation type
		do
			inspect
				a_type
			when html_help then
				is_html_help := True
				is_vsip_help := False
				is_web_help := False
			when vsip_help then
				is_html_help := False
				is_vsip_help := True
				is_web_help := False
			when web_help_tree then
				is_html_help := False
				is_vsip_help := False
				is_web_help := True
				is_tree_web_help := True
			when web_help_simple then				
				is_html_help := False
				is_vsip_help := False
				is_web_help := True
				is_tree_web_help := False
			end
		end			
		
feature -- Implementation

	html_help,
	vsip_help,
	web_help_tree,
	web_help_simple: INTEGER = unique
			-- Transformation type chosen identifier
		
invariant
	html_help_exclusive: is_html_help implies (not is_vsip_help and not is_web_help)
	vsip_help_exclusive: is_vsip_help implies (not is_html_help and not is_web_help)
	web_help_exclusive: is_web_help implies (not is_vsip_help and not is_html_help)

note
	copyright:	"Copyright (c) 1984-2006, Eiffel Software"
	license:	"GPL version 2 (see http://www.eiffel.com/licensing/gpl.txt)"
	licensing_options:	"http://www.eiffel.com/licensing"
	copying: "[
			This file is part of Eiffel Software's Eiffel Development Environment.
			
			Eiffel Software's Eiffel Development Environment is free
			software; you can redistribute it and/or modify it under
			the terms of the GNU General Public License as published
			by the Free Software Foundation, version 2 of the License
			(available at the URL listed under "license" above).
			
			Eiffel Software's Eiffel Development Environment is
			distributed in the hope that it will be useful,	but
			WITHOUT ANY WARRANTY; without even the implied warranty
			of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
			See the	GNU General Public License for more details.
			
			You should have received a copy of the GNU General Public
			License along with Eiffel Software's Eiffel Development
			Environment; if not, write to the Free Software Foundation,
			Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
		]"
	source: "[
			 Eiffel Software
			 356 Storke Road, Goleta, CA 93117 USA
			 Telephone 805-685-1006, Fax 805-685-6869
			 Website http://www.eiffel.com
			 Customer support http://support.eiffel.com
		]"
end -- class HELP_SETTING_CONSTANTS