Log in

Help for style


Usage:  /style [output_type] [filter] [style|clear]
        /style alias [alias_name [style|clear]]    

/style allows you to set style and color information for various kinds of 
output. Supported output types include:

  body     game    info  message  prompt  review
  command  header  link  notify   recips  sender
  confirm  help    memo                         

The output type of command matches general command output, and confirm matches 
confirmation messages output in parentheses. The output type of prompt is used 
in cases where PyLily prompts for input, such as requesting a blurb at login or 
when setting info or memos.

The output type of game matches output from games.

Output types of help, info, memo, and review match blocks of text output by 
their corresponding commands. No additional filtering is available for these 
output types.

Output types of message and notify represent message and notification events. 
For a list of available filters for these output types, see /help filter. Note 
that from and to filters only work on messages, but user is supported for both 
messages and notifications.

Output types of header, body, sender, and recips can be used to set the style 
for specific portions of messages, rather than the entire message. These output 
types support the same filters as the output type message.

The output type link can be used to set the style used when displaying HTTP and 
HTTPS URLs in messages. URLs appear in output will automatically be detected and
turned into links, or markup can be used to associate URLs with arbitrary text 
without the URL itself appearing in the output, on terminals that support it.

Output styling is handled by the Python "Rich" library. Supported styles can be 
found at https://rich.readthedocs.io/en/stable/style.html. This includes both 
setting foreground and background text colors as well as text styles such as 
bold, italic, underline, and strike-through, though not all terminals support 
all of the available styles.

Note that multiple style rules can apply simultaneously. For instance, a rule 
can set the style for review output and another rule which sets the style for 
message and notify output would apply to both new messages and notifications as 
well as those shown during a review. Similarly, if rules exist for both messages
and specific message parts the rules for message output will be the default 
style for messages, but rules for specific message parts can add to or override 
that.

The alias form of this command allow you to set aliases for specific 
combinations of output styles that you can then reference in multiple rules. If 
you later want to update the output style, you can update the alias and all the 
rules which refer to it will begin using the new style.

For some quick examples, see "/help style examples".

(subtopics: examples)                                               
(see also: events, filter, help, info, memo, review, sending markup)