Check-in [be09eb6de2]
Not logged in

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Some documentation changes. The precompiled files has been removed from the repository.
Timelines: family | ancestors | HelpServer
Files: files | file ages | folders
SHA1:be09eb6de2c5dbd5c9479a8cf476d50262a032fa
User & Date: johnfound 2015-12-02 12:27:35
Context
2015-12-02
12:27
Some documentation changes. The precompiled files has been removed from the repository. Leaf check-in: be09eb6de2 user: johnfound tags: HelpServer
2014-03-18
13:01
Added some example files and some code has been fixed. check-in: 383eee6465 user: johnfound tags: HelpServer
Changes

Deleted phWeb/phWeb.

cannot compute difference between binary files

Changes to phWeb/phWeb.conf.

1
2
3
4
Binding.BindIP   = $7f000001
Binding.BindPort = 7000

WebSite.DocumentRoot = "./www"

|


1
2
3
4
Binding.BindIP   = $7f000001
Binding.BindPort = 8080

WebSite.DocumentRoot = "./www"

Deleted phWeb/phWeb.exe.

cannot compute difference between binary files

Changes to phWeb/phWeb.fpr.

cannot compute difference between binary files

Deleted phWeb/phWeb.kex.

cannot compute difference between binary files

Changes to phWeb/www/help.css.

cannot compute difference between binary files

Changes to phWeb/www/index.md.

1
2
3
4
5
6
7

8
9
10
11





Fresh IDE help index.

# Fresh IDE help system.

This is the main index of the Fresh IDE help system. The following documents are available:

  [advanced_setup.md][Fresh IDE advanced setup guide.]


  [FreshLibRef.md][FreshLib programmers reference.]

  [FreshLibUserGuide.md][FreshLib user guide.]











|
>
|
|
|
|
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Fresh IDE help index.

# Fresh IDE help system.

This is the main index of the Fresh IDE help system. The following documents are available:

  [advanced_setup.md][Fresh IDE advanced setup guide] - How to install properly Fresh IDE in
Windows and Linux in order to get the best performance.

  [FreshLibRef.md][FreshLib programmers reference] - Reference manual for FreshLib.

  [FreshLibUserGuide.md][FreshLib user guide] - User guide explaining how to use FreshLib for
portable programming in assembly language.

  [tips.md][Fresh IDE tips and tricks] - How to use Fresh IDE for the best programming results.

  [FASM.html][Flat assembler programmers manual] - The full description of FASM syntax.

Changes to phWeb/www/tips.md.

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
..
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
...
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
...
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
The upcoming v3.0.0 is planed to be portable - for Windows and Linux. Of course every port
will be able to create applications for every OS.

    Despite of this situation, even the current versions can work in Linux through Wine.

    There is a separate [setup][setup manual] describing the setup of Fresh IDE for Linux development.

[setup] 0_advanced_setup.htm

## Goto address

    How to find the place in the source where application crashes?

    Press Ctrl+G in order to open "Goto address" dialog:

................................................................................

## Code exploration and cross reference.

There are several functions, aimed to provide easy exploration the source of the big project.

### Labels explorer

After compilation, you can browse all labels tree from the labels explorer. Open it from the 
main menu: `Project|Label explorer`.
In the label explorer you can view the lables values, type and where in the source these labels 
was defined and used.

### Editor cross reference

If you position the text caret on some label and press Ctrl+R, or choose from context menu 
"Cross reference", a window with the cross reference information for this label will be open.

          [!cross][Cross reference]

The first row of the table display the line of the source, label was defined. 
Following rows - the lines where the label is used. Besides the pointed label, all its 
children labels will be displayed.s

If you double click on some of the rows, the editor will bring you to this line of source.

The cross reference window can be closed by pressing *Esc* key.

## Goto definition

If you position the text caret on some symbol and press *Ctrl+D* or choose from the context menu 
"Goto definition", the editor will bring you to the line of the source where this symbol were 
defined.
The project must be compiled for this function to work.

## Embeded help

Similar to "Goto definition" is the next function "Embeded help". 

If the definition of some symbol is preceded by comments block, describing this symbol, Fresh can
show this description everywhere in the source, when you position the text caret on the symbol and
press *Ctrl+W* shortcut. 

The hint window looks like on the screenshot:

                    [!_images/EmbededHelp.png][Embeded help system]

The hint window can be closed by pressing *Esc* key.

................................................................................
move it to the current selected category.

## Fast open files

    How to open the file specified in "include" or "file" directive?

    Place the caret on the line that contains file name and press Ctrl+Enter.
    Opening files this way, Fresh replace the directory aliases and/or environment 
variables in the filename.

    Files like `%lib%/%TargetOS%/MyFile.asm` will be opened correctly.

## Directory aliases

    How to set promptly the values of the environment variables?
