diff --git a/documentation/current/community/index.wiki b/documentation/current/community/index.wiki index 6a2ea32f..279dece2 100644 --- a/documentation/current/community/index.wiki +++ b/documentation/current/community/index.wiki @@ -3,5 +3,9 @@ [[Property:uuid|75c75712-7c3e-2757-51b7-77b404471e2e]] == Community contributions == - Provide a place with the official documentation for referencing valuable work done by and available to the Eiffel community. +It is here that you will find references to valuable work done by and available to the Eiffel community. + +* [http://www.gobosoft.com/ Gobo Tools and Libraries] + +* [http://sourceforge.net/projects/safe Software App Foundations in Eiffel] (SAFE) diff --git a/documentation/current/eiffelstudio/eiffelstudio-guided-tour/graphics-based-design.wiki b/documentation/current/eiffelstudio/eiffelstudio-guided-tour/graphics-based-design.wiki index db8962f1..b150233b 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-guided-tour/graphics-based-design.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-guided-tour/graphics-based-design.wiki @@ -58,7 +58,7 @@ This is EiffelStudio's way of telling us that these two classes, listed because
==Adding a client link== -Let's add HEIR2 to the system by making TESTROOT a client of this class. Click the button that selects Client as the next relation to make links (the link creation buttons were shown on page [[EiffelStudio General: A Guided Tour|click here]] ). Pick-and-drop from the TESTROOT bubble to the HEIR2 bubble. This asks you what kind of client link you want: +Let's add HEIR2 to the system by making TESTROOT a client of this class. Click the button that selects Client as the next relation to make links. Pick-and-drop from the TESTROOT bubble to the HEIR2 bubble. This asks you what kind of client link you want:
[[Image:index-125]] [[general/guided_tour/studio/index-125.png|(link)]]
This technique gives you many option and in fact is a convenient way to build your classes, whether at the analysis, design or implementation level. Here, fill the fields as follows. For the top choice, keep the default, Attribute ; we'll give class TESTROOT an attribute of type HEIR2 . For its feature category, keep the choice currently displayed, Access . For its name, replace the default, new_feature , by the name my_heir . In the invariant clause, choose diff --git a/documentation/current/eiffelstudio/eiffelstudio-guided-tour/index.wiki b/documentation/current/eiffelstudio/eiffelstudio-guided-tour/index.wiki index 8f1f9273..9b121bcd 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-guided-tour/index.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-guided-tour/index.wiki @@ -1,50 +1,5 @@ [[Property:title|EiffelStudio: A Guided Tour]] [[Property:weight|0]] [[Property:uuid|4d68a136-f7c2-ddd3-d30d-e16ee7692302]] -==Interactive Software Engineering== - -===[[MANUAL IDENTIFICATION AND COPYRIGHT|MANUAL IDENTIFICATION AND COPYRIGHT]]=== - -{{note| This is not an introduction to the Eiffel method and language. See the list of [[Getting started with Eiffel|introductory documents]] for ''Invitation to Eiffel'' and a longer tutorial. }} -
-==[[1 OVERVIEW AND PREREQUISITES|1 OVERVIEW AND PREREQUISITES]]== - -==[[2 COPYING THE EXAMPLE FILES|2 COPYING THE EXAMPLE FILES]]== - -==[[3 STARTING EIFFELSTUDIO AND OPENING A PROJECT|3 STARTING EIFFELSTUDIO AND OPENING A PROJECT]]== - -==[[4 COMPILING AND EXECUTING A SYSTEM|4 COMPILING AND EXECUTING A SYSTEM]]== - -==[[5 A LOOK AT THE PROJECT DIRECTORY|5 A LOOK AT THE PROJECT DIRECTORY]]== - -==[[6 STARTING TO BROWSE|6 STARTING TO BROWSE]]== - -==[[7 CLASS VIEWS|7 CLASS VIEWS]]== - -==[[8 PRODUCING AND EXPORTING DOCUMENTATION|8 PRODUCING AND EXPORTING DOCUMENTATION]]== - -==[[9 BROWSING FEATURES|9 BROWSING FEATURES]]== - -==[[10 RETARGETING THROUGH PICK-AND-DROP|10 RETARGETING THROUGH PICK-AND-DROP]]== - -==[[11 RECOMPILING AND EDITING|11 RECOMPILING AND EDITING]]== - -==[[12 HANDLING SYNTAX AND VALIDITY ERRORS|12 HANDLING SYNTAX AND VALIDITY ERRORS]]== - -==[[13 DEBUGGING AND RUN-TIME MONITORING|13 DEBUGGING AND RUN-TIME MONITORING]]== - -==[[14 COMPUTING PROJECT METRICS|14 COMPUTING PROJECT METRICS]]== - -==[[15 GRAPHICS-BASED DESIGN|15 GRAPHICS-BASED DESIGN]]== - -==[[16 HOW EIFFELSTUDIO COMPILES|16 HOW EIFFELSTUDIO COMPILES]]== - -==[[17 THE COMMAND-LINE COMPILER|17 THE COMMAND-LINE COMPILER]]== - -==[[18 EXECUTING A SYSTEM WITHIN AND WITHOUT EIFFELSTUDIO|18 EXECUTING A SYSTEM WITHIN AND WITHOUT EIFFELSTUDIO]]== - -==[[19 APPENDIX: WRITING DOCUMENTATION FILTERS WITH EFF, THE EIFFEL FILTER FORMAT|19 APPENDIX: WRITING DOCUMENTATION FILTERS WITH EFF, THE EIFFEL FILTER FORMAT]]== -
- - +This is a guided tour of Eiffel Software's EiffelStudio interactive software development environment. diff --git a/documentation/current/eiffelstudio/eiffelstudio-guided-tour/look-project-directory.wiki b/documentation/current/eiffelstudio/eiffelstudio-guided-tour/look-project-directory.wiki index ca99271b..58ca08ef 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-guided-tour/look-project-directory.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-guided-tour/look-project-directory.wiki @@ -16,7 +16,7 @@ In this simple Tour, things have been set up so that all the files of interest,
[[Image:index-7]] [[general/guided_tour/studio/index-7.png|(link)]]
The contents of this YOURDIR directory include the following: * First you see a number of files with the extension . e , for "Eiffel": heir.e , invalid.e and others. These are the Eiffel source files, each containing one class. The recommended convention is to store a class of name CLASS_NAME into a file of name class_name .e , where class_name is the lower-case version of CLASS_NAME ; here, file heir.e contains the class HEIR and so on. As you may remember, Eiffel is case-insensitive, but the standard convention for class names is to write them in all upper case. Calling the file class_name .e is only a recommendation, not an obligation; but you are required to store one class per file. This keeps things simple and facilitates project and configuration management. -* You also notice a file with an ecf extension. This is the configuration file that specifies this project. As you remember, the ECF file for this example was available as part of the delivery; we used it to compile the project. In most practical cases, however, you won't need to build an ECF; if you use the " Create project " option of EiffelStudio (remember the first screen [[EiffelStudio General: A Guided Tour|here]] ), EiffelStudio will build the ECF for you; if you change the Project Settings during a session, EiffelStudio will update the ECF. ECF are written in a xml notation. +* You also notice a file with an ecf extension. This is the configuration file that specifies this project. As you remember, the ECF file for this example was available as part of the delivery; we used it to compile the project. In most practical cases, however, you won't need to build an ECF; if you use the " Create project " option of EiffelStudio, EiffelStudio will build the ECF for you; if you change the Project Settings during a session, EiffelStudio will update the ECF. ECF are written in a xml notation. * Finally you will notice a subdirectory called EIFGENs , for " EIF fel GEN erations". EIFGENs is created and maintained by the compiler to store information about your project, including generated code for execution. EiffelStudio manages your project in such a way that EIFGENs can always be re-generated if need be; this means in particular that if things go wrong for any reason and you want to make a fresh start you can always delete this directory and recompile your system. This also means that you should not add any files into this directory, or modify any of its files, since a later compilation is free to change or regenerate whatever it chooses in EIFGENs . Later on, we will see that EiffelStudio may generate three more subdirectories of the project directory: Diagrams , if you produce graphical system diagrams; Documentation , if you request system documentation, for example HTML; and Metrics , if you perform measurements on your system. Other than these directories, EIFGENs EiffelStudio will not touch anything in the project directory, so you may safely add and change whatever files and subdirectories you like. diff --git a/documentation/current/eiffelstudio/eiffelstudio-how-tos/index.wiki b/documentation/current/eiffelstudio/eiffelstudio-how-tos/index.wiki index 5e0422b6..b2dbd1e1 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-how-tos/index.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-how-tos/index.wiki @@ -1,15 +1,7 @@ [[Property:title|EiffelStudio How To's]] [[Property:weight|-1]] [[Property:uuid|10d806ce-5b43-26a5-6f0e-23b3b2faa2ed]] -* [[EiffelStudio: Starting a project|Starting a project]] -* [[Browsing|Browsing]] -* [[Editing a project|Editing a project]] -* [[Compiling|Compiling]] -* [[Running and debugging|Running and debugging]] -* [[Designing a project|Designing a project]] -* [[How to analyze a project|Analysing a project]] -* [[Generating documentation|Generating documentation]] -* [[Customizing EiffelStudio|Customizing]] +This chapter contains instructions for accomplishing some of the most commonly required tasks in EiffelStudio. diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/index.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/index.wiki index 31db6ac0..fabf7988 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/index.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/index.wiki @@ -1,24 +1,7 @@ [[Property:title|EiffelStudio Reference]] [[Property:weight|2]] [[Property:uuid|e34647c8-840e-159d-74b3-07353a27472e]] -* [[EiffelStudio Introduction|EiffelStudio Introduction]] -* [[Release notes for EiffelStudio 6.2|What's new in EiffelStudio 6.2]] -* [[EiffelStudio: General interface description|General interface description]] -* [[Browsing tools|Browsing tools]] -* [[EiffelStudio Editor|EiffelStudio Editor]] -* [[EiffelStudio: Project settings window|Project settings]] -* [[Compiler|Compiler]] -* [[EiffelStudio Debugger|EiffelStudio Debugger]] -* [[Error List Tool|Error List Tool]] -* [[Diagram tool|Diagram tool]] -* [[Metrics tool|Metrics tool]] -* [[Console tool|Console tool]] -* [[C Output tool|C Output tool]] -* [[Wizards and dialogs|Wizards and dialogs]] -* [[Formatted information about compiled classes and features|Formatted information about compiled classes and features]] -* [[EiffelStudio Preferences|Preferences]] -* [[Command line|Command line]] - +This EiffelStudio reference chapter contains technical information about many technical aspects of the EiffelStudio product. diff --git a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-freebsd.wiki b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-freebsd.wiki index 4a64244f..0a08d4b5 100644 --- a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-freebsd.wiki +++ b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-freebsd.wiki @@ -116,7 +116,7 @@ Most of the examples require that you have a precompiled version of EiffelBase. ===Starting EiffelStudio=== -Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio General: A Guided Tour|the guided tour]] . +Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio: A Guided Tour|the guided tour]] . ===EiffelStudio Appearance=== diff --git a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-hp-tru64-unix.wiki b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-hp-tru64-unix.wiki index 685571fa..6907a625 100644 --- a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-hp-tru64-unix.wiki +++ b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-hp-tru64-unix.wiki @@ -116,7 +116,7 @@ Most of the examples require that you have a precompiled version of EiffelBase. ===Starting EiffelStudio=== -Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio General: A Guided Tour|the guided tour]] . +Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio: A Guided Tour|the guided tour]] . ===EiffelStudio Appearance=== diff --git a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-hp-ux.wiki b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-hp-ux.wiki index 8bd46717..dcee2f77 100644 --- a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-hp-ux.wiki +++ b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-hp-ux.wiki @@ -116,7 +116,7 @@ Most of the examples require that you have a precompiled version of EiffelBase. ===Starting EiffelStudio=== -Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio General: A Guided Tour|the guided tour]] . +Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio: A Guided Tour|the guided tour]] . ===EiffelStudio Appearance=== diff --git a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-linux.wiki b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-linux.wiki index 9ce14417..fc0d568d 100644 --- a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-linux.wiki +++ b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-linux.wiki @@ -116,7 +116,7 @@ Most of the examples require that you have a precompiled version of EiffelBase. ===Starting EiffelStudio=== -Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio General: A Guided Tour|the guided tour]] . +Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio: A Guided Tour|the guided tour]] . ===EiffelStudio Appearance=== diff --git a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-linuxppc.wiki b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-linuxppc.wiki index b21b35a5..70a8c991 100644 --- a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-linuxppc.wiki +++ b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-linuxppc.wiki @@ -116,7 +116,7 @@ Most of the examples require that you have a precompiled version of EiffelBase. ===Starting EiffelStudio=== -Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio General: A Guided Tour|the guided tour]] . +Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio: A Guided Tour|the guided tour]] . ===EiffelStudio Appearance=== diff --git a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-mac-os-x.wiki b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-mac-os-x.wiki index f0972521..36e7b0ea 100644 --- a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-mac-os-x.wiki +++ b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-mac-os-x.wiki @@ -70,7 +70,7 @@ This probably means that the '''register''' program was not launched or did not ==Starting EiffelStudio== -Now everything should be properly installed and you should be able to run the compiler. You can now launch EiffelStudio from the Finder under '''/Developer/Applications/Eiffel62/'''. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio General: A Guided Tour|the guided tour]] . +Now everything should be properly installed and you should be able to run the compiler. You can now launch EiffelStudio from the Finder under '''/Developer/Applications/Eiffel62/'''. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio: A Guided Tour|the guided tour]] . diff --git a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-sgi-irix.wiki b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-sgi-irix.wiki index c78cac87..1bb12a19 100644 --- a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-sgi-irix.wiki +++ b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-sgi-irix.wiki @@ -119,7 +119,7 @@ Most of the examples require that you have a precompiled version of EiffelBase. ===Starting EiffelStudio=== -Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio General: A Guided Tour|the guided tour]] . +Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio: A Guided Tour|the guided tour]] . ===EiffelStudio Appearance=== diff --git a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-solaris.wiki b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-solaris.wiki index 838bc565..3e3314b1 100644 --- a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-solaris.wiki +++ b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/eiffelstudio-solaris.wiki @@ -116,7 +116,7 @@ Most of the examples require that you have a precompiled version of EiffelBase. ===Starting EiffelStudio=== -Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio General: A Guided Tour|the guided tour]] . +Now everything should be properly installed and you should be able to run the compiler. Launch '''estudio''' for the interactive graphical user interface of the compiler, or launch '''ec''' for the command line interface. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio: A Guided Tour|the guided tour]] . ===EiffelStudio Appearance=== diff --git a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/windows.wiki b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/windows.wiki index af47cdd5..0f24d441 100644 --- a/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/windows.wiki +++ b/documentation/current/eiffelstudio/software-installation/software-installation-eiffelstudio/windows.wiki @@ -66,7 +66,7 @@ EiffelStudio will not run on Windows 95, 98 and Me. Contact Eiffel Software dire ==Starting EiffelStudio== -Now everything should be properly installed and you should be able to run the compiler. You can now launch EiffelStudio from the Start menu or from the EiffelStudio shortcut on your desktop. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio General: A Guided Tour|the guided tour]] . +Now everything should be properly installed and you should be able to run the compiler. You can now launch EiffelStudio from the Start menu or from the EiffelStudio shortcut on your desktop. If you are a new user to EiffelStudio, we recommend that you follow [[EiffelStudio: A Guided Tour|the guided tour]] .