Differential D23050 Diff 63427 doc/katepart/development.docbook

Changeset View

Standalone View

View Options

doc/katepart/development.docbook

Show First 20 Lines • Show All 280 Lines • ▼ Show 20 Line(s)
281<varlistentry> 281​<varlistentry>
282<term>Next comes the <userinput>highlighting</userinput> element, which 282​<term>Next comes the <userinput>highlighting</userinput> element, which
283contains the optional element <userinput>list</userinput> and the required 283​contains the optional element <userinput>list</userinput> and the required
284elements <userinput>contexts</userinput> and <userinput>itemDatas</userinput>.</term> 284​elements <userinput>contexts</userinput> and <userinput>itemDatas</userinput>.</term>
285<listitem> 285​<listitem>
286<para><userinput>list</userinput> elements contain a list of keywords. In 286​<para><userinput>list</userinput> elements contain a list of keywords. In
287this case the keywords are <emphasis>class</emphasis> and <emphasis>const</emphasis>. 287​this case the keywords are <emphasis>class</emphasis> and <emphasis>const</emphasis>.
288You can add as many lists as you need.</para> 288​You can add as many lists as you need.</para>
289​<para>Since &kde-frameworks; 5.53, a list can include keywords from another
290​list or language/file, using the <userinput>include</userinput> element.
291​<userinput>##</userinput> is used to separate the list name and the language
292​definition name, in the same way as in the <userinput>IncludeRules</userinput> rule.
293​This is useful to avoid duplicating keyword lists, if you need to include the keywords
294​of another language/file. For example, the <emphasis>othername</emphasis> list
295​contains the <emphasis>str</emphasis> keyword and all the keywords of the
296​<emphasis>types</emphasis> list, which belongs to the <emphasis>ISO C++</emphasis>
297​language.</para>
289<para>The <userinput>contexts</userinput> element contains all contexts. 298​<para>The <userinput>contexts</userinput> element contains all contexts.
290The first context is by default the start of the highlighting. There are 299​The first context is by default the start of the highlighting. There are
291two rules in the context <emphasis>Normal Text</emphasis>, which match 300​two rules in the context <emphasis>Normal Text</emphasis>, which match
292the list of keywords with the name <emphasis>somename</emphasis> and a 301​the list of keywords with the name <emphasis>somename</emphasis> and a
293rule that detects a quote and switches the context to <emphasis>string</emphasis>. 302​rule that detects a quote and switches the context to <emphasis>string</emphasis>.
294To learn more about rules read the next chapter.</para> 303​To learn more about rules read the next chapter.</para>
295<para>The third part is the <userinput>itemDatas</userinput> element. It 304​<para>The third part is the <userinput>itemDatas</userinput> element. It
296contains all color and font styles needed by the contexts and rules. 305​contains all color and font styles needed by the contexts and rules.
297In this example, the <userinput>itemData</userinput> <emphasis>Normal Text</emphasis>, 306​In this example, the <userinput>itemData</userinput> <emphasis>Normal Text</emphasis>,
298<emphasis>String</emphasis> and <emphasis>Keyword</emphasis> are used. 307​<emphasis>String</emphasis> and <emphasis>Keyword</emphasis> are used.
299</para> 308​</para>
300<programlisting> 309​<programlisting>
301 &lt;highlighting&gt; 310​ &lt;highlighting&gt;
302 &lt;list name=&quot;somename&quot;&gt; 311​ &lt;list name=&quot;somename&quot;&gt;
303 &lt;item&gt; class &lt;/item&gt; 312​ &lt;item&gt;class&lt;/item&gt;
304 &lt;item&gt; const &lt;/item&gt; 313​ &lt;item&gt;const&lt;/item&gt;
305 &lt;/list&gt; 314​ &lt;/list&gt;
315​ &lt;list name=&quot;othername&quot;&gt;
316​ &lt;item&gt;str&lt;/item&gt;
317​ &lt;include&gt;types##ISO C++&lt;/include&gt;
318​ &lt;/list&gt;
306 &lt;contexts&gt; 319​ &lt;contexts&gt;
307 &lt;context attribute=&quot;Normal Text&quot; lineEndContext=&quot;#pop&quot; name=&quot;Normal Text&quot; &gt; 320​ &lt;context attribute=&quot;Normal Text&quot; lineEndContext=&quot;#pop&quot; name=&quot;Normal Text&quot; &gt;
308 &lt;keyword attribute=&quot;Keyword&quot; context=&quot;#stay&quot; String=&quot;somename&quot; /&gt; 321​ &lt;keyword attribute=&quot;Keyword&quot; context=&quot;#stay&quot; String=&quot;somename&quot; /&gt;
322​ &lt;keyword attribute=&quot;Keyword&quot; context=&quot;#stay&quot; String=&quot;othername&quot; /&gt;
309 &lt;DetectChar attribute=&quot;String&quot; context=&quot;string&quot; char=&quot;&amp;quot;&quot; /&gt; 323​ &lt;DetectChar attribute=&quot;String&quot; context=&quot;string&quot; char=&quot;&amp;quot;&quot; /&gt;
310 &lt;/context&gt; 324​ &lt;/context&gt;
311 &lt;context attribute=&quot;String&quot; lineEndContext=&quot;#stay&quot; name=&quot;string&quot; &gt; 325​ &lt;context attribute=&quot;String&quot; lineEndContext=&quot;#stay&quot; name=&quot;string&quot; &gt;
312 &lt;DetectChar attribute=&quot;String&quot; context=&quot;#pop&quot; char=&quot;&amp;quot;&quot; /&gt; 326​ &lt;DetectChar attribute=&quot;String&quot; context=&quot;#pop&quot; char=&quot;&amp;quot;&quot; /&gt;
313 &lt;/context&gt; 327​ &lt;/context&gt;
314 &lt;/contexts&gt; 328​ &lt;/contexts&gt;
315 &lt;itemDatas&gt; 329​ &lt;itemDatas&gt;
316 &lt;itemData name=&quot;Normal Text&quot; defStyleNum=&quot;dsNormal&quot; /&gt; 330​ &lt;itemData name=&quot;Normal Text&quot; defStyleNum=&quot;dsNormal&quot; /&gt;
▲ Show 20 Lines • Show All 2548 Lines • Show Last 20 Lines