From d974da559601a1c95740a01d72ce2ee91008354e Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 22 Apr 2011 03:23:07 +0100 Subject: removed docs/ from dev branch, since they're all in their own repo (well, wiki) by now. --- docs/Irssi/UI/Theme.pod | 169 ------------------------------------------------ 1 file changed, 169 deletions(-) delete mode 100644 docs/Irssi/UI/Theme.pod (limited to 'docs/Irssi/UI/Theme.pod') diff --git a/docs/Irssi/UI/Theme.pod b/docs/Irssi/UI/Theme.pod deleted file mode 100644 index 344b5ae..0000000 --- a/docs/Irssi/UI/Theme.pod +++ /dev/null @@ -1,169 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::UI::Theme - -=head1 FIELDS - -=head1 METHODS - -=head2 C - -C<$flags> is an optional bitmask of any of the following flags: - -=over - -=item C - -Any replacements specified in the theme are not applied to this expansion. - -=item C - -B - -=item C - -If the format contains variables and no values are specified, an empty string is -returned instead of a partially filled template. - -=back - -B - -Example: - - my $formatted_str = Irssi::current_theme()->format_expand('{hilight Hello}'); - -B. Weird> - -=head2 C - -Returns the unexpanded format template for the format name supplied in C<$tag>. - -Valid values for C<$module> are: - -=over - -=item C - -=item C - -=item C - -=item C - -=item C - -=item C - -=back - -Example: - - my $pubmsg_format = Irssi::current_theme()->get_format('fe-common/core', 'pubmsg'); - -=head1 THEME DETAILS - -=head2 Loading and Testing - -You can change themes by issuing a C> command from Irssi. -Reloading is slightly harder, since Irssi will only reload and process a new theme -if the C variable I. - -You can force a reload of the theme (and everything else) with C. This -reloads the configuration file too, so if you did any changes remember to C -first. - -B overwrites the theme file with old data so keep -backups C<:)>> - -Better alternatives are the following aliases: - - /ALIAS THEMERELOAD SCRIPT EXEC Irssi::themes_reload(); - -or - - /ALIAS THEMERELOAD SET theme default; EVAL SET theme $theme - -The former is preferred if you have scripting support, whereas the latter will -work without scripting (Perl) support loaded, but requires that you are editing -a custom theme, rather than modifying F. - -=head2 TEMPLATES - -The actual mechanism used by Irssi to print text into the client involves a -certain amount of indirection, which allows themes to reformat messages in -various ways before they are displayed. - -The overall structure of these templates is based around 3 basic ideas: - -=over - -=item Nested Templates - -=item Colour Codes - -=item Variable Expansion - -=item Special Variables - -=back - -The real text formats that irssi uses are the ones you can find with -/FORMAT command. Back in the old days all the colors and texts were mixed -up in those formats, and it was really hard to change the colors since you -might have had to change them in tens of different places. So, then came -this templating system. - -Now the Cs don't have any colors in them, and they also have very -little other styling. Most of the stuff you need to change is in this -theme file. If you can't change something here, you can always go back -to change the /FORMATs directly, they're also saved in the F<*.theme> files. - -So, the templates. They're those C<{blahblah}> parts you see all over the -/FORMATs and here. Their usage is simply C<{name parameter1 parameter2}>. - -When irssi sees this kind of text, it goes to find C from the abstracts -block below and sets C into C<$0> and C into C<$1> (you -can have more parameters of course). Templates can have sub-templates. Here's a -small example: - - /FORMAT format hello {colorify {underline world}} - - abstracts = { colorify = "%G$0-%n"; underline = "%U$0-%U"; } - -When irssi expands the templates in C<"format">, the final string would be: - - hello %G%Uworld%U%n - -ie. underlined bright green "world" text. and why C<$0->, why not C<$0>? C<$0> -would only mean the first parameter, C<$0-> means all the parameters. With -C<{underline hello world}> you'd really want to underline both of the words, not -just the hello (and world would actually be removed entirely). - -See also L for -details on the variable to argument mapping. - -=head2 COLOURS - -You can find definitions for the colour format codes in L. - -There's one difference here though. C<%n> format. Normally it means the default -color of the terminal (white mostly), but here it means the "reset color back to -the one it was in higher template". For example if there was C, and C, irssi would print yellow C<"foo"> (as set -with C<%Y>) but C<"bar"> would be green, which was set at the beginning before -the C<{foo}> template. If there wasn't the C<%g> at start, the normal behaviour -of C<%n> would occur. If you I want to use the terminal's default color, -use C<%N>. - -=head1 AUTHOR - -Based on the original content found as comments in the F file. -Copyright E 2000-2010 L. - -Formatting and additional content by Tom Feist - L - -- cgit v1.2.3