Skip to content

Commit 711ce97

Browse files
author
César Cardoso
committed
2 parents dde8e4a + f2a60e9 commit 711ce97

File tree

2 files changed

+29
-40
lines changed

2 files changed

+29
-40
lines changed

‎README.en.md

+17-24
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,6 @@
22
[![Static Badge](https://img.shields.io/badge/Portugu%C3%AAs-(ptBR)-green)](https://github.com/Code4Delphi/help-insight-delphi)
33
[![Static Badge](https://img.shields.io/badge/English-(en)-red)](https://github.com/Code4Delphi/help-insight-delphi/blob/master/README.en.md)
44

5-
6-
# Help Insight **Delphi**
7-
8-
<!--<p align="center">
9-
<img alt="Code4Delphi" height="100" src="https://github.com/Code4Delphi/diretivas-de-compilacao-delphi/assets/33873267/7191065f-96f6-46ed-aae4-4c4d3027b717">
10-
</p> -->
11-
12-
Help Insight, a feature of the Delphi IDE that displays a popup with a brief description of the identifier (class, procedure, function, variable, constant, enumerated...) on which the mouse cursor is positioned.
13-
14-
In this repository/article we will see how to create and customize Help Insight for our applications.
15-
165
## 📞 Contacts
176

187
<p align="left">
@@ -33,10 +22,11 @@ In this repository/article we will see how to create and customize Help Insight
3322
</a>
3423
</p>
3524

36-
## WHAT IS IT HELP INSIGHT?
37-
Help Insight is a feature of the Delphi IDE that presents a popup with a brief description of the identifier (class, procedure, function, variable, Enumerated, ...) at which the mouse cursor is positioned in the Code Editor.
38-
It is also possible to invoke Help Insight by pressing the CTRL + SHIFT + H keys.
25+
# Help Insight **Delphi**
26+
27+
Help Insight, a feature of the Delphi IDE that displays a popup with a brief description of the identifier (class, procedure, function, variable, constant, enumerated...) at which the mouse cursor is positioned in the Code Editor. It is also possible to invoke Help Insight by pressing the CTRL + SHIFT + H keys.
3928

29+
In this repository/article we will see how to create and customize Help Insight for our applications.
4030

4131
<br/>
4232

@@ -145,21 +135,23 @@ These comments must be immediately above the identifier, and must begin with **/
145135
```
146136
<c> Texto com fonte de largura fixa (Courier New) </c>
147137
```
148-
* Reference to a specific type, symbol or identifier:
138+
Reference to a specific type, symbol or identifier:
149139
```
150140
<see cref="string"/>
151141
```
152142

143+
<br/>
144+
153145
## WHERE CAN HELP INSIGHT BE USED?
154-
* Help Insight can be used in:
146+
Help Insight can be used in:
155147

156-
- [x] Classes
157-
- [x] Procedures
158-
- [x] Functions
159-
- [x] Constantes
160-
- [x] Enumerados
161-
- [x] Instance variables (declared in the private, protected, public or published scope of the classes)'
162-
- [ ] Local variables **ARE NOT SUPPORTED** by Help Insight
148+
✔️ Classes <br/>
149+
✔️ Procedures <br/>
150+
✔️ Functions <br/>
151+
✔️ Constantes <br/>
152+
✔️ Enumerados <br/>
153+
✔️ Instance variables (declared in the private, protected, public or published scope of the classes) <br/>
154+
❌ Local variables **ARE NOT SUPPORTED** by Help Insight
163155

164156
<br/>
165157

@@ -175,9 +167,10 @@ C:\Program Files (x86)\Embarcadero\Studio\20.0\ObjRepos\en\HelpInsight.css
175167
C:\Program Files (x86)\Embarcadero\Studio\20.0\ObjRepos\en\HelpInsight_Dark.css
176168
```
177169

178-
* Here's an example of how we can change the structure and layout of the Help Insight popup:
170+
Here's an example of how we can change the structure and layout of the Help Insight popup:
179171
![PopupMenu-Alterado.png](https://github.com/Code4Delphi/help-insight-delphi/blob/master/Images/PopupMenu-Alterado.png)
180172

173+
<br/>
181174

182175
## 🔗USEFUL LINKS
183176
- [Help Insight (docwiki embarcadero)](https://docwiki.embarcadero.com/RADStudio/Athens/en/Help_Insight)

‎README.md

+12-16
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
1-
### Alterar idioma
2-
[![Static Badge](https://img.shields.io/badge/Portugu%C3%AAs-(ptBR)-green)](https://github.com/Code4Delphi/help-insight-delphi)
3-
[![Static Badge](https://img.shields.io/badge/English-(en)-red)](https://github.com/Code4Delphi/help-insight-delphi/blob/master/README.en.md)
4-
5-
61
# Help Insight **Delphi**
72

8-
<!--<p align="center">
9-
<img alt="Code4Delphi" height="100" src="https://github.com/Code4Delphi/diretivas-de-compilacao-delphi/assets/33873267/7191065f-96f6-46ed-aae4-4c4d3027b717">
10-
</p> -->
11-
12-
Help Insight, um recurso do IDE do Delphi que exibe um popup com uma breve descrição sobre o identificador (classe, procedure, function, variável, constante, enumerado ...) na qual o cursor do mouse está posicionado.
13-
14-
Veremos neste repositório/artigo criar e personalizar Help Insight para nassas aplicações.
3+
## Alterar idioma
4+
[![Static Badge](https://img.shields.io/badge/Portugu%C3%AAs-(ptBR)-green)](https://github.com/Code4Delphi/help-insight-delphi)
5+
[![Static Badge](https://img.shields.io/badge/English-(en)-red)](https://github.com/Code4Delphi/help-insight-delphi/blob/master/README.en.md)
156

16-
## 📞 Contatos
7+
## Contatos
178

189
<p align="left">
1910
<a href="https://t.me/Code4Delphi" target="_blank">
@@ -34,9 +25,10 @@ Veremos neste repositório/artigo criar e personalizar Help Insight para nassas
3425
</p>
3526

3627
## O QUE É HELP INSIGHT?
37-
Help Insight, é um recurso do IDE do Delphi que apresenta um popup com uma breve descrição sobre o identificador (classe, procedure, function, variável, Enumerado, ...) a qual o cursor do mouse está posicionado no Editor de Códigos.
38-
Também é possível invocar o Help Insight precionando as teclas CTRL + SHIFT + H.
3928

29+
Help Insight (informações de ajuda), um recurso do IDE do Delphi que exibe um popup com uma breve descrição sobre o identificador (classe, procedure, function, variável, constante, enumerado...) a qual o cursor do mouse está posicionado no Editor de Códigos. Também é possível invocar o Help Insight precionando as teclas CTRL + SHIFT + H
30+
31+
Veremos neste repositório/artigo criar e personalizar Help Insight para nossas aplicações.
4032

4133
<br/>
4234

@@ -150,6 +142,8 @@ Referência a um tipo, símbolo ou identificador específico:
150142
<see cref="string"/>
151143
```
152144

145+
<br/>
146+
153147
## ONDE O HELP INSIGHT PODE SER USADO?
154148
Help Insight podem ser utilizados em:
155149

@@ -158,9 +152,10 @@ Help Insight podem ser utilizados em:
158152
✔️ Functions <br/>
159153
✔️ Constantes <br/>
160154
✔️ Enumerados <br/>
161-
✔️ Variáveis de instância (declaradas no escopo private, protected, public ou published das classes)' <br/>
155+
✔️ Variáveis de instância (declaradas no escopo private, protected, public ou published das classes) <br/>
162156
❌ Variáveis locais **NÃO SÃO SUPORTADAS** pelo Help Insight
163157

158+
<br/>
164159

165160
## ALTERANDO OS DADOS E LAYOUT DO POPUP
166161
Além de utilizarmos as TAGs disponibilizadas e demonstradas neste artigo, podemos também alterar ou adicionar nossas próprias TAGs XML, assim como alterar o Layout do popup exibido.
@@ -177,6 +172,7 @@ C:\Program Files (x86)\Embarcadero\Studio\20.0\ObjRepos\en\HelpInsight_Dark.css
177172
Veja um exemplo de como podemos alterar a estrutura e o layout do popup do Help Insight:
178173
![PopupMenu-Alterado.png](https://github.com/Code4Delphi/help-insight-delphi/blob/master/Images/PopupMenu-Alterado.png)
179174

175+
<br/>
180176

181177
## 🔗LINKS ÚTEIS
182178
- [Help Insight (docwiki embarcadero)](https://docwiki.embarcadero.com/RADStudio/Athens/en/Help_Insight)

0 commit comments

Comments
 (0)