Mercurial Repository: p/roundup/code: doc/upgrading.txt comparison

comparison doc/upgrading.txt @ 7277:41b2a0e12899

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.

author	John Rouillard <rouilj@ieee.org>
date	Mon, 24 Apr 2023 23:26:18 -0400
parents	c5d01886b27d
children	194093011cb7

comparison

equal deleted inserted replaced

-:90c70726e882
+:41b2a0e12899
 have a ``detectors/config.ini`` file. (Note this is
 ``detectors/config.ini`` do not confuse it with the main
 ``config.ini`` file at the root of the tracker home.)
 This enhancement is disabled by default. Enable it by changing the
-value in ``detectors/config.ini`` from:
+value in ``detectors/config.ini`` from::
 chatting_requires_two_users = False
-to
+to::
 chatting_requires_two_users = True
 (the values ``no`` and ``yes`` can also be used). Restart the tracker
 to enable the change.
 Jinja template changes
 ----------------------
 Auto escaping has been enabled in the jinja template engine, this
 means it is no longer necessary to manually escape dynamic strings
-with "\|e", but strings that should not be escaped need to be marked
+with ``|e``, but strings that should not be escaped need to be marked
-with "\|safe" (e.g. "{{ context.history()|u|safe }}"). Also, the i18n
+with ``|safe`` (e.g. ``{{ context.history()|u|safe }}``). Also, the i18n
 extension has been enabled and the template has been updated to use
-the extension for translatable text instead of explicit "i18n.gettext"
+the extension for translatable text instead of explicit ``i18n.gettext``
-calls:
+calls::
 {% trans %}List of issues{% endtrans %}
-instead of:
+instead of::
 {{ i18n.gettext('List of issues')|u }}
 The jinja template has been upgraded to use bootstrap 4.1.3 (from
 2.2.2). You can diff/merge changes into your jinja template based
 --------------------------
 After installing the new version of roundup, you should
 update the ``config.ini`` file for your tracker. To do this:
 1. backup your existing ``config.ini`` file
 2. using the newly installed code, run::
 roundup-admin -i /path/to/tracker updateconfig config.ini.new
 to create the file config.ini.new. Replace
 ``/path/to/tracker`` with the path to your tracker.
 3. replace your tracker's config.ini with config.ini.new
 Using updateconfig keeps all the settings from your
 tracker's config.ini file and adds settings for all the new
 options.
 is not true the post is rejected and the user is notified.
 The standard context/submit templating item creates CSRF tokens by
 default. If you have forms using the POST method that are not using
 the standard submit routine, you should add the following field to all
-forms:
+forms::
 <input name="@csrf" type="hidden"
 tal:attributes="value python:utils.anti_csrf_nonce()">
 A unique random token is generated by every call to
 utils.anti_csrf_nonce() and is put in a database to be
 retreived if the token is used. Token lifetimes are 2 weeks
 by default but can be configured in config.ini. Roundup will
 automatically prune old tokens. Calling anti_csrf_nonce with
-an integer lifetime, for example:
+an integer lifetime, for example::
 <input name="@csrf" type="hidden"
 tal:attributes="value python:utils.anti_csrf_nonce(lifetime=10)">
 sets the lifetime of that nonce to 10 minutes.
 assigned to __came_from must be url encoded/quoted and be under the
 tracker's base url. If the base_url uses http, you can set the url to
 https.
 Replace the existing code in the tracker's html/page.html page that
-looks similar to (look for name="__came_from")::
+looks similar to (look for name="__came_from"):
-<input type="hidden" name="__came_from" tal:attributes="value string:${request/base}${request/env/PATH_INFO}">
+.. code::
+:class: big-code
-with the following::
+<input type="hidden" name="__came_from" tal:attributes="value string:${request/base}${request/env/PATH_INFO}">
+with the following:
+.. code:: html
+:class: big-code
 <input type="hidden" name="__came_from"
 tal:condition="exists:request/env/QUERY_STRING"
 tal:attributes="value string:${request/base}${request/env/PATH_INFO}?${request/env/QUERY_STRING}">
 <input type="hidden" name="__came_from"
 keyword's name when creating the keyword. The new classic tracker has
 a new checkbox (checked by default) that keeps you on the same page so
 you can add a new keywords one after the other.
 To add this to your own tracker, add the following code (prefixed with
-a +) after the entry box for the new keyword in html/keyword.item.html::
+a +) after the entry box for the new keyword in html/keyword.item.html:
+.. code::
+:class: big-code
 <tr>
 <th i18n:translate="">Keyword</th>
 <td tal:content="structure context/name/field">name</td>
 +   <td tal:condition="not:context/id">
 A new method has been added to HTMLStringProperty called url_quote.
 The default templates have been updated to use this in the "Your
 Query" section of the trackers html/page.html file. You will want to
 change your template. Lines starting with - are the original line and
 you want to change it to match the line starting with the + (remove
-the + from the line)::
+the + from the line):
+.. code::
+:class: big-code
 <tal:block tal:repeat="qs request/user/queries">
 -    <a href="#" tal:attributes="href string:${qs/klass}?${qs/url}&@dispname=${qs/name}"
 +    <a href="#" tal:attributes="href string:${qs/klass}?${qs/url}&@dispname=${qs/name/url_quote}"
 	  tal:content="qs/name">link</a><br>

Mercurial > p > roundup > code

comparison doc/upgrading.txt @ 7277:41b2a0e12899