syntax:labels

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
syntax:labels [2015/12/01 18:21] – [navigation] adminsyntax:labels [2018/01/10 20:43] (current) – external edit 127.0.0.1
Line 12: Line 12:
  
  
-Labels give you a way fo quick navigation inside the document with [[view:pane:navigation|Navigation Bar]] (can be also called as Function List). It can be as a method or function definition, as include definition. Generally it can be any part of the code you want to refer.\\ +Labels give you a way fo quick navigation inside the document with [[view:pane:navigation|Navigation Bar]] (can be also called as Function List). It can be a method, a function definition, or an include definition. Generally, it can be any part of the code you want to refer.\\ 
 Labels are described with help of regular expression.\\  Labels are described with help of regular expression.\\ 
-HippoEDIT uses BOOST regular expression engine, which use [[http://www.boost.org/doc/libs/1_50_0/libs/regex/doc/html/boost_regex/syntax/perl_syntax.html|Perl regular expression syntax]].\\ +HippoEDIT uses BOOST regular expression engine, which uses [[http://www.boost.org/doc/libs/1_61_0/libs/regex/doc/html/boost_regex/syntax/perl_syntax.html|Perl regular expression syntax]].\\ 
 For testing of the label definition I am using [[http://regexlib.com/RETester.aspx|RegexLib service]]. For testing of the label definition I am using [[http://regexlib.com/RETester.aspx|RegexLib service]].
  
Line 24: Line 24:
  
 ==== match ==== ==== match ====
-Regular expression describing the label. Expression can be multi line and greedy. You can use sub matches (grouping) for later referring.+A regular expression describing the label. The expression can be a multi line and greedy. You can use sub matches (grouping) for later referring.
  
 Value: //any valid regular expression//. :!: - obligatory Value: //any valid regular expression//. :!: - obligatory
Line 39: Line 39:
  
 ==== descr_match ==== ==== descr_match ====
-Additional regular expression for better resolving of the description. Applied to result of the match. If exist, results of //descr_match// would be used for description back references. +The additional regular expression for better resolving of the description. Applied to the result of the match. If exist, results of //descr_match// would be used for description back references. 
  
 Value: //any valid regular expression// Value: //any valid regular expression//
Line 50: Line 50:
  
 ==== sub_image ==== ==== sub_image ====
-Sub image associated with label (image drawn on top of main image). Usually used for visualization of label visibility (public, protected, private). +Sub-image associated with the label (image drawn on top of the main image). Usually used for visualization of label visibility (public, protected, private). 
  
 Value: //[[syntax:images|enumeration from 2 till 4]]//\\ Value: //[[syntax:images|enumeration from 2 till 4]]//\\
Line 60: Line 60:
   * **1** - label includes relevant scope start,    * **1** - label includes relevant scope start, 
   * **2** - scope includes relevant scope end.    * **2** - scope includes relevant scope end. 
-If label is related to scope (1|2) HippoEDIT would try to find appropriate scope and associate label with it. Then you would see label description as name of the scope while navigating in [[view:pane:navigation|Navigation Bar]] and in [[editing:navigation:scroll|Scroll Info Tip]]. +If the label is related to scope (1|2) HippoEDIT would try to find the appropriate scope and associated label with it. Then you would see label description as the name of the scope while navigating in [[view:pane:navigation|Navigation Bar]] and in [[editing:navigation:scroll|Scroll Info Tip]]. 
  
 Value: //0|1|2//\\ Value: //0|1|2//\\
Line 66: Line 66:
  
 ==== navigation ==== ==== navigation ====
-If set, then label would not be shown in [[view:pane:navigation|Navigation Bar]], but would be used in [[editing:navigation:smart_navigate|Smart Navigate]] and when Go button pressed in [[view:pane:navigation|Navigation Bar]]. For example to navigate to include file. +If set, then label would be used in [[editing:navigation:smart_navigate|Smart Navigate]] and when Go button pressed in [[view:pane:navigation|Navigation Bar]]. For example to navigate to include file or to definition of label. 
  
  
Line 73: Line 73:
  
 ==== visible ==== ==== visible ====
-Indicates, if label shall be shown in description field of [[view:pane:navigation|Navigation Bar]] if you place cursor on it in text editor. Works as //navigation// flag for rest. Can be used if you use label only for highlighting purposes. +Indicates, if label shall be shown in the description field of [[view:pane:navigation|Navigation Bar]] when you place the cursor on it in the text editor. Works as //navigation// flag for rest. Can be used if you use label only for highlighting purposes. 
  
 Value: //true|false//\\ Value: //true|false//\\
Line 79: Line 79:
  
 ==== marker ==== ==== marker ====
-Defines image id to be shown on indicator margin in-front of label. Image id corresponds to image number for one of margin icons. Used for example, for displaying scope exits indicators.+Defines image id to be shown on indicator margin on the front of the label. Image id corresponds to image number for one of margin icons. Used for example, for displaying scope exits indicators.
  
 Value: //[-1..20]//\\ Value: //[-1..20]//\\
Line 164: Line 164:
  
 === in === === in ===
-Regular expression with back references to extract label part to be highlighted as keyword. If not defined, //highlight// attribute used for extracting. If //highlight// attribute is empty, whole matched label text used for processing.+Regular expression with back references to extract label part to be highlighted as keyword. If not defined, //highlight// attribute used for extracting. If //highlight// attribute is empty, //name// attribute is used for processing. If //all// and //first// attributes are empty/not defined, whole value of //in// (after appliying to match) used as keyword.
  
 === all === === all ===
Line 176: Line 176:
  
 ==== global ==== ==== global ====
-Indicates, that keywords are global, and shall be used in whole document, independent from scope. Currently only **true** value is supported.+Indicates, that keywords are global and shall be used in a whole document, independent from the scope. Currently, only **true** value is supported.
  
 ===== Containers ===== ===== Containers =====
 To restrict label for some style, you can also use [[syntax:containers|Containers]] node inside Label node. To restrict label for some style, you can also use [[syntax:containers|Containers]] node inside Label node.
 <code xml><Containers open="preprocessor"/></code> <code xml><Containers open="preprocessor"/></code>