Skip to content

Commit 5755b5e

Browse files
committed
initial pass to change references to reference doc where needed.
There are some references that don't seem to exist anymore. They were left pointing to their original values. These are in the 0.6 upgrade directions and whatsnew-0.7. They reference macros that don't exist or config.py that is no longer valid.
1 parent 9272e67 commit 5755b5e

File tree

9 files changed

+18
-15
lines changed

9 files changed

+18
-15
lines changed

CHANGES.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1082,7 +1082,7 @@ Features:
10821082
At some future date the older 3 argument style check command will
10831083
be deprecated. See ``upgrading.txt`` for details.
10841084
- New property for permissions added to simplify the model. See
1085-
``customizing.txt`` and search for props_only and
1085+
``reference.txt`` and search for props_only and
10861086
set_props_only_default in the section 'Adding a new Permission'.
10871087
(John Rouillard)
10881088
- issue2550690 - Inadequate CSRF protection. Improvements in

doc/FAQ.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ What is that stuff in the tracker html directory?
124124
This is the template code that Roundup uses to display the various pages.
125125
This is based upon the template markup language in Zope called, oddly
126126
enough, "Zope Page Templates". There's documentation in the Roundup
127-
customisation_ documentation. For more information have a look at:
127+
reference_ documentation. For more information have a look at:
128128

129129
https://zope.readthedocs.io/en/latest/zopebook/ZPT.html
130130

@@ -184,7 +184,7 @@ I can see values in a multilink but not display the items
184184

185185
Make sure that you have allowed the user to view the labelprop for the
186186
multilink class. Look for the setlabelprop explanation in the Roundup
187-
customisation_ documentation.
187+
reference_ documentation.
188188

189189
Using Roundup
190190
-------------
@@ -265,5 +265,5 @@ msg_header_property in the roundup docs. In some cases you have to
265265
explicitly enable the header.)
266266

267267

268-
.. _`customisation`: customizing.html
268+
.. _`reference`: reference.html
269269

doc/admin_guide.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -778,7 +778,7 @@ Email Access and Register
778778
will result in those users being registered with the tracker.
779779

780780
More information about how to customise your tracker's security settings
781-
may be found in the `customisation documentation`_.
781+
may be found in the `reference documentation`_.
782782

783783
Configuring Authentication Header/Variable
784784
------------------------------------------
@@ -1461,5 +1461,6 @@ them ',' separated so using '-dc' is almost always required.
14611461

14621462

14631463
.. _`customisation documentation`: customizing.html
1464+
.. _`reference documentation`: reference.html
14641465
.. _`upgrading documentation`: upgrading.html
14651466
.. _`installation documentation`: installation.html

doc/design.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1331,7 +1331,7 @@ field display a property like the plain displayer above, but in a
13311331
menu for a Link property, display a menu of the available choices
13321332
========= ==============================================================
13331333

1334-
See the `customisation`_ documentation for the complete list.
1334+
See the `reference`_ documentation for the complete list.
13351335

13361336

13371337
Index Views
@@ -1753,5 +1753,5 @@ Changes to this document
17531753
- Added "actor" property
17541754
- 'classname' format specified in class Class.
17551755

1756-
.. _customisation: customizing.html
1756+
.. _reference: reference.html
17571757

doc/installation.txt

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ in the following steps.
440440
set "main :: admin_email" to your local admin address to get email
441441
on unusual occurances. If you get stuck,
442442
and get configuration file errors, then see the `tracker
443-
configuration`_ section of the `customisation documentation`_.
443+
configuration`_ section of the `reference documentation`_.
444444

445445
If you just want to get set up to test things quickly (and follow
446446
the instructions in step 3 below), you can even just set the
@@ -449,7 +449,7 @@ in the following steps.
449449
web = http://localhost:8080/support/
450450

451451
The URL *must* end in a '/', or your web interface *will not work*.
452-
See `Customising Roundup`_ for details on configuration and schema
452+
See the `Roundup reference`_ for details on configuration and schema
453453
changes. You may change any of the configuration after
454454
you've initialised the tracker - it's just better to have valid values
455455
for this stuff now.
@@ -1933,7 +1933,8 @@ Further Reading
19331933

19341934
If you intend to use Roundup with anything other than the default
19351935
templates, if you would like to hack on Roundup, or if you would
1936-
like implementation details, you should read `Customising Roundup`_.
1936+
like implementation details, you should read `Customising
1937+
Roundup`_ and the `Roundup reference`_.
19371938

19381939

19391940
Running Multiple Trackers
@@ -2124,8 +2125,10 @@ please let us know!
21242125

21252126
.. _`user guide`: user_guide.html
21262127
.. _`roundup specification`: spec.html
2127-
.. _`tracker configuration`: customizing.html#tracker-configuration
2128+
.. _`tracker configuration`: reference.html#tracker-configuration
21282129
.. _`customisation documentation`: customizing.html
2130+
.. _`Roundup reference`: reference.html
2131+
.. _`reference documentation`: reference.html
21292132
.. _`preventing spam`: customizing.html#preventing-spam
21302133
.. _`Adding a new field to the classic schema`:
21312134
customizing.html#adding-a-new-field-to-the-classic-schema

doc/upgrading-history.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1067,7 +1067,7 @@ users mailing list:
10671067
See the customisation doc section on `Form Values`__ for documentation of the
10681068
new form variables possible.
10691069

1070-
__ customizing.html#form-values
1070+
__ reference.html#form-values
10711071

10721072

10731073
0.6.0 Multilingual character set support

doc/upgrading.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1994,7 +1994,6 @@ Migrating from older versions
19941994

19951995
See the `historical migration <upgrading-history.html>`_ document.
19961996

1997-
.. _`customisation documentation`: customizing.html
19981997
.. _`security documentation`: security-history.html
19991998
.. _`administration guide`: admin_guide.html
20001999
.. _`xmlrpc guide`: xmlrpc.html

doc/whatsnew-0.7.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ described in the `Defining new web actions`__ section of the customization
141141
documentation. You might also want to take a look at the `Using an external
142142
password validation source`__ example.
143143

144-
__ customizing.html#defining-new-web-actions
144+
__ reference.html#defining-new-web-actions
145145
__ customizing.html#using-an-external-password-validation-source
146146

147147
Actions may also return the content that should return to the user, which

doc/whatsnew-0.8.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,4 +184,4 @@ Web server
184184
The builtin web server may now perform HTTP Basic Authentication by
185185
itself.
186186

187-
.. _`customization documentation`: customizing.html
187+
.. _`customization documentation`: reference.html

0 commit comments

Comments
 (0)