Skip to content

Commit

Permalink
1.4.4dev: Sync from t.e.o wiki
Browse files Browse the repository at this point in the history
git-svn-id: http://trac.edgewall.org/intertrac/log:/branches/1.4-stable@17715 af82e41b-90c4-0310-8c96-b1721e28e2e2
  • Loading branch information
rjollos committed Aug 11, 2023
1 parent d2791f6 commit 5343cb8
Show file tree
Hide file tree
Showing 15 changed files with 83 additions and 63 deletions.
2 changes: 1 addition & 1 deletion INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -747,7 +747,7 @@ See also: `TracInstallPlatforms`_, `TracGuide`_, `TracUpgrade`_
.. _pyreadline: https://pypi.org/project/pyreadline
.. _PySqlite*: https://trac.edgewall.org/intertrac/PySqlite%23ThePysqlite2bindings
.. _pysqlite: https://pypi.org/project/pysqlite
.. _PySVN: http://pysvn.tigris.org/
.. _PySVN: https://pypi.org/project/PySVN
.. _Python: https://www.python.org/
.. _pytz: http://pytz.sourceforge.net
.. _Running the Standalone Server: https://trac.edgewall.org/wiki/TracInstall#RunningtheStandaloneServer
Expand Down
11 changes: 7 additions & 4 deletions trac/wiki/default-pages/InterMapTxt
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ MODPYTHON https://issues.apache.org/jira/browse/MODPYTHON- # Issue $1 i
mod-python-issue https://issues.apache.org/jira/browse/MODPYTHON- # Issue $1 in mod_python's JIRA instance

SvnWiki https://www.orcaware.com/svn/wiki/ # Subversion Wiki
svnissue http://subversion.tigris.org/issues/show_bug.cgi?id= # Subversion issue #$1
svn-issue http://subversion.tigris.org/issues/show_bug.cgi?id= # Subversion issue #$1
svncset http://svn.collab.net/viewvc/svn?view=revision&revision= # Subversion [$1]
svnissue https://issues.apache.org/jira/browse/SVN- # Subversion issue #$1
svn-issue https://issues.apache.org/jira/browse/SVN- # Subversion issue #$1
svncset https://svn.apache.org/r # Subversion [$1]

mod-wsgi https://code.google.com/p/modwsgi/wiki/ # mod_wsgi Wiki on Google Code
mod-wsgi-issue https://code.google.com/p/modwsgi/issues/detail?id= # mod_wsgi Issue Tracker on Google Code
Expand All @@ -84,7 +84,10 @@ MediaWiki https://www.mediawiki.org/wiki/

SO https://stackoverflow.com/questions/ # Question $1 in StackOverflow

Transifex https://www.transifex.com/projects/p/trac/
Transifex https://www.transifex.com/cboos/trac/
TransifexLang https://www.transifex.com/cboos/trac/language/$1/
TransifexResource https://www.transifex.com/cboos/trac/$1/
TransifexView https://www.transifex.com/cboos/trac/viewstrings/#$1/$2

kwquery /query?group=status&keywords=~ # Custom query for tickets matching keyword $1

Expand Down
2 changes: 1 addition & 1 deletion trac/wiki/default-pages/TracBackup
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Trac backups are a copied snapshot of the entire [TracEnvironment project environment] directory, including the database. Backups can be created using the `hotcopy` command of [TracAdmin trac-admin].

