templates of result strings
nametypeimplicit value
prolog_templatestring""
No parameters.

epilog_templatestring""
  • %0 - ansi sequence to set output to default color.

doc_file_template string"%1File %0:\n"
Document id for documents starting at offset 0.
  • %0 - file name
  • %1 - ansi sequence to set output to doc_name_color
  • %2 - title contained in a document (that is, words of document part specified as a first item of title_parts, from the first push_rx to its closing pop_rx), with text matching cruft_rx removed; see example
  • %3 to %9 - contents of other title parts (%3 for the second item, %4 for the third etc.)

doc_section_template string"%2File %0 (from %1)\n"
Document id for documents starting in the middle of a file.
  • %0 - file name
  • %1 - offset in file
  • %2 - ansi sequence to set output to doc_name_color
  • %3 - title contained in a document; see above
  • %4 to %9 - like above, contents of other title parts

doc_title_template string""
This is a template with specific capabilities for locus on HTTP server, meant to replace doc_file_template and doc_section_template. If it's not empty, it's used instead of them.
  • %0 - file name
  • %1 - offset in file
  • %2 - positions of words found in the document (list of numbers separated by hit_in_title_separator)
  • %3 to %9 - contents of title parts

doc_end_templatestring""
No parameters.

metric_templatestring"%0 = %1\n"
Value of a normalized metric for this document. See show_relevance.
  • %0 - metric name
  • %1 - metric value

relevance_templatestring"result = %0\n"
Relevance of this document. See show_relevance.
  • %0 - the value

clot_head_templatestring"%0*"
  • %0 - ansi sequence to set output to head_tail_color

clot_break_templatestring"%0\n...\n"
  • %0 - ansi sequence to set output to head_tail_color

clot_tail_templatestring"%0\n"
  • %0 - ansi sequence to set output to head_tail_color

passage_templatestring "%3%0%1%2"
  • %0 - punctuation at the beginning of text
  • %1 - the text
  • %2 - punctuation at the end of text
  • %3 - ansi sequence to set output to text_color
  • %4 - ansi sequence to set output to occ_color

highlighted_passage_templatestring"%4%0%1%3%2"
  • %0 - punctuation at the beginning of text
  • %1 - the text
  • %2 - punctuation at the end of text
  • %3 - ansi sequence to set output to text_color
  • %4 - ansi sequence to set output to occ_color

cruft_rxstring""
Any text in returned passages (%0, %1 and %2 in both passage_template and highlighted_passage_template) matching this regular expression is removed. My favorite value for HTML is "^[^<]*>|<[^<>]*>|<[^>]*$".

cruft_rx_is_case_sensitiveintyes
Self-explanatory.

hit_in_title_separator string"+"
See doc_title_template.

Default output formatting uses ANSI colors. Beware: due to a bug, clots can display twice at the same screen position, obscuring part of the output. In option values, colors are coded by a three-digit integer: hunderts means attribute (0 normal, 1 bold/bright, 2 underscore, 3 blink, 4 reverse, 5 concealed), tens foreground and ones background (0 black, 1 red, 2 green, 3 yellow, 4 blue, 5 magenta, 6 cyan, 7 white).

colors
nametypeimplicit value
doc_name_colorintbright yellow on black
text_colorintwhite on black
occ_colorintbright green on black
head_tail_colorintbright yellow on black

Up: output options Top: locus homepage