Edgewall Software
Modify

Opened 5 years ago

Closed 5 years ago

Last modified 4 years ago

#13271 closed enhancement (fixed)

Improve documentation for [project] url and [trac] base_url

Reported by: Ryan J Ollos Owned by: Ryan J Ollos
Priority: normal Milestone: 1.5.1
Component: general Version:
Severity: normal Keywords:
Cc: Branch:
Release Notes:
API Changes:
Internal Changes:

Improved TracIni documentation for trac.base_url and project.url.

Description

Discussed in gmessage:trac-users:eg9APtcEUiU/2V451tnuFgAJ. Minor changes proposed:

  • trac/env.py

    diff --git a/trac/env.py b/trac/env.py
    index 32581f1fe..1cc0a15c2 100644
    a b class Environment(Component, ComponentManager):  
    131131        """)
    132132
    133133    base_url = Option('trac', 'base_url', '',
    134         """Reference URL for the Trac deployment.
     134        """Base URL of the Trac site.
    135135
    136         This is the base URL that will be used when producing
    137         documents that will be used outside of the web browsing
    138         context, like for example when inserting URLs pointing to Trac
    139         resources in notification e-mails.""")
     136        This is used to produce documents outside of the web browsing
     137        context, such as URLs in notification e-mails that point to
     138        Trac resources.
     139        """)
    140140
    141141    base_url_for_redirect = BoolOption('trac', 'use_base_url_for_redirect',
    142142                                        False,
    class Environment(Component, ComponentManager):  
    173173        """Short description of the project.""")
    174174
    175175    project_url = Option('project', 'url', '',
    176         """URL of the main project web site, usually the website in
    177         which the `base_url` resides. This is used in notification
    178         e-mails.""")
     176        """URL of the project web site.
     177
     178        This is usually the domain in which the `base_url` resides.
     179        For example, the project URL might be https://myproject.com,
     180        with the Trac site (`base_url`) residing at either
     181        https://trac.myproject.com or https://myproject.com/trac.
     182        The project URL is added to the footer of notification e-mails.
     183        """)
    179184
    180185    project_admin = Option('project', 'admin', '',
    181186        """E-Mail address of the project's administrator.""")

Attachments (0)

Change History (2)

comment:1 by Ryan J Ollos, 5 years ago

Release Notes: modified (diff)
Resolution: fixed
Status: assignedclosed

Committed to trunk in r17272. New extraction in r17273.

comment:2 by Ryan J Ollos, 4 years ago

Internal Changes: modified (diff)
Release Notes: modified (diff)

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Ryan J Ollos.
The resolution will be deleted. Next status will be 'reopened'.
to The owner will be changed from Ryan J Ollos to the specified user.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.