[Rt-commit] rt branch, development, updated. bacd0f1d9b6016eae01c2d618b0260599f53538c

Thomas Sibley trs at bestpractical.com
Fri Jul 9 17:55:00 EDT 2010


The branch, development has been updated
       via  bacd0f1d9b6016eae01c2d618b0260599f53538c (commit)
       via  caae76dac3fa3c07d017e56b7129d32c4adcbd63 (commit)
      from  0e0a3367d7fe650e7c4bdbb0ae778242050ee922 (commit)

Summary of changes:
 lib/RT/Action/ConfigSystem.pm        |   12 ++
 lib/RT/Config.pod                    |  217 +++++++++++++++++-----------------
 lib/RT/View/SetupWizard.pm           |   30 ++++--
 share/web/static/css/app.css         |    1 +
 share/web/static/css/setupwizard.css |   17 +++
 5 files changed, 162 insertions(+), 115 deletions(-)
 create mode 100644 share/web/static/css/setupwizard.css

- Log -----------------------------------------------------------------
commit caae76dac3fa3c07d017e56b7129d32c4adcbd63
Author: Thomas Sibley <trs at bestpractical.com>
Date:   Fri Jul 9 16:35:38 2010 -0400

    Capitalize the defaults

diff --git a/lib/RT/Config.pod b/lib/RT/Config.pod
index c913f92..b00f4c3 100644
--- a/lib/RT/Config.pod
+++ b/lib/RT/Config.pod
@@ -13,7 +13,7 @@ Your domain name is recommended, so as not to pollute the namespace.
 once you start using a given tag, you should probably never change it.
 (otherwise, mail for existing tickets won't get put in the right place)
 
-default: C<"example.com">
+Default: C<"example.com">
 
 
 =item C<email_subject_tag_regex>
@@ -35,7 +35,7 @@ C<qr/(example.com|example.org)/i>
 This setting would make RT behave exactly as it does without the 
 setting enabled.
 
-default: C<"example.com">
+Default: C<"example.com">
 
 =item C<organization>
 
@@ -43,21 +43,21 @@ You should set this to your organization's DNS domain. For example,
 I<fsck.com> or I<asylum.arkham.ma.us>. It's used by the linking interface to
 guarantee that ticket URIs are unique and easy to construct.
 
-default: C<"example.com">
+Default: C<"example.com">
 
 =item C<minimum_password_length>
 
 C<minimum_password_length> defines the minimum length for user
 passwords. Setting it to 0 disables this check.
 
-default: C<"5">
+Default: C<"5">
 
 =item C<time_zone>
 
 C<time_zone> is used to convert times entered by users into GMT and back again
 It should be set to a time zone recognized by L<DateTime::TimeZone>.
 
-default: C<'America/New_York'>
+Default: C<'America/New_York'>
 
 =back
 
@@ -75,7 +75,7 @@ Set C<use_sql_for_acl_checks> to 1 to use SQL and get rid of these problems.
 However, this option is beta. In some cases it result in performance
 improvements, but some setups can not handle it.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<full_text_search>
 
@@ -87,7 +87,7 @@ different database back-ends. Use F<sbin/rt-setup-fulltext-index> helper
 for quick start. This script creates required structures in the DB and
 gives some ideas on next steps.
 
-default: C<< {
+Default: C<< {
         enable  => 0,
         indexed => 0,
         table   => 'AttachmentsIndex',
@@ -106,14 +106,14 @@ C<owner_email> is the address of a human who manages RT. RT will send
 errors generated by the mail gateway to this address.  This address
 should _not_ be an address that's managed by your RT instance.
 
-default: C<'root'>
+Default: C<'root'>
 
 =item C<loops_to_rt_owner>
 
 If C<loops_to_rt_owner> is defined, RT will send mail that it believes
 might be a loop to C<owner_email>
 
-default: C<1>
+Default: C<1>
 
 =item C<store_loops>
 
@@ -123,7 +123,7 @@ to be part of mail loops.
 As it does this, it will try to be careful not to send mail to the
 sender of these messages
 
-default: C<undef>
+Default: C<undef>
 
 =item C<max_attachment_size>
 
@@ -134,21 +134,21 @@ For mysql and oracle, we set this size at 10 megabytes.
 If you're running a postgres version earlier than 7.1, you will need
 to drop this to 8192. (8k)
 
-default: C<10000000>
+Default: C<10000000>
 
 =item C<truncate_long_attachments>
 
 C<truncate_long_attachments>: if this is set to a non-'' value,
 RT will truncate attachments longer than C<max_attachment_size>.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<drop_long_attachments>
 
 C<drop_long_attachments>: if this is set to a non-'' value,
 RT will silently drop attachments longer than C<max_attachment_size>.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<parse_new_message_for_ticket_ccs>
 
@@ -158,14 +158,14 @@ Be forewarned that if you have _any_ addresses which forward mail to
 RT automatically and you enable this option without modifying
 C<rt_address_regexp> below, you will get yourself into a heap of trouble.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<rt_address_regexp> 
 
 C<rt_address_regexp> is used to make sure RT doesn't add itself as a ticket CC if
 the setting above is enabled.
 
-default: C<'^rt\@example.com$'>
+Default: C<'^rt\@example.com$'>
 
 =item C<canonicalize_email_match>, C<canonicalize_email_replace>
 
@@ -179,8 +179,8 @@ for the value in $<CanonicalizeEmailAddressMatch>
 By default, that routine performs a C<s/$match/$replace/gi> on any address
 passed to it.
 
-default: C<''>
-default: C<''>
+Default: C<''>
+Default: C<''>
 
 =item C<canonicalize_email_match>
 
@@ -188,7 +188,7 @@ Set this to true and the create new user page will use the values that you
 enter in the form but use the function CanonicalizeUserInfo in
 F<RT/User_Local.pm>
 
-default: C<0>
+Default: C<0>
 
 =item C<sender_must_exist_in_external_database>
 
@@ -204,14 +204,14 @@ has no effect.
 If you define an AutoRejectRequest template, RT will use this
 template for the rejection message.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<mail_plugins>
 
 C<mail_plugins> is a list of auth plugins for L<RT::Interface::Email>
 to use; see L<rt-mailgate>
 
-default: C<[]>
+Default: C<[]>
 
 
 =item C<unsafe_email_commands>
@@ -227,7 +227,7 @@ The default "extract remote tracking tags" scrip settings; these
 detect when your RT is talking to another RT, and adjusts the
 subject accordingly.
 
-default: C<'\\[.+? #\\d+\\]' >
+Default: C<'\\[.+? #\\d+\\]' >
 
 =back
 
@@ -245,7 +245,7 @@ or 'qmail'.
 Note that you should remove the '-t' from C<sendmail_arguments>
 if you use 'sendmail' rather than 'sendmailpipe'
 
-default: C<'sendmailpipe'>
+Default: C<'sendmailpipe'>
 
 =back
 
@@ -265,7 +265,7 @@ These options are good for most sendmail wrappers and workalikes
 These arguments are good for sendmail brand sendmail 8 and newer
 C<default: C<"-oi -t -ODeliveryMode=b -OErrorMode=m">>
 
-default: C<"-oi -t">
+Default: C<"-oi -t">
 
 
 =item C<sendmail_bounce_arguments>
@@ -273,14 +273,14 @@ default: C<"-oi -t">
 C<sendmail_bounce_arguments> defines what flags to pass to C<sendmail>
 assuming RT needs to send an error (ie. bounce).
 
-default: C<'-f "<>"'>
+Default: C<'-f "<>"'>
 
 =item C<sendmail_path>
 
 If you selected 'sendmailpipe' above, you MUST specify the path to
 your sendmail binary in C<sendmail_path>.
 
-default: C<"/usr/sbin/sendmail">
+Default: C<"/usr/sbin/sendmail">
 
 
 =back
@@ -295,20 +295,20 @@ These options only take effect if C<mail_command> is 'smtp'
 
 C<smtp_server> should be set to the hostname of the SMTP server to use
 
-default: C<undef>
+Default: C<undef>
 
 =item C<smtp_from>
 
 C<smtp_from> should be set to the 'From' address to use, if not the
 email's 'From'
 
-default: C<undef>
+Default: C<undef>
 
 =item C<smtp_debug> 
 
 C<smtp_debug> should be set to true to debug SMTP mail sending
 
-default: C<0>
+Default: C<0>
 
 =back
 
@@ -321,7 +321,7 @@ default: C<0>
 C<mail_params> defines a list of options passed to $mail_command if it
 is not 'sendmailpipe', 'sendmail', or 'smtp'
 
-default: C<[]>
+Default: C<[]>
 
 =item C<correspond_address>, C<comment_address>
 
@@ -333,16 +333,16 @@ that will be listed in From: and Reply-To: headers of correspondence
 and comment mail tracked by RT, unless overridden by a queue-specific
 address.
 
-default: C<''>
+Default: C<''>
 
-default: C<''>
+Default: C<''>
 
 =item C<dashboard_address>
 
 The email address from which RT will send dashboards. If none is set, then
 C<owneremail> will be used.
 
-default: C<''>
+Default: C<''>
 
 
 =item C<use_friendly_from_line>
@@ -350,14 +350,14 @@ default: C<''>
 By default, RT sets the outgoing mail's "From:" header to
 "SenderName via RT".  Setting C<use_friendly_from_line> to 0 disables it.
 
-default: C<1>
+Default: C<1>
 
 =item C<friendly_from_line_format>
 
 C<sprintf()> format of the friendly 'From:' header; its arguments
 are SenderName and SenderEmailAddress.
 
-default: C<"\"%s via RT\" <%s>">
+Default: C<"\"%s via RT\" <%s>">
 
 =item C<use_friendly_to_line>
 
@@ -368,14 +368,14 @@ This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL
 If you are using sendmail, rather than postfix, qmail, exim or some other MTA,
 you _must_ disable this option.
 
-default: C<0>
+Default: C<0>
 
 =item C<friendly_to_line_format>
 
 C<sprintf()> format of the friendly 'From:' header; its arguments
 are WatcherType and TicketId.
 
-default: C<"\"%s of example.com Ticket #%s\":;">
+Default: C<"\"%s of example.com Ticket #%s\":;">
 
 =item C<notify_actor>
 
@@ -383,14 +383,14 @@ By default, RT doesn't notify the person who performs an update, as they
 already know what they've done. If you'd like to change this behaviour,
 Set C<notify_actor> to 1
 
-default: C<0>
+Default: C<0>
 
 =item C<record_outgoing_email>
 
 By default, RT records each message it sends out to its own internal database.
 To change this behavior, set C<record_outgoing_email> to 0 
 
-default: C<1>
+Default: C<1>
 
 =item C<verp_prefix>, C<verp_prefix>
 
@@ -405,7 +405,7 @@ This currently only works with sendmail and sendmailppie.
 # verp_prefix => C<'rt-'>
 # verp_domain => C<$rt::organization>
 
-default: undef
+Default: undef
 
 =item C<forward_from_user>
 
@@ -415,7 +415,7 @@ subject of the outgoing message, so recipients' replies go into RT as correspond
 To change this behavior, set C<forward_from_user> to true value and RT will use
 address of the current user and leave subject without RT's tag.
 
-default: C<0>
+Default: C<0>
 
 =item C<show_bcc_header>
 
@@ -424,7 +424,7 @@ reply or comment.
 
 To change this set the following option to true value.
 
-default: C<0>
+Default: C<0>
 
 =item C<dashboard_subject>
 
@@ -432,7 +432,7 @@ Lets you set the subject of dashboards. Arguments are the frequency (Daily,
 Weekly, Monthly) of the dashboard and the dashboard's name. %1 for the name
 of the dashboard.
 
-default: C<'%s Dashboard: %s'>
+Default: C<'%s Dashboard: %s'>
 
 =back
 
@@ -452,7 +452,7 @@ signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
 If you want to allow people to encrypt attachments inside the DB then
 set C<allow_encrypt_data_in_db> to true
 
-default: C<< {
+Default: C<< {
         enable                   => 1,
         outgoing_messages_format => 'RFC',    # Inline
         allow_encrypt_data_in_db => 0,
@@ -474,7 +474,7 @@ e.g. C<< {
        'auto-key-retrieve' => '',
     } >>
 
-default: C<< { } >>
+Default: C<< { } >>
 
 =back
 
@@ -495,7 +495,7 @@ from which RT will try to load the file main.css (which should
 easily and cleanly create your own stylesheets to apply to RT.  This
 option can be overridden by users in their preferences.
 
-default: C<'web2'>
+Default: C<'web2'>
 
 =item C<username_format>
 
@@ -504,7 +504,7 @@ either NickName, RealName, Name or EmailAddress, depending on what exists
 and whether the user is privileged or not. Verbose will show RealName and
 EmailAddress.
 
-default: C<'concise'>
+Default: C<'concise'>
 
 =item C<web_path>
 
@@ -516,19 +516,19 @@ C<web_path> requires a leading / but no trailing /.
 
 In most cases, you should leave C<web_path> set to '' (an empty value).
 
-default: C<"">
+Default: C<"">
 
 =item C<logo_url>
 
 C<logo_url> points to the URL of the RT logo displayed in the web UI
 
-default: C<"/static/images/bplogo.gif">
+Default: C<"/static/images/bplogo.gif">
 
 =item C<web_no_auth_regex>
 
 What portion of RT's URLspace should not require authentication.
 
-default: C<'(?x-ism:^ (?:\/+NoAuth\/ | \/+REST\/\d+\.\d+\/NoAuth\/) )' >
+Default: C<'(?x-ism:^ (?:\/+NoAuth\/ | \/+REST\/\d+\.\d+\/NoAuth\/) )' >
 
 =item C<self_service_regex>
 
@@ -537,7 +537,7 @@ This does not override the redirect from F</Ticket/Display.html> to
 F</SelfService/Display.html> when Unprivileged users attempt to access
 ticked displays
 
-default: C<'^(?:\/+SelfService\/)' >
+Default: C<'^(?:\/+SelfService\/)' >
 
 =item C<message_box_width>, C<message_box_height>
 
@@ -550,7 +550,7 @@ Default width: 72, height: 15
 These settings only apply to the non-RichText message box.
 See below for Rich Text settings.
 
-default:
+Default:
 message_box_width => C<72>
 message_box_width => C<15>
 
@@ -558,25 +558,25 @@ message_box_width => C<15>
 
 Default wrapping: "HARD"  (choices "SOFT", "HARD")
 
-default: C<"HARD">
+Default: C<"HARD">
 
 =item C<message_box_rich_text>
 
 Should "rich text" editing be enabled? This option lets your users send html email messages from the web interface.
 
-default: C<1>
+Default: C<1>
 
 =item C<message_box_rich_text_height>
 
 Height of RichText javascript enabled editing boxes (in pixels)
 
-default: C<200>
+Default: C<200>
 
 =item C<message_box_include_signature>
 
 Should your user's signatures (from their Preferences page) be included in comments and Replies
 
-default: C<1>
+Default: C<1>
 
 =item C<wiki_implicit_links>
 
@@ -585,7 +585,7 @@ causes InterCapped or ALLCAPS words in WikiText fields to
 automatically become links to searches for those words.  If used on
 RTFM articles, it links to the RTFM article with that name.
 
-default: C<0>
+Default: C<0>
 
 =item C<trust_html_attachments>
 
@@ -593,7 +593,7 @@ if C<trust_html_attachments> is not defined, we will display them
 as text. This prevents malicious HTML and javascript from being
 sent in a request (although there is probably more to it than that)
 
-default: C<undef>
+Default: C<undef>
 
 =item C<redistribute_auto_generated_messages>
 
@@ -604,7 +604,7 @@ You can also use 'privileged' (the default), which will redistribute
 only to privileged users. This helps to protect against malformed
 bounces and loops caused by autocreated requestors with bogus addresses.
 
-default: C<'privileged'>
+Default: C<'privileged'>
 
 =item C<prefer_rich_text>
 
@@ -613,35 +613,35 @@ messages in preference to their plaintext alternatives. RT "scrubs" the
 html to show only a minimal subset of HTML to avoid possible contamination
 by cross-site-scripting attacks.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<web_external_auth>
 
 If C<web_external_auth> is defined, RT will defer to the environment's
 REMOTE_USER variable.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<web_fallback_to_internal_auth>
 
 If C<web_fallback_to_internal_auth> is ''ined, the user is allowed a chance
 of fallback to the login screen, even if REMOTE_USER failed.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<web_external_gecos>
 
 C<web_external_gecos> means to match 'gecos' field as the user identity);
 useful with mod_auth_pwcheck and IIS Integrated Windows logon.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<web_external_auto>
 
 C<web_external_auto> will create users under the same name as REMOTE_USER
 upon login, if it's missing in the Users table.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<auto_create>
 
@@ -650,7 +650,7 @@ Create method.  Use it to set defaults, such as creating
 Unprivileged users with C<{ privileged => 0 }>
 ( Must be a hashref of arguments )
 
-default: C<undef>
+Default: C<undef>
 
 =item C<web_session_class>
 
@@ -668,7 +668,7 @@ browser. With the C<auto_logoff> option you can setup session lifetime in
 minutes. A user will be logged out if he or she doesn't send any requests 
 to RT for the defined time.
 
-default: C<0>
+Default: C<0>
 
 =item C<web_secure_cookies>
 
@@ -679,7 +679,7 @@ and so on. To enable this behaviour, set C<web_secure_cookies> to a true value.
 NOTE: You probably don't want to turn this on _unless_ users are only connecting
 via SSL encrypted HTTP connections.
 
-default: C<0>
+Default: C<0>
 
 =item C<web_flush_db_cache_every_request>
 
@@ -690,7 +690,7 @@ Setting C<web_flush_db_cache_every_request> to '0' will turn this off,
 which will speed RT up a bit, at the expense of a tiny bit of data 
 accuracy.
 
-default: C<'1'>
+Default: C<'1'>
 
 
 =item C<max_inline_body>
@@ -700,20 +700,20 @@ inline when viewing a transaction.  RT will inline any text if value
 is ''ined or 0.  This option can be overridden by users in their
 preferences.
 
-default: C<12000>
+Default: C<12000>
 
 =item C<default_summary_rows>
 
 C<default_summary_rows> is default number of rows displayed in for search
 results on the frontpage.
 
-default: C<10>
+Default: C<10>
 
 =item C<disable_graphviz>
 
 Disable GraphViz or not
 
-default: C<'0'>
+Default: C<'0'>
 
 =item C<oldest_transactions_first>
 
@@ -721,14 +721,14 @@ By default, RT shows newest transactions at the bottom of the ticket
 history page, if you want see them at the top set this to '0'.  This
 option can be overridden by users in their preferences.
 
-default: C<'1'>
+Default: C<'1'>
 
 =item C<show_transaction_images>
 
 By default, RT shows images attached to incoming (and outgoing) ticket updates
 inline. Set this variable to 0 if you'd like to disable that behaviour
 
-default: C<1>
+Default: C<1>
 
 =item C<plain_text_pre>
 
@@ -738,7 +738,7 @@ to be displayed correctly.  By setting $plain_text_pre they'll be
 displayed using <pre> instead so such formatting works, but they'll
 use a monospaced font.
 
-default: C<0>
+Default: C<0>
 
 
 =item C<show_unread_message_notifications>
@@ -748,7 +748,7 @@ tickets they are viewing.
 
 Set C<show_unread_message_notifications> to a false value to disable this feature.
 
-default: C<1>
+Default: C<1>
 
 
 =item C<homepage_components>
@@ -756,7 +756,7 @@ default: C<1>
 C<homepage_components> is an arrayref of allowed components on a user's
 customized homepage ("RT at a glance").
 
-default: C<[qw(QuickCreate QuickSearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards)]>
+Default: C<[qw(QuickCreate QuickSearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards)]>
 
 
 =item C<mason_parameters>
@@ -768,13 +768,13 @@ for debugging, eg. profiling individual components with:
     use MasonX::Profiler; # available on CPAN
     default: C<[preamble => 'my $p = MasonX::Profiler->new($m, $r);']>
 
-default: C<[]>
+Default: C<[]>
 
 =item C<default_search_result_format>
 
-default format for RT search results
+Default format for RT search results
 
-default: C<< qq{
+Default: C<< qq{
    '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
    '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__subject__</a></B>/TITLE:subject',
    status,
@@ -796,7 +796,7 @@ If C<suppress_inline_text_files> is set to a true value, then uploaded
 text files (text-type attachments with file names) are prevented
 from being displayed in-line when viewing a ticket's history.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<dont_search_file_attachments>
 
@@ -804,7 +804,7 @@ If C<dont_search_file_attachments> is set to a true value, then uploaded
 files (attachments with file names) are not searched during full-content
 ticket searches.
 
-default: C<undef>
+Default: C<undef>
 
 =item C<chart_font>
 
@@ -813,7 +813,7 @@ have full Unicode support. You can use a particular TrueType font by setting
 $chart_font to the absolute path of that font. Your GD library must have
 support for TrueType fonts to use this option.
 
-default: C<undef>
+Default: C<undef>
 
 
 =item C<active_make_clicky>
@@ -832,7 +832,7 @@ provides two formats:
 
 See F<share/html/Elements/MakeClicky> for documentation on how to add your own.
 
-default: C<[]>
+Default: C<[]>
 
 =item C<default_queue>
 
@@ -840,7 +840,7 @@ Use this to select the default queue name that will be used for creating new
 tickets. You may use either the queue's name or its ID. This only affects the
 queue selection boxes on the web interface.
 
-default: C<'General'>
+Default: C<'General'>
 
 =back
 
@@ -854,7 +854,7 @@ The absolute minimum and maximum number of servers that will be created to
 handle requests. Having multiple servers means that serving a slow page will
 affect other users less.
 
-default:
+Default:
 standalone_min_servers => C<1>
 standalone_max_servers => C<1>
 
@@ -863,7 +863,7 @@ standalone_max_servers => C<1>
 These next two options can be used to scale up and down the number of servers
 to adjust to load. These two options will respect the C<$standalone_min_servers
 > and C<$standalone_max_servers options>.
-default:
+Default:
 standalone_min_spare_servers => C<0>
 standalone_max_spare_servers => C<0>
 
@@ -873,7 +873,7 @@ This sets the absolute maximum number of requests a single server will serve.
 Setting this would be useful if, for example, memory usage slowly crawls up
 every hit.
 
-default: C<50>
+Default: C<50>
 
 =item C<net_server_options>
 
@@ -883,7 +883,7 @@ reverse_lookups to get the hostnames for all users with:
 
 C<< {reverse_lookups => 1} >>
 
-default: C<[]>
+Default: C<[]>
 
 =back
 
@@ -897,7 +897,7 @@ An array that contains languages supported by RT's internationalization
 interface.  Defaults to all *.po lexicons; setting it to C<qw(en ja)> will make
 RT bilingual instead of multilingual, but will save some memory.
 
-default: C<[qw(*)]>
+Default: C<[qw(*)]>
 
 =item C<email_input_encodings>
 
@@ -905,13 +905,13 @@ An array that contains default encodings used to guess which charset
 an attachment uses if not specified.  Must be recognized by
 L<Encode::Guess>.
 
-default: C<[qw(utf-8 iso-8859-1 us-ascii)]>
+Default: C<[qw(utf-8 iso-8859-1 us-ascii)]>
 
 =item C<email_output_encoding>
 
 The charset for localized email.  Must be recognized by Encode.
 
-default: C<'utf-8'>
+Default: C<'utf-8'>
 
 
 =back
@@ -929,28 +929,28 @@ This option can be overridden by users in their preferences.
 
 Some examples: C<'iso'>, C<'rfc2822'>
 
-default: C<'iso'>
+Default: C<'iso'>
 
 =item C<date_day_before_month>
 
 Set this to 1 if your local date convention looks like "dd/mm/yy"
 instead of "mm/dd/yy".
 
-default: C<1>
+Default: C<1>
 
 =item C<ambiguous_day_in_past>, C<ambiguous_day_in_future>
 
 Should an unspecified day or year in a date refer to a future or a
 past value? For example, should a date of "Tuesday" default to mean
 the date for next Tuesday or last Tuesday? Should the date "March 1"
-default to the date for next March or last March?
+Default to the date for next March or last March?
 
 Set $<AmbiguousDayInPast> for the last date, or $<$ambiguous_day_in_future> for the
 next date.
 
 The default is usually good.
 
-default:
+Default:
 
 ambiguous_day_in_past => C<0>
 
@@ -969,7 +969,7 @@ WARNING. DO NOT DELETE ANY OF THE DEFAULT STATUSES. If you do, RT
 will break horribly. The statuses you add must be no longer than
 10 characters.
 
-default:
+Default:
 active_status => C<[qw(new open stalled)]>
 inactive_status =>  C<[qw(resolved rejected deleted)]>
 
@@ -979,7 +979,7 @@ RT-3.4 backward compatibility setting. Add/Delete Link used to record one
 transaction and run one scrip. Set this value to 1 if you want
 only one of the link transactions to have scrips run.
 
-default: C<0>
+Default: C<0>
 
 =item C<strict_link_acl>
 
@@ -987,14 +987,14 @@ When this feature is enabled a user needs I<ModifyTicket> rights on both
 tickets to link them together, otherwise he can have rights on either of
 them.
 
-default: C<1>
+Default: C<1>
 
 =item C<preview_scrip_messages>
 
 Set C<preview_scrip_messages> to 1 if the scrips preview on the ticket
 reply page should include the content of the messages to be sent.
 
-default: C<0>
+Default: C<0>
 
 =item C<use_transaction_batch>
 
@@ -1003,7 +1003,7 @@ such that a resolve and comment (for example) would happen
 simultaneously, instead of as two transactions, unaware of each
 others' existence.
 
-default: C<1>
+Default: C<1>
 
 =item C<custom_field_values_sources>
 
@@ -1011,7 +1011,7 @@ Set C<custom_field_values_sources> to a list of class names which extend
 L<RT::CustomFieldValues::External>.  This can be used to pull lists of
 custom field values from external sources at runtime.
 
-default: C<[]>
+Default: C<[]>
 
 =item C<canonicalize_redirect_urls>
 
@@ -1021,13 +1021,13 @@ than the one we get from C<env>.
 If you use RT behind a reverse proxy, you almost certainly want to
 enable this option.
 
-default: C<0>
+Default: C<0>
 
 =item C<enable_reminders>
 
 Hide links/portlets related to Reminders by setting this to 0
 
-default: C<1>
+Default: C<1>
 
 =back
 

commit bacd0f1d9b6016eae01c2d618b0260599f53538c
Author: Thomas Sibley <trs at bestpractical.com>
Date:   Fri Jul 9 17:55:29 2010 -0400

    Spruce up the config field doc and step
    
    Now with snazzy JS that should get standardized across all the config
    forms where applicable.  It also might be too snazzy, in which case we
    should move descriptions to the right instead of underneath.

diff --git a/lib/RT/Action/ConfigSystem.pm b/lib/RT/Action/ConfigSystem.pm
index 5f9c203..272e97c 100644
--- a/lib/RT/Action/ConfigSystem.pm
+++ b/lib/RT/Action/ConfigSystem.pm
@@ -13,10 +13,21 @@ sub arguments {
     return $self->{__cached_arguments} if ( $self->{__cached_arguments} );
     my $args = {};
 
+    # Translate from config name to a friendly label
+    my %labels = (
+        rtname      => 'RT Name',
+        time_zone   => 'Timezone',
+    );
+
     my $configs = RT::Model::ConfigCollection->new;
     $configs->unlimit;
     while ( my $config = $configs->next ) {
         my $value = RT->config->get( $config->name );
+        my $label = ucfirst $config->name;
+        $label =~ tr/_/ /;
+
+        $label = $labels{$config->name} if $labels{$config->name};
+
         $args->{ $config->name } = {
             default_value => defer {
                 local $Data::Dumper::Terse = 1;
@@ -26,6 +37,7 @@ sub arguments {
                 $dump =~ s/['"]\s*$//;
                 return $dump;
             },
+            label => $label,
             ref $value ? ( render_as => 'textarea' ) : (),
         };
 
diff --git a/lib/RT/Config.pod b/lib/RT/Config.pod
index b00f4c3..9d7c3ca 100644
--- a/lib/RT/Config.pod
+++ b/lib/RT/Config.pod
@@ -6,12 +6,12 @@ package RT::Config;
 
 =item C<rtname>
 
-C<rtname> is the string that RT will look for in mail messages to
+C<rtname> is the string that RT will look for in email subjects to
 figure out what ticket a new piece of mail belongs to.
 
-Your domain name is recommended, so as not to pollute the namespace.
-once you start using a given tag, you should probably never change it.
-(otherwise, mail for existing tickets won't get put in the right place)
+Your domain name is recommended so as not to pollute the namespace.
+Once you start using a given tag, you should probably never change it.
+(Otherwise mail for existing tickets won't get put in the right place.)
 
 Default: C<"example.com">
 
@@ -54,10 +54,13 @@ Default: C<"5">
 
 =item C<time_zone>
 
-C<time_zone> is used to convert times entered by users into GMT and back again
+Set the default timezone you want RT to use for displaying dates and times.
+Individual users are able to choose their own timezone in their preferences.
+
+=for man
 It should be set to a time zone recognized by L<DateTime::TimeZone>.
 
-Default: C<'America/New_York'>
+Default: C<"America/New_York">
 
 =back
 
diff --git a/lib/RT/View/SetupWizard.pm b/lib/RT/View/SetupWizard.pm
index ab6ec16..ff335a9 100644
--- a/lib/RT/View/SetupWizard.pm
+++ b/lib/RT/View/SetupWizard.pm
@@ -132,15 +132,29 @@ template 'organization' => setup_page {
     my $config = new_action( class => 'RT::Action::ConfigSystem' );
     my $meta = $config->metadata;
 
-    render_param( $config => 'rtname' );
-    p {
-        outs_raw( $meta->{'rtname'}{'doc'} )
-    } if $meta->{'rtname'};
+    my $selector = 'jQuery(this).parent().parent().find(".doc")';
+
+    for my $field (qw( rtname organization time_zone )) {
+        div {{ class is 'config-field' };
+            render_param(
+                $config => $field,
+                onfocus => "$selector.slideDown();",
+                onblur  => "$selector.slideUp();",
+            );
+            div {{ class is 'doc' };
+                outs_raw( $meta->{$field}{'doc'} )
+            } if $meta->{$field} and defined $meta->{$field}{'doc'};
+        };
+    }
 
-    render_param( $config => 'time_zone' );
-    p {
-        outs_raw( $meta->{'time_zone'}{'doc'} )
-    } if $meta->{'time_zone'};
+    script {
+        outs_raw(<<'JSEND');
+jQuery(function() {
+    jQuery('.config-field .doc').hide();
+    jQuery('.config-field .widget')[0].focus();
+});
+JSEND
+    };
     
     show 'buttons', for => 'organization';
 };
diff --git a/share/web/static/css/app.css b/share/web/static/css/app.css
index 5269f16..1a17d7e 100644
--- a/share/web/static/css/app.css
+++ b/share/web/static/css/app.css
@@ -12,6 +12,7 @@
 @import "tools.css";
 @import "admin.css";
 @import "misc.css";
+ at import "setupwizard.css";
 @import "yui/calendar/calendar.css";
 
 @import "rulebuilder.css";
diff --git a/share/web/static/css/setupwizard.css b/share/web/static/css/setupwizard.css
new file mode 100644
index 0000000..fc21957
--- /dev/null
+++ b/share/web/static/css/setupwizard.css
@@ -0,0 +1,17 @@
+.config-field .form_field .label {
+    width: 12em;
+    font-weight: bold;
+    font-size: 1em;
+    line-height: 1.6em;
+}
+
+.config-field .doc {
+    display: block;
+    width: 50%;
+    margin-left: 12.7em;
+}
+
+.config-field .doc p:first-child {
+    padding-top: 0;
+    margin-top: 0;
+}

-----------------------------------------------------------------------


More information about the Rt-commit mailing list