Mercurial > hg > forks > UniversalIndentGUI

annotate doc/iniFileFormat.html @ 800:ca899a323c52

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Pull in updated changes from Debian package.
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 13 Apr 2018 02:02:06 +0300
parents 24e1fd6d4bfa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
3 <head>
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
5 <title>iniFileFormat</title>
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
6 </head>
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
7 <body>
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
8 <p>
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
9 Fileformat of the UniversalIndentGUI indent description ini files<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
10 =================================================================<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
11 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
12 1. General<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
13 ----------<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
14 The ini file has equal base format as common used ini files. It contains groups, which are written in brackets []. These groups can contain keys, to which a value can be assigned by the equal sign =.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
15 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
16 2. Ini file header<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
17 ------------------<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
18 At the beginning of the ini file the header is located. It is named [header]. In the following a ini file header is shown:<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
19 </p>
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
20 <pre>
477
ce6cd144159d Because no values are written back to the uigui ini files anymore since version 0.8.0, the section/group names are no longer reordered nor renamed. So I do not use a "%20" prepended to the section name "[header]".
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 324
diff changeset
21 [header]
94
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
22 categories=Predefined Style|Tab and Bracket|Indentation|Formatting
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
23 cfgFileParameterEnding=cr
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
24 configFilename=.astylerc
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
25 fileTypes=*.cpp|*.c|*.h|*.hpp|*.cs|*.java
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
26 indenterFileName=astyle
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
27 indenterName=Artistic Style
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
28 inputFileName=indentinput
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
29 inputFileParameter=
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
30 manual=&quot;http://website.of.onlinemanual&quot;
94
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
31 outputFileName=indentinput
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
32 outputFileParameter=none
bfe30adbe595 Merged the QScintilla branch of UniversalIndentGUI into the main trunk. So QScintilla is the used text edit component from now on.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 44
diff changeset
33 parameterOrder=ipo
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
34 stringparaminquotes=false
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
35 useCfgFileParameter=&quot;--options=&quot;
289
aa41b34387ea Updated the ini file documentation.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 207
diff changeset
36 version=1.21
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
37 </pre>
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
38 <p>
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
39 &quot;categories&quot; defines the categories, where each parameter can be assigned to. It is a list of strings, with each category name divied by a &quot;|&quot; from the other.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
40 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
41 &quot;cfgFileParameterEnding&quot; defines how each parameter setting in the indenters config file is seperated from the other. Possible values are &quot;cr&quot; for CarriageReturn or any other string (also space signs, which are normally used if parameters are only set via commandline).<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
42 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
43 &quot;configFilename&quot; is the filename of the indenters default config file. It is used when the indenter is being called and might be explicit handed over as argument by setting the parameter &quot;useCfgFileParameter&quot;. If &quot;configFilename&quot; is left empty, all parameters are set with the commandline call of the indenter. (As needed for csstidy and phpCB for example.)<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
44 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
45 &quot;fileTypes&quot; is a list of fileendings used for the selection in the &quot;open source file&quot; file dialog.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
46 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
47 &quot;indenterFileName&quot; is the name of the indenters executable without any extension. Under linux it is tested, whether only a file with the extension &quot;.exe&quot; exists. If so, wine will be used to call the indenter.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
48 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
49 &quot;indenterName&quot; is the name of the indenter as it will be shown in UniversalIndentGUIs indenters selection. Theoretic it can be any string.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
50 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
51 &quot;inputFileName&quot; defines the file used as input file for the called indenter. It is a copy of the previous opened source code file.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
52 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
53 &quot;inputFileParameter&quot; sets the eventually needed parameter in front of &quot;inputFileName&quot; to tell the indenter and the command line call that the following string is the input file. If set to &quot;none&quot; no special output file will be set.
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
54 If set to &quot;&lt;&quot; or &quot;stdin&quot; the to be formatted source code will be sent to the indenter using the standard input stdin.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
55 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
56 &quot;manual&quot; is a string that points to a website that hosts the indenters online manual.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
57 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
58 &quot;outputFileName&quot; the file name where the indenter writes its formatted source code to. Also the file UniversalIndentGUI reads after the indenter call to show it in the preview. Some times an indenter overwrites the content of the inputfile by default and creates a backup (as AStyle does). In this case &quot;outputFileName&quot; is equal to &quot;inputFileName&quot; but the parameter &quot;outputFileParameter&quot; has to be set to &quot;none&quot;. No output file name will be selected for the indenter but UniversalIndentGUI knows where the output was written to.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
59 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
60 &quot;outputFileParameter&quot; same as for &quot;inputFileParameter&quot; with respect to the special case mentioned for &quot;inputFileParameter&quot; if the input file will be overwritten. If the indenter only writes to standard output (stdout) this value has to be set to &quot;stdout&quot; (see uigui_phpCB.ini). In that case &quot;outputFileName&quot; can be left empty. It will be ignored anyway.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
61 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
62 &quot;parameterOrder&quot; Some indenters need a strict order of the command line parameters for input file, output file and eventually indent settings. &quot;parameterOrder&quot; can be set to &quot;iop&quot;, &quot;ipo&quot; and &quot;pio&quot; to define the order of input, ouput and paramters at the commandline call.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
63 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
64 &quot;stringparaminquotes&quot; tells UniversalIndentGUI that all string values should be written to the indenter config file in quotes.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
65 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
66 &quot;useCfgFileParameter&quot; is the parameter for the indenter used to tell the indenter where to find the config file, set in &quot;configFilename&quot;, that it should use. If this parameter is left empty you should read the indenters manual where it searches by default for the config file.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
67 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
68 &quot;version&quot; is not evaluated by UiGUI, but by this it is easier to see for which version of the indenter the configuration file has been written for.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
69 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
70 3. The indenters parameters<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
71 ---------------------------<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
72 After the header definition the paramters used by the indenter are defined. Each paramter name is written in brackets [] again, but the name is only descriptive and not functional. Each parameter consists of keys with values (same as in header). There are four types of parameters: boolean, numeric, string and multiple. All have the following keys in common:<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
73 &quot;Category&quot; defines to which category they belong and are corresponding only shown there in the GUI.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
74 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
75 &quot;Description&quot; holds a text describing the parameter and it options. It is formatted as html, so source code examples can be embedded via &lt;pre&gt;&lt;/pre&gt; for example. This text is shown as tool tip for each parameter.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
76 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
77 &quot;EditorType&quot; defines whether the parameter is boolean, numeric, string or multiple.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
78 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
79 &quot;ValueDefault&quot; is the default value that is normally used by the indenter if this parameter is not defined. It is needed if the config file of an indenter is loaded but this parameter value is not defined there. For boolean 0 is equal to false and 1 is equal to true. In case of multiple the number defines which of the multiple choice parameters is selected, starting with 0.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
80 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
81 &quot;Enabled&quot; is not used for boolean but for all other parameters. Defines whether the value should be written to the indenters config file or not. If it is disabled it will not be written and the indenter uses its default value.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
82 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
83 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
84 3.1. Boolean parameters<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
85 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
86 Example:<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
87 </p>
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
88 <pre>
290
d9faaa10153a Updated the ini file documentation.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 289
diff changeset
89 [ANSI style formatting]
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
90 Category=0
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
91 Description=&quot;&lt;html&gt;ANSI style formatting/indenting.&lt;/html&gt;&quot;
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
92 EditorType=boolean
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
93 TrueFalse=&quot;--style=ansi|&quot;
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
94 Value=0
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
95 ValueDefault=0
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
96 </pre>
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
97 <p>
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
98 The only special here is the key &quot;TrueFalse&quot;. The string is a parameter list always consists of two parameters devided by a &quot;|&quot; sign, where the first one defines the true case and the second the false case. Some indenters like GreatCode have a parameter for true and false, some other like AStyle in this example only have a parameter for the false case, so the second parameter is empty.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
99 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
100 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
101 3.2. Numeric parameters<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
102 </p>
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
103 <pre>
289
aa41b34387ea Updated the ini file documentation.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 207
diff changeset
104 [Indent spaces]
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
105 CallName=&quot;--indent=spaces=&quot;
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
106 Category=1
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
107 Description=&quot;&lt;html&gt;Indent using # spaces per indent&lt;/html&gt;&quot;
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
108 EditorType=numeric
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
109 Enabled=false
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
110 MaxVal=20
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
111 MinVal=2
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
112 Value=4
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
113 ValueDefault=4
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
114 </pre>
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
115 <p>
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
116 Numeric parameters have defined a maximum value &quot;MaxVal&quot; and a minimum value &quot;MinVal&quot; which can/should not be exceeded. The &quot;CallName&quot; is the parameter as string as it will be written to the indenters config file. At its ending &quot;Value&quot; will be appended.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
117 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
118 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
119 3.3. String parameters<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
120 </p>
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
121 <pre>
289
aa41b34387ea Updated the ini file documentation.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 207
diff changeset
122 [Comment separation char]
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
123 CallName=-cmt_sep_char_4-
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
124 Category=5
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
125 Description=&quot;&lt;html&gt;Set the special character to fill automatic comments.&lt;/html&gt;&quot;
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
126 EditorType=string
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
127 Enabled=true
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
128 Value=*
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
129 ValueDefault=*
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
130 </pre>
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
131 <p>
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
132 The &quot;CallName&quot; is the parameter as string as it will be written to the indenters config file. At its ending &quot;Value&quot; will be appended. Value can also be a list of strings separated by the &quot;|&quot; sign. By this the parameter is written to the config file with each value in the list. <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
133 In the upper example value could be &quot;C|c|K&quot;. The result in the ouput file would be:<br />
207
c7db1b05ecb7 [add] Feature Request ID 1673659 : The string parameter in the uigui ini files for each indenter can now also be a list of strings divided by "|" sign. As result the parameter name with value will be written to the indenter config file for each of the values. http://universalindent.sf.net/issue/1673659
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 167
diff changeset
134 -cmt_sep_char_4-C
c7db1b05ecb7 [add] Feature Request ID 1673659 : The string parameter in the uigui ini files for each indenter can now also be a list of strings divided by "|" sign. As result the parameter name with value will be written to the indenter config file for each of the values. http://universalindent.sf.net/issue/1673659
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 167
diff changeset
135 -cmt_sep_char_4-c
c7db1b05ecb7 [add] Feature Request ID 1673659 : The string parameter in the uigui ini files for each indenter can now also be a list of strings divided by "|" sign. As result the parameter name with value will be written to the indenter config file for each of the values. http://universalindent.sf.net/issue/1673659
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 167
diff changeset
136 -cmt_sep_char_4-K
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
137 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
138 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
139 <br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
140 3.4. Multiple parameters<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
141 </p>
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
142 <pre>
289
aa41b34387ea Updated the ini file documentation.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 207
diff changeset
143 [Bracket style]
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
144 Category=1
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
145 Choices=&quot;--brackets=break|--brackets=attach|--brackets=linux|--brackets=break-closing-headers&quot;
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
146 ChoicesReadable=&quot;Break brackets|Attach brackets|Break brackets Linux like|Break closing headers&quot;
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
147 Description=&quot;&lt;html&gt;Sets the bracket style.&lt;/html&gt;&quot;
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
148 EditorType=multiple
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
149 Enabled=false
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
150 Value=1
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
151 ValueDefault=-1
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
152 </pre>
657
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
153 <p>
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
154 Multiple parameters can have exactly one parameter out of a list selected. &quot;Choices&quot; is a parameter list consisting of parameters devided by a &quot;|&quot; sign. Each parameter in the list will be exactly written to the indenters config file as defined here. The list &quot;ChoicesReadable&quot; can be used to show more readable text in the combo box, instead of the &quot;Choices&quot; text. &quot;ChoicesReadable&quot; must have as many entries as &quot;Choices&quot;.<br />
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
155 </p>
24e1fd6d4bfa Updated the documentation and the changelog.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
156 </body>
41
fddb9ef6baaf Added the documentation of the ini file format.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
157 </html>