ui: tutorial adjustments
* adjusted the start of the tutorial to work with the "overview" filter. * fixes some spelling errors in the tutorial. * tabs can be encoded by "\\t" in the project description.
This commit is contained in:
@@ -7,7 +7,7 @@
|
||||
//------------------------------------------------------------------------------
|
||||
//
|
||||
// 1 - THE CODE TUTORIAL
|
||||
// As you already know the code view displays the snippets of code that are
|
||||
// As you already know the Code View displays the snippets of code that are
|
||||
// related to your currently active symbol. These snippets show the relevant
|
||||
// lines in combination with some context.
|
||||
// In case you discover something interesting as part of the snippet's context
|
||||
|
||||
@@ -37,9 +37,9 @@ void function_with_snippets()
|
||||
// 9 - EDIT YOUR CODE
|
||||
// In case you wondered if you can edit your code using Coati: You can't. Coati
|
||||
// is designed for code exploration, not as a text editor or an IDE. But there
|
||||
// is a chance that Coati can talk to your favourite editor (that you already
|
||||
// is a chance that Coati can talk to your favorite editor (that you already
|
||||
// know how to operate) via plugin. For more information about available
|
||||
// plugins please take a look at Coati's user manual.
|
||||
// plugins please take a look at Coati's documentation.
|
||||
//
|
||||
// We hope you enjoyed this tutorial. You can follow the call below to get back
|
||||
// to the central hub.
|
||||
@@ -51,6 +51,7 @@ void function_with_snippets()
|
||||
//
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
|
||||
the_central_hub();
|
||||
|
||||
|
||||
|
||||
@@ -19,10 +19,11 @@ public:
|
||||
// You completed the tutorial on the graph view. There is still more to learn
|
||||
// but I guess you will figure it out on your own. One last thing: If you see
|
||||
// an element with a hatched background please call us. It's a runaway!
|
||||
// Just kidding. Those are elements that are used within your code, but without
|
||||
// a definition anywhere in your source folder. So if you click them, Coati
|
||||
// will display all the relations for the element, but the code view won't show
|
||||
// a definition. If you want to learn more about Coati, go back to the central
|
||||
// Just kidding. Those are elements that are used within your code, but have no
|
||||
// definition anywhere in your source folder (like the "int" symbol on the
|
||||
// right hand side of the graph). So if you click them, Coati will display
|
||||
// all the relations for the element, but the code view won't show a
|
||||
// definition. If you want to learn more about Coati, go back to the central
|
||||
// hub. It is called in the function below but you can also try to get there
|
||||
// using only the graph.
|
||||
//
|
||||
|
||||
@@ -6,18 +6,10 @@
|
||||
|
||||
//------------------------------------------------------------------------------
|
||||
//
|
||||
// WHAT IS THIS?
|
||||
// This is a tutorial and it is one of the fastest ways to get to know Coati.
|
||||
//
|
||||
// WHERE AM I?
|
||||
// This is Coati's Code View and you are looking at the main function of this
|
||||
// project's program.
|
||||
//
|
||||
// WHY AM I HERE?
|
||||
// Every time you open up a project in Coati it will look for a function called
|
||||
// "main". In case this function is defined it will be displayed right away.
|
||||
// Otherwise Coati will just activate the first thing in your codebase it
|
||||
// happens to stumble across.
|
||||
// WHAT IS THIS?
|
||||
// Now the Code View finally shows some real code of the tutorial project.
|
||||
// And who could think of a better place to start a tutorial that involves
|
||||
// code than a main function?
|
||||
//
|
||||
// WHAT CAN I DO NOW?
|
||||
// Left-click the "my_first_step()" function call inside the main function.
|
||||
|
||||
@@ -2,7 +2,19 @@
|
||||
<config>
|
||||
<info>
|
||||
<description>
|
||||
This is the tutorial project of Coati.\nIt will introduce you to Coati's user interface.\nPlease click on the function [main] below to start the tutorial\n\n[main](); // <- start here\n\n
|
||||
WHAT IS THIS?\n
|
||||
\tThis is a tutorial and it is one of the fastest ways to get to know Coati.\n
|
||||
\n
|
||||
WHERE AM I?\n
|
||||
\tYou're looking at Coati's Code View which usually displays source code,\n
|
||||
\tbut every time a new project is loaded it gives a quick summary to\n
|
||||
\testimate the project's size. This is a fairly small project. It only\n
|
||||
\tcontains a few hundred lines of code as you can see by the numbers below.\n
|
||||
\n
|
||||
LET'S GET STARTED!\n
|
||||
\tTo keep things simple just click the "main" symbol below to start the tour.\n
|
||||
\n
|
||||
[main](); // <- start here\n\n
|
||||
</description>
|
||||
</info>
|
||||
<source>
|
||||
|
||||
Reference in New Issue
Block a user