User Tools

Site Tools


parsermonster_flags

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
parsermonster_flags [2015/08/14 23:21]
Mitch
parsermonster_flags [2015/08/15 18:06] (current)
Mitch [System Flags]
Line 1: Line 1:
 ====== ParserMonster Flags ====== ====== ParserMonster Flags ======
  
-ParserMonster flags are simply variables that can be true or false. Tasks and scripts can use a mix of predefined flags and temporary, local flags.+ParserMonster flags are variables that can be either true or false. Flags may be predefined or created by tasks. 
 +See [sys][] or is it, see [sys] [foo]?
  
-Both types of flags are read, set and tested by the same directives. The directives will create a local flag the first time it is used. For this reason, don't expect to use a predefined flag for your own purposes.+Predefined flags are stored in a hidden file named [[recognized_filetypes|cx-Flags.txt]]. Since that file is read before any user-defined constants or user-defined tasksnone of the predefined flag names should be used for other purposes.
  
 To set a flag to True, use the <true> directive. If the flag does not exist, it will be created and set to True. To set a flag to True, use the <true> directive. If the flag does not exist, it will be created and set to True.
Line 9: Line 10:
 To set a flag to False, use the <false> directive. If the flag does not exist, it will be created and set to False. To set a flag to False, use the <false> directive. If the flag does not exist, it will be created and set to False.
  
-To test whether a flag is True or False, use the <test> directive. If the flag does not exist, it will be created and set to False.+Tip: if you plan to test multiple flags, you can save time by commenting out <true> directives. Just place one flag on each line of your script, like this: 
 + 
 +<code> 
 +<true>ReportMerge 
 +<true>ReportHeaderNoPath 
 +</code> 
 + 
 +To disable **ReportHeaderNoPath**, comment out the line: 
 + 
 +<code> 
 +<true>ReportMerge 
 +'<true>ReportHeaderNoPath 
 +</code> 
 + 
 + 
 + 
 + 
 +<del>To test whether a flag is True or False, use the <test> directive. If the flag does not exist, it will be created and set to False.</del>
  
 ===== Main Window Flags ===== ===== Main Window Flags =====
Line 28: Line 46:
  
 By default, ParserMonster generates one report per file processed. Reports, previews and output can be modified by setting the following flags to **<true>**: By default, ParserMonster generates one report per file processed. Reports, previews and output can be modified by setting the following flags to **<true>**:
 +
 +==== Output (to Disk) ====
 +==== Preview ====
 +==== Header ====
 +||HeaderNoPath||
 +==== Footer ====
 +
 +
 +
  
 [[reportoff|ReportOff]] suppresses writing reports to disk. [[reportoff|ReportOff]] suppresses writing reports to disk.
Line 43: Line 70:
  
 ===== System Flags ===== ===== System Flags =====
 +These flags operate independently of their inclusion in a [[constantfiles|cx-file]]. Applications that don't ship with predefined constants will still recognize system flags.
  
 +^ Name ^ Purpose ^
 +| AdHoc | Allows custom code to run before, during and after the major [[parsermonsterloops|loops]] |
 +| AutoRun | Set to true if [[autorun|autorun.task]] is detected during startup |
 +| AutoRun2 | Set to true if [[autorun|autorun2.task]] is detected during startup |
 ===== Undocumented Flags ===== ===== Undocumented Flags =====
 These flags have been implemented and will be documented, eventually. These flags have been implemented and will be documented, eventually.
 +AdHoc 
 +AutoRun 
 +AutoRun2 
 +OverwriteSessionLog 
 +Pipe 
 +ProcessFileNames 
 +ReportCompact 
 +ReportFooter 
 +ReportHeader 
 +ReportHeaderNoPath 
 +ReportHeaderShortName 
 +ReportMerge 
 +ReportOff 
 +ReportPreview 
 +ReportPreviewCompact
 SafeBrowseReadFrom SafeBrowseReadFrom
 SafeBrowseWriteTo SafeBrowseWriteTo
 +ScriptIcons 
 +StatusDisplayTaskInfo
 Trace Trace
 +TraceStartup
  
-ScriptIcons 
-AutoRun 
-AutoRun2 
  
-ProcessFileNames 
- 
-Pipe 
parsermonster_flags.1439594514.txt.gz · Last modified: 2015/08/14 23:21 by Mitch