Skip to content

Commit f92dccc

Browse files
committed
Formatting fixes
Fix some blocks that should be code blocks but weren't. Use smaller type for larger/wide code blocks by replacing: stuff:: wide code here with: stuff: .. code:: :class: big-code wide code here The big-code class uses a smaller font size so it fits the width of the page without overflow. Fix an ordered list that was indented more than it should have been.
1 parent 2c31b46 commit f92dccc

File tree

1 file changed

+32
-20
lines changed

1 file changed

+32
-20
lines changed

doc/upgrading.txt

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1098,11 +1098,11 @@ have a ``detectors/config.ini`` file. (Note this is
10981098
``config.ini`` file at the root of the tracker home.)
10991099

11001100
This enhancement is disabled by default. Enable it by changing the
1101-
value in ``detectors/config.ini`` from:
1101+
value in ``detectors/config.ini`` from::
11021102

11031103
chatting_requires_two_users = False
11041104

1105-
to
1105+
to::
11061106

11071107
chatting_requires_two_users = True
11081108

@@ -1142,15 +1142,15 @@ Jinja template changes
11421142

11431143
Auto escaping has been enabled in the jinja template engine, this
11441144
means it is no longer necessary to manually escape dynamic strings
1145-
with "\|e", but strings that should not be escaped need to be marked
1146-
with "\|safe" (e.g. "{{ context.history()|u|safe }}"). Also, the i18n
1145+
with ``|e``, but strings that should not be escaped need to be marked
1146+
with ``|safe`` (e.g. ``{{ context.history()|u|safe }}``). Also, the i18n
11471147
extension has been enabled and the template has been updated to use
1148-
the extension for translatable text instead of explicit "i18n.gettext"
1149-
calls:
1148+
the extension for translatable text instead of explicit ``i18n.gettext``
1149+
calls::
11501150

11511151
{% trans %}List of issues{% endtrans %}
11521152

1153-
instead of:
1153+
instead of::
11541154

11551155
{{ i18n.gettext('List of issues')|u }}
11561156

@@ -1185,14 +1185,14 @@ Update tracker config file
11851185
After installing the new version of roundup, you should
11861186
update the ``config.ini`` file for your tracker. To do this:
11871187

1188-
1. backup your existing ``config.ini`` file
1189-
2. using the newly installed code, run::
1188+
1. backup your existing ``config.ini`` file
1189+
2. using the newly installed code, run::
11901190

1191-
roundup-admin -i /path/to/tracker updateconfig config.ini.new
1191+
roundup-admin -i /path/to/tracker updateconfig config.ini.new
11921192

1193-
to create the file config.ini.new. Replace
1194-
``/path/to/tracker`` with the path to your tracker.
1195-
3. replace your tracker's config.ini with config.ini.new
1193+
to create the file config.ini.new. Replace
1194+
``/path/to/tracker`` with the path to your tracker.
1195+
3. replace your tracker's config.ini with config.ini.new
11961196

11971197
Using updateconfig keeps all the settings from your
11981198
tracker's config.ini file and adds settings for all the new
@@ -1278,7 +1278,7 @@ is not true the post is rejected and the user is notified.
12781278
The standard context/submit templating item creates CSRF tokens by
12791279
default. If you have forms using the POST method that are not using
12801280
the standard submit routine, you should add the following field to all
1281-
forms:
1281+
forms::
12821282

12831283
<input name="@csrf" type="hidden"
12841284
tal:attributes="value python:utils.anti_csrf_nonce()">
@@ -1288,7 +1288,7 @@ utils.anti_csrf_nonce() and is put in a database to be
12881288
retreived if the token is used. Token lifetimes are 2 weeks
12891289
by default but can be configured in config.ini. Roundup will
12901290
automatically prune old tokens. Calling anti_csrf_nonce with
1291-
an integer lifetime, for example:
1291+
an integer lifetime, for example::
12921292

12931293
<input name="@csrf" type="hidden"
12941294
tal:attributes="value python:utils.anti_csrf_nonce(lifetime=10)">
@@ -1502,11 +1502,17 @@ tracker's base url. If the base_url uses http, you can set the url to
15021502
https.
15031503

15041504
Replace the existing code in the tracker's html/page.html page that
1505-
looks similar to (look for name="__came_from")::
1505+
looks similar to (look for name="__came_from"):
1506+
1507+
.. code::
1508+
:class: big-code
1509+
1510+
<input type="hidden" name="__came_from" tal:attributes="value string:${request/base}${request/env/PATH_INFO}">
15061511

1507-
<input type="hidden" name="__came_from" tal:attributes="value string:${request/base}${request/env/PATH_INFO}">
1512+
with the following:
15081513

1509-
with the following::
1514+
.. code:: html
1515+
:class: big-code
15101516

15111517
<input type="hidden" name="__came_from"
15121518
tal:condition="exists:request/env/QUERY_STRING"
@@ -1552,7 +1558,10 @@ a new checkbox (checked by default) that keeps you on the same page so
15521558
you can add a new keywords one after the other.
15531559

15541560
To add this to your own tracker, add the following code (prefixed with
1555-
a +) after the entry box for the new keyword in html/keyword.item.html::
1561+
a +) after the entry box for the new keyword in html/keyword.item.html:
1562+
1563+
.. code::
1564+
:class: big-code
15561565

15571566
<tr>
15581567
<th i18n:translate="">Keyword</th>
@@ -1643,7 +1652,10 @@ The default templates have been updated to use this in the "Your
16431652
Query" section of the trackers html/page.html file. You will want to
16441653
change your template. Lines starting with - are the original line and
16451654
you want to change it to match the line starting with the + (remove
1646-
the + from the line)::
1655+
the + from the line):
1656+
1657+
.. code::
1658+
:class: big-code
16471659

16481660
<tal:block tal:repeat="qs request/user/queries">
16491661
- <a href="#" tal:attributes="href string:${qs/klass}?${qs/url}&@dispname=${qs/name}"

0 commit comments

Comments
 (0)