NAME
Syntax::Kamelon::Diagnostics - Explore syntax definition XML files
SYNOPSIS
DESCRIPTION
OPTIONS
The constructor is called with a paired list or hash of options as parameters. You can use the following options.
- indexer => ref to instance of Syntax::Kamelon::Indexer
-
Here you can specify your own instance of the indexer module you wish to use. If you specify this option, all other options become meaningless.
- indexfile => filename
-
Specifies the filename where Kamelon stores information about available syntax definitions.
By default it points to 'indexrc' in the xmlfolder. If the file does not exist Kamelon will load all xml files in the xmlfolder and attempt to create the indexfile.
Once the indexfile has been created it becomes static. If you add a syntax definition XML file to the xmlfolder it will no longer be recognized. Delete the indexfile and reload Kamelon to fix that.
See also Syntax::Kamelon::Indexer
- noindex => boolean
-
By default 0. If you set this option Kamelon will ignore the existence of an indexfile and manually build the index, without saving it. But it gives you the liberty of adding and removing syntax highlight definition files.
- xmlfolder => folder
-
This is the place where Kamelon looks for syntax highlight definition XML files. By default it searches @INC for 'Syntax/Kamelon/XML'. Here you find the XML files used in the Kate text editor. They are specially crafted for this module.
See also Syntax::Kamelon::Indexer
USER METHODS
SYSTEM METHODS
- AttributeExists
- AvailableContextKeys
- AvailableLanguageKeys
- AvailableOperators
- AvailableRuleKeys
- AvailableSyntaxes
- CheckDuplicateAttributes
- CheckContextAttribute
- CheckListSizes
- Clear
- ContextExists
- ContextFilter
- CurContext
- CurRule
- CurSyntax
- CurXML
- Diagnoze
- Filter
- FilterContext
- FilterRule
- FilterSyntax
- FormatStringLength
- GetIndexer
- GetXMLObject
- IndentDown
- IndentUp
- IndentString
- OutCall
- PrintAnsi
- PrintClear
- PrintHash
- PrintLine
- PrintRelease
- PrintStyle
- RuleAnyChar
- RuleDefault
- RuleDetectChar
- RuleDetect2Chars
- RuleFilter
- RuleIncludeRules
- RuleInt
- RuleKeyword
- RuleLineContinue
- RuleRangeDetect
- RuleRegExpr
- RuleStringDetect
- RuleWordDetect
- ShowAttributes
- ShowContext
- ShowDetails
- ShowLists
- ShowRules
- SyntaxFilter
AUTHOR AND COPYRIGHT
This module is written and maintained by:
Hans Jeuken < hanje at cpan dot org >
Copyright (c) 2017 - 2023 by Hans Jeuken, all rights reserved.
Published under the same license as Perl.
SEE ALSO
Syntax::Kamelon, Syntax::Kamelon::Builder, Syntax::Kamelon::Debugger, Syntax::Kamelon::Indexer, Syntax::Kamelon::XMLData, Syntax::Kamelon::Format::Base, Syntax::Kamelon::Format::ANSI, Syntax::Kamelon::Format:HTML4