................................................................................
but even now it allows creating of small applications that can be compiled for Win32 and Linux platforms
without change of the source.

    Read the unfinished [FreshLibRef][FreshLib reference manual]
and check the sources of FreshLib in "Fresh/freshlib" directory of your Fresh IDE installation.
There is a working test project called TestFreshLib.fpr that I use to test different FreshLib features.

Also, you can create FreshLib projects from template engine. Choose "File|New Application" from the 
main menu or press *Shift+Ctrl+N* shortcut. 

In the dialog window, select the target directory and application template - 
"FreshLib portble console application" or "FreshLib portable GUI application", 
then click *"OK"* and new project will be created.

Press *Shift+Ctrl+S* to save all new created files (you can change the filenames to whatever you like).

Then you can compile your application to Linux or Windows executable file.

The latest development version of FreshLib can be downloaded from the [rep][repository] - *FreshLibDev* branch.

[FreshLibRef] 2_FreshLibDoc.htm

[rep] http://chiselapp.com/user/johnfound/repository/FreshIDE/
        
[!goto] _images/goto.png

[!procarg] _images/ProcArgumentsHint.png

[!code] _images/CodeCompletion.png

[!alias] _images/AliasFastChange.png

[!cross] _images/CrossReference.png







|







 







|

|




|




|
|








|
|





|



|







 







|







 







|
|

|
|








|


|









18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
..
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
...
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
...
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
The upcoming v3.0.0 is planed to be portable - for Windows and Linux. Of course every port
will be able to create applications for every OS.

    Despite of this situation, even the current versions can work in Linux through Wine.

    There is a separate [setup][setup manual] describing the setup of Fresh IDE for Linux development.

[setup] advanced_setup.md

## Goto address

    How to find the place in the source where application crashes?

    Press Ctrl+G in order to open "Goto address" dialog:

................................................................................

## Code exploration and cross reference.

There are several functions, aimed to provide easy exploration the source of the big project.

### Labels explorer

After compilation, you can browse all labels tree from the labels explorer. Open it from the
main menu: `Project|Label explorer`.
In the label explorer you can view the lables values, type and where in the source these labels
was defined and used.

### Editor cross reference

If you position the text caret on some label and press Ctrl+R, or choose from context menu
"Cross reference", a window with the cross reference information for this label will be open.

          [!cross][Cross reference]

The first row of the table display the line of the source, label was defined.
Following rows - the lines where the label is used. Besides the pointed label, all its
children labels will be displayed.s

If you double click on some of the rows, the editor will bring you to this line of source.

The cross reference window can be closed by pressing *Esc* key.

## Goto definition

If you position the text caret on some symbol and press *Ctrl+D* or choose from the context menu
"Goto definition", the editor will bring you to the line of the source where this symbol were
defined.
The project must be compiled for this function to work.

## Embeded help

Similar to "Goto definition" is the next function "Embeded help".

If the definition of some symbol is preceded by comments block, describing this symbol, Fresh can
show this description everywhere in the source, when you position the text caret on the symbol and
press *Ctrl+W* shortcut.

The hint window looks like on the screenshot:

                    [!_images/EmbededHelp.png][Embeded help system]

The hint window can be closed by pressing *Esc* key.

................................................................................
move it to the current selected category.

## Fast open files

    How to open the file specified in "include" or "file" directive?

    Place the caret on the line that contains file name and press Ctrl+Enter.
    Opening files this way, Fresh replace the directory aliases and/or environment
variables in the filename.

    Files like `%lib%/%TargetOS%/MyFile.asm` will be opened correctly.

## Directory aliases

    How to set promptly the values of the environment variables?
................................................................................
but even now it allows creating of small applications that can be compiled for Win32 and Linux platforms
without change of the source.

    Read the unfinished [FreshLibRef][FreshLib reference manual]
and check the sources of FreshLib in "Fresh/freshlib" directory of your Fresh IDE installation.
There is a working test project called TestFreshLib.fpr that I use to test different FreshLib features.

Also, you can create FreshLib projects from template engine. Choose "File|New Application" from the
main menu or press *Shift+Ctrl+N* shortcut.

In the dialog window, select the target directory and application template -
"FreshLib portble console application" or "FreshLib portable GUI application",
then click *"OK"* and new project will be created.

Press *Shift+Ctrl+S* to save all new created files (you can change the filenames to whatever you like).

Then you can compile your application to Linux or Windows executable file.

The latest development version of FreshLib can be downloaded from the [rep][repository] - *FreshLibDev* branch.

[FreshLibRef] FreshLibRef.md

[rep] http://chiselapp.com/user/johnfound/repository/FreshIDE/

[!goto] _images/goto.png

[!procarg] _images/ProcArgumentsHint.png

[!code] _images/CodeCompletion.png

[!alias] _images/AliasFastChange.png

[!cross] _images/CrossReference.png