Difference between revisions of "Defining New Protocol"

 
Line 1: Line 1:
 
[[Category:Eiffel Information System]]
 
[[Category:Eiffel Information System]]
 
[[Category:Extending EiffelStudio]]
 
[[Category:Extending EiffelStudio]]
 
+
{{UnderConstruction}}
 
==General==
 
==General==
 
This article demonstrate the way to extend [[Eiffel Information System]] (EIS) within EiffelStudio to support more [[Eiffel Information System#Protocol|protocols]]. To support a new protocol in EiffelStudio, the only thing to do is to provide a new {{red|Help Provider}}.
 
This article demonstrate the way to extend [[Eiffel Information System]] (EIS) within EiffelStudio to support more [[Eiffel Information System#Protocol|protocols]]. To support a new protocol in EiffelStudio, the only thing to do is to provide a new {{red|Help Provider}}.

Revision as of 20:11, 22 July 2008

Construction.png Not Ready for Review: This Page is Under Development!

General

This article demonstrate the way to extend Eiffel Information System (EIS) within EiffelStudio to support more protocols. To support a new protocol in EiffelStudio, the only thing to do is to provide a new Help Provider.

Steps to Create a New Help Provider

Redefining ES_EIS_ENTRY_HELP_PROVIDER

Adding a New Kind of Help Provider

All known kinds of help providers should be written in class {HELP_PROVIDER_KINDS}. An instance of {UUID} and a string of that uuid are needed in the class. Existing example:

...
	frozen pdf: !UUID
			-- PDF help system
		once
			create Result.make_from_string (pdf_uuid_string)
		end
...
	pdf_uuid_string: !STRING_8		= "BA35A9BB-5B69-4BD3-88B3-FB8DAE5CA08E"
...

Registering Help Provider

Doing this to make the system really take the new protocol into account. Added a line at {ES_SERVICE_INITIALIZER}.register_help_provider This is an existing example:

 a_service.register_provider (l_kinds.pdf, {PDF_HELP_PROVIDER})