annotate website/www/code.txt @ 5661:b08a308c273b

Better display for Link/Multilink and content Link/Multilink are now displayed as a dictionary by default. The format is controlled by the setting of the @verbose option. With @verbose=0 we get the old behavior displaying only the id. With the default @verbose=1 we get a dictionary with the id and a link inside. With @verbose=2 or larger we get the label property in the dictionary in addition (e.g. the name of a status or the name of a file). The content property is also handled differently now. For @verbose < 2 we get a dictionary with a link property in it. The property points to the standard download link for the content (or message). For @verbose >= 2 we get the previous behavior, the content property as a possibly very large json string.
author Ralf Schlatterbeck <rsc@runtux.com>
date Fri, 22 Mar 2019 14:03:37 +0100
parents c36ad0ba6aa3
children 45e8d10a9609
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
1 Code
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
2 ====
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
3
5018
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
4 Project history is maintained in `CHANGES.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt>`_
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
5 file in code repository of Roundup, which can also be viewed online
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
6 through SourceForge `web interface <https://sourceforge.net/p/roundup/code/>`_.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
7
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
8 Get sources
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
9 -----------
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
10
5018
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
11 Official **read-only access** to Mercurial repository is provided through ::
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
12
5017
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
13 hg clone http://hg.code.sf.net/p/roundup/code roundup
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
14
5018
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
15 **Read/write access** requires SSH password or SSH key
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
16 authorization (see `SourceForge.net docs for details
4775
d00a3ede67e4 Changing www/code.txt towards new SF paths.
Bernhard Reiter <bernhard@intevation.de>
parents: 4596
diff changeset
17 <https://sourceforge.net/p/forge/documentation/Mercurial/>`_) ::
4552
68d647848ffc nicer formatting
Richard Jones <richard@users.sourceforge.net>
parents: 4549
diff changeset
18
5017
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
19 hg clone ssh://USERNAME@hg.code.sf.net/p/roundup/code roundup
4552
68d647848ffc nicer formatting
Richard Jones <richard@users.sourceforge.net>
parents: 4549
diff changeset
20
5017
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
21 You also need to be added as a Roundup developer for write access - ask
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
22 for it on the :doc:`roundup-devel list <contact>`.
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
23
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
24 Run demo
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
25 --------
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
26
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
27 Roundup doesn't need any dependencies and works out of the box. Demo
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
28 is accessible at http://localhost:8917/demo/ by default ::
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
29
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
30 cd roundup
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
31 python demo.py
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
32
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
33 Execute tests
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
34 -------------
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
35 ::
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
36
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
37 python run_tests.py
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
38
5058
c36ad0ba6aa3 www: Fix link to README.txt
anatoly techtonik <techtonik@gmail.com>
parents: 5057
diff changeset
39 See repository `README.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/README.txt>`_
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
40 for more info.

Roundup Issue Tracker: http://roundup-tracker.org/