'''Note''': Trac uses the `hotcopy` nomenclature to match that of [http://subversion.tigris.org/ Subversion], to make it easier to remember when managing both Trac and Subversion servers.
'''Note''': Trac uses the `hotcopy` nomenclature to match that of [https://subversion.apache.org/ Subversion].

== Creating a Backup

Expand Down
9 changes: 9 additions & 0 deletions trac/wiki/default-pages/TracChangeLog
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ To see where Trac is going in future releases, see the [trac:roadmap Roadmap].

== 1.4.x Releases

=== 1.4.4

//(August 11, 2023)//

Trac 1.4.4 contains about a dozen minor fixes
and improvements.

[trac:source:/tags/trac-1.4.4 View Tag] | [trac:milestone:1.4.4 View Milestone]

=== 1.4.3

//(May 9, 2021)//
Expand Down
4 changes: 2 additions & 2 deletions trac/wiki/default-pages/TracChangeset
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ The changeset view consists of two parts, the ''header'' and the ''diff views''.
The header shows an overview of the whole changeset.
Here you will find metadata:

* Timestamp — When the changeset was commited
* Author — Who commited the changeset
* Timestamp — When the changeset was committed
* Author — Who committed the changeset
* Message — A brief description from the author (the commit log message)
* Location — Parent directory of all files affected by this changeset
* Files — A list of files affected by this changeset
Expand Down
2 changes: 1 addition & 1 deletion trac/wiki/default-pages/TracImport
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ For more details on the available options, see the configuration section at the

== !PlanetForge

[https://trac-hacks.org/wiki/PlanetForgeImportExportPlugin PlanetForgeImportExportPlugin]: this plugin exports Trac data (wiki, tickets, compoments, permissions, repositories, etc.) using the open format designed by the [https://gforge.inria.fr/projects/coclico/ COCLICO] project. It extends the webadmin panel and the 'trac admin ...' command. Has no 'import' feature.
[https://trac-hacks.org/wiki/PlanetForgeImportExportPlugin PlanetForgeImportExportPlugin]: this plugin exports Trac data (wiki, tickets, components, permissions, repositories, etc.) using the open format designed by the [https://gforge.inria.fr/projects/coclico/ COCLICO] project. It extends the webadmin panel and the 'trac admin ...' command. Has no 'import' feature.

== Scarab

Expand Down
2 changes: 1 addition & 1 deletion trac/wiki/default-pages/TracInstall
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ There are [https://subversion.apache.org/packages.html pre-compiled SWIG binding

{{{#!div style="border: 1pt dotted; margin: 1em"
**Note:**
* Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings.
* Trac '''doesn't''' use [https://pypi.org/project/PySVN PySVN], nor does it work yet with the newer `ctype`-style bindings.
* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are [trac:ticket:493 not supported].
}}}

Expand Down
4 changes: 2 additions & 2 deletions trac/wiki/default-pages/TracInterfaceCustomization
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Say you want to add a link to a custom stylesheet, and then your own header and
}}}

Notice that as Jinja2 is mostly content agnostic, you are free to open some `<div>` element in the `site_header.html` file and only close it in `site_footer.html` file.
Besides, as in any other Trac Jinja2 template, you can use some Trac specific features, for example the `${href.chrome('site/style.css')}` attribute references `style.css` in the environment's `htdocs/` directory. In a similar fashion `${chrome.htdocs_location}` is used to specify the common `htdocs/` directory belonging to a Trac installation. That latter location can however be overriden using the [TracIni#trac-htdocs_location-option "[trac] htdocs_location"] setting.
Besides, as in any other Trac Jinja2 template, you can use some Trac specific features, for example the `${href.chrome('site/style.css')}` attribute references `style.css` in the environment's `htdocs/` directory. In a similar fashion `${chrome.htdocs_location}` is used to specify the common `htdocs/` directory belonging to a Trac installation. That latter location can however be overridden using the [TracIni#trac-htdocs_location-option "[trac] htdocs_location"] setting.

Example snippet of adding introduction text to the new ticket form (but not shown during preview):

Expand Down Expand Up @@ -193,7 +193,7 @@ $ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template

== Project Templates

The appearance of each individual Trac environment, ie instance of a project, can be customized independently of other projects, even those hosted on the same server. The recommended way is to use `site_{head,header,footer}.html` templates whenever possible, see [#SiteAppearance]. Using `site_{head,header,footer}.html` means changes are made to the original templates as they are rendered, and you should not normally need to redo modifications whenever Trac is upgraded. If you do make a copy of `theme.html` or any other Trac template, you need to migrate your modifiations to the newer version. If not, new Trac features or bug fixes may not work as expected.
The appearance of each individual Trac environment, ie instance of a project, can be customized independently of other projects, even those hosted on the same server. The recommended way is to use `site_{head,header,footer}.html` templates whenever possible, see [#SiteAppearance]. Using `site_{head,header,footer}.html` means changes are made to the original templates as they are rendered, and you should not normally need to redo modifications whenever Trac is upgraded. If you do make a copy of `theme.html` or any other Trac template, you need to migrate your modifications to the newer version. If not, new Trac features or bug fixes may not work as expected.

With that word of caution, any Trac template may be copied and customized. The default Trac templates are located in the Trac egg or wheel, such as `/usr/lib/pythonVERSION/site-packages/Trac-VERSION.egg/trac/templates, ../trac/ticket/templates, ../trac/wiki/templates`. The [#ProjectList] template file is called `index.html`, while the template responsible for main layout is called `theme.html`. Page assets such as images and CSS style sheets are located in the egg's or wheel's `trac/htdocs` directory.

Expand Down
2 changes: 1 addition & 1 deletion trac/wiki/default-pages/TracModPython
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ PythonOption TracEnvParentDir /var/trac/myprojects
# For the index of multiple projects
PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html

# A space delimitted list, with a "," between key and value pairs.
# A space delimited list, with a "," between key and value pairs.
PythonOption TracTemplateVars key1,val1 key2,val2

# Useful to get the date in the wanted order
Expand Down
2 changes: 1 addition & 1 deletion trac/wiki/default-pages/TracModWSGI
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ Configuration for [https://httpd.apache.org/docs/2.4/mod/mod_ldap.html mod_ldap]
</Location>
}}}

Note 1: This is the case where the LDAP search will get around the multiple OUs, conecting to the Global Catalog Server portion of AD. Note the port is 3268, not the normal LDAP 389. The GCS is basically a "flattened" tree which allows searching for a user without knowing to which OU they belong.
Note 1: This is the case where the LDAP search will get around the multiple OUs, connecting to the Global Catalog Server portion of AD. Note the port is 3268, not the normal LDAP 389. The GCS is basically a "flattened" tree which allows searching for a user without knowing to which OU they belong.

Note 2: You can also require the user be a member of a certain LDAP group, instead of just having a valid login:
{{{#!apache
Expand Down
12 changes: 8 additions & 4 deletions trac/wiki/default-pages/TracNotification
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To receive notification mails, you can either enter a full email address or your

Alternatively, a default domain name ('''`smtp_default_domain`''') can be set in the TracIni file, see [#ConfigurationOptions Configuration Options] below. In this case, the default domain will be appended to the username, which can be useful for an "Intranet" kind of installation.

When using apache and mod_kerb for authentication against Kerberos / Active Directory, usernames take the form ('''`[email protected]`'''). To avoid this being interpreted as an email address, add the Kerberos domain to ('''`ignore_domains`''').
When using apache and mod_kerb for authentication against Kerberos / Active Directory, usernames take the form ('''`[email protected]`'''). To avoid this being interpreted as an email address, add the Kerberos domain to ('''`ignore_domains`''').

=== Ticket attachment notifications

Expand Down Expand Up @@ -208,7 +208,7 @@ If notifications are not working, inspect the [TracLogging log] for error messag

Notification errors are not always reported through the web interface, so the user who submits a change or creates a ticket may not get notified about a notification failure. The Trac administrator needs to look at the log to find the error message and traceback.

=== ''Permission denied'' error
=== Permission denied error

Typical error message:
{{{#!sh
Expand Down Expand Up @@ -239,13 +239,17 @@ For SELinux in Fedora 10:
$ setsebool -P httpd_can_sendmail 1
}}}

=== ''Suspected spam'' error
=== Suspected spam error

Some SMTP servers may reject the notification email sent by Trac.

The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' spam detection on sensitive email servers. In such an event, change the default encoding to "quoted-printable" using the `mime_encoding` option.

Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.

=== Emails not sent

If you are switching back to using Trac to send emails from, say, the [https://trac-hacks.org/wiki/AnnouncerPlugin AnnouncerPlugin], be sure to enable `EmailDistributor` in your Trac configuration. It may have been disabled when using an email plugin. There may be no message in the Trac log when all is good to go, but the actual sending is disabled.

----
See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]
See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]
Loading

0 comments on commit 5343cb8

Please sign in to comment.