T2B Wiki - User contributions [en-gb]

XenQuattor

2015-08-26T12:29:32Z

Maintenance script: Created page with " === Xen and Quattor === *use QWG (or CB5) *in a dom0 machine add necesaary parametrs (example below). **install machine **verify that xen kernel is loaded **remove fil..."

=== Xen and Quattor ===

*use QWG (or CB5)
*in a dom0 machine add necesaary parametrs (example below).
**install machine
**verify that xen kernel is loaded
**remove file from /etc/libvirt/qemu/networks/autostart/ (they intercept the domU dhcp requests)
**add second xen virt bridge if needed
<pre>
/etc/xen/scripts/network-bridge start vifnum=1 bridge=xenbr1 netdev=eth1
</pre>

==== Templates ====
*dom0
<pre>
object template profile_fireman.iihe.ac.be;

## no largesmp kernels in centos
variable KERNEL_VARIANT = '';
## test dom0 for gridce and wms
variable XEN_PROFILE_PREFIX = "profile_";
variable XEN_GUESTS = list("voms.iihe.ac.be");

variable XEN_CREATE_FILESYSTEMS = true;
variable XEN_CREATE_DOMAINS = true;

variable FILESYSTEM_LAYOUT_CONFIG_SITE = "site/filesystems/dom0";
variable XEN_VG = "vg.domU";

include machine-types/base;

include xen/host/config;

include {GLITE_OS_POSTCONFIG};

#
# software repositories (should be last)
#
include { PKG_REPOSITORY_CONFIG };

</pre>

{{TracNotice|{{PAGENAME}}}}

WorkingWithRHEL7

2015-08-26T12:29:32Z

Maintenance script: Created page with " === Getting rid of firewalld and coming back to iptables === Here are the magic commands : <pre> systemctl stop firewalld systemctl disable firewalld yum remove firewall..."

=== Getting rid of firewalld and coming back to iptables ===
Here are the magic commands :
<pre>
systemctl stop firewalld
systemctl disable firewalld
yum remove firewalld
yum install iptables-services
systemctl enable iptables.service
systemctl enable ip6tables.service
</pre>
Don't forget to configure SSH with system-config-firewall-tui. And after that :
<pre>
systemctl start iptables.service
systemctl start ip6tables.service
</pre>

=== Replacing NetworkManager by network ===
Type these commands :
<pre>
systemctl stop NetworkManager
systemctl disable NetworkManager
</pre>
And now, we can restart network :
<pre>
service network restart
</pre>

=== Adoption of Predictable Network Interface Names ===
Names of NICs will change. To prepare yourself to the new naming rules, please read these documents :
*http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames/
*http://blog.laimbock.com/2014/11/22/systemd-understanding-predictable-network-interface-names/

=== Default filesystem : xfs ===
RHEL7 adopts XFS as the default filesystem. It might generates troubles with our Quattor scdb -> check our filesystem layout templates.

{{TracNotice|{{PAGENAME}}}}

WorkingInT2BCloud

2015-08-26T12:29:32Z

Maintenance script: Created page with " == Golden rules == *Before starting, please read the [http://docs.opennebula.org/4.12/index.html doc] *Never, ever, change the status of a VM using virt-manager ! Do everyt..."

== Golden rules ==
*Before starting, please read the [http://docs.opennebula.org/4.12/index.html doc]
*Never, ever, change the status of a VM using virt-manager ! Do everything using Sunstone only, and nothing else !
*Admin tasks on OpenNebula : most of them requires that you become oneadmin ("su - oneadmin").

== Admin tasks ==
=== How to stop OpenNebula ? ===
Connect as root to the front-end machine, and type the following commands :
<pre>
su - oneadmin
sunstone-server stop
oneflow-server stop
econe-server stop
one stop
</pre>

=== How to start OpenNebula ? ===
Connect as root to the front-end machine, and type the following commands :
<pre>
su - oneadmin
one start
sunstone-server start
</pre>

== Using Sunstone front-end ==

=== Connecting to the Sunstone front-end ===
The Sunstone front-end is installed on dom02. Open a "socks" port to qnat or ccq (or configure your FoxyProxy) to connect to the the following URL :
<pre>
http://192.168.10.35:9869/
</pre>
You will be asked a login and a password.

{{TracNotice|{{PAGENAME}}}}

WorkingInCB9

2015-08-26T12:29:32Z

Maintenance script: Created page with " == Things that are worth to have in mind when starting to work in CB9 == === OS flavour === In CB9, we start to work with OS flavour : <pre> object template profile_node1..."

== Things that are worth to have in mind when starting to work in CB9 ==
=== OS flavour ===
In CB9, we start to work with OS flavour :
<pre>
object template profile_node19-101.wn.iihe.ac.be;
variable OS_FLAVOUR_ENABLED = true;
...
</pre>
It means that the OS templates will be taken from os/sl6.x-x86_64 (instead of os/sl630-x86_64 for example). However, you still have to define the precise OS you want in the template site/os_version_db through the nlist OS_VERSION, but this choice will have an effect on the list of OS repositories, that is constructed in the template repository/config/os located in os/sl6.x-x86_64.

If you want to understand in deep the mechanism of OS flavoring, then read the template os/version in standard directory.
=== Working with repo snapshots ===
With the new SPMA, the choice of the version of each software is done on-the-fly by the component, in function of the content of the repositories at the time the component is running. If you change the repositories, then it might impact all the machines using them. So, to get a minimum of stability in the software environment of machines, it is necessary to work with repository snapshots.
==== Repository templates in CB9 ====
The templates of the repositories managed by snapshots are all located under begrid/repository/snapshot. Since with SPMA-YUM, we don't need the software versions anymore, so the content of these templates can be minimalist. Example :
<pre>
structure template repository/snapshot/ca;

"name" = "ca";
"owner" = "grid_admin@listserv.vub.ac.be";
"protocols" = list(
nlist("name","http",
"url","http://yum.iihe.ac.be/cb9/"+REPO_YUM_SNAPSHOT_DATE['ca']+"/egi_ca")
);
</pre>
In the above example, you see the role played by the nlist REPO_YUM_SNAPSHOT_DATE, that is used to construct the real URL pointing to the desired snapshot of the repository.

==== Managing the snapshot dates ====
Let us suppose that, on the 19th of March 2014, you have updated the "ca" repository, and that you have created a new snapshot just after. To force your machine to use the new snapshot, you will have to adapt accordingly the following nlist in site/global_variables :
<pre>
variable REPO_YUM_SNAPSHOT_DATE = nlist(
'ca','20140319',
'sl6_addons','20140313',
'sl6_epel','20140313',
'sl630_x86_64','20140313',
'sl630_x86_64_errata','20140313',
'emi_3_0_sl6_x86_64_base','20140313',
'emi_3_0_sl6_x86_64_third_party','20140313',
'emi_3_0_sl6_x86_64_updates','20140313',
'wlcg_x86_64','20140313',
);
</pre>
If you don't adapt this nlist, then the URL of the "ca" repo will still point to the old snapshot with old RPMs !

== Howto ==

=== How to update repositories and create snapshots ? ===
Most of local repositories are stored on yum.iihe.ac.be. Update of these repositories should always been done with the command "reposync" (or with the script described below, which is a wrapper above reposync) because they are mirrors of official repositories.
There are several possibilies to manage repository snapshots. This can be achieved at a low level by the filesystem (possible with btrfs, LVM, ZFS,...). Or we can simply use hard links, as in the tool created by Michel Jouvin, available in the SCDB repo in Quattor GitHub, in utils/misc (name of the scripts : yum_snapshot and update_yum_repos).

A wrapper to simplify repo management has been written. Here is how to use it :
#Log in as root on yum.iihe.ac.be
2. Go to the directory /var/www/html/
3. Launch the interactive script manage_repositories.pl and follow the instructions...

Note 1 : on yum, the repositories are defined it /etc/yum.repos.d/cb9.repo.

Note 2 : for packages that don't belong to official repos, please use the sl6_t2b repository (the corresponding repository template is "site").

=== How to install a package that I can't find in the main repositories ? ===
A dedicated place has been foreseen for such packages : the repository sl6_t2b. Here is the recipe :
#Drop your package in yum.iihe.ac.be:/var/www/html/cb9/sl6_t2b
2. Create a snapshot of the repo.
3. Change the snapshot date for the repo sl6_t2b in the REPO_YUM_SNAPSHOT_DATE nlist.

Important remark : as of 13th of August 2014, we decided to use the date in timestamp format, instead of Ymd format, to avoid problems with yum cache when the same repository is modified several times during the same day.

{{TracNotice|{{PAGENAME}}}}

Workernode-v0.0.2

2015-08-26T12:29:31Z

Maintenance script: Created page with " === Basic OS Installation === The basic requirement for this benchmark is to have SLC 4.5 for the x86_64 architecture installed and running on the hardware. You may use ..."

=== Basic OS Installation ===

The basic requirement for this benchmark is to have SLC 4.5 for the x86_64 architecture installed and running on the hardware. You may use PXE or CD installation from:

http://linuxsoft.cern.ch/scientific/45/x86_64/images/SL/pxeboot/

http://linuxsoft.cern.ch/scientific/45/x86_64/images/SL/boot.iso

Here is a summary of what the configuration must be:

*take the "Personal Desktop" installation
*let the installation procedure "Automatically partion" the disk(s)
*keep the default firewall settings
*put SElinux mode active
*"Install default packages"
*add a username and call it <tt>bench</tt>
*at the CERN customization step select:
**"No, I will do setup myself"
**"Enable checks for updates"

=== Installing the Benchmarks ===

This installation will download around 2 GB of software.

*Login as user <tt>bench</tt>
*Run
<pre>
wget http://mon.iihe.ac.be/trac/t2b/attachment/wiki/Workernode-v0.0.2/bench_1.tar?format=raw -O bench_1.tar; tar -xvf bench_1.tar;./install.sh
</pre>

=== Power Consumption Benchmark ===

This benchmark takes between 10 to 15 minuntes.

*Setup a measurement device between the power supply and the power plug
*Run as <tt>bench</tt>:
<pre>
./start_all.sh power
</pre>
*Collect the measured maximum power consumed before the start (in idle state) and the measured maximum power consumed during the benchmark run.

=== CPU Benchmarks ===

These benchmarks take between 12 to 24 hours and requires no manual intervention.

*Run as <tt>bench</tt>:
<pre>
./start_all.sh all
</pre>
*To check that the benchmarks are finished just run:
<pre>
./start_all.sh check
</pre>
*When the benchmarks are finished, run the following command and follow the instructions:
<pre>
./get_output.py
</pre>

=== Useful Commands ===

You can also run :
*<tt>./start_all.sh stop</tt> to stop the benchmarks
*<tt>./start_all.sh check</tt> to check if the benchmarks are still running

{{TracNotice|{{PAGENAME}}}}

Workernode-v0.0.1

2015-08-26T12:29:31Z

Maintenance script: Created page with " === Basic System Installation === The basic requirements for this benchmark is to have RHEL ES 4.3 for the x86_64 architecture installed and running on the hardware. The RHEL..."

=== Basic System Installation ===
The basic requirements for this benchmark is to have RHEL ES 4.3 for the x86_64 architecture installed and running on the hardware.
The RHEL4 clones CentOS 4.3 http://www.centos.org/ and Scientific Linux 4.3 https://www.scientificlinux.org/ are also valid for the benchmark. We even recommand one of those clones because they provide yum (updater and package installer which is used below) by default.
Installation instructions can be found on the sites or are provide with the copy.

All benchmarks will be run in 64-bit mode. In order to complete the benchmarks succesfully, a number of compatibility rpms have to be installed on the system.

Starting from a standard Desktop installation, install the following rpms (.i386 and .x86_64 indicate the rpms for both architecture versions) and their corresponding dependencies. (This is easiest done using yum.):
yum install libf2c.i386 libf2c.x86_64 openmotif.i386 openmotif.x86_64 xorg-x11-Mesa-libGLU.i386 xorg-x11-Mesa-libGLU.x86_64
yum install compat-libstdc++-33-3.2.3-47.3
==== Partition and Filesystem setup ====
In order to run the benchmark succesfully, there must be approximately 4GB free diskspace on one partition. We advise to use ext3 as filesystem. No further requirements are needed.
=== CMS benchmark ===
Make sure the machine is connected to the internet. Run as root:
wget -q http://nahi.iihe.ac.be/run_cmsbench-4.sh -O run_cmsbench-4.sh;chmod +x run_cmsbench-4.sh;./run_cmsbench-4.sh 4

The benchmark consists of a script that will
# download the necessary software in one single tarball (approximately 650MB. It might take a while to download.)
# extract the tarball and install the software
# run all benchmarks
# printout the numbers
# create a tarball with detailed results.

Running the application benchmark itself takes at most 6 hours and requires
no manual intervention. At the end, a number will be printed on screen indicating
the relative performance of the system. Also a file with a detailed description
of the system used and detailed results of all the tests will be provided.

When the script ran successfully, it will print out something like
Running test from directory /benchmark
/benchmark/cms
Now timing 1 single Root stress test:
Now timing 1 single Root stressgeom test:
Now timing 1 single Root stressLinear test:
Now timing 1 single Root bench test:
Now timing 4 simultaneous root stress runs:
Exit code 0
Now timing 1 single Pythia stress test:
Now timing 4 simultaneous pythia stress runs:
Exit code 0
ATTENTION !!! All environment variables
matching pattern *_PATH will be unset !!!
Now timing 1 single oscar run:

...

1guest249.fynu.ucl.ac.be/64/stress1.txt , 0
Gold1 1288.3
1guest249.fynu.ucl.ac.be/64/stress2.txt , 0
Gold2 1291.4
1guest249.fynu.ucl.ac.be/64/stress3.txt , 0
Gold3 1285.2
1guest249.fynu.ucl.ac.be/64/stress4.txt , 0
Gold4 1292.8
Res64 0: 1.0901462631045
1guest249.fynu.ucl.ac.be/64/timesusy1.txt , 1
Gold1 135.488503800453
1guest249.fynu.ucl.ac.be/64/timesusy2.txt , 1
Gold2 135.50135501355
1guest249.fynu.ucl.ac.be/64/timesusy3.txt , 1
Gold3 135.699940292026
1guest249.fynu.ucl.ac.be/64/timesusy4.txt , 1
Gold4 135.587704906919
Res64 1: 1.10156314295309
Relative strength of this box: Res= 4.78483211009748
Relative 32 to 64= 1.03331347491351
32 to 64= 1.2876476914783

The number indicating the relative performance of the system is found at the line biginning by: "Relative strength of this box: Res=".
The file with the detailed results is the zipped file created in the directory where the script was executed.

{{TracNotice|{{PAGENAME}}}}

WikiStart

2015-08-26T12:29:31Z

Maintenance script: Created page with " == Welcome to the CMS Belgian T2 Wiki == PageOutline === General information for users === ==== Information for new users ==== *[[T2bSupport| T2B Support guidelin..."

== Welcome to the CMS Belgian T2 Wiki ==
[[PageOutline]]

=== General information for users ===

==== Information for new users ====
*[[T2bSupport| T2B Support guidelines]]
*[[Certificates_and_VOs| How to get access to T2B?]]
*[[AccessToT2_IIHEForUsersFromT2_UCL| How users from UCL's T2 can gain access to IIHE's T2 ?]]

==== Using the Tier2 computing resources ====
*[[policies| Policies concerning the usage of computing resources.]]
*[[CurrentStatus| Current status of the Tier2]]
*[[Getting_started_with_the_CMSSW_software| Getting started with the CMSSW software]]
*[[Using_Git| Using Git]]
*[[Getting_started_with_the_MadGraph_software| Getting started with the MadGraph software]]
*Submitting jobs with CRAB
**[[gridSubmission_withCrab| To the worldwide grid]]
*Submitting jobs without CRAB
**[[localSubmission| To the local resources]]
**[[gridSubmission| To the worldwide grid]]
*[[GridStorageAccess| How to handle data on Grid storage]]
*[[FAQ_CMSSW_on_the_Grid| FAQ CMSSW on the Grid on proxy and more!]]
*[[OtherSoftware| Other software available at the T2]]

==== Back-up procedures ====
*[[BackupDocsLinuxLaptop| Procedure to automate backups of personal documents (Linux laptops only)]]
*[[Backup| Backup scheme for the user disks]]
*[[AccidentalDeleteOfFiles| What to do if I have accidentally deleted some files on my personal computer ?]]

==== Other topics ====
*[[User_Meetings]] list of user meetings with added transparencies
*[[Basic_computing_skills| Basic computing skills]]
*[[CernLxplus| Useful info on use of lxplus.cern.ch]]

----

=== Dedicated twiki pages maintained by several research groups ===
*[[TtBar_Analysis_Framework| TtBar Analysis Framework (old)]]
*[[TopQuarkGroup| Top Quark Group wiki]]
*[[HEEP_Analysis_Framework| HEEP Analysis Framework]]
*[[V0_Analysis_wiki| V0 Analysis wiki]]
*[[Info_exchange| Higgs analysis]]

----

=== Service work for CMS ===
*[[DDT]]
*[[CMSSWDeployment]]
*[[ProdAgentAllUsers| Prodagent for users]]
*[[TestStoreTemp| Writing tests in /store/temp/user on T2 SE's]]
*[[CrabServerInstall| CRAB Server installation]]
*[[CrabValidation| Basic validation of CRAB releases]]

----

=== Obsolete twiki pages ===
*[[DIY-UI]]
*[[CrabIIHETransitionSLC4ToSLC5| Using CRAB at IIHE during the transition from SLC4 to SLC5]]
*[[DataSamplesRequests2007| Samples Requests for 2007]]
*[[DataSamplesRequests2008| Samples Requests for 2008]]
*[[CrabNewIIHE| Crab at IIHE]]
*[[OldMainPage| The old main page is kept here for reference]]

----
=== Welcome to Trac ===
==== Starting Points ====
*WikiFormatting -- Trac Wiki Formatting information
*TracGuide -- Built-in Documentation
*TitleIndex -- A complete list of local wiki pages

----

== Admin section ==
[[AdminPage| Pages for administrators]]

{{TracNotice|{{PAGENAME}}}}

WikiRestructuredTextLinks

2015-08-26T12:29:31Z

Maintenance script: Created page with " == TracLinks in reStructuredText == This document illustrates how to use the <tt>:trac:</tt> role in reStructuredText. The page is written like: <pre> <pre> #rst Examples:..."

== TracLinks in reStructuredText ==

This document illustrates how to use the <tt>:trac:</tt> role in reStructuredText. The page is written like:

<pre>
<pre>
#rst
Examples:

*Tickets: :trac:<tt>#1</tt> or :trac:<tt>ticket:1</tt>
*Ticket comments: :trac:<tt>comment:ticket:1:2</tt>
*Reports: :trac:<tt>{1}</tt> or :trac:<tt>report:1</tt>
*Changesets: :trac:<tt>r1</tt>, :trac:<tt>[1]</tt> or :trac:<tt>changeset:1</tt>
*Revision log: :trac:<tt>r1:3</tt>, :trac:<tt>[1:3]</tt> or :trac:<tt>log:@1:3</tt>, :trac:<tt>log:trunk@1:3</tt>
*Diffs (since version 0.10): :trac:<tt>diff:@20:30</tt>, :trac:<tt>diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default</tt> or :trac:<tt>diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539</tt>
*Wiki pages: :trac:<tt>CamelCase</tt> or :trac:<tt>wiki:CamelCase</tt>
*Milestones: :trac:<tt>milestone:1.0</tt>
*Attachment: :trac:<tt>attachment:ticket:944:attachment.1073.diff</tt>
*Files: :trac:<tt>source:trunk/COPYING</tt>
*A specific file revision: :trac:<tt>source:/trunk/COPYING@200</tt>
*A particular line of a specific file revision: :trac:<tt>source:/trunk/COPYING@200#L25</tt>

An explicit label can be specified, separated from the link by a space:

*See :trac:<tt>#1 ticket 1</tt> and the :trac:<tt>source:trunk/COPYING license</tt>.
</pre>
</pre>

Provided you have docutils installed, the above block will render as:
----
<pre>
#rst
Examples:

*Tickets: :trac:<tt>#1</tt> or :trac:<tt>ticket:1</tt>
*Ticket comments: :trac:<tt>comment:ticket:1:2</tt>
*Reports: :trac:<tt>{1}</tt> or :trac:<tt>report:1</tt>
*Changesets: :trac:<tt>r1</tt>, :trac:<tt>[1]</tt> or :trac:<tt>changeset:1</tt>
*Revision log: :trac:<tt>r1:3</tt>, :trac:<tt>[1:3]</tt> or :trac:<tt>log:@1:3</tt>, :trac:<tt>log:trunk@1:3</tt>
*Diffs (since version 0.10): :trac:<tt>diff:@20:30</tt>, :trac:<tt>diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default</tt> or :trac:<tt>diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539</tt>
*Wiki pages: :trac:<tt>CamelCase</tt> or :trac:<tt>wiki:CamelCase</tt>
*Milestones: :trac:<tt>milestone:1.0</tt>
*Attachment: :trac:<tt>attachment:ticket:944:attachment.1073.diff</tt>
*Files: :trac:<tt>source:trunk/COPYING</tt>
*A specific file revision: :trac:<tt>source:/trunk/COPYING@200</tt>
*A particular line of a specific file revision: :trac:<tt>source:/trunk/COPYING@200#L25</tt>

An explicit label can be specified, separated from the link by a space:

*See :trac:<tt>#1 ticket 1</tt> and the :trac:<tt>source:trunk/COPYING license</tt>.
</pre>
----

Note also that any of the above could have been written using substitution references and the <tt>trac::</tt> directive:
<pre>
<pre>
#rst
See |ticket123|.

.. |ticket123| trac:: ticket:123 this ticket
</pre>
</pre>

This renders as:
----

<pre>
#rst
See |ticket123|.

.. |ticket123| trac:: ticket:123 this ticket
</pre>

----
See also: WikiRestructuredText, TracLinks

{{TracNotice|{{PAGENAME}}}}

WikiRestructuredText

2015-08-26T12:29:30Z

Maintenance script: Created page with " == reStructuredText Support in Trac == Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used. From the reStu..."

== reStructuredText Support in Trac ==

Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used.

From the reStucturedText webpage:
"''reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. reStructuredText is designed for extensibility for specific application domains. ''"

If you want a file from your Subversion repository be displayed as reStructuredText in Trac's source browser, set <tt>text/x-rst</tt> as value for the Subversion property <tt>svn:mime-type</tt>. See [trac:source:/trunk/INSTALL this example].

==== Requirements ====
Note that to activate RST support in Trac, the python docutils package must be installed.
If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].

Install docutils using <tt>easy_install docutils</tt>. Do not use the package manager of your OS (e.g. <tt>apt-get install python-docutils</tt>), because Trac will not find docutils then.

==== More information on RST ====

*reStructuredText Website -- http://docutils.sourceforge.net/rst.html
*RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html

----

=== Using RST in Trac ===
To specify that a block of text should be parsed using RST, use the ''rst'' processor.

==== TracLinks in reStructuredText ====

*Trac provides a custom RST directive <tt>trac::</tt> to allow TracLinks from within RST text.

Example:
<pre>
<pre>
#rst
This is a reference to |a ticket|

.. |a ticket| trac:: #42
</pre>
</pre>

*Trac allows an even easier way of creating TracLinks in RST, using the custom <tt>:trac:</tt> role.

Example:
<pre>
<pre>
#rst
This is a reference to ticket <tt>#12</tt>:trac:

To learn how to use Trac, see <tt>TracGuide</tt>:trac:
</pre>
</pre>

For a complete example of all uses of the <tt>:trac:</tt> role, please see WikiRestructuredTextLinks.

==== Syntax highlighting in reStructuredText ====

There is a directive for doing TracSyntaxColoring in RST as well. The directive is called
code-block

Example

<pre>
<pre>
#rst

.. code-block:: python

class Test:

def TestFunction(self):
pass

</pre>
</pre>

Will result in the below.

<pre>
#rst

.. code-block:: python

class Test:

def TestFunction(self):
pass

</pre>

==== Wiki Macros in reStructuredText ====

For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block.

==== Wiki Macro Example ====

<pre>
<pre>
#rst

.. code-block:: RecentChanges

Trac,3

</pre>
</pre>

Will result in the below:

[[RecentChanges(Trac,3)]]

Or a more concise Wiki Macro like syntax is also available:

<pre>
<pre>
#rst

:code-block:<tt>RecentChanges:Trac,3</tt>
</pre>
</pre>

==== Bigger RST Example ====
The example below should be mostly self-explanatory:
<pre>
#html
<pre class="wiki"><pre>
#rst
FooBar Header
=============
reStructuredText is **nice**. It has its own webpage_.

A table:

===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======

RST TracLinks
-------------

See also ticket <tt>#42</tt>:trac:.

.. _webpage: http://docutils.sourceforge.net/rst.html
</pre></pre>
</pre>

Results in:
<pre>
#rst
FooBar Header
=============
reStructuredText is **nice**. It has its own webpage_.

A table:

===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======

RST TracLinks
-------------

See also ticket <tt>#42</tt>:trac:.

.. _webpage: http://docutils.sourceforge.net/rst.html
</pre>

----
See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting

{{TracNotice|{{PAGENAME}}}}

WikiProcessors

2015-08-26T12:29:30Z

Maintenance script: Created page with " == Wiki Processors == Processors are WikiMacros designed to provide alternative markup formats for the [TracWiki Wiki engine]. Processors can be thought of as ''macro functi..."

== Wiki Processors ==

Processors are WikiMacros designed to provide alternative markup formats for the [TracWiki Wiki engine]. Processors can be thought of as ''macro functions to process user-edited text''.

Wiki processors can be used in any Wiki text throughout Trac,
for various different purposes, like:
- [#CodeHighlightingSupport syntax highlighting] or for rendering text verbatim,
- rendering [#HTMLrelated Wiki markup inside a context],
like inside <div> blocks or <span> or within <td> or <th> table cells,
- using an alternative markup syntax, like [[WikiHtml| raw HTML]] and
[[WikiRestructuredText| Restructured Text]],
or [http://www.textism.com/tools/textile/ textile]

=== Using Processors ===

To use a processor on a block of text, first delimit the lines using
a Wiki ''code block'':
<pre>
<pre>
The lines
that should be processed...
</pre>
</pre>

Immediately after the <tt><pre></tt> or on the line just below,
add <tt>#!</tt> followed by the ''processor name''.

<pre>
<pre>
#processorname
The lines
that should be processed...
</pre>
</pre>

This is the "shebang" notation, familiar to most UNIX users.

Besides their content, some Wiki processors can also accept ''parameters'',
which are then given as <tt>key=value</tt> pairs after the processor name,
on the same line. If <tt>value</tt> has to contain space, as it's often the case for
the style parameter, a quoted string can be used (<tt>key="value with space"</tt>).

As some processors are meant to process Wiki markup, it's quite possible to
''nest'' processor blocks.
You may want to indent the content of nested blocks for increased clarity,
this extra indentation will be ignored when processing the content.

=== Examples ===

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td colspan=2 align=center style="border: none"

<u>Example 1</u>: Inserting raw HTML
</pre>
|-----------------------------------------------------------------
<pre>#td style="border: none"
<pre>
<pre>
<h1 style="color: grey">This is raw HTML</h1>
</pre>
</pre>
</pre>
<pre>#td valign=top style="border: none; padding-left: 2em"
<pre>
#html
<h1 style="color: grey">This is raw HTML</h1>
</pre>
</pre>
|-----------------------------------------------------------------
<pre>#td colspan=2 align=center style="border: none"

<u>Example 2</u>: Highlighted Python code in a <div> block with custom style
</pre>
|-----------------------------------------------------------------
<pre>#td style="border: none"
<pre>
<pre>#div style="background: #ffd; border: 3px ridge"

This is an example of embedded "code" block:

<pre>
#python
def hello():
return "world"
</pre>

</pre>
</pre>
</pre>
<pre>#td valign=top style="border: none; padding: 1em"
<pre>#div style="background: #ffd; border: 3px ridge"

This is an example of embedded "code" block:

<pre>
#python
def hello():
return "world"
</pre>

</pre>
</pre>
|-----------------------------------------------------------------
<pre>#td colspan=2 align=center style="border: none"

<u>Example 3</u>: Searching tickets from a wiki page, by keywords.
</pre>
|-----------------------------------------------------------------
<pre>#td style="border: none"
<pre>
<pre>
#html
<form action="/query" method="get">
<input type="text" name="keywords" value="~" size="30">
<input type="submit" value="Search by Keywords">

</form>
</pre>
</pre>
</pre>
<pre>#td valign=top style="border: none; padding: 1em"
<pre>
#html
<form action="/query" method="get">
<input type="text" name="keywords" value="~" size="30">
<input type="submit" value="Search by Keywords">

</form>
</pre>
</pre>
=== Available Processors ===

The following processors are included in the Trac distribution:

<tt>#default</tt> :: Present the text verbatim in a preformatted text block.
This is the same as specifying ''no'' processor name
(and no <tt>#!</tt>)
<tt>#comment</tt> :: Do not process the text in this section (i.e. contents exist
only in the plain text - not in the rendered page).

==== HTML related ====

<tt>#html</tt> :: Insert custom HTML in a wiki page.
<tt>#htmlcomment</tt> :: Insert an HTML comment in a wiki page (''since 0.12'').

Note that <tt>#html</tt> blocks have to be ''self-contained'',
#e. you can't start an HTML element in one block and close it later in a second block. Use the following processors for achieving a similar effect.

<tt>#div</tt> :: Wrap an arbitrary Wiki content inside a <div> element
(''since 0.11'').
<tt>#span</tt> :: Wrap an arbitrary Wiki content inside a <span> element
(''since 0.11'').

<tt>#td</tt> :: Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'')
<tt>#th</tt> :: Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'')
<tt>#tr</tt> :: Can optionally be used for wrapping <tt>#td</tt> and <tt>#th</tt> blocks,
either for specifying row attributes of better visual grouping
(''since 0.12'')

See WikiHtml for example usage and more details about these processors.

==== Other Markups ====

<tt>#rst</tt> :: Trac support for Restructured Text. See WikiRestructuredText.
<tt>#textile</tt> :: Supported if [http://cheeseshop.python.org/pypi/textile Textile]
is installed.
See [http://www.textism.com/tools/textile/ a Textile reference].

==== Code Highlighting Support ====

Trac includes processors to provide inline syntax highlighting:
<tt>#c</tt> (C), <tt>#cpp</tt> (C++), <tt>#python</tt> (Python), <tt>#perl</tt> (Perl),
<tt>#ruby</tt> (Ruby), <tt>#php</tt> (PHP), <tt>#asp</tt> (ASP), <tt>#java</tt> (Java),
<tt>#js</tt> (Javascript), <tt>#sql (SQL)</tt>, <tt>#xml</tt> (XML or HTML),
<tt>#sh</tt> (Bourne/Bash shell), etc.

Trac relies on external software packages for syntax coloring,
like [http://pygments.org Pygments].

See TracSyntaxColoring for information about which languages
are supported and how to enable support for more languages.

Note also that by using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. For example, you can write:
<pre>
<pre>
#text/html
<h1>text</h1>
</pre>
</pre>

The result will be syntax highlighted HTML code:
<pre>
#text/html
<h1>text</h1>
</pre>

The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported].

For more processor macros developed and/or contributed by users, visit:
*[trac:ProcessorBazaar]
*[trac:MacroBazaar]
*[th:WikiStart Trac Hacks] community site

Developing processors is no different from Wiki macros.
In fact they work the same way, only the usage syntax differs.
See WikiMacros#DevelopingCustomMacros for more information.

----
See also: WikiMacros, WikiHtml, WikiRestructuredText, TracSyntaxColoring, WikiFormatting, TracGuide

{{TracNotice|{{PAGENAME}}}}

WikiPageNames

2015-08-26T12:29:30Z

Maintenance script: Created page with " == Wiki Page Names == TracGuideToc Wiki page names commonly use the CamelCase convention. Within wiki text, any word in CamelCase automatically becomes a hyperlink to th..."

== Wiki Page Names ==
[[TracGuideToc]]

Wiki page names commonly use the CamelCase convention. Within wiki text, any word in CamelCase automatically becomes a hyperlink to the wiki page with that name.

CamelCase page names must follow these rules:

#The name must consist of '''alphabetic characters only'''. No digits, spaces, punctuation, or underscores are allowed.
2. A name must have at least two capital letters.
3. The first character must be capitalized.
4. Every capital letter must be followed by one or more lower-case letters.
5. The use of slash ( / ) is permitted in page names (possibly representing a hierarchy).

If you want to create a wiki page that doesn't follow CamelCase rules you can use the following syntax:
<pre>
*[[Wiki_page]], [[ISO9000]],
and with a label: [[ISO9000| ISO 9000 standard]]
*[["Space| Matters"]]
and with a label: [["Space| Matters" all about white space]]
*or simply: ["WikiPageName"]s
*even better, the new [[WikiCreole link style]]
and with a label: [[WikiCreole link style|WikiCreole style links]]
</pre>

This will be rendered as:
*[[Wiki_page]], [[ISO9000]],
and with a label: [[ISO9000| ISO 9000 standard]]
*[["Space| Matters"]] ''(that page name embeds space characters)''
and with a label: [["Space| Matters" all about white space]]
*or simply: ["WikiPageName"]s ''(old MoinMoin's internal free links style)''
*even better, the new [[WikiCreole link style]]
and with a label: [[WikiCreole link style|WikiCreole style links]]
''(since 0.12, also now adopted by MoinMoin)''

Starting with Trac 0.11, it's also possible to link to a specific ''version'' of a Wiki page, as you would do for a specific version of a file, for example: WikiStart@1.

You can also prevent a CamelCase name to be interpreted as a TracLinks, by quoting it. See TracLinks#EscapingLinks.

As visible in the example above, one can also append an anchor to a Wiki page name, in order to link to a specific section within that page. The anchor can easily be seen by hovering the mouse over a section heading, then clicking on the [[html(¶)]] sign that appears at its end. The anchor is usually generated automatically, but it's also possible to specify it explicitly: see WikiFormatting#using-explicit-id-in-heading.
----
See also: WikiNewPage, WikiFormatting, TracWiki, TracLinks

{{TracNotice|{{PAGENAME}}}}

WikiNewPage

2015-08-26T12:29:30Z

Maintenance script: Created page with " == Steps to Add a New Wiki Page == TracGuideToc #Choose a name for your new page. See WikiPageNames for naming conventions. 2. Edit an existing page (or any other resou..."

== Steps to Add a New Wiki Page ==
[[TracGuideToc]]

#Choose a name for your new page. See WikiPageNames for naming conventions.
2. Edit an existing page (or any other resources that support WikiFormatting and add a [TracLinks link] to your new page. Save your changes.
3. Follow the link you created to take you to the new page. Trac will display a "describe PageName here" message.
4. Click the "Edit this page" button to edit and add content to your new page. Save your changes.
5. All done. Your new page is published.

You can skip the second step by entering the CamelCase name of the page in the quick-search field at the top of the page. But note that the page will effectively be "orphaned" unless you link to it from somewhere else.

== Rename a page #renaming

While picking up good WikiPageNames is important, you can always change your mind
and rename the page later.

You'll need to ask for the WIKI_RENAME permission in order to be allowed to do this.
When renaming a page, you'll be offered the possibility to create a redirection page, so that links pointing to the old location will not be left dangling.

----
See also: TracWiki, PageTemplates, WikiFormatting, TracLinks, WikiDeletePage

{{TracNotice|{{PAGENAME}}}}

WikiMacros

2015-08-26T12:29:30Z

Maintenance script: Created page with " == Trac Macros == PageOutline Trac macros are plugins to extend the Trac engine with custom 'functions' written in Python. A macro inserts dynamic HTML data in any cont..."

== Trac Macros ==

[[PageOutline]]

Trac macros are plugins to extend the Trac engine with custom 'functions' written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting.

Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting).

=== Using Macros ===

Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.

==== Getting Detailed Help ====
The list of available macros and the full help can be obtained using the MacroList macro, as seen [#AvailableMacros below].

A brief list can be obtained via ![[MacroList(*)]] or ![[?]].

Detailed help on a specific macro can be obtained by passing it as an argument to MacroList, e.g. ![[MacroList(MacroList)]], or, more conveniently, by appending a question mark (?) to the macro's name, like in ![[MacroList?]].

==== Example ====

A list of 3 most recently changed wiki pages starting with 'Trac':

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
[[RecentChanges(Trac,3)]]
</pre>
</pre>
<pre>#td style="padding-left: 2em;"
[[RecentChanges(Trac,3)]]
</pre>
|-----------------------------------
<pre>#td
<pre>
[[RecentChanges?(Trac,3)]]
</pre>
</pre>
<pre>#td style="padding-left: 2em;"
[[RecentChanges?(Trac,3)]]
</pre>
|-----------------------------------
<pre>#td
<pre>
[[?]]
</pre>
</pre>
<pre>#td style="padding-left: 2em; font-size: 80%"
[[?]]
</pre>

=== Available Macros ===

''Note that the following list will only contain the macro documentation if you've not enabled <tt>-OO</tt> optimizations, or not set the <tt>PythonOptimize</tt> option for [[TracModPython| mod_python]].''

[[MacroList]]

=== Macros from around the world ===

The [http://trac-hacks.org/ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you're looking for new macros, or have written one that you'd like to share with the world, please don't hesitate to visit that site.

=== Developing Custom Macros ===
Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.

For more information about developing macros, see the [trac:TracDev development resources] on the main project site.

Here are 2 simple examples showing how to create a Macro with Trac 0.11.

Also, have a look at [trac:source:tags/trac-0.11/sample-plugins/Timestamp.py Timestamp.py] for an example that shows the difference between old style and new style macros and at the [trac:source:tags/trac-0.11/wiki-macros/README macros/README] which provides a little more insight about the transition.

==== Macro without arguments ====
To test the following code, you should saved it in a <tt>timestamp_sample.py</tt> file located in the TracEnvironment's <tt>plugins/</tt> directory.
<pre>
#python
from datetime import datetime
# Note: since Trac 0.11, datetime objects are used internally

from genshi.builder import tag

from trac.util.datefmt import format_datetime, utc
from trac.wiki.macros import WikiMacroBase

class TimeStampMacro(WikiMacroBase):
"""Inserts the current time (in seconds) into the wiki page."""

revision = "$Rev$"
url = "$URL$"

def expand_macro(self, formatter, name, text):
t = datetime.now(utc)
return tag.b(format_datetime(t, '%c'))
</pre>

==== Macro with arguments ====
To test the following code, you should saved it in a <tt>helloworld_sample.py</tt> file located in the TracEnvironment's <tt>plugins/</tt> directory.
<pre>
#python
from genshi.core import Markup

from trac.wiki.macros import WikiMacroBase

class HelloWorldMacro(WikiMacroBase):
"""Simple HelloWorld macro.

Note that the name of the class is meaningful:
- it must end with "Macro"
- what comes before "Macro" ends up being the macro name

The documentation of the class (i.e. what you're reading)
will become the documentation of the macro, as shown by
the MacroList macro (usually used in the WikiMacros page).
"""

revision = "$Rev$"
url = "$URL$"

def expand_macro(self, formatter, name, text, args):
"""Return some output that will be displayed in the Wiki content.

<tt>name</tt> is the actual name of the macro (no surprise, here it'll be
<tt>'HelloWorld'</tt>),
<tt>text</tt> is the text enclosed in parenthesis at the call of the macro.
Note that if there are ''no'' parenthesis (like in, e.g.
[[HelloWorld]]), then <tt>text</tt> is <tt>None</tt>.
<tt>args</tt> are the arguments passed when HelloWorld is called using a
<tt>#HelloWorld</tt> code block.
"""
return 'Hello World, text = %s, args = %s' % \
(Markup.escape(text), Markup.escape(repr(args)))

</pre>

Note that <tt>expand_macro</tt> optionally takes a 4<sup>th</sup> parameter ''<tt>args</tt>''. When the macro is called as a [WikiProcessors WikiProcessor], it's also possible to pass <tt>key=value</tt> [WikiProcessors#UsingProcessors processor parameters]. If given, those are stored in a dictionary and passed in this extra <tt>args</tt> parameter. On the contrary, when called as a macro, <tt>args</tt> is <tt>None</tt>. (''since 0.12'').

For example, when writing:
<pre>
<pre>#HelloWorld style="polite"
<Hello World!>
</pre>

<pre>#HelloWorld
<Hello World!>
</pre>

[[HelloWorld(<Hello World!>)]]
</pre>
One should get:
<pre>
Hello World, text = <Hello World!> , args = {'style': u'polite'}
Hello World, text = <Hello World!> , args = {}
Hello World, text = <Hello World!> , args = None
</pre>

Note that the return value of <tt>expand_macro</tt> is '''not''' HTML escaped. Depending on the expected result, you should escape it by yourself (using <tt>return Markup.escape(result)</tt>) or, if this is indeed HTML, wrap it in a Markup object (<tt>return Markup(result)</tt>) with <tt>Markup</tt> coming from Genshi, (<tt>from genshi.core import Markup</tt>).

You can also recursively use a wiki Formatter (<tt>from trac.wiki import Formatter</tt>) to process the <tt>text</tt> as wiki markup, for example by doing:

<pre>
#python
text = "whatever wiki markup you want, even containing other macros"
# Convert Wiki markup to HTML, new style
out = StringIO()
Formatter(self.env, formatter.context).format(text, out)
return Markup(out.getvalue())
</pre>

{{TracNotice|{{PAGENAME}}}}

WikiHtml

2015-08-26T12:29:29Z

Maintenance script: Created page with " == Using HTML in Wiki Text == Trac supports inserting HTML into any wiki context, accomplished using the <tt>#html</tt> WikiProcessor. However a constr..."

== Using HTML in Wiki Text ==

Trac supports inserting HTML into any wiki context, accomplished using the <tt>#html</tt> [[WikiProcessors| WikiProcessor]].

However a constraint is that this HTML has to be well-formed.
In particular you can't insert a start tag in an <tt>#html</tt> block,
resume normal wiki text and insert the corresponding end tag in a
second <tt>#html</tt> block.

Fortunately, for creating styled <div>s, <span>s or even complex tables
containing arbitrary Wiki text, there's a powerful alternative: use of
dedicated <tt>#div</tt>, <tt>#span</tt> and <tt>#table</tt>, <tt>#tr</tt>, <tt>#td</tt> and <tt>#th</tt> blocks.

Those Wiki processors are built-in, and does not require installing any additional packages.

=== How to use <tt>#html</tt> === #HowtoUseHTML
To inform the wiki engine that a block of text should be treated as HTML, use the ''html'' processor.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
<pre>
#html
<h1 style="text-align: right; color: blue">HTML Test</h1>
</pre>
</pre>
</pre>
<pre>#td style="padding-left: 2em"
<pre>
#html
<h1 style="text-align: right; color: blue">HTML Test</h1>
</pre>
</pre>

Note that Trac sanitizes your HTML code before displaying it. That means that if you try to use potentially dangerous constructs such as Javascript event handlers, those will be removed from the output.

Since 0.11, the filtering is done by Genshi, and as such, the produced output will be a well-formed fragment of HTML. As noted above in the introduction, this mean that you can no longer use two HTML blocks, one for opening a <div>, the second for closing it, in order to wrap arbitrary wiki text.
The new way to wrap any wiki content inside a <div> is to use the <tt>#div</tt> Wiki processor.

=== How to use <tt>#div</tt> and <tt>#span</tt> === #HowtoUseDivSpan

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
<pre>
#div class="important" style="border: 2pt solid; text-align: center"
This is the ''only'' way to go in Trac 0.11
</pre>

<pre>
#div class="wikipage" style="border: 1pt dotted"
Only <tt>wikipage</tt> (same as specifying no class attribute)
</pre>

<pre>
#div class="wikipage compact " style="border: 1pt solid"
Use combined classes (<tt>compact</tt> and <tt>wikipage</tt>)
</pre>

<pre>
#div class="compact" style="border: 1pt dotted"
Only <tt>compact</tt>
</pre>

<pre>
#div class="" style="border: 1pt solid"
No classes (//not// the same as specifying no class attribute...)
</pre>
</pre>
</pre>
<pre>#td style="padding-left: 2em"
<pre>
#div class="important" style="border: 2pt solid; text-align: center"
This is the ''only'' way to go in Trac 0.11
</pre>

<pre>
#div class="wikipage" style="border: 1pt dotted"
Only <tt>wikipage</tt> (same as specifying no class attribute)
</pre>

<pre>
#div class="wikipage compact " style="border: 1pt solid"
Use combined classes (<tt>compact</tt> and <tt>wikipage</tt>)
</pre>

<pre>
#div class="compact" style="border: 1pt dotted"
Only compact
</pre>

<pre>
#div class="" style="border: 1pt solid"
No classes (//not// the same as specifying no class attribute...)
</pre>
</pre>

Note that the contents of a <tt>#div</tt> block are contained in one or more paragraphs, which have a non-zero top and bottom margin. This leads to the top and bottom padding in the example above. To remove the top and bottom margin of the contents, add the <tt>compact</tt> class to the <tt>#div</tt>. Another predefined class besides <tt>wikipage</tt> and <tt>compact</tt> is <tt>important</tt>, which can be used to make a paragraph stand out. Extra CSS classes can be defined via the <tt>site/style.css</tt> file for example, see TracInterfaceCustomization#SiteAppearance.

For spans, you should rather use the Macro call syntax:
{| border=1 class="simple"
!= Wiki Markup =
|}

<pre>#td
<pre>
Hello
[[span(''WORLD'' (click [#anchor here]), style=color: green; font-size: 120%, id=anchor)]]!
</pre>
</pre>
|---------------------------------------------------------------------------------
{| border=1 class="simple"
!= Display =
|}

<pre>#td style="padding-left: 2em"
Hello
[[span(''WORLD'' (click [#anchor here]), style=color: green; font-size: 120%, id=anchor)]]!
</pre>

=== How to use <tt>#td</tt> and other table related processors === #Tables

<tt>#td</tt> or <tt>#th</tt> processors are actually the main ones, for creating table data and header cells, respectively. The other processors <tt>#table</tt> and <tt>#tr</tt> are not required for introducing a table structure, as <tt>#td</tt> and <tt>#th</tt> will do this automatically. The <tt>|-</tt> row separator can be used to start a new row when needed, but some may prefer to use a <tt>#tr</tt> block for that, as this introduces a more formal grouping and offers the possibility to use an extra level of indentation. The main purpose of the <tt>#table</tt> and <tt>#tr</tt> is to give the possibility to specify HTML attributes, like ''style'' or ''valign'' to these elements.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
Simple 2x2 table with rich content:
<pre>#th align=left
- Left
- Header
</pre>
<pre>#th align=left
- Right
- Header
</pre>
|----------------------------------
<pre>#td style="background: #ffd"
- Left
- Content
</pre>
<pre>#td style="vertical-align: top"
RightContent
</pre>
|----------------------------------
{| border=1 class="simple"
! ... and this can be mixed
!\
|}

{| border=1 class="simple"
!with pipe-based cells
|}

<pre>#td colspan=2
Pick the style the more appropriate
to your content

See WikiFormatting#Tables for details
on the pipe-based table syntax.
</pre>

If one needs to add some
attributes to the table itself...

<pre>
#table style="border:none;text-align:center;margin:auto"
<pre>#tr ====================================
<pre>#th style="border: none"
Left header
</pre>
<pre>#th style="border: none"
Right header
</pre>
</pre>
<pre>#tr ==== style="border: 1px dotted grey"
<pre>#td style="border: none"
###1
</pre>
<pre>#td style="border: none"
###2
</pre>
</pre>
<pre>#tr ====================================
<pre>#td style="border: none"
2.1
</pre>
<pre>#td
2.2
</pre>
</pre>
</pre>

</pre>
</pre>
<pre>#td valign=top
Simple 2x2 table with rich content:
<pre>#th align=left
- Left
- Header
</pre>
<pre>#th align=left
- Right
- Header
</pre>
|----------------------------------
<pre>#td style="background: #ffd"
- Left
- Content
</pre>
<pre>#td style="vertical-align: top"
RightContent
</pre>
|----------------------------------
{| border=1 class="simple"
! ... and this can be mixed
!\
|-
| colspan=2|with pipe-based cells
|}

<pre>#td colspan=2
Pick the style the more appropriate
to your content

See WikiFormatting#Tables for details
on the pipe-based table syntax.
</pre>

If one needs to add some
attributes to the table itself...

<pre>
#table style="border:none;text-align:center;margin:auto"
<pre>#tr ====================================
<pre>#th style="border: none"
Left header
</pre>
<pre>#th style="border: none"
Right header
</pre>
</pre>
<pre>#tr ==== style="border: 1px dotted grey"
<pre>#td style="border: none"
###1
</pre>
<pre>#td style="border: none"
###2
</pre>
</pre>
<pre>#tr ====================================
<pre>#td style="border: none"
2.1
</pre>
<pre>#td
2.2
</pre>
</pre>
</pre>
</pre>

Note that by default tables are assigned the "wiki" CSS class, which gives a distinctive look to the header cells and a default border to the table and cells (as can be seen for the tables on this page). By removing this class (<tt>#table class=""</tt>), one regains complete control on the table presentation. In particular, neither the table, the rows nor the cells will have a border, so this is a more effective way to get such an effect than having to specify a <tt>style="border: no"</tt> parameter everywhere.

<pre>#table class=""
{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
<pre>#table class=""
{| border=1 class="simple"
! 0
! 1
! 2
|}

{| border=1 class="simple"
! 10
! 20
! 30
|}

{| border=1 class="simple"
! 11
! 22
! 33
|}

{| border=1 class="simple"
!
!
!= numbers =
|}

</pre>
</pre>
</pre>
<pre>#td
<pre>#table class=""
{| border=1 class="simple"
! 0
! 1
! 2
|}

{| border=1 class="simple"
! 10
! 20
! 30
|}

{| border=1 class="simple"
! 11
! 22
! 33
|}

{| border=1 class="simple"
!
!
!= numbers =
|}

</pre>
</pre>
</pre>

Other classes can be specified as alternatives (remember that you can define your own in [TracInterfaceCustomization#SiteAppearance site/style.css]).

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
<pre>#table class="listing"
{| border=1 class="simple"
! 0
! 1
! 2
|}

{| border=1 class="simple"
! 10
! 20
! 30
|}

{| border=1 class="simple"
! 11
! 22
! 33
|}

{| border=1 class="simple"
!
!
!= numbers =
|}

</pre>
</pre>
</pre>
<pre>#td
<pre>#table class="listing"
{| border=1 class="simple"
! 0
! 1
! 2
|}

{| border=1 class="simple"
! 10
! 20
! 30
|}

{| border=1 class="simple"
! 11
! 22
! 33
|}

{| border=1 class="simple"
!
!
!= numbers =
|}

</pre>
</pre>

=== HTML comments ===
HTML comments are stripped from the output of the <tt>html</tt> processor. To add an HTML comment to a wiki page, use the <tt>htmlcomment</tt> processor (available since 0.12). For example, the following code block:
{| border=1 class="simple"
!= Wiki Markup =
|}

<pre>#td
<pre>
<pre>
#htmlcomment
This block is translated to an HTML comment.
It can contain <tags> and &entities; that will not be escaped in the output.
</pre>
</pre>
</pre>
|---------------------------------------------------------------------------------
{| border=1 class="simple"
!= Display =
|}

<pre>#td
<pre>

</pre>
</pre>

Please note that the character sequence "--" is not allowed in HTML comments, and will generate a rendering error.

=== More Information ===

*http://www.w3.org/ -- World Wide Web Consortium
*http://www.w3.org/MarkUp/ -- HTML Markup Home Page

----
See also: WikiProcessors, WikiFormatting, WikiRestructuredText

{{TracNotice|{{PAGENAME}}}}

WikiFormatting

2015-08-26T12:29:29Z

Maintenance script: Created page with " == WikiFormatting == TracGuideToc Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole. Trac has a ..."

== WikiFormatting ==
[[TracGuideToc]]

Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.

Trac has a built in small and powerful wiki rendering engine. This wiki engine implements an ever growing subset of the commands from other popular Wikis,
especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole].

This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.

The ''Cheat sheet'' below gives you a quick overview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page.

A few other wiki pages present the advanced features of the Trac wiki markup in more depth:
- TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof,
- WikiPageNames talks about the various names a wiki page can take, CamelCase or not
- WikiMacros lists the macros available for generating dynamic content,
- WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways

=== Cheat sheet ===

{| border=1 class="simple"
!= '''Category''' =
!= '''Wiki Markup''' =
!= '''Display''' =
|}

|-----------------------------------------------------------
<pre>#th rowspan=3
[#FontStyles Font Styles]
</pre>
{| border=1 class="simple"
! <tt>'''bold'''</tt>, <tt>''italic''</tt>, <tt>'''''Wikipedia style'''''</tt>
! \
|-
| colspan=2| '''bold''', ''italic'', '''''Wikipedia style'''''
|-
| <tt><tt>monospaced and ''nowiki''</tt></tt>
| \
|-
| colspan=2| <tt>monospaced and nowiki</tt>
|-
| <tt>**bold**</tt>, <tt>//italic//</tt>, <tt>**//WikiCreole style//**</tt>
| \
|-
| colspan=2| **bold**, //italic//, **//WikiCreole style//**
|}

|-----------------------------------------------------------
{| border=1 class="simple"
!= [#Headings Headings] =
!\
|}

<pre>#td
<pre>
== Level 2 ==
=== Level 3 <sup>([#hn note])</sup>
</pre>
</pre>
<pre>#td style="padding-left: 2em"
== Level 2
=== Level 3 <sup>([#hn note])</sup>
</pre>
|-----------------------------------------------------------
{| border=1 class="simple"
!= [#Paragraphs Paragraphs] =
!\
|}

<pre>#td
<pre>
First paragraph
on multiple lines.

Second paragraph.
</pre>
</pre>
<pre>#td
First paragraph
on multiple lines.

Second paragraph.
</pre>
|-----------------------------------------------------------
{| border=1 class="simple"
!= [#Lists Lists] =
!\
|}

<pre>#td
<pre>
*bullets list
on multiple paragraphs
##nested list
###different numbering
styles
</pre>
</pre>
<pre>#td
*bullets list
on multiple paragraphs
##nested list
###different numbering
styles
</pre>
|-----------------------------------------------------------
<pre>#th
[#DefinitionLists Definition Lists]
</pre>
<pre>#td
<pre>
term:: definition on
multiple paragraphs
</pre>
</pre>
<pre>#td
term:: definition on
multiple paragraphs
</pre>
|-----------------------------------------------------------
{| border=1 class="simple"
!= [#PreformattedText Preformatted Text] =
!\
|}

<pre>#td
<pre>
<pre>
multiple lines, ''no wiki''
white space respected
</pre>
</pre>
</pre>
<pre>#td
<pre>
multiple lines, ''no wiki''
white space respected
</pre>
</pre>
|-----------------------------------------------------------
{| border=1 class="simple"
!= [#Blockquotes Blockquotes] =
!\
|}

<pre>#td
<pre>
if there's some leading
space the text is quoted
</pre>
</pre>
<pre>#td
if there's some leading
space the text is quoted
</pre>
|-----------------------------------------------------------
{| border=1 class="simple"
!= [#DiscussionCitations Discussion Citations] =
!\
|}

<pre>#td
<pre>
>> ... (I said)
> (he replied)
</pre>
</pre>
<pre>#td
>>... (I said)
> (he replied)
</pre>
|-----------------------------------------------------------
{| border=1 class="simple"
!= [#Tables Tables] =
!\
|}

<pre>#td
<pre>
{| border=1 class="simple"
!= Table Header =
! Cell
|}

{| border=1 class="simple"
!
! (details below)
|}

</pre>
</pre>
<pre>#td
{| border=1 class="simple"
!= Table Header =
! Cell
|-
|
| (details below)
|}

</pre>
|-----------------------------------------------------------
<pre>#th rowspan=2
[#Links Links]
</pre>
{| border=1 class="simple"
! <tt>http://trac.edgewall.org</tt>
!\
|-
| colspan=2| http://trac.edgewall.org
|-
| <tt>WikiFormatting (CamelCase)</tt>
| \
|-
| colspan=2| WikiFormatting (CamelCase)
|}

|-----------------------------------------------------------
<pre>#th rowspan=5
[#TracLinks TracLinks]
</pre>
{| border=1 class="simple"
! <tt>wiki:WikiFormatting</tt>, <tt>wiki:"WikiFormatting"</tt>
!\
|-
| colspan=2| wiki:WikiFormatting, wiki:"WikiFormatting"
|-
| <tt>#1 (ticket)</tt>, <tt>[1] (changeset)</tt>, <tt>{1} (report)</tt>
| \
|-
| colspan=2| #1 (ticket), [1] (changeset), {1} (report)
|-
| <tt>ticket:1, ticket:1#comment:1</tt>
| \
|-
| colspan=2| ticket:1, ticket:1#comment:1
|-
| <tt>Ticket [ticket:1]</tt>, <tt>[ticket:1 ticket one]</tt>
| \
|-
| colspan=2| Ticket [ticket:1], [ticket:1 ticket one]
|-
| <tt>Ticket [[ticket:1]]</tt>, <tt>[[ticket:1/ticket one]]</tt>
| \
|-
| colspan=2| Ticket [[ticket:1]], [[ticket:1/ticket one]]
|}

|-----------------------------------------------------------
<pre>#th rowspan=2
[#SettingAnchors Setting Anchors]
</pre>
{| border=1 class="simple"
! <tt>[=#point1 (1)] First...</tt>
!\
|-
| colspan=2| [=#point1 (1)] First...
|-
| <tt>see [#point1 (1)]</tt>
| \
|-
| colspan=2| see [#point1 (1)]
|}

|-----------------------------------------------------------
<pre>#th rowspan=2
[#EscapingLinksandWikiPageNames Escaping Markup]
</pre>
{| border=1 class="simple"
! <tt>!'' doubled quotes</tt>
!\
|-
| colspan=2| !'' doubled quotes
|-
| <tt>wiki:WikiFormatting</tt>, <tt>WikiFormatting</tt>
| \
|-
| colspan=2| wiki:WikiFormatting, WikiFormatting
|}

|-----------------------------------------------------------
{| border=1 class="simple"
!= [#Images Images] =
! <tt>[[Image(</tt>''link''<tt>)]]</tt>
! [[Image(htdocs:../common/trac_logo_mini.png)]]
|}

|-----------------------------------------------------------
<pre>#th rowspan=2
[#Macros Macros]
</pre>
{| border=1 class="simple"
! <tt>[[MacroList(*)]]</tt>
! ''(short list of all available macros)''
|-
| <tt>[[Image?]]</tt>
| ''(help for the Image macro)''
|}

|-----------------------------------------------------------
{| border=1 class="simple"
!= [#Processors Processors] =
!\
|}

<pre>#td
<pre>
<pre>
#div style="font-size: 80%"
Code highlighting:
<pre>#python
hello = lambda: "world"
</pre>
</pre>
</pre>
</pre>
<pre>#td style="padding-left: 2em"
<pre>
#div style="font-size: 80%"
Code highlighting:
<pre>#python
hello = lambda: "world"
</pre>
</pre>
</pre>
|-----------------------------------------------------------
{| border=1 class="simple"
!= [#Comments Comments] =
!\
|}

<pre>#td
<pre>
<pre>#comment
Note to Editors: ...
</pre>
</pre>
</pre>
<pre>#td style="padding-left: 2em"
<pre>#comment
Note to Editors: ...
</pre>
</pre>
|-----------------------------------------------------------
{| border=1 class="simple"
!= [#Miscellaneous Miscellaneous] =
!\
|}

<pre>#td
<pre>
Line <br> break
Line \\ break
----
</pre>
</pre>
<pre>#td style="padding-left: 2em"
Line <br> break
Line \\ break
----
</pre>

=== Font Styles ===

The Trac wiki supports the following font styles:
{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
**'''bold''',
''' triple quotes !'''
can be bold too if prefixed by ! ''',
**''italic''
**'''''bold italic''''' or ''italic and
''' italic bold ''' ''
**<u>underline</u>
**<tt>monospace</tt> or <tt>monospace</tt>
(hence <tt><tt></tt> or <pre>`</tt> quoting)
**<s>strike-through</s>
**<sup>superscript</sup>
**<sub>subscript</sub>
****also bold**, //italic as well//,
and **'' bold italic **'' //(since 0.12)//
</pre>
</pre>
<pre>#td
*'''bold''',
''' triple quotes !'''
can be bold too if prefixed by ! ''',
*''italic''
*'''''bold italic''''' or ''italic and
''' italic bold ''' ''
*<u>underline</u>
*<tt>monospace</tt> or <tt>monospace</tt>
(hence <tt><tt></tt> or <pre>`</tt> quoting)
*<s>strike-through</s>
*<sup>superscript</sup>
*<sub>subscript</sub>
***also bold**, //italic as well//,
and **'' bold italic **'' //(since 0.12)//
</pre>

Notes:
*<tt><tt>...</tt></tt> and <tt><tt>...</tt></tt> commands not only select a monospace font, but also treat their content as verbatim text, meaning that no further wiki processing is done on this text.
*<tt> ! </tt> tells wiki parser to not take the following characters as wiki format, so pay attention to put a space after !, e.g. when ending bold.
*all the font styles marks have to be used in opening/closing pairs,
and they must nest properly (in particular, an <tt>''</tt> italic can't be paired
with a <tt>//</tt> one, and <tt>'''</tt> can't be paired with <tt>**</tt>)

=== Headings ===

You can create heading by starting a line with one up to six ''equal'' characters ("=")
followed by a single space and the headline text.

[=#hn] The headline text can be followed by the same number of "=" characters, but this is no longer mandatory.

Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
= Heading =
== Subheading
=== About ''this'' ===
=== Explicit id === #using-explicit-id-in-heading
== Subheading #sub2
</pre>
</pre>
<pre>#td style="padding: 1em;"
<pre>
#div
== Subheading
=== About ''this'' ===
=== Explicit id === #using-explicit-id-in-heading
== Subheading #sub2
</pre>
</pre>

=== Paragraphs ===

A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.

A forced line break can also be inserted, using:
{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
Line 1<br>Line 2
</pre>
<pre>
Paragraph
one

Paragraph
two
</pre>
</pre>
<pre>#td
Line 1<br>Line 2

Paragraph
one

Paragraph
two
</pre>

=== Lists ===

The wiki supports both ordered/numbered and unordered lists.

Example:
{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
**Item 1
***Item 1.1
*****Item 1.1.1
*****Item 1.1.2
*****Item 1.1.3
***Item 1.2
**Item 2
- items can start at the beginning of a line
and they can span multiple lines
- be careful though to continue the line
with the appropriate indentation, otherwise
that will start a new paragraph...

##Item 1
###Item 1.a
###Item 1.b
#####Item 1.b.i
#####Item 1.b.ii
##Item 2
And numbered lists can also be restarted
with an explicit number:
3. Item 3
</pre>
</pre>
<pre>#td
*Item 1
**Item 1.1
****Item 1.1.1
****Item 1.1.2
****Item 1.1.3
**Item 1.2
*Item 2
- items can start at the beginning of a line
and they can span multiple lines
- be careful though to continue the line
with the appropriate indentation, otherwise
that will start a new paragraph...

#Item 1
##Item 1.a
##Item 1.b
####Item 1.b.i
####Item 1.b.ii
#Item 2
And numbered lists can also be restarted with an explicit number:
3. Item 3
</pre>

=== Definition Lists ===

The wiki also supports definition lists.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
llama::
some kind of mammal, with hair
ppython::
some kind of reptile, without hair
(can you spot the typo?)
</pre>
</pre>
<pre>#td
llama::
some kind of mammal, with hair
ppython::
some kind of reptile, without hair
(can you spot the typo?)
</pre>

Note that you need a space in front of the defined term.

=== Preformatted Text ===

Block containing preformatted text are suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text to define a block quote. The curly braces need to be on a separate line.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
<pre>
def HelloWorld():
print '''Hello World'''
</pre>
</pre>
</pre>
<pre>#td
<pre>
def HelloWorld():
print '''Hello World'''
</pre>
</pre>

Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.

=== Blockquotes ===

In order to mark a paragraph as blockquote, indent that paragraph with two spaces.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
Paragraph
This text is a quote from someone else.
</pre>
</pre>
<pre>#td
Paragraph
This text is a quote from someone else.
</pre>

=== Discussion Citations ===

To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
>> Someone's original text
> Someone else's reply text
> - which can be any kind of Wiki markup
My reply text
</pre>
</pre>
<pre>#td
>> Someone's original text
> Someone else's reply text
> - which can be any kind of Wiki markup
My reply text
</pre>

=== Tables ===
==== Simple Tables ====
Simple tables can be created like this:
{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
{| border=1 class="simple"
!Cell 1
!Cell 2
!Cell 3
|}

{| border=1 class="simple"
!Cell 4
!Cell 5
!Cell 6
|}

</pre>
</pre>
<pre>#td style="padding: 2em;"
{| border=1 class="simple"
!Cell 1
!Cell 2
!Cell 3
|-
| Cell 4
| Cell 5
| Cell 6
|}

</pre>

Cell headings can be specified by wrapping the content in a pair of '=' characters.
Note that the '=' characters have to stick to the cell separators, like this:
{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
{| border=1 class="simple"
!
!= stable =
!= latest =
|}

{| border=1 class="simple"
!= 0.10 =
! 0.10.5
! 0.10.6dev
|}

{| border=1 class="simple"
!= 0.11 =
! 0.11.6
! 0.11.7dev
|}

</pre>
</pre>
<pre>#td style="padding: 2em;"
{| border=1 class="simple"
!
!= stable =
!= latest =
|-
| = 0.10 =
| 0.10.5
| 0.10.6dev
|-
| = 0.11 =
| 0.11.6
| 0.11.7dev
|}

</pre>

Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example:
{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
{| border=1 class="simple"
! 1
! 2
! 3
|}

{| border=1 class="simple"
!
! 1-2
! 3
|}

{| border=1 class="simple"
! 1
!
! 2-3
|}

{| border=1 class="simple"
!
!
! 1-2-3
|}

</pre>
</pre>
<pre>#td style="padding: 2em;"
{| border=1 class="simple"
! 1
! 2
! 3
|-
|
| 1-2
| 3
|-
| 1
|
| 2-3
|-
|
|
| 1-2-3
|}

</pre>

Note that if the content of a cell "sticks" to one side of the cell and only one, then the text will be aligned on that side. Example:
{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
{| border=1 class="simple"
!=Text =
!= Numbers =
|}

{| border=1 class="simple"
!left align
! 1.0
|}

{| border=1 class="simple"
! center
! 4.5
|}

{| border=1 class="simple"
! right align
! 4.5
|}

{| border=1 class="simple"
! default alignment
! 2.5
|}

{| border=1 class="simple"
!default
! 2.5
|}

{| border=1 class="simple"
! default
! 2.5
|}

{| border=1 class="simple"
! default
! 2.5
|}

</pre>
</pre>
<pre>#td style="padding: 2em;"
{| border=1 class="simple"
!=Text =
!= Numbers =
|-
| left align
| 1.0
|-
| center
| 4.5
|-
| right align
| 4.5
|-
| default alignment
| 2.5
|-
| default
| 2.5
|-
| default
| 2.5
|-
| default
| 2.5
|}

</pre>

If contrary to the example above, the cells in your table contain more text, it might be convenient to spread a table row over multiple lines of markup. The <tt>\</tt> character placed at the end of a line after a cell separator tells Trac to not start a new row for the cells on the next line.

{| border=1 class="simple"
!= Wiki Markup =
|}

<pre>#td
<pre>
{| border=1 class="simple"
! this is column 1 [http://trac.edgewall.org/newticket new ticket]
! \
|}

{| border=1 class="simple"
! this is column 2 [http://trac.edgewall.org/roadmap the road ahead]
! \
|}

{| border=1 class="simple"
! that's column 3 and last one
|}

</pre>
</pre>
|-------------
{| border=1 class="simple"
!= Display =
|}

<pre>#td style="padding: 2em;"
{| border=1 class="simple"
! this is column 1 [http://trac.edgewall.org/newticket new ticket]
! \
|-
| this is column 2 [http://trac.edgewall.org/roadmap the road ahead]
| \
|-
| colspan=2| that's column 3 and last one
|}

</pre>

==== Complex Tables ====

If the possibilities offered by the simple "pipe"-based markup for tables described above are not enough for your needs, you can create more elaborated tables by using [#Processors-example-tables WikiProcessor based tables].

=== Links ===

Hyperlinks are automatically created for WikiPageNames and URLs. WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as <tt>WikiPageLink</tt>.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
TitleIndex, http://www.edgewall.com/, NotAlink
</pre>
</pre>
<pre>#td
TitleIndex, http://www.edgewall.com/, NotAlink
</pre>

Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.
If the descriptive title is omitted, then the explicit prefix is discarded, unless the link is an external link. This can be useful for wiki pages not adhering to the WikiPageNames convention.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
**[http://www.edgewall.com Edgewall Software]
**[[TitleIndex| Title Index]]
**[[TitleIndex]]
**[[ISO9000]]
</pre>
</pre>
<pre>#td
**[http://www.edgewall.com Edgewall Software]
**[[TitleIndex| Title Index]]
**[[TitleIndex]]
**[[ISO9000]]
</pre>

Following the [trac:WikiCreole] trend, the descriptive title can also be specified by writing the link followed by a pipe ('|') and a title and all this inside //double// square brackets.

<pre>#td
<pre>
**[[http://www.edgewall.com|Edgewall Software]]
**[[[TitleIndex|Title| Index]]]
or even [[TitleIndex|Title Index]]
**[[[TitleIndex]]]
''' but not ![[TitleIndex]]! '''
**[[ISO9000]]
</pre>
</pre>
<pre>#td
**[[http://www.edgewall.com|Edgewall Software]]
**[[[TitleIndex|Title| Index]]]
or even [[TitleIndex|Title Index]]
**[[[TitleIndex]]]
''' but not ![[TitleIndex]]! '''
**[[ISO9000]]
</pre>

'''Note''': the [trac:WikiCreole] style for links is quick to type and
certainly looks familiar as it's the one used on Wikipedia and in many
other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
So in the rare case when you need to refer to a page which is named after
a macro (typical examples being TitleIndex, InterTrac and InterWiki),
by writing <tt>[[TitleIndex]]</tt> you will actually call the macro instead of linking
to the page.

=== Trac Links ===

Wiki pages can link directly to other parts of the Trac system. Pages can refer to tickets, reports, changesets, milestones, source files and other Wiki pages using the following notations:

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
**Tickets: #1 or ticket:1
**Reports: {1} or report:1
**Changesets: r1, [1] or changeset:1
**...
**targeting other Trac instances,
so called InterTrac links:
- Tickets: #Trac1 or Trac:ticket:1
- Changesets: [Trac1] or Trac:changeset:1
</pre>
</pre>
<pre>#td
*Tickets: #1 or ticket:1
*Reports: {1} or report:1
*Changesets: r1, [1] or changeset:1
*...
*targeting other Trac instances,
so called InterTrac links:
- Tickets: #Trac1 or Trac:ticket:1
- Changesets: [Trac1] or Trac:changeset:1
</pre>

There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.

=== Setting Anchors ===

An anchor, or more correctly speaking, an [http://www.w3.org/TR/REC-html40/struct/links.html#h-12.2.1 anchor name] can be added explicitly at any place in the Wiki page, in order to uniquely identify a position in the document:

<pre>
[=#point1]
</pre>

This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example:
<pre>
=== Long title === #title
</pre>

It's also very close to the syntax for the corresponding link to that anchor:
<pre>
[#point1]
</pre>

Optionally, a label can be given to the anchor:
<pre>
[[=#point1 '''Point 1''']]
</pre>

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

|----------------------------------
<pre>#td
<pre>
[#point2 jump to the second point]

...

Point2: [=#point2] Jump here
</pre>
</pre>
<pre>#td
[#point2 jump to the second point]

...

Point2: [=#point2] Jump here
</pre>

For more complex anchors (e.g. when a custom title is wanted), one can use the Span macro, e.g. <tt>[[span(id=point2, class=wikianchor, title=Point 2, <sup>(2)</sup>)]]</tt>.

=== Escaping Links and WikiPageNames ===

You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
NoHyperLink
!#42 is not a link
</pre>
</pre>
<pre>#td
NoHyperLink
!#42 is not a link
</pre>

=== Images ===

Urls ending with <tt>.png</tt>, <tt>.gif</tt> or <tt>.jpg</tt> are no longer automatically interpreted as image links, and converted to <tt><img></tt> tags.

You now have to use the ![[Image]] macro. The simplest way to include an image is to upload it as attachment to the current page, and put the filename in a macro call like <tt>[[Image(picture.gif)]]</tt>.

In addition to the current page, it is possible to refer to other resources:
*<tt>[[Image(wiki:WikiFormatting:picture.gif)]]</tt> (referring to attachment on another page)
*<tt>[[Image(ticket:1:picture.gif)]]</tt> (file attached to a ticket)
*<tt>[[Image(htdocs:picture.gif)]]</tt> (referring to a file inside project htdocs)
*<tt>[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]</tt> (a file in repository)

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
[[Image(htdocs:../common/trac_logo_mini.png)]]
</pre>
</pre>
<pre>#td
[[Image(htdocs:../common/trac_logo_mini.png)]]
</pre>

See WikiMacros for further documentation on the <tt>[[Image()]]</tt> macro.

=== Macros ===

Macros are ''custom functions'' to insert dynamic content in a page.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
[[RecentChanges(Trac,3)]]
</pre>
</pre>
<pre>#td style="padding-left: 2em"
[[RecentChanges(Trac,3)]]
</pre>

See WikiMacros for more information, and a list of installed macros.

The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
[[MacroList?]]
</pre>
</pre>
<pre>#td style="padding-left: 2em"
[[MacroList?]]
</pre>

=== Processors ===

Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
[[WikiRestructuredText| reStructuredText]] or [[WikiHtml| HTML]].

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

|--------------------------------------------------------
<pre>#td align="center" colspan=2 style="border: 0px; font-size: 90%"

[=#Processors-example-html Example 1:] HTML

</pre>
|--------------------------------------------------------
<pre>#td style="border: 0px"
<pre>
<pre>
#html
<h1 style="text-align: right; color: blue">
HTML Test
</h1>
</pre>
</pre>
</pre>
<pre>#td valign="top" style="border: 0px"

<pre>
#html
<h1 style="text-align: right; color: blue">HTML Test</h1>
</pre>

</pre>
|--------------------------------------------------------
<pre>#td align="center" colspan=2 style="border: 0px; font-size: 90%"

[=#Processors-example-highlight Example 2:] Code Highlighting

</pre>
|--------------------------------------------------------
<pre>#td style="border: 0px"
<pre>
<pre>
#python
class Test:

def <u>init</u>(self):
print "Hello World"
if <u>name</u> == '<u>main</u>':
Test()
</pre>
</pre>
</pre>
<pre>
#td valign="top" style="border: 0px"

<pre>
#python
class Test:
def <u>init</u>(self):
print "Hello World"
if <u>name</u> == '<u>main</u>':
Test()
</pre>

</pre>
|--------------------------------------------------------
<pre>#td align="center" colspan=2 style="border: 0px; font-size: 90%"

[=#Processors-example-tables Example 3:] Complex Tables

</pre>
|--------------------------------------------------------
<pre>#td style="border: 0px"
<pre>
<pre>#th rowspan=4 align=justify
With the <tt>#td</tt> and <tt>#th</tt> processors,
table cells can contain any content:
</pre>
|----------------
<pre>#td
- lists
- embedded tables
- simple multiline content
</pre>
|----------------
<pre>#td
As processors can be easily nested,
so can be tables:
<pre>#th
Example:
</pre>
<pre>#td style="background: #eef"
{| border=1 class="simple"
! must be at the third level now...
|}

</pre>
</pre>
|----------------
<pre>#td
Even when you don't have complex markup,
this form of table cells can be convenient
to write content on multiple lines.
</pre>
</pre>
</pre>
<pre>
#td valign="top" style="border: 0px"

<pre>#th rowspan=4 align=justify
With the <tt>#td</tt> and <tt>#th</tt> processors,
table cells can contain any content:
</pre>
|----------------
<pre>#td
- lists
- embedded tables
- simple multiline content
</pre>
|----------------
<pre>#td
As processors can be easily nested,
so can be tables:
<pre>#th
Example:
</pre>
<pre>#td style="background: #eef"
{| border=1 class="simple"
! must be at the third level now...
|}

</pre>
</pre>
|----------------
<pre>#td
Even when you don't have complex markup,
this form of table cells can be convenient
to write content on multiple lines.
</pre>

</pre>

See WikiProcessors for more information.

=== Comments ===

Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
Nothing to
<pre>
#comment
Your comment for editors here
</pre>
see ;-)
</pre>
</pre>
<pre>#td
Nothing to
<pre>
#comment
Your comment for editors here
</pre>
see ;-)
</pre>

=== Miscellaneous ===

An horizontal line can be used to separated different parts of your page:

{| border=1 class="simple"
!= Wiki Markup =
!= Display =
|}

<pre>#td
<pre>
Four or more dashes will be replaced
by an horizontal line (<HR>)
----
See?
</pre>
</pre>
<pre>#td
Four or more dashes will be replaced
by an horizontal line (<HR>)
----
See?
</pre>
|----------------------------------
<pre>#td
<pre>
"macro" style <br> line break
</pre>
</pre>
<pre>#td
"macro" style <br> line break
</pre>
|----------------------------------
<pre>#td
<pre>
WikiCreole style \\ line\\break
</pre>
</pre>
<pre>#td
WikiCreole style \\ line\\break
</pre>

{{TracNotice|{{PAGENAME}}}}

WikiDeletePage

2015-08-26T12:29:29Z

Maintenance script: Created page with " == Deleting a Wiki Page == Existing wiki pages can be completely deleted using the ''Delete Page'' or the ''Delete this Version'' buttons at the bottom of the wiki page. The..."

== Deleting a Wiki Page ==

Existing wiki pages can be completely deleted using the ''Delete Page'' or the ''Delete this Version'' buttons at the bottom of the wiki page. These buttons are only visible for users with <tt>WIKI_DELETE</tt> permissions.

'''Note:''' Deleting a wiki page is an irreversible operation.

If you want to delete a page because you actually re-created a new page with the same content but a different name, it is recommended to keep the page and use it as a redirection page instead of completely deleting it, as to not frustrate the visitor with broken links when coming to the site from a search engine.

In this situation, chances are that you actually wanted to [[WikiNewPage#renaming|rename]] the page instead of doing a copy + delete.
The ''Rename'' operation also offers you the possibility to create a redirection page.
A redirection page is a short page that contains a link such as “See SomeOtherPage”.

However, deleting specific versions or even complete pages can make sense to remove spam or other abusive submissions.

----
See also: TracWiki, TracPermissions

{{TracNotice|{{PAGENAME}}}}

WhoAreWe

2015-08-26T12:29:28Z

Maintenance script: Created page with " {{TracNotice|{{PAGENAME}}}}"

{{TracNotice|{{PAGENAME}}}}

VMForStatsCourse

2015-08-26T12:29:28Z

Maintenance script: Created page with " PageOutline == Special seminar "Advanced statistics for discoveries" == {| border=1 class="simple" !April 12, 2012 - Introduction <br> April 24-25, 2012 - Advance..."

[[PageOutline]]

== Special seminar "Advanced statistics for discoveries" ==
{| border=1 class="simple"
!April 12, 2012 - Introduction <br> April 24-25, 2012 - Advanced theory and hands-on part
|-
| [http://w3.iihe.ac.be/ IIHE ULB-VUB], Large seminar room <br> [http://w3.iihe.ac.be/route.php How to get to the IIHE: click here]
|}

Organised by Pascal Vanlaer (ULB) and Jorgen D'Hondt (VUB)

[[Image(logo-ulb.jpg,15%)]] [[Image(logoIIHE.png,9%)]] [[Image(VUB_official.png,15%)]] <br>

This special 3-day seminar on "advanced statistics for discoveries" provides the advanced statistical foundations that allow discrepancies with an expected background to be quantified, paving the way to a discovery. It is meant for graduate students and above. It covers tests of the presence of a new signal and the evaluation of its significance, both in theory and in practice using the RooStats statistical tool.

The seminar is organised as follows: on the first day, a reminder of statistics will be given by IIHE staff (fitting and hypothesis testing); followed by a simple RooStats exercise in the afternoon, taught by IIHE PhD students.
The second part would be taught by Wouter Verkerke, one of the RooStats authors, from NIKHEF, who will teach the advanced theory part interleaved with hands-on exercises.

'''People attending must come with a laptop configured as described [#platform below].''' The configuration contains a virtual machine with the required operating system and Root version already installed, that guarantees a unique platform for all people attending. '''This setup is mandatory.''' In case of problems, please contact grid_adminATlistserv.ulb.ac.be

This seminar is organized with financial support from the doctoral schools on Physics and Astrophysics (Ecole doctorale thematique PandA - Communaute francaise de Belgique) and on Natural Sciences and (Bioscience) Engineering (NSE - VUB), the Fonds de la Recherche Scientifique (F.R.S.-FNRS) and the Fonds Wetenschappelijk Onderzoek (FWO). <br> <br>
[[Image(panda-school.png,7%)]] [[Image(NSElogo.jpeg,16%)]] <br><br>

----

=== Seminar programme ===

[[Introduction]] <br>
[[advanced| Advanced theory and hands-on part]]

----

=== Registration ===

Maximum 35 people at a time can attend the seminar. Register by entering your name into the doodle poll <br> http://www.doodle.com/mxhu388h4mtmx5dr <br>

The dates of the seminar have been fixed, but there are still a few places left. People who can't attend the introduction day can participate to the advanced theory and hands-on part on April 24-25 provided that they feel confortable with parameter estimation and hypothesis testing, and master the RooStats tutorial taught in the introduction (see the Introduction link from the Seminar programme above). In this case please register your name in the poll above, leaving all days red.

----
[=#platform]
=== Installation of a Virtual machine for the statistics course ===

Please follow the instructions to install the virtual machine containing the root version necessary to follow the statistics course. It is a mandatory installation, so that everybody starts with the same settings.<br>
Most of the instructions work for Linux, MAC and Windows. There is an extra section specially for windows users, as they require some more installation. there is also a special procedure for Ubuntu users as the standard VM does not work on this distribution.

==== Install Virtual Box ====
Virtual Box is the software that will allow you to run a 'guest operating system' that is different form the one you use now. <br>
Go to https://www.virtualbox.org/wiki/Downloads and download the version of Virtual Box for the operating system that is installed on you laptop now and install it.
==== Prepare the ground ====
To be able to run the virtual machine (VM), we need to configure virtualbox. <br>

From the virtualbox download page, download the extension pack. <br>
Open VirtualBox; go to the following menus: File > Preferences > Extensions. <br>
Click on the triangle to add a package<br>
[[Image(VM_add_package.png,25%)]]<br>
Browse to where you saved the extension file and add it.<br>
<br>
Next, in the same window, click on Network. And add a Host-only network. <br>
[[Image(VM_add_network.png,25%)]]<br>
The new network should also have the name vboxnet0<br>

==== Install the VM ====
Ubuntu users need to follow the second procedure. Other users are recommended to use the first procedure, although the second might also work for them. This was, however, not tested.
==== For all platforms except Ubuntu ====
Download the file with the VM: http://mon.iihe.ac.be/~odevroed/VM/VirtualBox_Fedora.tar.bz2 <br>
also available here : http://193.190.247.172/VM/VirtualBox_Fedora.tar.bz2 <br>
bunzip and untar the file. <br>

Then, in VirtualBox, click: Machine > Add ; Go to the directory where you untarred the file and select "Fedora16.vbox". <br>
A new Icon with the VM will come up. Just start the new VM and you have a working Fedora 16 with lightweight xFCE window manager.<br>

==== For Ubuntu users ====
Download the file with the VM: http://mon.iihe.ac.be/~odevroed/VM/Ubuntu.ova <br>
Also available here : http://193.190.247.172/VM/Ubuntu.ova <br>
Then, in VirtualBox, click: File > Import Appliance > Choose <br>
Then browse to the downloaded file and import it.

==== run Root ====
We could run root from the VM window, but as this is a bit small, we will just run it from a terminal on our laptop.<br>
Log into the VM as user course (password= course;123 the same password holds for root)<br>
Open a terminal (black icon in lower left ) and type: ifconfig <br>
look for the line "inet addr:192.168.56.3" ; The last digit (3) will probably be different on your system. It is this IP address that we will ssh to.<br>

<pre>
ssh -X course@192.168.56.X
</pre>
And then run root. The root icon should now appear in your laptop. Test the settings by opening a TBrowser for instance.

<pre>
t=TBrowser();
</pre>

To test if all RooStats libraries required are correctly installed, try:
<pre>
cd $ROOTSYS/tutorials/roostats
root -l StandardHypoTestInvDemo.C
</pre>

This will run the full chain of building a model, storing it in a workspace, reading it in and
calculating a CLS limit use a PLL test statistics. It takes about 90 seconds to execute.

==== Extra instructions for Windows users ====

On windows you might need another step, as the VM host only network does not have the same name. To do this, right click on the name of VM > configuration > network <br>
In the second tab (named card 2), change the name to whatever card name you can find in the drop-down menu.<br>
As the VM contains linux, it natively runs X-windows. This is unfortunately not the case for windows. You need to install an X server. This one works: http://sourceforge.net/projects/xming/?_test=b , but you might already use another one.<br>
Then, install an ssh client. The most famous is putty: http://the.earth.li/~sgtatham/putty/latest/x86/putty.exe <br>
Determine the IP of the VM as above and ssh to the machine, before go to the options on X11 and put X11-forwarding on.

{{TracNotice|{{PAGENAME}}}}

VirtWithKVM1

2015-08-26T12:29:28Z

Maintenance script: Created page with " == KVM installation and configuration on dom04 == === Short description of the software and hardware === The KVM host will be named dom04.wn. The operating system will be S..."

== KVM installation and configuration on dom04 ==
=== Short description of the software and hardware ===
The KVM host will be named dom04.wn. The operating system will be Scientific Linux 6.1 x86_64. There are 9 ports :
*iLO3 port (IP 192.168.9.224) -> use this address in your browser to access the iLO3 Web pages of the machine;
*eth0 -> eth3 : bnx2 NIC
*eth4 -> eth7 : igb NIC
Since the rule is to always take the first available NIC as the public one, and since we will use the bnx2 NICs, then eth0 will be the public NIC and eth1 will be the private one :
<pre>
eth0 --> public, no IP address;
eth1 --> private, IP 192.168.10.37
</pre>
The machine is an HP ProLiant DL360 G7 with 2 CPUs, each CPU having 6 hyperthreaded cores (12 cores from the OS point of view) and 72 GB of memory.
There are four RAID-1 systems of 500GB each.

=== OS installation ===
*Installation was done through the iLO Integrated Remote Console
*Installation media : SL61 DVD iso's, mounted on the machine via a Virtual DVD Drive (in the Remote Console, menu "Virtual Drives" > sub-menu "CD/DVD" > select option "Virtual Image" > select the *.iso file)
*Disk space layout : one volume group using the first RAID-1 systems (sda); we will use sdb, sdc and sdd as physical disks for virtual machines. (See next section for more details)

=== Disk space layout in details ===

During the SL installation process, the wizard will ask you to add the RAID systems on which you want to install the OS. If you add all the 4 RAIDs, then the installation process will create a volume group that will spread accross the 4 RAID systems, and that's not what we want ! The volume group for the OS should be contained in the first RAID (physical device /dev/sda), and the other three RAIDs should exists as physical devices (/dev/sdb, /dev/sdc, and /dev/sdd) outside the volume group. This way, the three last RAID systems can be used as physical disks for the virtual machines.

Now speaking about the default partioning layout, if you let the installation process do the job for you, it will create three logical volumes : swap (virtual memory), home (mounted to /home) and root (mounted to /). The first device (sda) will be splitted in two physical partitions : sda1 mounted to /boot is outside the volume group, and sda2 is added to the volume group.

After the installation process is finished, you may want to correct the disk space layout. You can easily do it with the GUI called system-config-lvm :
<pre>
yum install system-config-lvm
system-config-lvm
</pre>
(since it is a graphical, don't forget to open you ssh session on dom04 with the option -XC).

The following screenshot shows what you should get :

[[Image(system-config-lvm1.png,50%)]]

In the picture above, you can see that there is no /home : it has been deleted because not useful, and the resulting unallocated space has been added to the root logical volume. If you do so, don't forget to remove the line corresponding to /home in /etc/fstab, otherwise, your machine won't be able to reboot (during the reboot, it will try to fscheck /home, resulting in an error, and you'll be obliged to restart the machine in rescue mode to correct the /etc/fstab) !

=== Network configuration ===
Here are the NICs as they are stated in iLO :
{| border=1 class="simple"
!iLO3
!iLO Dedicated Network Port
!9c:8e:99:2e:c6:a6
|-
| iSCSI
| Port 1
| 9c:8e:99:2d:e1:e5
|-
| iSCSI
| Port 2
| 9c:8e:99:2d:e1:e7
|-
| iSCSI
| Port 3
| 9c:8e:99:2d:e1:dd
|-
| iSCSI
| Port 4
| 9c:8e:99:2d:e1:df
|-
| NIC
| Port 1
| 9c:8e:99:2d:e1:e4
|-
| NIC
| Port 2
| 9c:8e:99:2d:e1:e6
|-
| NIC
| Port 3
| 9c:8e:99:2d:e1:dc
|-
| NIC
| Port 4
| 9c:8e:99:2d:e1:de
|}

In fact, in the table above, only the four bnx2 ports are visible (each port has two MAC addresses). There is still a PCI extension card providing four igb ports not visible in the iLO web pages. However, if you look at the output of dmesg, you should see blocks of lines like these :
<pre>
igb 0000:06:00.1: irq 70 for MSI/MSI-X
igb 0000:06:00.1: Intel(R) Gigabit Ethernet Network Connection
igb 0000:06:00.1: eth5: (PCIe:5.0Gb/s:Width x4) f4:ce:46:a6:e5:59
igb 0000:06:00.1: eth5: PBA No: E84069-007
igb 0000:06:00.1: Using MSI-X interrupts. 8 rx queue(s), 8 tx queue(s)
</pre>
Notice the different MAC address range used for igb interfaces.
{| border=1 class="simple"
!eth4
!f4:ce:46:a6:e5:58
|-
| eth5
| f4:ce:46:a6:e5:59
|-
| eth6
| f4:ce:46:a6:e5:5a
|-
| eth7
| f4:ce:46:a6:e5:5b
|}

Two bridges must be created : one for the public network and another for the private network.

Here is the content of the needed network scripts in /etc/sysconfig/network-scripts/ :
<pre>
# cat ifcfg-eth0
----------------
DEVICE="eth0"
BOOTPROTO="static"
HWADDR="9C:8E:99:2D:E1:E4"
NM_CONTROLLED="no"
ONBOOT="yes"
BRIDGE="br0"
----------------

# cat ifcfg-br0
----------------
DEVICE="br0"
TYPE="Bridge"
NM_CONTROLLED="no"
BOOTPROTO="static"
ONBOOT="yes"
----------------

# cat ifcfg-eth1
----------------
DEVICE="eth1"
HWADDR="9C:8E:99:2D:E1:E6"
NM_CONTROLLED="no"
ONBOOT="yes"
BOOTPROTO="static"
BRIDGE="br1"
----------------

# cat ifcfg-br1
----------------
DEVICE="br1"
TYPE="Bridge"
BOOTPROTO="static"
ONBOOT="yes"
IPADDR="192.168.10.37"
NETMASK="255.255.0.0"
----------------
</pre>
After editing these files, restart the network :
<pre>
service network restart
</pre>
Now, let us control that everything is ok :
<pre>
# brctl show
----------------
bridge name bridge id STP enabled interfaces
br0 8000.9c8e992de1e4 no eth0
br1 8000.9c8e992de1e6 no eth1
----------------

# ifconfig
----------------
br0 Link encap:Ethernet HWaddr 9C:8E:99:2D:E1:E4
inet6 addr: fe80::9e8e:99ff:fe2d:e1e4/64 Scope:Link
...

br1 Link encap:Ethernet HWaddr 9C:8E:99:2D:E1:E6
inet addr:192.168.10.37 Bcast:192.168.255.255 Mask:255.255.0.0
inet6 addr: fe80::9e8e:99ff:fe2d:e1e6/64 Scope:Link
...

eth0 Link encap:Ethernet HWaddr 9C:8E:99:2D:E1:E4
inet6 addr: fe80::9e8e:99ff:fe2d:e1e4/64 Scope:Link
...

eth1 Link encap:Ethernet HWaddr 9C:8E:99:2D:E1:E6
inet6 addr: fe80::9e8e:99ff:fe2d:e1e6/64 Scope:Link
...
----------------
</pre>
Now, iptables must be configured to allow forwarding across the bridges :
<pre>
# iptables -I FORWARD -m physdev --physdev-is-bridged -j ACCEPT
# service iptables save
# service iptables restart
</pre>
SElinux must be disabled, otherwise you'll get strange error messages when trying to start your virtual machines :
<pre>
/usr/sbin/setenforce 0
vim /etc/selinux/config
--> you must set the following : SELINUX=disabled
</pre>
We still have to add a default route through ccq :
<pre>
route add default gw 192.168.10.100
</pre>
and to make this default route permanent, don't forget to add the following line in /etc/sysconfig/network :
<pre>
GATEWAY=192.168.10.100
</pre>
As a result, your root table should look like this :
<pre>
[root@dom05 ~]# route
Kernel IP routing table
Destination Gateway Genmask Flags Metric Ref Use Iface
192.168.122.0 * 255.255.255.0 U 0 0 0 virbr0
link-local * 255.255.0.0 U 1015 0 0 br0
link-local * 255.255.0.0 U 1016 0 0 br1
192.168.0.0 * 255.255.0.0 U 0 0 0 br1
default ccq.wn.iihe.ac. 0.0.0.0 UG 0 0 0 br1
</pre>
And then configure the DNS resolution by adding the following in /etc/resolv.conf :
<pre>
search wn.iihe.ac.be
nameserver 192.168.10.100
nameserver 193.190.247.140
</pre>

We can now make the machine ready for SSH. Simply run :
<pre>
ssh-keygen -t rsa
</pre>
for key pair generation. It is also a good idea to add in .ssh/authorized_keys the public key of ccq, dom02, and dom03.

Don't forget to also add dom04.wn.iihe.ac.be in the private DNS on ccq.

=== RPMs installation ===
We simply did a :
<pre>
yum groupinstall "Virtualization*"
</pre>
This will install four software groups :
*Virtualization
*Virtualization Client
*Virtualization Platform
*Virtualization Tools
The following is also necessary for X forwarding with SSH :
<pre>
yum install xorg-x11-xauth
</pre>
After that, you must log off, and then log in back with the option -X (this log off and in is necessary to create the .Xauthority file).

=== Configuration of daemons ===
Start libvirtd :
<pre>
service libvirtd start
</pre>
Doing a "brctl show" or and an "ifconfig", you should see new interface virbr0.

=== Manage the storage pools ===

Launch virt-manager, right click on the virtual host (localhost), select the "Details" option in the menu, and the select the "Storage" tab in the new window. Now, we will add the three RAID systems (sdb, sdc, and sdd) to the storage pools. I will show in details the steps for the device sdb :

[[Image(system-config-lvm2.png,25%)]]

Click on the "+" button at the lower left corner of the previous window, this will launch a wizard. In the first window of the wizard, give a name to the new pool (for example "sdb"). On the next windows, fill in the fields like this :

[[Image(system-config-lvm3.png,25%)]]

== Example of a VM installation from CD/DVD ISO ==
It should be the same as [http://mon.iihe.ac.be/trac/t2b/wiki/VirtWithKVM#ExampleofaVMinstallationfromCDDVDISO here]
== Example of a VM installation from PXE ==
It should be the same as [http://mon.iihe.ac.be/trac/t2b/wiki/VirtWithKVM#ExampleofaVMinstallationfromPXE here]

{{TracNotice|{{PAGENAME}}}}

VirtWithKVM

2015-08-26T12:29:28Z

Maintenance script: Created page with " == KVM installation and configuration on dom02 == === Short description of the software and hardware === The KVM host will be named dom02. The operating system is SL 5.5 x8..."

== KVM installation and configuration on dom02 ==
=== Short description of the software and hardware ===
The KVM host will be named dom02. The operating system is SL 5.5 x86_64. There are three ports :
*iLO3 port (IP 192.168.9.222);
*eth0 : as usual, public NIC, without IP address;
*eth1 : private NIC with IP 192.168.10.35.
The machine is an HP DL360G7 with CPU L5640 (12 cores) and 24 GB of memory.

=== Network configuration ===
Two bridges must be created : one for the public network and another for the private network. Here is the content of the needed network scripts in /etc/sysconfig/network-scripts/ :
<pre>
# cat ifcfg-eth0
----------------
DEVICE=eth0
BRIDGE=br0
BOOTPROTO=static
ONBOOT=yes
HOTPLUG=no
TYPE=Ethernet
USERCTL=no
PEERDNS=yes
IPV6INIT=yes
IPV6_AUTOCONF=yes
----------------

# cat ifcfg-br0
----------------
DEVICE=br0
TYPE=Bridge
BOOTPROTO=static
ONBOOT=yes
----------------

# cat ifcfg-eth1
----------------
DEVICE=eth1
BRIDGE=br1
BOOTPROTO=static
ONBOOT=yes
TYPE=Ethernet
PEERDNS=yes
USERCTL=no
IPV6INIT=no
IPV6_AUTOCONF=no
----------------

# cat ifcfg-br1
----------------
DEVICE=br1
TYPE=Bridge
BOOTPROTO=static
ONBOOT=yes
IPADDR=192.168.10.35
NETMASK=255.255.0.0
BROADCAST=192.168.10.255
----------------
</pre>
After editing these files, restart the network :
<pre>
service network restart
</pre>
Now, let us control that everything is ok :
<pre>
# brctl show
----------------
bridge name bridge id STP enabled interfaces
br0 8000.68b599bd46bc no eth0
br1 8000.68b599bd46be no eth1
----------------

# ifconfig
----------------
br0 Link encap:Ethernet HWaddr 68:B5:99:BD:46:BC
inet6 addr: fe80::6ab5:99ff:febd:46bc/64 Scope:Link
...

br1 Link encap:Ethernet HWaddr 68:B5:99:BD:46:BE
inet addr:192.168.10.35 Bcast:192.168.10.255 Mask:255.255.0.0
inet6 addr: fe80::6ab5:99ff:febd:46be/64 Scope:Link
...

eth0 Link encap:Ethernet HWaddr 68:B5:99:BD:46:BC
inet6 addr: fe80::6ab5:99ff:febd:46bc/64 Scope:Link
...

eth1 Link encap:Ethernet HWaddr 68:B5:99:BD:46:BE
inet6 addr: fe80::6ab5:99ff:febd:46be/64 Scope:Link
...
----------------
</pre>
Now, iptables must be configured to allow forwarding across the bridges :
<pre>
# iptables -I FORWARD -m physdev --physdev-is-bridged -j ACCEPT
# service iptables save
# service iptables restart
</pre>
SElinux must be disabled, otherwise you'll get strange error messages when trying to start your virtual machines :
<pre>
/usr/sbin/setenforce 0
vim /etc/selinux/config
--> you must set the following : SELINUX=disabled
</pre>
We still have to add a default route through ccq :
<pre>
route add default gw 192.168.10.100
</pre>

And then configure the DNS resolution by adding the following in /etc/resolv.conf :
<pre>
search wn.iihe.ac.be
nameserver 192.168.10.100
nameserver 193.190.247.140
</pre>

=== RPMs installation ===
We simply did a :
<pre>
yum groupinstall KVM
</pre>

=== Configuration of daemons ===
Start libvirtd :
<pre>
service libvirtd start
</pre>
Doing a "brctl show" or and an "ifconfig", you should see new interface virbr0.

== Example of a VM installation from CD/DVD ISO ==
We used the GUI virt-manager (don't forget the X forwarding when you connect to dom02 !). Here are the steps in the wizard :
*First screen : Virtual machine name : cream02;
*Second screen : Virtualization method : "Fully virtualized";
*Third screen : Installation method : we have worked with ISOs; and for OS type and variant, Linux-RHEL5.4 or later was the closest to SL5.5;
*Fourth screen : Storage : we used a file (disk image), keeping the suggested location and rising the size to 40000 MB and pre-allocating the entire virtual disk space;
*Fifth screen : Network : we chose the option "Shared physical device", which corresponds to the bridging solution, and as a device, we took "eth0 (Bridge br0)";
*Sixth screen : Memory and CPU allocation : max. memory to 4096 MB and 2 virtual CPUs;
After VM creation, we still had to add a second NIC for the private network, and of course we linked it to the bridge br1.

== Example of a VM installation from PXE ==
In this example, we used command line (''virsh'') instead of the GUI virt-manager :
#Login to dom02.
#Each VM has a universal unique identifier (uuid). This number is generated with the command uuid.
#With the command :
<pre>
virsh edit <Name of KVM>
</pre>
you can create and edit the XML profile of the machine. For example :
<pre>
<domain type='kvm'>
<name>submit</name>
<uuid>e8e837ed-22a9-8a65-feba-0ef6784d8ccf</uuid>
<memory>1048576</memory>
<currentMemory>1048576</currentMemory>
<vcpu>1</vcpu>
<os>
<type arch='x86_64' machine='rhel5.4.0'>hvm</type>
<boot dev='network'/>
</os>
<features>
<acpi/>
<apic/>
<pae/>
</features>
<clock offset='utc'/>
<on_poweroff>destroy</on_poweroff>
<on_reboot>restart</on_reboot>
<on_crash>restart</on_crash>
<devices>
<emulator>/usr/libexec/qemu-kvm</emulator>
<disk type='file' device='disk'>
<source file='/var/lib/libvirt/images/submit.img'/>
<target dev='hda' bus='ide'/>
</disk>
<interface type='bridge'>
<mac address='54:52:00:12:64:7a'/>
<source bridge='br1'/>
</interface>
<serial type='pty'>
<target port='0'/>
</serial>
<console type='pty'>
<target port='0'/>
</console>
<input type='mouse' bus='ps2'/>
<graphics type='vnc' port='-1' autoport='yes' keymap='en-us'/>
</devices>
</domain>
</pre>
The XML file will be created in /etc/libvirt/qemu. If you want more info about editing this XML, just read [http://publib.boulder.ibm.com/infocenter/lnxinfo/v3r0m0/topic/liaai/kvmadv/kvmadvexrhel.htm this].

4. You can now define your new VM from the XML file :
<pre>
virsh define <Name of XML definition file>
</pre>

5. Then, you can create the image file for the hard drive of the VM :
<pre>
qemu-img create /var/lib/libvirt/images/submit.img 10G
</pre>

6. We can now start the machine :
<pre>
virsh start <Name of KVM>
</pre>
and check that it is running :
<pre>
virsh list
</pre>

== Convert IDE/SCSI/SATA HD to virtio HD ==
Installation of a VM with virtio drive through PXE does not work with SL5 because the initrd doesn't load virtio modules during first reboot. To avoid this issue, we can create and install the VM with an IDE hard drive. In the machine xml the disk specification should read like
<pre>
<disk type='file' device='disk'>
<source file='/var/lib/libvirt/images/submit.img'/>
<target dev='hda' bus='ide'/>
</disk>
</pre>

When the installation is finished, convert the HD of the machine to a virtio device. Here are the steps in brief :
#Log on the VM
2. Create a new initrd with virtio support :
3. Modify init script in initrd, and replace references to hda by vda.
4. Modify the grub device map file (/boot/grub/device.map)
5. On the host machine, change the XML definition of the VM (virsh edit <VM>).
6. Reboot the VM
To make this conversion easier, we have written a script that you can find in the attachments. Just run this script on the VM, and then type the following on the host :
<pre>
virsh edit <VM>
--> edit the XML : change <target dev='hda' bus='ide'/> to <target dev='vda' bus='virtio'/>
virsh define <VM_XML>
</pre>

There is a script dom03:/root/convert_vm_hd_to_virtio.pl to ease this procedure

== Useful links ==
*Doc from INFN : http://wiki.infn.it/cn/ccr/virtualizzazione/documentazione/kvm_howto
*Doc from IBM : http://publib.boulder.ibm.com/infocenter/lnxinfo/v3r0m0/topic/liaai/liaaivirtualization.htm
*Page about virtio in the official libvirt Wiki : http://wiki.libvirt.org/page/Virtio

{{TracNotice|{{PAGENAME}}}}

VeryQuickGuideCMSSWDeployment

2015-08-26T12:29:27Z

Maintenance script: Created page with " CMSSW Deployment Home == A Very Quick Guide To CMSSW Deployment == === Before Each Deployment === *login on m1.iihe.ac.be as cmssw <pre> ssh cmssw..."

[[CMSSWDeployment| CMSSW Deployment Home]]

== A Very Quick Guide To CMSSW Deployment ==
=== Before Each Deployment ===
*login on m1.iihe.ac.be as cmssw
<pre>
ssh cmssw@m1.iihe.ac.be
</pre>
*create a proxy:
<pre>
source CreateProxy.sh yourname
</pre>
This command changes the current directory to the release-installer area
<pre>
/user/cmssw/Deployment/tag-handler
</pre>

=== What To Do If ... ===
*'''a new version of CMSSW is released or an old version is deprecated:'''
***submit installation/removal jobs
<pre>
ri -s
</pre>
***Check the job status.
<pre>
ri -l
</pre>
***Retrieve (Fetch) the output of the installation jobs:
<pre>
ri -f
</pre>
The output is stored in
<pre>
/user/cmssw/cms/release-installer/<JOBSTATUS>/<CE>/<TIMESTAMP>
</pre>
<JOBSTATUS> is the status of the job<br>
<CE> is de site ce name<br>
<TIMESTAMP is the time of submission in the format yyyy-mm-dd_T_hh_mm_ss

*'''you want to know where and which releases have to be installed/removed'''
<pre>
ri -d
</pre>

*'''a site needs manual intervention'''
<pre>
ri -d
</pre>
This command will also show which sites need manual intervention. If this is the case, there exists a directory
<pre>
/user/cmssw/cms/release-installer/stopped/<CE>/
</pre>
where CE is de site's CE name.<br>
Go through the output, solve the problem. Open, if useful, a Savannah Ticket. Once the problem is solved, remove the direcory

*'''a site makes a special request''' to remove, add or keep a specific release.<br>
Edit the file manual_install_requests.xml and submit to the site(s)
<pre>
emacs -nw manual_install_requests.xml
ri -c CE1,CE2 -s
</pre>

*'''you're not sure what to do''':
<pre>
ri
</pre>
a help page will be displayed

{{TracNotice|{{PAGENAME}}}}

V0 Analysis wiki

2015-08-26T12:29:27Z

Maintenance script: Created page with " === Running the V0Tree production code with CMSSW 3_6_2 === ''Note: the example of the code with all the neccessary config files is at'' /user_mnt/user/threus/CMSSW_3_6_2/..."

=== Running the V0Tree production code with CMSSW 3_6_2 ===

''Note: the example of the code with all the neccessary config files is at'' /user_mnt/user/threus/CMSSW_3_6_2/src/

0) copy the /user_mnt/user/vanlaer/kinefit362/src/RecoVertex/V0Tree directory to your respective /src/RecoVertex/ dir.

- it contains all neccessary links between various config files, such that step 2)a and 3) is done already.

1) '''Patching track-to-track covariance'''
- cvs the patched code:

cvs co -r V01-01-08 RecoVertex/KalmanVertexFit

cvs co -r V01-01-04 RecoVertex/VertexPrimitives

cvs co -r V00-01-09 RecoVertex/LinearizationPointFinders

cvs co -r V01-01-06 RecoVertex/VertexTools

cvs co -r V01-00-18 RecoVertex/V0Producer

- update /RecoVertex/VertexPrimitives/src/TransientVertex.cc, method TransientVertex::tkToTkCovariance(const TransientTrack& t1, const TransientTrack& t2):

comment piece of code starting at line 158:
if (t1<t2) {
tr1 = &t1;
tr2 = &t2;
} else {
tr1 = &t2;
tr2 = &t1;
}

and instead insert

tr1 = &t1;
tr2 = &t2;

(i.e. disable unwanted track swapping).

2) '''Track Refit''', which consists of two steps:

a) refitting of the reconstructed tracks with the pion mass hypothesis (w.r.t. default muon mass hypothesis)

- load the refitter module and tell the refitter to use pion hypothesis:

in your mainconfig.py file (that you use when running cmsRun mainconfig.py) add:

''process.load("RecoTracker.TrackProducer.TrackRefitters_cff")''

''process.RungeKuttaTrackerPropagator.Mass = 0.139''

''process.RungeKuttaTrackerPropagatorOpposite.Mass = 0.139''

- add refitter module into your path (in mainconfig.py) ''before'' the V0Tree module (process.demo):

''process.p = cms.Path(... *... *process.TrackRefitter *...)''

b) rerunning the V0 producer on the refitted tracks

- tell the V0 producer to use refitted tracks: in ./RecoVertex/V0Producer/python/generalV0Candidates_cfi.py,

change ''trackRecoAlgorithm = cms.InputTag('generalTracks')'' to ''trackRecoAlgorithm = cms.InputTag('TrackRefitter')''

you may also modify the main config file with the following line:

process.generalV0Candidates.trackRecoAlgorithm = 'TrackRefitter'

it has the same effect but it does not require recompiling of the RecoVertex/V0Producer/python config.

- add the V0 produced module into your path (in mainconfig.py) ''before'' the V0Tree module (process.demo) and ''after'' the refitter module (process.TrackRefitter):

''process.p = cms.Path(... *... *process.TrackRefitter *process.generalV0Candidates *process.demo)''

For the completed mainconfig.py file have a look at /user_mnt/user/threus/CMSSW_3_6_2/src/RecoVertex/V0Tree/test/runV0Tree_MC_simtracks_7TeV_refitpions_cfg.py

ISSUE: DATA sample throws an error, so for the moment track refitting works only for MC.

3) '''Matching reconstructed tracks with simulated tracks''' (TrackingParticles)

- add the corresponding modules into your mainconfig.py:

''process.load("SimTracker.TrackAssociation.TrackAssociatorByHits_cfi")''

''process.load("SimTracker.TrackAssociation.trackingParticleRecoTrackAsssociation_cfi")''

''process.TrackAssociatorByHits.SimToRecoDenominator = cms.string('reco')''

- copy /user_mnt/user/threus/CMSSW_3_6_2/src/RecoVertex/V0Tree/python/v0tree_cfi.py to your respective directory

note how the parameters are defined and if you use the TrackRefitter (see above), set the ''label'' to

''label = cms.VInputTag(cms.InputTag("TrackRefitter"))'', to use refitted reconstructed tracks for the reco-sim matching.

if you don't use TrackRefitter, set the ''label'' to ''label = cms.VInputTag(cms.InputTag("generalTracks"))''

- set the parameters inside mainconfig.py:

''process.demo.associators = ['TrackAssociatorByHits']''

''process.demo.label = ['cutsRecoTracks']''

''process.demo.UseAssociators = cms.bool(True)''

- define track selection cuts for the matching algorithm for both, simulated and reconstructed tracks:

copy these files from /user_mnt/user/threus/CMSSW_3_6_2/src/RecoVertex/V0Tree/python/ to your respective directory:

TrackingParticleSelectionForEfficiency_cfi.py

cutsRecoTracks_cfi.py

cutsTPEffic_cfi.py

cutsTPFake_cfi.py

cuts_cff.py

- include the track selection cuts into your path, before the main V0Tree module (process.demo):

process.p = cms.Path(... *... *process.cutsRecoTracks *process.demo)

compile all from your /src/RecoVertex directory.

ROOT scripts with the kinematic fits are in directory /user_mnt/user/threus/CMSSW_3_6_2/src/kinefitv0:

minim_pt_7.C /.h mass fit

minim_ptpo_v3.C /.h mass + pointing + vertexing fit

HistogramContainer.h which contain the class definitions

=== Kinematic Fit Variables in V0Tree ===

The kinematic fit code is implemented directly inside the V0Tree.cc code. You can find it in /user_mnt/user/threus/CMSSW_3_6_2/src/RecoVertex/V0Tree/plugins/V0Tree.cc.fit ; copy it, rename to V0Tree.cc and compile.

Saved variables contain information on the chi2 probability of the kinematic fit result and fitted daughter four-vectors, separately for three mass hypotheses: K0s, Lambda and Antilambda. In case of Lambda (Antilambda) hypothesis, proton (antiproton) is assumed to be the track with the positive (negative) charge. The returned flag from the kinematic fit method is saved as well, to know if the fit converged and if not, why. Both, the kinematic fit with the mass constraint alone and the full kinematic fit with the mass, vertex and pointing constraints are performed on the V0 candidate.

1) New saved variables related to kinematic fit with mass constrain are:

double chi2prob_k0_massfit[100]; //chi2 prob. for K0s hyp.

double chi2prob_la_massfit[100]; //chi2 prob. for Lambda hyp.

double chi2prob_al_massfit[100]; //chi2 prob. for Antilambda hyp.

int flag_k0_massfit[100]; //flag returned by the kinematic fit for K0s hyp. (see below for details)

int flag_la_massfit[100]; // Lambda hyp.

int flag_al_massfit[100]; // Antilambda hyp.

- Meaning of the flag_xx values:

>= 0 : fit OK, returned is the number of iterations needed for convergence

== -1 : error, fit not converged within the nmber of allowed iterations

<= -90: error, one of the matrices not inverted; for the exact matrix see code

2) New saved variables related to kinematic fit with mass, vertex and pointing constraints are:

double chi2prob_k0_fullfit[100];

double chi2prob_la_fullfit[100];

double chi2prob_al_fullfit[100];

int flag_k0_fullfit[100];

int flag_la_fullfit[100];

int flag_al_fullfit[100];

double V0_d1_k0_fullfit_pt[100]; // daughter 1 four-vector for the K0s hypothesis

double V0_d1_k0_fullfit_eta[100];

double V0_d1_k0_fullfit_phi[100];

double V0_d1_k0_fullfit_e[100];

double V0_d2_k0_fullfit_pt[100]; // daughter 2 four-vector for the K0s hypothesis

...

double V0_d1_la_fullfit_pt[100]; // daughter 1 four-vector for the Lambda hypothesis

...

double V0_d2_la_fullfit_pt[100]; // daughter 2 four-vector for the Lambda hypothesis

...

double V0_d1_al_fullfit_pt[100]; // daughter 1 four-vector for the Antilambda hypothesis

...

double V0_d2_al_fullfit_pt[100]; // daughter 2 four-vector for the Antilambda hypothesis

...

3) Additional variable (not related to kinematic fits) which carries the information on the V0 particle type as given by the CMSSW finder is saved:

int V0_type[100]; //type of V0: 0=K0s, 1=Lambda, as returned by the CMSSW finder

4) DATA / MC samples with this information (except the daughter four-vectors) are here:

DATA: /user_mnt/user/threus/trees/data/Commissioning10-GOODCOLL-Jun14thSkim_v1/CMSSW_3_6_2/loose

MC: /user_mnt/user/threus/trees/mc/MinBias_TuneD6T_7TeV-pythia6_Summer10-START36_V10_SP10-v1/CMSSW_3_6_2/loose

{{TracNotice|{{PAGENAME}}}}

Using Git

2015-08-26T12:29:27Z

Maintenance script: Created page with " ==== Using Git on the T2:==== *First you need to create a pair of private/public ssh keys on the UIs (mX machines): <pre> ssh-keygen </pre> and follow the instruction..."

==== Using Git on the T2:====

*First you need to create a pair of private/public ssh keys on the UIs (mX machines):
<pre>
ssh-keygen
</pre>
and follow the instructions. Defaults are fine.

*Create an account on [https://github.com/ github]
*Go in you settings:
[[Image(git_ssh_key.png, 10%)]]
then SSH keys . Click on "Add SSH key", and copy the content of .ssh/id_rsa.pub (from the UI) in there.
[[Image(git_ssh_key2.png, 50%)]]

*Now you should be able to clone the repositories you want from any UI !

{{TracNotice|{{PAGENAME}}}}

User Meetings

2015-08-26T12:29:27Z

Maintenance script: Created page with " ==== User meetings ==== List of User meetings.<br> *User meeting at the IIHE: User_meeting_11_06_09 *User Meeting in Gent : User_meeting_26_10_11 *User Meeting..."

==== User meetings ====
List of User meetings.<br>
*User meeting at the IIHE: [[User_meeting_11_06_09]]
*User Meeting in Gent : [[User_meeting_26_10_11]]
*User Meeting in Antwerp : [[User_meeting_18_10_12]]

{{TracNotice|{{PAGENAME}}}}

User meeting 26 10 11

2015-08-26T12:29:27Z

Maintenance script: Created page with " User Meeting Held in Gent on October 26th 2011<br> *[https://mon.iihe.ac.be/trac/t2b/attachment/wiki/User_meeting_26_10_11/User_meeting_26_10_2011.odp General news from the ..."

User Meeting Held in Gent on October 26th 2011<br>
*[https://mon.iihe.ac.be/trac/t2b/attachment/wiki/User_meeting_26_10_11/User_meeting_26_10_2011.odp General news from the T2] ''O. Devroede''
*[https://mon.iihe.ac.be/trac/t2b/attachment/wiki/User_meeting_26_10_11/NewUsersSession_26oct2011.odp New users section] ''J. Maes''

{{TracNotice|{{PAGENAME}}}}

User meeting 18 10 12

2015-08-26T12:29:26Z

Maintenance script: Created page with " === User Meeting Held in Antwerp on October 18th 2012 === The slides are in [http://w3.iihe.ac.be/indico/conferenceDisplay.py?confId=388 indico]. {{TracNotice|{{PAGEN..."

=== User Meeting Held in Antwerp on October 18th 2012 ===

The slides are in [http://w3.iihe.ac.be/indico/conferenceDisplay.py?confId=388 indico].

{{TracNotice|{{PAGENAME}}}}

User meeting 11 06 09

2015-08-26T12:29:26Z

Maintenance script: Created page with " ==== User_meeting_11_06_09 ==== *[https://mon.iihe.ac.be/trac/t2b/attachment/wiki/User_meeting_11_06_09/Grid_JDLSubmission.pdf Direct submission with JDL macro's] ''E.Chab..."

==== User_meeting_11_06_09 ====

*[https://mon.iihe.ac.be/trac/t2b/attachment/wiki/User_meeting_11_06_09/Grid_JDLSubmission.pdf Direct submission with JDL macro's] ''E.Chabert''
*[https://mon.iihe.ac.be/trac/t2b/attachment/wiki/User_meeting_11_06_09/Grid_Seminar_11June.pdf Using crab to run fwlite macros] ''V. Dero''
*[https://mon.iihe.ac.be/trac/t2b/attachment/wiki/User_meeting_11_06_09/IlariaT2brussels11Jun09.pdf MadGraph and root macros on the grid] ''I. Villella
*[https://mon.iihe.ac.be/trac/t2b/attachment/wiki/User_meeting_11_06_09/User_meeting_11_06_2009.odp Procedures, rules and possibilities at the T2_BE_IIHE] ''O. Devroede''
*Discussion: user requests and feedback

{{TracNotice|{{PAGENAME}}}}

UsefulImages

2015-08-26T12:29:26Z

Maintenance script: Created page with " This a page with useful images <br><br> Image(UsefulImages:Exclamation_mark.png) {{TracNotice|{{PAGENAME}}}}"

This a page with useful images <br><br>

[[Image(UsefulImages:Exclamation_mark.png)]]

{{TracNotice|{{PAGENAME}}}}

UseCervisia

2015-08-26T12:29:26Z

Maintenance script: Created page with " === Prerequisites === Open an SSH session on a CERN's UI with the appropriate options : <pre> ssh mdupont@lxplus.cern.ch -XC </pre> and launch Cervisia : <pre> cervisi..."

=== Prerequisites ===
Open an SSH session on a CERN's UI with the appropriate options :
<pre>
ssh mdupont@lxplus.cern.ch -XC
</pre>
and launch Cervisia :
<pre>
cervisia &
</pre>
=== How to checkout a project ? ===
In the menu, go to Repository > Checkout, fill in the form and click on "Ok" button to launch the checkout. Here is an example of values you can put in the fields of the form :

--> Repository : :gserver:cmscvs.cern.ch:/cvs_server/repositories/CMSSW

--> Module : COMP/INTEGRATION/crabvalidation

--> Working folder : /afs/cern.ch/user/s/sgerard/public

--> Check out as : test

Once the checkout if finished, you can open your local copy of the project. Go to the menu File > Open Sandbox and choose the path of the local copy of the project.

{{TracNotice|{{PAGENAME}}}}

UpgradeWNstoSL5.5

2015-08-26T12:29:26Z

Maintenance script: Created page with " === Upgrade of Workernodes in CB6 to SL5.5 === *Currently all nodes in CB6 are running SL5.3, the goal is to upgrade them to SL5.5 *The testing node is node16-5; first st..."

=== Upgrade of Workernodes in CB6 to SL5.5 ===

*Currently all nodes in CB6 are running SL5.3, the goal is to upgrade them to SL5.5
*The testing node is node16-5; first step is to out it offline so it can drain.
<pre>
pbsnodes -o node16-5.wn.iihe.ac.be
</pre>
*In the template for the os version the entry for node16-5 is upgraded to sl550-x86_64
<pre>
/CBv6/cfg/sites/iihe-production/site/os_version_db.tpl
</pre>
*This file is then compiled in the CDB and commited
*To make the changes do a runcheck on ccq3
<pre>
ssh ccq3
cd /opt/CB6/svncheck/
./runcheck
</pre>
*And do the changes
<pre>
aii-shellfe --remove node16-5.wn.iihe.ac.be #remove the current configuration for this machine
aii-shellfe --configure node16-5.wn.iihe.ac.be #create the new kickstart file for this machine
aii-shellfe --install node16-5.wn.iihe.ac.be#Update of DHCP and PXE for this machine to be installed at next boot
</pre>
*To check the status simply issue something like this
<pre>
for line in $(cat wn_list); do aii-shellfe --status $line; done
</pre>
'''REMARK: it is better to do the remove before the runcheck to not clash the xml file with the existing configuration'''
*Reboot the machine
<pre>
ssh node16-5.wn
reboot -n
</pre>
*Once the machine is back you will see in the spma log file the following error message
<pre>
/var/log/smpa.log
error code: cpio: open failed - Too many open files
</pre>
*To fix this you have to reboot the machine after moving the kickstart log file
<pre>
mv ks-post-install.log ks-post-install.log.old
</pre>
*Once the quattor installation finished successfully you still have to reboot a last time

==== Re-installation campaign ====

*The re-installation campaign is executed in the following steps
*Adapt the file os_version_db.tpl in the quattor database, compile, commit and do a runcheck
*First of all, all nodes need to reconfigured with the aii-shellfe command. In the following location you find a little script to do this:
<pre>
[root@ccq3] /root/joris/nodeReinstallation.sh
</pre>
*The script takes as an argument a file listing all the workernodes to be removed. The file was generated with the a script found here:
<pre>
[root@ccq] /root/stephane/generate_list_of_online_nodes_CB6.sh
</pre>
*Once the script is executed on ccq3 it is time to move to ccq to perform the reboot of all the nodes. To do this Stephane has written a nice script. More details about this script can be found [[KernelUpdate| here]].
*The script has been adapted by Joris to allow the re-installation of a workernode. Technically a few more reboot cycles have been added with the appropriate handles to check if the installation was done in a correct way. The script can be found here and is executed with the same options as the original script
<pre>
cd /root/stephane/UserCode/T2B_IIHE/reboot_wns
./reboot_wns.pl --init wnfile_list_sl55campaign
./reboot_wns.pl --start
</pre>
*In this directory there are some small scripts to test various things, eg.
**./print_wn_job_number.pl wn_list: shows the number of jobs running on this node
**./clear_after_test.pl: removes all lists of workernodes

==== List of workernodes that are under update procedure ====
{| border=1 class="simple"
! workernode
! status
! done
|-
| node15-1.wn.iihe.ac.be
|
| y + on
|-
| node15-2.wn.iihe.ac.be
|
| y + on
|-
| node15-3.wn.iihe.ac.be
|
| y + on
|-
| node15-4.wn.iihe.ac.be
| not in production
|
|-
| node15-5.wn.iihe.ac.be
| not in production
|
|-
| node15-6.wn.iihe.ac.be
| not in production
|
|-
| node15-7.wn.iihe.ac.be
| not in production
|
|-
| node15-8.wn.iihe.ac.be
|
| y + on
|-
|
|
|
|-
| node16-1.wn.iihe.ac.be
|
| y + on
|-
| node16-2.wn.iihe.ac.be
| reserved
| y
|-
| node16-3.wn.iihe.ac.be
|
| y + on
|-
| node16-4.wn.iihe.ac.be
|
| y + on
|-
| node16-5.wn.iihe.ac.be
|
| y + on
|-
| node16-6.wn.iihe.ac.be
| removed
|
|-
| node16-7.wn.iihe.ac.be
|
| y + on
|-
| node16-8.wn.iihe.ac.be
| reserved
|
|-
| node16-9.wn.iihe.ac.be
|
| y + on
|-
| node16-10.wn.iihe.ac.be
| reserved
| y
|-
|
|
|
|-
| node17-1.wn.iihe.ac.be
| reserved
| y
|-
| node17-2.wn.iihe.ac.be
| n/a
|
|-
| node17-3.wn.iihe.ac.be
|
| y + on
|-
| node17-4.wn.iihe.ac.be
|
| y + on
|-
| node17-5.wn.iihe.ac.be
| reserved
| y
|-
| node17-6.wn.iihe.ac.be
|
| y + on
|-
| node17-7.wn.iihe.ac.be
|
| y + on
|-
| node17-8.wn.iihe.ac.be
|
| y + on
|-
| node17-9.wn.iihe.ac.be
|
| y + on
|-
| node17-10.wn.iihe.ac.be
|
| y + on
|-
| node17-11.wn.iihe.ac.be
|
| y + on
|-
| node17-12.wn.iihe.ac.be
|
| y + on
|-
| node17-13.wn.iihe.ac.be
|
| y + on
|-
| node17-14.wn.iihe.ac.be
| down
|
|-
|
|
|
|-
| node18-1.wn.iihe.ac.be
|
| y + on
|-
| node18-2.wn.iihe.ac.be
|
| y + on
|-
| node18-3.wn.iihe.ac.be
|
| y + on
|-
| node18-4.wn.iihe.ac.be
|
| y + on
|-
| node18-5.wn.iihe.ac.be
|
| y + on
|-
| node18-6.wn.iihe.ac.be
|
| y + on
|-
| node18-7.wn.iihe.ac.be
|
| y + on
|-
| node18-8.wn.iihe.ac.be
|
| y + on
|-
|
|
|
|-
| node19-1.wn.iihe.ac.be
|
| y + on
|-
| node19-2.wn.iihe.ac.be
|
| y + on
|-
| node19-3.wn.iihe.ac.be
|
| y + on
|-
| node19-4.wn.iihe.ac.be
|
| y + on
|-
| node19-5.wn.iihe.ac.be
|
| y + on
|-
| node19-6.wn.iihe.ac.be
|
| y + on
|-
| node19-7.wn.iihe.ac.be
|
| y + on
|-
| node19-8.wn.iihe.ac.be
|
| y + on
|-
| node19-9.wn.iihe.ac.be
|
| y + on
|-
| node19-10.wn.iihe.ac.be
|
| y + on
|-
| node19-11.wn.iihe.ac.be
|
| y + on
|-
| node19-12.wn.iihe.ac.be
|
| y + on
|-
| node19-13.wn.iihe.ac.be
|
| y + on
|-
| node19-14.wn.iihe.ac.be
|
| y + on
|-
| node19-15.wn.iihe.ac.be
|
| y + on
|-
| node19-16.wn.iihe.ac.be
|
| y + on
|-
| node19-17.wn.iihe.ac.be
|
| y + on
|-
| node19-18.wn.iihe.ac.be
|
| y + on
|-
| node19-19.wn.iihe.ac.be
|
| y + on
|-
| node19-20.wn.iihe.ac.be
|
| y + on
|-
| node19-21.wn.iihe.ac.be
|
| y + on
|-
| node19-22.wn.iihe.ac.be
|
| y + on
|-
| node19-23.wn.iihe.ac.be
|
| y + on
|-
| node19-24.wn.iihe.ac.be
|
| y + on
|-
| node19-25.wn.iihe.ac.be
|
| y + on
|-
| node19-26.wn.iihe.ac.be
|
| y + on
|-
| node19-27.wn.iihe.ac.be
|
| y + on
|-
| node19-28.wn.iihe.ac.be
|
| y + on
|-
| node19-29.wn.iihe.ac.be
|
| y + on
|-
| node19-30.wn.iihe.ac.be
|
| y + on
|-
| node19-31.wn.iihe.ac.be
|
| y + on
|-
| node19-32.wn.iihe.ac.be
|
| y + on
|-
|
|
|
|-
| node20-1.wn.iihe.ac.be
|
| y + on
|-
| node20-2.wn.iihe.ac.be
|
| y + on
|-
| node20-3.wn.iihe.ac.be
|
| y + on
|-
| node20-4.wn.iihe.ac.be
|
| y + on
|-
| node20-5.wn.iihe.ac.be
|
| y + on
|-
| node20-6.wn.iihe.ac.be
|
| y + on
|-
| node20-7.wn.iihe.ac.be
|
| y + on
|-
| node20-8.wn.iihe.ac.be
|
| y + on
|-
| node20-9.wn.iihe.ac.be
|
| y + on
|-
| node20-10.wn.iihe.ac.be
|
| y + on
|-
| node20-11.wn.iihe.ac.be
|
| y + on
|-
| node20-12.wn.iihe.ac.be
|
| y + on
|-
| node20-13.wn.iihe.ac.be
|
| y + on
|-
| node20-14.wn.iihe.ac.be
|
| y + on
|-
| node20-15.wn.iihe.ac.be
|
| y + on
|-
| node20-16.wn.iihe.ac.be
|
| y + on
|-
| node20-17.wn.iihe.ac.be
|
| y + on
|-
| node20-18.wn.iihe.ac.be
|
| y + on
|-
| node20-19.wn.iihe.ac.be
|
| y + on
|-
| node20-20.wn.iihe.ac.be
|
| y + on
|-
| node20-21.wn.iihe.ac.be
|
| y + on
|-
| node20-22.wn.iihe.ac.be
|
| y + on
|-
| node20-23.wn.iihe.ac.be
| need to be included in maui
|
|-
| node20-24.wn.iihe.ac.be
| need to be included in maui
|
|}

{{TracNotice|{{PAGENAME}}}}

UpgradeDcachePool180REF

2015-08-26T12:29:25Z

Maintenance script: Created page with " === Upgrade Dcache Pool (180 REF) === *To upgrade a dcache pool from 180 to 195 the following steps work on pool-shadow testbed: *Stop all dCache Components <pre> /op..."

=== Upgrade Dcache Pool (180 REF) ===

*To upgrade a dcache pool from 180 to 195 the following steps work on pool-shadow testbed:

*Stop all dCache Components
<pre>
/opt/d-cache/bin/dcache stop
</pre>
*Download the RPMs
<pre>
wget http://www.dcache.org/downloads/1.9/dcache-server-1.9.5-29.noarch.rpm
scp ccq:/root/Joris/dcache-srmclient-1.9.5-23.noarch.rpm .
</pre>
*Upgrade the RPMs
<pre>
rpm -Uvh dcache-server-1.9.5-29.noarch.rpm
rpm -Uvh dcache-srmclient-1.9.5-23.noarch.rpm
</pre>
*Adapt the following files to point to the correct headnode
<pre>
/opt/d-cache/config/dCacheSetup
/opt/d-cache/etc/node_config
</pre>
*Run install script
<pre>
/opt/d-cache/install/install.sh
</pre>
*Start dCache components
<pre>
/opt/d-cache/bin/dcache start
</pre>

{{TracNotice|{{PAGENAME}}}}

UpgradeDcache

2015-08-26T12:29:25Z

Maintenance script: Created page with " == dCache upgrade == *To upgrade dCache to v1.9.12 it is recommended to first upgrade to v1.9.5 === Upgrade to v1.9.5 === *Installation of a headnode: [[InstallDcach..."

== dCache upgrade ==

*To upgrade dCache to v1.9.12 it is recommended to first upgrade to v1.9.5

=== Upgrade to v1.9.5 ===

*Installation of a headnode: [[InstallDcache]]
*Installation of a headnode, using extended Quattor template: [[InstallDcacheExt]]
*Installation of a pool node: [[InstallDcacheShadowPool]]
*Installation of a ui: [[InstallDcacheUI]]

=== Installing a v1.8.0 box for reference ===

*Installation of a headnode: [[InstallDcache180REF]]
*Installation of a pool node: [[InstallDcachePool180REF]]
**Upgrade of a pool node: [[UpgradeDcachePool180REF]]

=== Upgrade to v1.9.12 ===

*The following documentation describes how to upgrade from v1.9.5 to v1.9.12
**http://www.dcache.org/manuals/2011/goettingen/upgradeguide/upgrade-guide.html
*An attempt has been performed to upgrade immediately to v1.9.12: [[InstallDcache1912direct]]

=== Important remark on dcap configuration ===

*To allow enough dcap connections (from all WNs and UIs) two parameters need to be set
**ulimit on the host
**dcapMaxLogin in the dCacheSetup config file

=== Support ===
*dCache webpage:
*Mailing lists:
**support@dcache.org or user-forum
**Paul Millar via RT

{{TracNotice|{{PAGENAME}}}}

UpdateDcacheTo22

2015-08-26T12:29:25Z

Maintenance script: Created page with " update instructions.<br> Remark, these instructions are for the mostly for the headnode, but will work fine on the pools also. Some files do not exist in the pools. If one i..."

update instructions.<br>
Remark, these instructions are for the mostly for the headnode, but will work fine on the pools also. Some files do not exist in the pools. If one is asked to overwrite a file, always say YES.

'''This only on Headnode'''

<pre>

SSHDcache
cd PoolManager
save
</pre>

'''For all:'''

<pre>
/opt/d-cache/bin/dcache stop
rpm -e dcache-server
'''#java versions could differ on pools as they have different OS's'''
rpm -e java-1.6.0-openjdk-devel-1.6.0.0-1.11.b16.el5 java-1.6.0-openjdk-1.6.0.0-1.11.b16.el5 java-1.6.0-sun-compat-1.6.0.20-1.sl5.jpp
rpm -e jdk-1.6.0_20-fcs
rpm -ivh jdk-7u40-linux-x64.rpm
rpm -ivh dcache-2.2.23-1.noarch.rpm
</pre>
both rpms can be found on ccq:/root/Olivier/RPMs/Update

<pre>
cp -r /opt/d-cache/etc/* /etc/dcache/.
cp /opt/d-cache/etc/authorized_keys /etc/dcache/admin/.
cp /opt/d-cache/etc/*key* /etc/dcache/admin/.
cp /opt/d-cache/config/PoolManager.conf /var/lib/dcache/config/poolmanager.conf
cp /opt/d-cache/etc/dcache.conf.rpmsave /etc/dcache/dcache.conf
</pre>

'''edit /etc/dcache/dcache.conf'''

<pre>
replace {portBase} by 22
add: dcache.user=root
change value of dcache.home to /usr/share/dcache
comment out this line:
metaDataRepositoryImport=org.dcache.pool.repository.meta.file.FileMetaDataRepository

mv /opt/d-cache/etc/dcachesrm-gplazma.policy.rpmsave /etc/dcache/dcachesrm-gplazma.policy
edit /etc/dcache/dcachesrm-gplazma.policy also this file as it contains references to the /opt layout.
</pre>

'''Only on headnode:'''

<pre>
edit /var/lib/pgsql/data/postgresql.conf
put max_connections to 1000

restart the machine

</pre>

{{TracNotice|{{PAGENAME}}}}

UpdateCertificates

2015-08-26T12:29:25Z

Maintenance script: Created page with " == Deprecated content ! Please read before going any further on this page ! == The procedure to request certificates has changed since a few months. The new procedure is des..."

== Deprecated content ! Please read before going any further on this page ! ==
The procedure to request certificates has changed since a few months. The new procedure is described [http://wikit.iihe.ac.be/index.php/SSL_Certificates here].

So, what is written below is not valid anymore and needs to be adapted...

== Update and request server certificates ==
[[PageOutline]]
----
=== Introduction ===
All certificates for our machines will have to be updated every year. We will receive mails starting 2 weeks before the certificates expire. <br>
the decision was taken to update all the certificates at once and Stein De Weirdt wrote a script to do just that. <br>
The last update of the certificates happened on 2 mai 2008 on a cloudy but warm afternoon.

=== Procedure ===

Log in on '''ccq3''' and generate all the necessary certificates with this tool:
<pre>
/opt/CB6/tmp/src/begrid/cb-client/certificate_tool.py
</pre>
the tools help output gives:
<pre>
Usage:
--mode Mode: new,renew,conv,get (default: renew)
renew: make new server requests from existing certificates (in directory --dir) and upload the requests
get: - will make quattor templates in <--dir>/private
- public key need to be put in <--dir>/PemDir (to be created)
- the matching private key is looked for in <--dir>
new: make new server request (with DN attributes --att and create the requests/key in --dir)
--dir Read/write templates to/from dir (default: .)

--debug Set debug mode. (default: False)
--att DN Attributes, comma separated list eg (OU=IIHE,CN=gridce.iihe.ac.be,emailAddress=grid_admin@listserv.vub.ac.be)
- assumes C=BE and O=BEGRID
- emailAddress is mandatory (and should be last att)

</pre>

'''1.''' Create/renew certificate
==== Create New Certificate ====
To create a new certificate, do:
<pre>
/opt/CB6/tmp/src/begrid/cb-client/certificate_tool.py --mode=new --dir=/root/new-cert/ --att=OU=IIHE,CN=behar050.iihe.ac.be,emailAddress=grid_admin@listserv.vub.ac.be --debug
</pre>
==== Renew Certificates ====
To renew all certificates, first remove all .pem files in /root/new-cert/. Move the .tpl files from /root/new-cert/private to /root/new-cert/. Then, remove everything from the 2 subdirectories (private and PemDir)<br>
Then Do:
<pre>
/opt/CB6/tmp/src/begrid/cb-client/certificate_tool.py --mode=renew --dir=/root/new-cert/ --debug
</pre>
'''2.'''All the keys need to be uploaded one by one to the belnet site. Go to https://gridra.belnet.be , click "Request a Certificate", choose server from the drop down box. Upload one generate certificate (the ones with -req). On OU needs to be added. For this chose 'VUB'. <br> <br>

'''3.''' All the generated certificates will be send via mail. Download them all (choose only the one ending in _iihe_ac_be.pem from every mail) and put them in /root/new-cert/PemDir and do:
<pre>
/opt/CB6/tmp/src/begrid/cb-client/certificate_tool.py --mode=get --dir=/root/new-cert/ --debug
</pre>
all the certificates templates will be saved in /root/new-cert/private. <br> <br>
'''4.''' next step is to update all the quattor files and to make the clients connect for their new certificates. <br>
For this, put the private templates on ccq3, /opt/CB6/private or /opt/CB5/private, in the appropriate glite version dir.
<pre>
cd /opt/CB6/svncheck/
./runcheck
</pre>
'''5.''' This will broadcast a message to all the machines and they will respond within 5 minutes and start updating. All services except one will update fine <br> <br>
'''6.''' We now check that the update was complete and for this we first log in to '''maite'''.
<pre>
grep filecopy /var/log/ncm-cdispd.log
</pre>
Or alternatively
<pre>
less /var/log/ncm/component-filecopy.log
</pre>
Now, check the certificate:
<pre>
openssl x509 -in /etc/grid-security/hostcert.pem -noout -dates
</pre>
And make sure the new end date is indeed a year from now.<br>

copy the certificates so that they can be used by srm:

<pre>
cp /etc/grid-security/hostcert.pem /var/glite/rgma/.certs/
cp /etc/grid-security/hostkey.pem /var/glite/rgma/.certs/
</pre>

and restart srm. All should be running.

'''7.''' Restart maite once the new certificates have been propagated.<br>
probably not needed at all.
'''8.''' We now perform a final check: log in to any UI and do
<pre>
srmls srm://maite.iihe.ac.be:8443/pnfs/iihe/cms
</pre>
also try to copy some files from storage to the use disk using dccp.
All directories should be listed.

'''9.''' The certificate for rgma on mon needs to be deployed by hand:

<pre>
cd /var/glite/rgma/.certs/
cp /etc/grid-security/*pem ./
/etc/init.d/tomcat5 stop
/etc/init.d/tomcat5 start
</pre>

If the test ops for mon does not turn into green, reboot mon.

'''10.''' Restart argus services on argus-emi

<pre>
service argus restart
</pre>
If this is not enough think of restarting the node.

{{TracNotice|{{PAGENAME}}}}

TunnelSSHThroughSu

2015-08-26T12:29:24Z

Maintenance script: Created page with " How to tunnel ssh display through su on fedora:<br> When you su through root like that and then to another (non-root) user you need to copy root's xauthorization first (this..."

How to tunnel ssh display through su on fedora:<br>
When you su through root like that and then to another (non-root) user you need to copy root's xauthorization first (this is regardless of whether you are in an ssh session or not)<br>
so, while you are still root type 'xauth list' to get the cookie, and copy the whole line by highlighting it, then su to the other user and use 'xauth add' to add the authorization<br>

<pre>
[root@linux1 ~]# xauth list
linux1/unix:10 MIT-MAGIC-COOKIE-1 6a84e4f2561f9b25858f7e2e4b969d60
</pre>

<pre>
su - user1
xauth add linux1/unix:10 MIT-MAGIC-COOKIE-1 6a84e4f2561f9b25858f7e2e4b969d60
</pre>

alternate solution:<br>
You can either use the xauthority of the original ssh user or root's, probably best to do it your way. Note that if you don't go through root then this isn't required eg

ssh -X -l user1 <server><br>
su - user2<br>
su - user3<br>
su - user4<br>

then xapps work fine for user4, the authority is propagated through the chain of logins. Once you switch user to root the chain is broken and you must manually create the xauthority.

EDIT
This behaviour is controlled by pam_xauth, and apparently you can make it automatic for root to forward the xauth key to a user by creating a file /root/.xauth/export and adding the allowed users to it, see http://www.kernel.org/pub/linux/libs...pam_xauth.html

{{TracNotice|{{PAGENAME}}}}

TtSemiMuSelection

2015-08-26T12:29:24Z

Maintenance script: Created page with " obsolete page {{TracNotice|{{PAGENAME}}}}"

obsolete page

{{TracNotice|{{PAGENAME}}}}

TtBar Analysis Framework

2015-08-26T12:29:24Z

Maintenance script: Created page with " === How to get the code === The Top Quark Analysis code as we will develop in Brussels will be part of the Top-package in the CMSSW-software. Every stable version of this co..."

=== How to get the code ===
The Top Quark Analysis code as we will develop in Brussels will be part of the Top-package in the CMSSW-software. Every stable version of this code should be accessible by means of the central CVS-server from CERN. However, for daily development, a CVS server is setup in Brussels. In order to get a recent version of the code, you should:
**login to the lxpub2 or lxpub3 machine
<pre>
e.g: ssh -X username@lxpub2.iihe.ac.be
</pre>
**make sure the CMS software is sourced
<pre>
setenv VO_CMS_SW_DIR /msa3/cmssoft
source $VO_CMS_SW_DIR/cmsset_default.csh ## initialiseert de cms env
</pre>
**get a recent CMSSW workspace (CMSSW_1_2_0) in your /beo5/<tt>username</tt> directory
<pre>
scramv1 p CMSSW CMSSW_1_2_0; cd CMSSW_1_2_0/src
</pre>
**make a symlink to this latest version
<pre>
in /beo5/<tt>uname</tt>, type 'ln -s CMSSW_1_2_0 CMSSW'
</pre>
**set the path's to the Brussels' CVS server
<pre>
export CVS_RSH=/usr/bin/ssh
export CVSROOT=:pserver:<tt>uname</tt>@pc150.iihe.ac.be:/home/cvs/cms
</pre>
**login to this server
<pre>
cvs login (and type your normal lxpub password)
</pre>
(these two lines might be put your .bashrc)
**get the Top -code from the Brussels' CVS server
<pre>
cvs co -r Top_1_0 Top
</pre>
**compile the code
<pre>
scramv1 b
</pre>
**make your own library
<pre>
look in e.g. TtObjectResolutions to have an example on how to do this
</pre>
As you will notice, you will have to change all the PATH's in your header files when importing your code into the new framework. Another important difference is the extraction of the KinFit package to a standalone library. Now <tt>scramv1 b</tt> will as well take care of the compilation of this package.<br>
<br>
For the moment, only Jan Heyninck is supposed to commit changes to the code. In near future however, everyone should be able to do this. This means that if you would like to add a feature to the code, or you have found a bug, this is send on the top quark mailing list.
<br>
Get the code from global dbs
**make sure the CMS software is sourced
**set the path
<pre>
setenv CVSROOT :pserver:anonymous@cmscvs.cern.ch:/cvs_server/repositories/CMSSW
</pre>
**login to this server
<pre>
cvs login (and type following password: 98passwd)
</pre>
**go in the source directory and type
<pre>
cvs co TopQuarkAnalysis
</pre>

----
<br><br>

=== Some useful cvs commands ===
still to add
----
<br><br>

=== Documentation ===
A [http://w3.iihe.ac.be/~heyninck/ Ttbar doxygen documentation page] is available and similar to [http://cmsdoc.cern.ch/cms/sw/slc3_ia32_gcc323/cms/cmssw/CMSSW_1_2_0/doc/html/ the global CMSSW-software page]. This page is updated each night, and is meant to be a never ending work-in-progress, where everyone should contribute! To know how to add documentation, compare the content of the doc directories in the Top-code subdirectories with what you see on the doxygen page.
----
<br><br>

=== Running your analysis on the locally produced Ttbar sample ===
If you want to run on the 200k of inclusive Ttbar reco data, please find the ROOT-files in:
<pre>
Top/TtEventProducers/test/TtRecoFiles.cfi
</pre>
If you want to access the 200k of semileptonic Ttbar events, a list of ROOT-files can be found in:
<pre>
Top/TtEventProducers/test/TtSemiEvents.cfi
</pre>
(TODO)

----
<br><br>
=== Frequently Asked Questions ===
shoot!

{{TracNotice|{{PAGENAME}}}}

TravNacToc

2015-08-26T12:29:24Z

Maintenance script: Created page with " Contents *T2B ** Home {{TracNotice|{{PAGENAME}}}}"

Contents

*T2B
**[[WikiStart| Home]]

{{TracNotice|{{PAGENAME}}}}

TracWorkflow

2015-08-26T12:29:24Z

Maintenance script: Created page with " == The Trac Ticket Workflow System == TracGuideToc The Trac issue database provides a configurable workflow. === The Default Ticket Workflow === ==== Environments upgra..."

== The Trac Ticket Workflow System ==
[[TracGuideToc]]

The Trac issue database provides a configurable workflow.

=== The Default Ticket Workflow ===
==== Environments upgraded from 0.10 ====
When you run <tt>trac-admin <env> upgrade</tt>, your <tt>trac.ini</tt> will be modified to include a <tt>[ticket-workflow]</tt> section.
The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10.

Graphically, that looks like this:

[[Image(htdocs:../common/guide/original-workflow.png)]]

There are some significant "warts" in this; such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state. Perfectly obvious, right?
So you will probably want to migrate to "basic" workflow; [trac:source:trunk/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] may be helpful.

==== Environments created with 0.11 ====
When a new environment is created, a default workflow is configured in your trac.ini. This workflow is the basic workflow (described in <tt>basic-workflow.ini</tt>), which is somewhat different from the workflow of the 0.10 releases.

Graphically, it looks like this:

[[Image(htdocs:../common/guide/basic-workflow.png)]]

=== Additional Ticket Workflows ===

There are several example workflows provided in the Trac source tree; look in [trac:source:trunk/contrib/workflow contrib/workflow] for <tt>.ini</tt> config sections. One of those may be a good match for what you want. They can be pasted into the <tt>[ticket-workflow]</tt> section of your <tt>trac.ini</tt> file. However if you have existing tickets then there may be issues if those tickets have states that are not in the new workflow.

Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.

=== Basic Ticket Workflow Customization ===

Note: Ticket "statuses" or "states" are not separately defined. The states a ticket can be in are automatically generated by the transitions defined in a workflow. Therefore, creating a new ticket state simply requires defining a state transition in the workflow that starts or ends with that state.

Create a <tt>[ticket-workflow]</tt> section in <tt>trac.ini</tt>.
Within this section, each entry is an action that may be taken on a ticket.
For example, consider the <tt>accept</tt> action from <tt>simple-workflow.ini</tt>:
<pre>
accept = new,accepted -> accepted
accept.permissions = TICKET_MODIFY
accept.operations = set_owner_to_self
</pre>
The first line in this example defines the <tt>accept</tt> action, along with the states the action is valid in (<tt>new</tt> and <tt>accepted</tt>), and the new state of the ticket when the action is taken (<tt>accepted</tt>).
The <tt>accept.permissions</tt> line specifies what permissions the user must have to use this action.
The <tt>accept.operations</tt> line specifies changes that will be made to the ticket in addition to the status change when this action is taken. In this case, when a user clicks on <tt>accept</tt>, the ticket owner field is updated to the logged in user. Multiple operations may be specified in a comma separated list.

The available operations are:
- del_owner -- Clear the owner field.
- set_owner -- Sets the owner to the selected or entered owner.
- ''actionname''<tt>.set_owner</tt> may optionally be set to a comma delimited list or a single value.
- set_owner_to_self -- Sets the owner to the logged in user.
- del_resolution -- Clears the resolution field
- set_resolution -- Sets the resolution to the selected value.
- ''actionname''<tt>.set_resolution</tt> may optionally be set to a comma delimited list or a single value.
<pre>
Example:

resolve_new = new -> closed
resolve_new.name = resolve
resolve_new.operations = set_resolution
resolve_new.permissions = TICKET_MODIFY
resolve_new.set_resolution = invalid,wontfix
</pre>
- leave_status -- Displays "leave as <current status>" and makes no change to the ticket.
'''Note:''' Specifying conflicting operations (such as <tt>set_owner</tt> and <tt>del_owner</tt>) has unspecified results.

<pre>
resolve_accepted = accepted -> closed
resolve_accepted.name = resolve
resolve_accepted.permissions = TICKET_MODIFY
resolve_accepted.operations = set_resolution
</pre>

In this example, we see the <tt>.name</tt> attribute used. The action here is <tt>resolve_accepted</tt>, but it will be presented to the user as <tt>resolve</tt>.

For actions that should be available in all states, <tt>*</tt> may be used in place of the state. The obvious example is the <tt>leave</tt> action:
<pre>
leave = * -> *
leave.operations = leave_status
leave.default = 1
</pre>
This also shows the use of the <tt>.default</tt> attribute. This value is expected to be an integer, and the order in which the actions are displayed is determined by this value. The action with the highest <tt>.default</tt> value is listed first, and is selected by default. The rest of the actions are listed in order of decreasing <tt>.default</tt> values.
If not specified for an action, <tt>.default</tt> is 0. The value may be negative.

There are a couple of hard-coded constraints to the workflow. In particular, tickets are created with status <tt>new</tt>, and tickets are expected to have a <tt>closed</tt> state. Further, the default reports/queries treat any state other than <tt>closed</tt> as an open state.

While creating or modifying a ticket workfow, <tt>contrib/workflow/workflow_parser.py</tt> may be useful. It can create <tt>.dot</tt> files that [http://www.graphviz.org GraphViz] understands to provide a visual description of the workflow.

This can be done as follows (your install path may be different).
<pre>
cd /var/local/trac_devel/contrib/workflow/
sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
</pre>
And then open up the resulting <tt>trac.pdf</tt> file created by the script (it will be in the same directory as the <tt>trac.ini</tt> file).

An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl

After you have changed a workflow, you need to restart apache for the changes to take effect. This is important, because the changes will still show up when you run your script, but all the old workflow steps will still be there until the server is restarted.

=== Example: Adding optional Testing with Workflow ===

By adding the following to your [ticket-workflow] section of trac.ini you get optional testing. When the ticket is in new, accepted or needs_work status you can choose to submit it for testing. When it's in the testing status the user gets the option to reject it and send it back to needs_work, or pass the testing and send it along to closed. If they accept it then it gets automatically marked as closed and the resolution is set to fixed. Since all the old work flow remains, a ticket can skip this entire section.

<pre>
testing = new,accepted,needs_work,assigned,reopened -> testing
testing.name = Submit to reporter for testing
testing.permissions = TICKET_MODIFY

reject = testing -> needs_work
reject.name = Failed testing, return to developer

pass = testing -> closed
pass.name = Passes Testing
pass.operations = set_resolution
pass.set_resolution = fixed
</pre>

==== How to combine the <tt>tracopt.ticket.commit_updater</tt> with the testing workflow ====

The [[source:trunk/tracopt/ticket/commit_updater.py|tracopt.ticket.commit_updater]] is the optional component that [[TracRepositoryAdmin#trac-post-commit-hook|replaces the old trac-post-commit-hook]], in Trac 0.12.

By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.

If you have a more complex workflow, like the testing stage described above and you want the ''closes'' keyword to move the ticket to the ''testing'' status instead of the ''closed'' status, you need to adapt the code a bit.

Have a look at the [[0.11/TracWorkflow#How-ToCombineSVNtrac-post-commit-hookWithTestWorkflow|Trac 0.11 recipe]] for the <tt>trac-post-commit-hook</tt>, this will give you some ideas about how to modify the component.

=== Example: Add simple optional generic review state ===

Sometimes Trac is used in situations where "testing" can mean different things to different people so you may want to create an optional workflow state that is between the default workflow's <tt>assigned</tt> and <tt>closed</tt> states, but does not impose implementation-specific details. The only new state you need to add for this is a <tt>reviewing</tt> state. A ticket may then be "submitted for review" from any state that it can be reassigned. If a review passes, you can re-use the <tt>resolve</tt> action to close the ticket, and if it fails you can re-use the <tt>reassign</tt> action to push it back into the normal workflow.

The new <tt>reviewing</tt> state along with its associated <tt>review</tt> action looks like this:

<pre>
review = new,assigned,reopened -> reviewing
review.operations = set_owner
review.permissions = TICKET_MODIFY
</pre>

Then, to integrate this with the default Trac 0.11 workflow, you also need to add the <tt>reviewing</tt> state to the <tt>accept</tt> and <tt>resolve</tt> actions, like so:

<pre>
accept = new,reviewing -> assigned
[…]
resolve = new,assigned,reopened,reviewing -> closed
</pre>

Optionally, you can also add a new action that allows you to change the ticket's owner without moving the ticket out of the <tt>reviewing</tt> state. This enables you to reassign review work without pushing the ticket back to the <tt>new</tt> status.

<pre>
reassign_reviewing = reviewing -> *
reassign_reviewing.name = reassign review
reassign_reviewing.operations = set_owner
reassign_reviewing.permissions = TICKET_MODIFY
</pre>

The full <tt>[ticket-workflow]</tt> configuration will thus look like this:

<pre>
[ticket-workflow]
accept = new,reviewing -> assigned
accept.operations = set_owner_to_self
accept.permissions = TICKET_MODIFY
leave = * -> *
leave.default = 1
leave.operations = leave_status
reassign = new,assigned,reopened -> new
reassign.operations = set_owner
reassign.permissions = TICKET_MODIFY
reopen = closed -> reopened
reopen.operations = del_resolution
reopen.permissions = TICKET_CREATE
resolve = new,assigned,reopened,reviewing -> closed
resolve.operations = set_resolution
resolve.permissions = TICKET_MODIFY
review = new,assigned,reopened -> reviewing
review.operations = set_owner
review.permissions = TICKET_MODIFY
reassign_reviewing = reviewing -> *
reassign_reviewing.operations = set_owner
reassign_reviewing.name = reassign review
reassign_reviewing.permissions = TICKET_MODIFY
</pre>

=== Example: Limit the resolution options for a new ticket ===

The above resolve_new operation allows you to set the possible resolutions for a new ticket. By modifying the existing resolve action and removing the new status from before the <tt>-></tt> we then get two resolve actions. One with limited resolutions for new tickets, and then the regular one once a ticket is accepted.

<pre>
resolve_new = new -> closed
resolve_new.name = resolve
resolve_new.operations = set_resolution
resolve_new.permissions = TICKET_MODIFY
resolve_new.set_resolution = invalid,wontfix,duplicate

resolve = assigned,accepted,reopened -> closed
resolve.operations = set_resolution
resolve.permissions = TICKET_MODIFY
</pre>

=== Advanced Ticket Workflow Customization ===

If the customization above is not extensive enough for your needs, you can extend the workflow using plugins. These plugins can provide additional operations for the workflow (like code_review), or implement side-effects for an action (such as triggering a build) that may not be merely simple state changes. Look at [trac:source:trunk/sample-plugins/workflow sample-plugins/workflow] for a few simple examples to get started.

But if even that is not enough, you can disable the ConfigurableTicketWorkflow component and create a plugin that completely replaces it.

=== Adding Workflow States to Milestone Progress Bars ===

If you add additional states to your workflow, you may want to customize your milestone progress bars as well. See [TracIni#milestone-groups-section TracIni].

=== some ideas for next steps ===

New enhancement ideas for the workflow system should be filed as enhancement tickets against the <tt>ticket system</tt> component. If desired, add a single-line link to that ticket here. Also look at the [th:wiki:AdvancedTicketWorkflowPlugin] as it provides experimental operations.

If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.

*the "operation" could be on the nodes, possible operations are:
**'''preops''': automatic, before entering the state/activity
**'''postops''': automatic, when leaving the state/activity
**'''actions''': can be chosen by the owner in the list at the bottom, and/or drop-down/pop-up together with the default actions of leaving the node on one of the arrows.
''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.''

*operations could be anything: sum up the time used for the activity, or just write some statistical fields like
''A workflow plugin can add an arbitrary workflow operation, so this is already possible.''

*set_actor should be an operation allowing to set the owner, e.g. as a "preop":
**either to a role, a person
**entered fix at define time, or at run time, e.g. out of a field, or select.
''This is either duplicating the existing <tt>set_owner</tt> operation, or needs to be clarified.''

*Actions should be selectable based on the ticket type (different Workflows for different tickets)
''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s <tt>triage</tt> operation.''

{{TracNotice|{{PAGENAME}}}}

TracWiki

2015-08-26T12:29:23Z

Maintenance script: Created page with " == The Trac Wiki Engine == TracGuideToc Trac has a built-in wiki engine, used for text and documentation throughout the system. WikiFormatting is used in [[TitleIndex| w..."

== The Trac Wiki Engine ==
[[TracGuideToc]]

Trac has a built-in wiki engine, used for text and documentation throughout the system. WikiFormatting is used in [[TitleIndex| wiki pages]], [[TracTickets| tickets]], [[TracChangeset| check-in log messages]], [[TracRoadmap| milestone]] and [[TracReports| report]] descriptions. It allows for formatted text and hyperlinks in and between all Trac modules.

Editing wiki text is easy, using any web browser and a simple [WikiFormatting formatting system], rather than more complex markup languages like HTML. The reasoning behind its design is that HTML, with its large collection of nestable tags, is too complicated to allow fast-paced editing, and distracts from the actual content of the pages. Note though that Trac also supports [WikiHtml HTML], [WikiRestructuredText reStructuredText] and [http://www.textism.com/tools/textile/ Textile] as alternative markup formats.

The main goal of the wiki is to make editing text easier and ''encourage'' people to contribute and annotate text content for a project. Trac also provides a simple toolbar to make formatting text even easier.

The wiki itself does not enforce any structure, but rather resembles a stack of empty sheets of paper, where you can organize information and documentation as you see fit, and later reorganize if necessary.
As contributing to a wiki is essentially building an hypertext,
general advice regarding HTML authoring apply here as well.
For example, the ''[http://www.w3.org/Provider/Style Style Guide for online hypertext]'' explains how to think about the
[http://www.w3.org/Provider/Style/Structure.html overall structure of a work]
and how to organize information [http://www.w3.org/Provider/Style/WithinDocument.html within each document]. One of the most important is “make your HTML page such that you can read it even if you don't follow any links.”

Learn more about:
*WikiNewPage creation, which can be configured to start from a [PageTemplates page template]
*WikiFormatting rules, including advanced topics like WikiMacros and WikiProcessors
*How to use WikiPageNames and other forms of TracLinks which are used to refer in a precise way to any resource within Trac

If you want to practice editing, please use the SandBox.

Before saving your changes, you can ''Preview'' the page or ''Review the Changes'' you've made.
You can get an automatic preview of the formatting as you type when you activate the ''Edit Side-by-side'' mode. '' There is a [[/TracIni#trac-section| configurable delay]] between when you make your edit and when the automatic preview will update.''

Some more information about wikis on the web:
*A definition of [http://wikipedia.org/wiki/Wiki Wiki], in a famous wiki encyclopedia
*The [http://c2.com/cgi/wiki?WikiHistory History] of the original wiki
*A wiki page explaining [http://www.usemod.com/cgi-bin/mb.pl?WhyWikiWorks why wiki works]

----
See also: TracGuide

{{TracNotice|{{PAGENAME}}}}

TracUpgrade

2015-08-26T12:29:23Z

Maintenance script: Created page with " == Upgrade Instructions == TracGuideToc === Instructions === Typically, there are seven steps involved in upgrading to a newer version of Trac: ==== 1. Update the Trac..."

== Upgrade Instructions ==
[[TracGuideToc]]

=== Instructions ===

Typically, there are seven steps involved in upgrading to a newer version of Trac:

==== 1. Update the Trac Code ==== #UpdatetheTracCode

Get the new version as described in TracInstall, or your operating system specific procedure.

If you already have a 0.11 version of Trac installed via <tt>easy_install</tt>, it might be the easiest to use it also to upgrade you Trac installation.

<pre>
# easy_install --upgrade Trac==0.12b1
</pre>
(once beta1 is released, that is)

If you do a manual (not operating system specific) upgrade, you should also stop any running Trac server before the installation. Doing "hot" upgrades is not advised, especially not on Windows ([trac:ticket:7625 #7265]).

You may also want to remove the pre-existing Trac code by deleting the <tt>trac</tt> directory from the Python <tt>lib/site-packages</tt> directory, or remove Trac .eggs from former versions.
The location of the site-packages directory depends on the operating system, and the location in which Python was installed. However, the following locations are common:
*on Linux: <tt>/usr/lib/python2.X/site-packages</tt>
*on Windows: <tt>C:\Python2.X\lib\site-packages</tt>
*on MacOSX: <tt>/Library/Python/2.X/site-packages</tt>

You may also want to remove the Trac <tt>cgi-bin</tt>, <tt>htdocs</tt>, <tt>templates</tt> and <tt>wiki-default</tt> directories that are commonly found in a directory called <tt>share/trac</tt> (the exact location depends on your platform).

This cleanup is not mandatory, but it makes it easier to troubleshoot issues later on, as you won't waste your time looking at code or templates from a previous release that are not being used anymore... As usual, make a backup before actually deleting things.

==== 2. Upgrade the Trac Environment ==== #UpgradetheTracEnvironment

Environment upgrades are not necessary for minor version releases unless otherwise noted.

After restarting, Trac should show the instances which need a manual upgrade via the automated upgrade scripts to ease the pain. These scripts are run via [TracAdmin trac-admin]:
<pre>
trac-admin /path/to/projenv upgrade
</pre>

This command will do nothing if the environment is already up-to-date.

Note that a backup of your database will be performed automatically prior to the upgrade.
This feature is relatively new for the PostgreSQL or MySQL database backends, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade, run:
<pre>
trac-admin /path/to/projenv upgrade --no-backup
</pre>

==== 3. Update the Trac Documentation ==== #UpdatetheTracDocumentation

Every [TracEnvironment Trac environment] includes a copy of the Trac documentation for the installed version. As you probably want to keep the included documentation in sync with the installed version of Trac, [TracAdmin trac-admin] provides a command to upgrade the documentation:
<pre>
trac-admin /path/to/projenv wiki upgrade
</pre>

Note that this procedure will of course leave your <tt>WikiStart</tt> page intact.

==== 4. Resynchronize the Trac Environment Against the Source Code Repository ====

Each [TracEnvironment Trac environment] must be resynchronized against the source code repository in order to avoid errors such as "[http://trac.edgewall.org/ticket/6120 No changeset ??? in the repository]" while browsing the source through the Trac interface:

<pre>
trac-admin /path/to/projenv repository resync '*'
</pre>

==== 5. Refresh static resources ====

If you've setup web server to give out static resources directly (accessed using /chrome/ URL) then you need to refresh them using the same command:
<pre>
trac-admin /path/to/env deploy /deploy/path
</pre>
this will extract static resources and CGI scripts (trac.wsgi, etc) from new Trac version and its plugins into <tt>/deploy/path</tt>.

Some web browsers cache the CSS and Javascript file in a strong way, so you'll perhaps need to refresh the cache of the browsers by a force reload (and tell your users to do so!).

==== 6. Steps specific to a given Trac version ====
==== Upgrading from Trac 0.11 to Trac 0.12 ====
===== Python 2.3 no longer supported =====
The minimum supported version of python is now 2.4

===== SQLite v3.x required =====
SQLite v2.x is no longer supported, if you happen to still use a Trac database using this format, you'll need to convert it to SQLite v3.x first. See [trac:PySqlite#UpgradingSQLitefrom2.xto3.x] for details.

===== Multiple Repository Support =====
If you plan to add more repositories to your Trac instance, as this is now possible with the newly introduced multiple repository support, please refer to TracRepositoryAdmin#Migration.

This can be of interest even if you only have one repository, as there's now a way to avoid the potentially costly resync check at every request.

===== Improved repository synchronization =====
In addition to supporting multiple repositories, a new more efficient method for synchronizing Trac and your repositories was implemented.

While you can keep the same synchronization as in 0.11 adding the post-commit hook as outlined in TracRepositoryAdmin#Synchronization and TracRepositoryAdmin#ExplicitSync will allow more efficient synchronization and is more or less required for multiple repositories.

Note that if you were using the <tt>trac-post-commit-hook</tt>, ''you're strongly advised to upgrade it'' to the new hook documented in the above references, as the old hook will not work with anything else than the default repository and even for this case, it won't trigger the appropriate notifications.

==== Upgrading from Trac 0.10 to Trac 0.11 ====
===== Site Templates and Styles =====
The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.

If you are using custom CSS styles or modified templates in the <tt>templates</tt> directory of the TracEnvironment, you will need to convert them to the Genshi way of doing things. To continue to use your style sheet, follow the instructions at TracInterfaceCustomization#SiteAppearance.

===== Trac Macros, Plugins =====
The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore (due to the drop of [trac:ClearSilver ClearSilver] and the HDF); they need to be converted to the new-style macros, see WikiMacros. When they are converted to the new style, they need to be placed into the plugins directory instead and not wiki-macros, which is no longer scanned for macros or plugins.

===== For FCGI/WSGI/CGI users =====
For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
<pre>
trac-admin /path/to/env deploy /deploy/directory/path
</pre>

This will create a deploy directory with the following two subdirectories: <tt>cgi-bin</tt> and <tt>htdocs</tt>. Then update your Apache configuration file <tt>httpd.conf</tt> with this new <tt>trac.cgi</tt> location and <tt>htdocs</tt> location.

===== Web Admin plugin integrated =====
If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.

==== 7. Restart the Web Server ==== #RestarttheWebServer

If you are not running [[TracCgi| CGI]], reload the new Trac code by restarting your web server.

=== Known Issues ===

==== parent dir ====
If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.

==== Wiki Upgrade ====
<tt>trac-admin</tt> will not delete or remove default wiki pages that were present in a previous version but are no longer in the new version.

=== Changing Database Backend ===
==== SQLite to PostgreSQL ====

The [http://trac-hacks.org/wiki/SqliteToPgScript sqlite2pg] script on [http://trac-hacks.org trac-hacks.org] has been written to assist in migrating a SQLite database to a PostgreSQL database

=== Older Versions ===

For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].

-----
See also: TracGuide, TracInstall

{{TracNotice|{{PAGENAME}}}}

TracUnicode

2015-08-26T12:29:23Z

Maintenance script: Created page with " == Unicode Support in Trac == TracGuideToc Trac stores all text using UTF-8 encoding, including text in tickets and wiki pages. Internal processing of text uses true Uni..."

== Unicode Support in Trac ==
[[TracGuideToc]]

Trac stores all text using UTF-8 encoding, including text in tickets and wiki pages. Internal processing of text uses true Unicode representations.

As such, it supports most (all?) commonly used character encodings.

If your encoding is not UTF-8, you can use [[TracModPython| mod_python]] to handle it. For example, if your local encoding is gbk, you can set
default_charset = gbk
in trac.ini.

You also must make sure that your [trac:DatabaseBackend database backend] stores its data in UTF-8; otherwise strange things will happen.

To convert your database to UTF-8, the easiest way is to dump the database, convert the dump into UTF-8 and then import the converted dump back into the database.<br>
You can use [http://www.gnu.org/software/libiconv/documentation/libiconv/iconv.1.html iconv] to convert the dump.

=== Examples ===

==== Arabic ====
تراك يقوم بحفظ كل الكلمات باستخدام صيغة UTF-8، بما في ذلك الكلمات المستخدمة في صفحات التيكت والويكي.

==== Bulgarian ====
Българският език работи ли?

==== Česky ====
Čeština v kódování UTF-8, žádný problém.

==== Chinese ====
Traditional: 繁體中文, 漢字測試; Simplified: 简体中文，汉字测试

==== Croatian ====
Ako podržava srpski i slovenski mora podržavati i Hrvatski - čćžšđ ČĆŽŠĐ

==== English ====
Yes indeed, Trac supports English. Fully.

==== Français ====
Il est possible d'écrire en Français : à, ç, û, ...

==== German ====
Trac-Wiki muß auch deutsche Umlaute richtig anzeigen: ö, ä, ü, Ä, Ö, Ü; und das scharfe ß

==== Greek ====
Τα Ελληνικά υποστηρίζονται επαρκώς επίσης.

==== Hebrew ====
אני יכול לאכול זכוכית וזה לא מזיק לי

==== Hindi ====
अब हिन्दी में।

==== Hungarian ====
Árvíztűrő tükörfúrógép

==== Icelandic ====
Ævar sagði við ömmu sína: Sjáðu hvað ég er stór!

==== Japanese ====
漢字ひらがなカタカナﾊﾝｶｸｶﾅ日本語試験

==== Korean ====
이번에는 한글로 써보겠습니다. 잘 보이나요? 한글

==== Latvian ====

Latviešu valoda arī strādā!

==== Lithuanian ====
Sudalyvaukime ir mes. Ar veikia lietuviškos raidės? ąčęėįšųūž ĄČĘĖĮŠŲŪŽ Žinoma, kad veikia :)
Kas tie mes?

==== Persian (Farsi) ====
این یک متن فارسی است ولی امکان نوشتن مستقیم فارسی نیست چون حالت متن از راست به چپ و جود ندارد برای فارسی نوشتن باید از HTML استفاده کنید.
<pre>
#html
<div dir="rtl">
</pre>
این نمونه یک متن از راست به چپ فارسی است که در HTML نوشته شده تا اعداد 12345 و حروف لاتین ABCDEF در محل خودشان نمایش داده شوند.
<pre>
#html
</div>
</pre>

==== Polish ====
Pchnąć w tę łódź jeża lub osiem skrzyń fig; Nocna gżegżółka zawsze dzienną przekuka.

==== Portuguese ====
É possível guardar caracteres especias da língua portuguesa, incluindo o símbolo da moeda européia '€', trema 'ü', crase 'à', agudos 'áéíóú', circunflexos 'âêô', til 'ãõ', cedilha 'ç', ordinais 'ªº', grau '°¹²³'.

==== Russian ====
Проверка русского языка: кажется работает... И буква "ё" есть...

==== Serbian ====
Podržan, uprkos činjenici da se za njegovo pisanje koriste чак два алфабета.

==== Slovenian ====
Ta suhi škafec pušča vodo že od nekdaj!

==== Spanish ====
Esto es un pequeño texto en Español, donde el veloz murciélago hindú comía cardlllo y kiwi

==== Swedish ====
Räven raskar över isen med luva på.

==== Thai ====
Trac แสดงภาษาไทยได้อย่างถูกต้อง!

==== Ukrainian ====
Перевірка української мови...

==== Urdu ====
ٹریک اردو بھی سپورٹ کرتا ہے۔

==== Vietnamese ====
Viết tiếng Việt cũng được.

{{TracNotice|{{PAGENAME}}}}

TracTimeline

2015-08-26T12:29:23Z

Maintenance script: Created page with " == The Trac Timeline == TracGuideToc The timeline provides a historic view of the project in a single report. It lists all Trac events that have occurred in chronologic..."

== The Trac Timeline ==
[[TracGuideToc]]

The timeline provides a historic view of the project in a single report.

It lists all Trac events that have occurred in chronological order, a
brief description of each event and if applicable, the person responsible for
the change.

The timeline lists these kinds of events:
*'''Wiki page events''' — Creation and changes
*'''Ticket events''' — Creation and resolution/closing (and optionally other changes)
*'''Source code changes ''' — Repository check-ins
*'''Milestone ''' — Milestone completed

Each event entry provides a hyperlink to the specific event in question, who authored the change as well as
a brief excerpt of the actual comment or text, if available.

It is possible to filter the displayed events with the various filters in the option panel:
*''View changes from'' — the date from which to start displaying events (current date if empty). Events that occurred after this date will not be shown, only those that occurred before that date.
*''and X days back'' — how many days backwards in time to get events.
*''done by'' — the author of an event. It accepts a space-separated list of authors for which events should be included. Alternatively, if the author names are prefixed by a "-" character, then the events having those authors will be excluded, and all the others included. Single or double quotes can be used for specifying author names containing space characters. ''(since 0.12)''
*''Changesets in all repositories'' — if you have more than one repository connected to your Trac project, then you can filter the output so events from specific repositories are not shown. ''(since 0.12)''
*''Milestones reached'' — display or hide milestones reached.
*''Opened and closed tickets'' — display or hide ticket open or close events.
*''Wiki changes'' — display or hide Wiki change events.

See TracIni's [[TracIni#timeline-section| "[timeline]] section"] for timeline configuration options.

=== RSS Support ===

The Timeline module supports subscription using RSS 2.0 syndication. To subscribe to project events, click the orange '''XML''' icon at the bottom of the page. See TracRss for more information on RSS support in Trac.

----
See also: TracGuide, TracIni, TracWiki, WikiFormatting, TracRss, TracNotification

{{TracNotice|{{PAGENAME}}}}

TracTicketsCustomFields

2015-08-26T12:29:22Z

Maintenance script: Created page with " == Custom Ticket Fields == Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets...."

== Custom Ticket Fields ==
Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.

=== Configuration ===
Configuring custom ticket fields is done in the [[TracIni| trac.ini]] file. All field definitions should be under a section named <tt>[ticket-custom]</tt>.

The syntax of each field definition is:
<pre>
FIELD_NAME = TYPE
(FIELD_NAME.OPTION = VALUE)
...
</pre>
The example below should help to explain the syntax.

==== Available Field Types and Options ====
*'''text''': A simple (one line) text field.
**label: Descriptive label.
**value: Default value.
**order: Sort order placement. (Determines relative placement in forms with respect to other custom fields.)
**format: Either <tt>plain</tt> for plain text or <tt>wiki</tt> to interpret the content as WikiFormatting. (''since 0.11.3'')
*'''checkbox''': A boolean value check box.
**label: Descriptive label.
**value: Default value (0 or 1).
**order: Sort order placement.
*'''select''': Drop-down select box. Uses a list of values.
**label: Descriptive label.
**options: List of values, separated by '''|''' (vertical pipe).
**value: Default value (one of the values from options).
**order: Sort order placement.
*'''radio''': Radio buttons. Essentially the same as '''select'''.
**label: Descriptive label.
**options: List of values, separated by '''|''' (vertical pipe).
**value: Default value (one of the values from options).
**order: Sort order placement.
*'''textarea''': Multi-line text area.
**label: Descriptive label.
**value: Default text.
**cols: Width in columns.
**rows: Height in lines.
**order: Sort order placement.
**format: Either <tt>plain</tt> for plain text or <tt>wiki</tt> to interpret the content as WikiFormatting. (''since 0.11.3'')

==== Sample Config ====
<pre>
[ticket-custom]

test_one = text
test_one.label = Just a text box

test_two = text
test_two.label = Another text-box
test_two.value = Default [mailto:joe@nospam.com owner]
test_two.format = wiki

test_three = checkbox
test_three.label = Some checkbox
test_three.value = 1

test_four = select
test_four.label = My selectbox
test_four.options = one|two|third option|four
test_four.value = two

test_five = radio
test_five.label = Radio buttons are fun
test_five.options = uno|dos|tres|cuatro|cinco
test_five.value = dos

test_six = textarea
test_six.label = This is a large textarea
test_six.value = Default text
test_six.cols = 60
test_six.rows = 30
</pre>

''Note: To make entering an option for a <tt>select</tt> type field optional, specify a leading <tt>|</tt> in the <tt>fieldname.options</tt> option.''

==== Reports Involving Custom Fields ====

Custom ticket fields are stored in the <tt>ticket_custom</tt> table, not in the <tt>ticket</tt> table. So to display the values from custom fields in a report, you will need a join on the 2 tables. Let's use an example with a custom ticket field called <tt>progress</tt>.

<pre>
#sql
SELECT p.value AS <u>color</u>,
id AS ticket, summary, owner, c.value AS progress
FROM ticket t, enum p, ticket_custom c
WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
AND p.name = t.priority AND p.type = 'priority'
ORDER BY p.value
</pre>
'''Note''' that this will only show tickets that have progress set in them, which is '''not the same as showing all tickets'''. If you created this custom ticket field ''after'' you have already created some tickets, they will not have that field defined, and thus they will never show up on this ticket query. If you go back and modify those tickets, the field will be defined, and they will appear in the query. If that's all you want, you're set.

However, if you want to show all ticket entries (with progress defined and without), you need to use a <tt>JOIN</tt> for every custom field that is in the query.
<pre>
#sql
SELECT p.value AS <u>color</u>,
id AS ticket, summary, component, version, milestone, severity,
{| border=1 class="simple"
!' *' ELSE owner END) AS owner,
|}

time AS created,
changetime AS _changetime, description AS _description,
reporter AS _reporter,
(CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
FROM ticket t
LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
JOIN enum p ON p.name = t.priority AND p.type='priority'
WHERE status IN ('new', 'assigned', 'reopened')
ORDER BY p.value, milestone, severity, time
</pre>

Note in particular the <tt>LEFT OUTER JOIN</tt> statement here.

==== Updating the database ====

As noted above, any tickets created before a custom field has been defined will not have a value for that field. Here's a bit of SQL (tested with SQLite) that you can run directly on the Trac database to set an initial value for custom ticket fields. Inserts the default value of 'None' into a custom field called 'request_source' for all tickets that have no existing value:

<pre>
#sql
INSERT INTO ticket_custom
(ticket, name, value)
SELECT
id AS ticket,
'request_source' AS name,
'None' AS value
FROM ticket
WHERE id NOT IN (
SELECT ticket FROM ticket_custom
);
</pre>

If you added multiple custom fields at different points in time, you should be more specific in the subquery on table <tt>ticket</tt> by adding the exact custom field name to the query:

<pre>
#sql
INSERT INTO ticket_custom
(ticket, name, value)
SELECT
id AS ticket,
'request_source' AS name,
'None' AS value
FROM ticket
WHERE id NOT IN (
SELECT ticket FROM ticket_custom WHERE name = 'request_source'
);
</pre>

----
See also: TracTickets, TracIni

{{TracNotice|{{PAGENAME}}}}

TracTickets

2015-08-26T12:29:22Z

Maintenance script: Created page with " == The Trac Ticket System == TracGuideToc The Trac ticket database provides simple but effective tracking of issues and bugs within a project. As the central project ma..."

== The Trac Ticket System ==
[[TracGuideToc]]

The Trac ticket database provides simple but effective tracking of issues and bugs within a project.

As the central project management element of Trac, tickets are used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''.

As with the TracWiki, this subsystem has been designed with the goal of making user contribution and participation as simple as possible. It should be as easy as possible to report bugs, ask questions and suggest improvements.

An issue is assigned to a person who must resolve it or reassign the ticket to someone else.
All tickets can be edited, annotated, assigned, prioritized and discussed at any time.

=== Ticket Fields ===

A ticket contains the following information attributes:

*'''Reporter''' — The author of the ticket.
*'''Type''' — The nature of the ticket (for example, defect or enhancement request)

*'''Component''' — The project module or subsystem this ticket concerns.
*'''Version''' — Version of the project that this ticket pertains to.
*'''Keywords''' — Keywords that a ticket is marked with. Useful for searching and report generation.

*'''Priority''' — The importance of this issue, ranging from ''trivial'' to ''blocker''.
*'''Milestone''' — When this issue should be resolved at the latest.
*'''Assigned to/Owner''' — Principal person responsible for handling the issue.
*'''Cc''' — A comma-separated list of other users or E-Mail addresses to notify. ''Note that this does not imply responsiblity or any other policy.''

*'''Resolution''' — Reason for why a ticket was closed. One of <tt>fixed</tt>, <tt>invalid</tt>, <tt>wontfix</tt>, <tt>duplicate</tt>, <tt>worksforme</tt>.
*'''Status''' — What is the current status? One of <tt>new</tt>, <tt>assigned</tt>, <tt>closed</tt>, <tt>reopened</tt>.
*'''Summary''' — A brief description summarizing the problem or issue.
*'''Description''' — The body of the ticket. A good description should be specific, descriptive and to the point.

'''Note:''' Versions of Trac prior to 0.9 did not have the ''type'' field, but instead provided a ''severity'' field and different default values for the ''priority'' field. This change was done to simplify the ticket model by removing the somewhat blurry distinction between ''priority'' and ''severity''. However, the old model is still available if you prefer it: just add/modify the default values of the ''priority'' and ''severity'', and optionally hide the ''type'' field by removing all the possible values through [[TracAdmin| trac-admin]].

'''Note:''' the [trac:TicketTypes type], [trac:TicketComponent component], version, priority and severity fields can be managed with [[TracAdmin| trac-admin]] or with the [trac:WebAdmin WebAdmin] plugin.

'''Note:''' Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes]

=== Changing and Commenting Tickets ===

Once a ticket has been entered into Trac, you can at any time change the
information by '''annotating''' the bug. This means changes and comments to
the ticket are logged as a part of the ticket itself.

When viewing a ticket, the history of changes will appear below the main ticket area.

''In the Trac project, we use ticket comments to discuss issues and tasks. This makes
understanding the motivation behind a design- or implementation choice easier,
when returning to it later.''

'''Note:''' An important feature is being able to use TracLinks and
WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to
other issues, changesets or files to make your ticket more specific and easier
to understand.

'''Note:''' See TracNotification for how to configure email notifications of ticket changes.

'''Note:''' See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized.

=== Default Values for Drop-Down Fields ===

The option selected by default for the various drop-down fields can be set in [[TracIni| trac.ini]], in the <tt>[ticket]</tt> section:

*<tt>default_component</tt>: Name of the component selected by default
*<tt>default_milestone</tt>: Name of the default milestone
*<tt>default_priority</tt>: Default priority value
*<tt>default_severity</tt>: Default severity value
*<tt>default_type</tt>: Default ticket type
*<tt>default_version</tt>: Name of the default version
*<tt>default_owner</tt>: Name of the default owner, ''if no owner for the component has been set''

If any of these options are omitted, the default value will either be the first in the list, or an empty value, depending on whether the field in question is required to be set. Some of these can be chosen through the [trac:WebAdmin WebAdmin] plugin in the "Ticket System" section (others in the "trac.ini" section). The default owner for a ticket will be the component owner, if that is set, or <tt>default_owner</tt>, if not.

=== Hiding Fields and Adding Custom Fields ===

Many of the default ticket fields can be hidden from the ticket web interface simply by removing all the possible values through [[TracAdmin| trac-admin]]. This of course only applies to drop-down fields, such as ''type'', ''priority'', ''severity'', ''component'', ''version'' and ''milestone''.

Trac also lets you add your own custom ticket fields. See TracTicketsCustomFields for more information.

=== Assign-to as Drop-Down List ===

If the list of possible ticket owners is finite, you can change the ''assign-to'' ticket field from a text input to a drop-down list. This is done by setting the <tt>restrict_owner</tt> option of the <tt>[ticket]</tt> section in [[TracIni| trac.ini]] to “true”. In that case, Trac will use the list of all users who have accessed the project to populate the drop-down field.

To appear in the dropdown list, a user needs be registered with the project, ''i.e.'' a user session should exist in the database. Such an entry is automatically created in the database the first time the user submits a change in the project, for example when editing the user's details in the ''Settings'' page, or simply by authenticating if the user has a login. Also, the user must have <tt>TICKET_MODIFY</tt> [TracPermissions permissions].

'''Note:''' See [http://pacopablo.com/wiki/pacopablo/blog/set-assign-to-drop-down Populating Assign To Drop Down] on how to add user entries at database level

'''Note 2:''' If you need serious flexibility and aren't afraid of a little plugin coding of your own, see [http://trac-hacks.org/wiki/FlexibleAssignToPlugin FlexibleAssignTo] (disclosure: I'm the author)

'''Note 3:''' Activating this option may cause some performance degradation, read more about this in the [trac:TracPerformance#Configuration Trac performance] page.

=== Preset Values for New Tickets ===

To create a link to the new-ticket form filled with preset values, you need to call the <tt>/newticket?</tt> URL with variable=value separated by &.

Possible variables are :

*'''type''' — The type droplist
*'''reporter''' — Name or email of the reporter
*'''summary''' — Summary line for the ticket
*'''description''' — Long description of the ticket
*'''component''' — The component droplist
*'''version''' — The version droplist
*'''severity''' — The severity droplist
*'''keywords''' — The keywords
*'''priority''' — The priority droplist
*'''milestone''' — The milestone droplist
*'''owner''' — The person responsible for the ticket
*'''cc''' — The list of emails for notifying about the ticket change

'''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''<br>

----
See also: TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery

{{TracNotice|{{PAGENAME}}}}

TracSyntaxColoring

2015-08-26T12:29:22Z

Maintenance script: Created page with " == Syntax Coloring of Source Code == Trac supports language-specific syntax highlighting of source code within wiki formatted text in [WikiProcessors#CodeHighlightingSupport ..."

== Syntax Coloring of Source Code ==
Trac supports language-specific syntax highlighting of source code within wiki formatted text in [WikiProcessors#CodeHighlightingSupport wiki processors] blocks and in the [TracBrowser repository browser].

To do this, Trac uses external libraries with support for a great number of programming languages.

Currently Trac supports syntax coloring using one or more of the following packages:

*[http://pygments.pocoo.org/ Pygments], by far the preferred system, as it covers a wide range of programming languages and other structured texts and is actively supported
*[http://www.codento.com/people/mtr/genscript/ GNU Enscript], commonly available on Unix but somewhat unsupported on Windows
*[http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be [http://trac.edgewall.org/wiki/TracFaq#why-is-my-css-code-not-being-highlighted-even-though-i-have-silvercity-installed problematic]

To activate syntax coloring, simply install either one (or more) of these packages (see [#ExtraSoftware] section below).
If none of these packages is available, Trac will display the data as plain text.

==== About Pygments ====

Starting with trac 0.11 [http://pygments.org/ pygments] will be the new default highlighter. It's a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented].

The Pygments default style can specified in the [TracIni#mimeviewer-section mime-viewer] section of trac.ini. The default style can be overridden by setting a Style preference on the [/prefs/pygments preferences page].

It's very likely that the list below is outdated because the list of supported pygments lexers is growing weekly. Just have a look at the page of [http://pygments.org/docs/lexers/ supported lexers] on the pygments webpage.

=== Syntax Coloring Support ===

=== Known MIME Types

[[KnownMimeTypes]]

=== List of Languages Supported, by Highlighter #language-supported

This list is only indicative.

{| border=1 class="simple"
!
!= SilverCity =
!= Enscript =
!= Pygments =
|-
| Ada
|
| ✓
|
|-
| Asm
|
| ✓
|
|-
| Apache Conf
|
|
| ✓
|-
| ASP
| ✓
| ✓
|
|-
| C
| ✓
| ✓
| ✓
|-
| C#
|
| ✓ <sup>[#a1 (1)]</sup>
| ✓
|-
| C++
| ✓
| ✓
| ✓
|-
| Java
| ✓ <sup>[#a2 (2)]</sup>
| ✓
| ✓
|-
| Awk
|
| ✓
|
|-
| Boo
|
|
| ✓
|-
| CSS
| ✓
|
| ✓
|-
| Python Doctests
|
|
| ✓
|-
| Diff
|
| ✓
| ✓
|-
| Eiffel
|
| ✓
|
|-
| Elisp
|
| ✓
|
|-
| Fortran
|
| ✓ <sup>[#a1 (1)]</sup>
| ✓
|-
| Haskell
|
| ✓
| ✓
|-
| Genshi
|
|
| ✓
|-
| HTML
| ✓
| ✓
| ✓
|-
| IDL
|
| ✓
|
|-
| INI
|
|
| ✓
|-
| Javascript
| ✓
| ✓
| ✓
|-
| Lua
|
|
| ✓
|-
| m4
|
| ✓
|
|-
| Makefile
|
| ✓
| ✓
|-
| Mako
|
|
| ✓
|-
| Matlab <sup>[#a3 (3)]</sup>
|
| ✓
| ✓
|-
| Mygthy
|
|
| ✓
|-
| Objective-C
|
| ✓
| ✓
|-
| OCaml
|
|
| ✓
|-
| Pascal
|
| ✓
| ✓
|-
| Perl
| ✓
| ✓
| ✓
|-
| PHP
| ✓
|
| ✓
|-
| PSP
| ✓
|
|
|-
| Pyrex
|
| ✓
|
|-
| Python
| ✓
| ✓
| ✓
|-
| Ruby
| ✓
| ✓ <sup>[#a1 (1)]</sup>
| ✓
|-
| Scheme
|
| ✓
| ✓
|-
| Shell
|
| ✓
| ✓
|-
| Smarty
|
|
| ✓
|-
| SQL
| ✓
| ✓
| ✓
|-
| Troff
|
| ✓
| ✓
|-
| TCL
|
| ✓
|
|-
| Tex
|
| ✓
| ✓
|-
| Verilog
| ✓ <sup>[#a2 (2)]</sup>
| ✓
|
|-
| VHDL
|
| ✓
|
|-
| Visual Basic
|
| ✓
| ✓
|-
| VRML
|
| ✓
|
|-
| XML
| ✓
|
| ✓
|}

''[=#a1 (1)] Not included in the Enscript distribution. Additional highlighting rules can be obtained for
[http://neugierig.org/software/ruby/ Ruby],
[http://wiki.hasno.info/index.php/Csharp.st C#],
[http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003]

''[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23

''[=#a3 (3)] By default <tt>.m</tt> files are considered Objective-C files. In order to treat <tt>.m</tt> files as MATLAB files, add "text/matlab:m" to the "mime_map" setting in the [[TracIni#mimeviewer-section| "[mimeviewer]] section of trac.ini"].

=== Extra Software ===
*GNU Enscript -- http://directory.fsf.org/GNU/enscript.html
*GNU Enscript for Windows -- http://gnuwin32.sourceforge.net/packages/enscript.htm
*SilverCity -- http://silvercity.sf.net/
*Pygments -- http://pygments.org/

----
See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser

{{TracNotice|{{PAGENAME}}}}

TracSupport

2015-08-26T12:29:22Z

Maintenance script: Created page with " == Trac Support == Like in most [http://www.opensource.org/ open source projects], "free" Trac support is available primarily through the community itself, mainly through th..."

== Trac Support ==

Like in most [http://www.opensource.org/ open source projects], "free" Trac support is available primarily through the community itself, mainly through the [trac:MailingList mailing list] and the project wiki.

There is also an [trac:IrcChannel IRC channel], where people might be able to help out. Much of the 'live' development discussions also happen there.

Before you start a new support query, make sure you've done the appropriate searching:
*in the project's [trac:TracFaq FAQ]
*in past messages to the Trac [http://blog.gmane.org/gmane.comp.version-control.subversion.trac.general?set_user_css=http%3A%2F%2Fwww.edgewall.com%2Fcss%2Fgmane.css&do_set_user_css=t Mailing List]
*in the Trac ticket system, using either a [http://trac.edgewall.org/search?q=&ticket=on&wiki=on full search] or a [http://trac.edgewall.org/query?summary=~&keywords=~ ticket query].

Please '''don't''' create a ticket in this Trac for asking a support question about Trac. Only use it when you face a ''real'' and ''new'' bug in Trac, and do so only after having read the [trac:NewTicketGuidelines NewTicketGuidelines]. The more a bug report or enhancement request complies with those guidelines, the higher the chances are that it will be fixed or implemented promptly!

----
See also: [trac:MailingList MailingList], [trac:TracTroubleshooting TracTroubleshooting], [trac:CommercialServices CommercialServices]

{{TracNotice|{{PAGENAME}}}}

TracStandalone

2015-08-26T12:29:21Z

Maintenance script: Created page with " == Tracd == Tracd is a lightweight standalone Trac web server. It can be used in a variety of situations, from a test or development server to a multiprocess setup behind an..."

== Tracd ==

Tracd is a lightweight standalone Trac web server.
It can be used in a variety of situations, from a test or development server to a multiprocess setup behind another web server used as a load balancer.

=== Pros ===

*Fewer dependencies: You don't need to install apache or any other web-server.
*Fast: Should be almost as fast as the [[TracModPython| mod_python]] version (and much faster than the [[TracCgi| CGI]]), even more so since version 0.12 where the HTTP/1.1 version of the protocol is enabled by default
*Automatic reloading: For development, Tracd can be used in ''auto_reload'' mode, which will automatically restart the server whenever you make a change to the code (in Trac itself or in a plugin).

=== Cons ===

*Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd.
*No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead,
or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.

=== Usage examples ===

A single project on port 8080. (http://localhost:8080/)
<pre>
$ tracd -p 8080 /path/to/project
</pre>
Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
<pre>
$ tracd --hostname=localhost -p 8080 /path/to/project
</pre>
With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
<pre>
$ tracd -p 8080 /path/to/project1 /path/to/project2
</pre>

You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the
different projects unique. So if you use <tt>/project1/path/to</tt> and <tt>/project2/path/to</tt>, you will only see the second project.

An alternative way to serve multiple projects is to specify a parent directory in which each subdirectory is a Trac project, using the <tt>-e</tt> option. The example above could be rewritten:
<pre>
$ tracd -p 8080 -e /path/to
</pre>

To exit the server on Windows, be sure to use <tt>CTRL-BREAK</tt> -- using <tt>CTRL-C</tt> will leave a Python process running in the background.

=== Installing as a Windows Service ===

==== Option 1 ====
To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
<pre>
C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
reg add HKLM\SYSTEM\CurrentControlSet\Services\tracd\Parameters /v Application /d "\"C:\path\to\python.exe\" \"C:\path\to\python\scripts\tracd-script.py\" <your tracd parameters>"
net start tracd
</pre>

'''DO NOT''' use <tt>tracd.exe</tt>. Instead register <tt>python.exe</tt> directly with <tt>tracd-script.py</tt> as a parameter. If you use <tt>tracd.exe</tt>, it will spawn the python process without SRVANY's knowledge. This python process will survive a <tt>net stop tracd</tt>.

If you want tracd to start automatically when you boot Windows, do:
<pre>
sc config tracd start= auto
</pre>

The spacing here is important.

For Windows 7 User, srvany.exe may not be an option, so you can use [http://www.google.com/search?q=winserv.exe WINSERV] utility and run:
<pre>
"C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\tracd-script.py <your tracd parameters>"

net start tracd
</pre>

==== Option 2 ====

Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.

=== Using Authentication ===

Using tracd with Apache .htpasswd files:

To create a .htpasswd file using htpasswd:

<pre>
$ htpasswd -c /path/to/env/.htpasswd username
</pre>
then for additional users:
<pre>
$ htpasswd /path/to/env/.htpasswd username2
</pre>
then for starting the tracd (on windows skip the "=" after --basic-auth):
<pre>
tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
</pre>

<tt>environmentname</tt> is the directory name of the Trac project folder, as opposed to <tt>/fullpath/environmentname</tt> which is the full path to the Trac project folder. See below for another example.

Tracd provides support for both Basic and Digest authentication. The default is to use Digest; to use Basic authentication, replace <tt>--auth</tt> with <tt>--basic-auth</tt> in the examples below. (You must still specify a dialogic "realm", which can be an empty string by trailing the BASICAUTH with a comma.)

''Support for Basic authentication was added in version 0.9.''

The general format for using authentication is (replace <tt>--auth</tt> with <tt>--basic-auth</tt> if you want to use Basic auth):

<pre>
$ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
</pre>

where:

*'''base_project_dir''': the base directory of the project specified as follows:
**when serving multiple projects: ''relative'' to the <tt>project_path</tt>
**when serving only a single project (<tt>-s</tt>): the name of the project directory
Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows.
*'''password_file_path''': path to the password file
*'''realm''': the realm name (can be anything)
*'''project_path''': path of the project

Examples:

<pre>
$ tracd -p 8080 \
--auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
</pre>

Of course, the password file can be be shared so that it is used for more than one project:
<pre>
$ tracd -p 8080 \
--auth="project1,/path/to/passwordfile,mycompany.com" \
--auth="project2,/path/to/passwordfile,mycompany.com" \
/path/to/project1 /path/to/project2
</pre>

Another way to share the password file is to specify "*" for the project name:
<pre>
$ tracd -p 8080 \
--auth="*,/path/to/users.htdigest,mycompany.com" \
/path/to/project1 /path/to/project2
</pre>

==== Using a htpasswd password file ====
This section describes how to use <tt>tracd</tt> with Apache .htpasswd files.

To create a .htpasswd file use Apache's <tt>htpasswd</tt> command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):

<pre>
$ sudo htpasswd -c /path/to/env/.htpasswd username
</pre>
then for additional users:
<pre>
$ sudo htpasswd /path/to/env/.htpasswd username2
</pre>

Then to start <tt>tracd</tt> run something like this:

<pre>
$ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
</pre>

For example:

<pre>
$ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
</pre>

''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).

==== Using a htdigest password file ====

If you have Apache available, you can use the htdigest command to generate the password file. Type 'htdigest' to get some usage instructions, or read [http://httpd.apache.org/docs/2.0/programs/htdigest.html this page] from the Apache manual to get precise instructions. You'll be prompted for a password to enter for each user that you create. For the name of the password file, you can use whatever you like, but if you use something like <tt>users.htdigest</tt> it will remind you what the file contains. As a suggestion, put it in your <projectname>/conf folder along with the [TracIni trac.ini] file.

Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.

==== Generating Passwords Without Apache ====

If you don't have Apache available, you can use this simple Python script to generate your passwords:

<pre>
#python
from optparse import OptionParser
# The md5 module is deprecated in Python 2.5
try:
from hashlib import md5
except ImportError:
from md5 import md5
realm = 'trac'

# build the options
usage = "usage: %prog [options]"
parser = OptionParser(usage=usage)
parser.add_option("-u", "--username",action="store", dest="username", type = "string",
help="the username for whom to generate a password")
parser.add_option("-p", "--password",action="store", dest="password", type = "string",
help="the password to use")
parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
help="the realm in which to create the digest")
(options, args) = parser.parse_args()

# check options
if (options.username is None) or (options.password is None):
parser.error("You must supply both the username and password")
if (options.realm is not None):
realm = options.realm

# Generate the string to enter into the htdigest file
kd = lambda x: md5(':'.join(x)).hexdigest()
print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
</pre>

Note: If you use the above script you must use the --auth option to tracd, not --basic-auth, and you must set the realm in the --auth value to 'trac' (without the quotes). Example usage (assuming you saved the script as trac-digest.py):

<pre>
$ python trac-digest.py -u username -p password >> c:\digest.txt
$ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
</pre>

Note: If you would like to use --basic-auth you need to use htpasswd tool from apache server to generate .htpasswd file. The remaining part is similar but make sure to use empty realm (i.e. coma after path). Make sure to use -m option for it. If you do not have Apache, [trac:source:/tags/trac-0.11/contrib/htpasswd.py htpasswd.py] may help. (Note that it requires a <tt>crypt</tt> or <tt>fcrypt</tt> module; see the source comments for details.)

It is possible to use md5sum utility to generate digest-password file using such method:
<pre>
$ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
</pre>
and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.

=== Tips ===

==== Serving static content ====

If <tt>tracd</tt> is the only web server used for the project,
it can also be used to distribute static content
(tarballs, Doxygen documentation, etc.)

This static content should be put in the <tt>$TRAC_ENV/htdocs</tt> folder,
and is accessed by URLs like <tt><project_URL>/chrome/site/...</tt>.

Example: given a <tt>$TRAC_ENV/htdocs/software-0.1.tar.gz</tt> file,
the corresponding relative URL would be <tt>/<project_name>/chrome/site/software-0.1.tar.gz</tt>,
which in turn can be written as <tt>htdocs:software-0.1.tar.gz</tt> (TracLinks syntax) or <tt>[/<project_name>/chrome/site/software-0.1.tar.gz]</tt> (relative link syntax).

''Support for <tt>htdocs:</tt> TracLinks syntax was added in version 0.10''

==== Using apache rewrite rules ====
In some situations when you choose to use tracd behind apache, you might experience issues with redirects, like being redirected to URLs with the wrong host or protocol. In this case (and only in this case), setting the <tt>[trac] use_base_url_for_redirect</tt> to <tt>true</tt> can help, as this will force Trac to use the value of <tt>[trac] base_url</tt> for doing the redirects.

==== Serving a different base path than / ====
Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
<pre>
$ tracd --base-path=/some/path
</pre>

----
See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]

{{TracNotice|{{PAGENAME}}}}

TracSearch

2015-08-26T12:29:21Z

Maintenance script: Created page with " == Using Search == Trac has a built-in search engine to allow finding occurrences of keywords and substrings in wiki pages, tickets and changeset properties (author, revisio..."

== Using Search ==

Trac has a built-in search engine to allow finding occurrences of keywords and substrings in wiki pages, tickets and changeset properties (author, revision and log message).

Using the Trac search facility is straightforward and its interface should be familiar to most users.

Apart from the [search: Search module], you will also find a small search field above the navigation bar at all time. It provides convenient access to the search module from all pages.

=== "Quickjump" searches ===
For quick access to various project resources, the quick-search field at the top of every page can be used to enter a [TracLinks wiki link], which will take you directly to the resource identified by that link.

For example:

*![42] -- Opens change set 42
*!#42 -- Opens ticket number 42
*!{1} -- Opens report 1
*/trunk -- Opens the browser for the <tt>trunk</tt> directory

=== Advanced ===

==== Disabling Quickjumps ====
To disable the quickjump feature for a search keyword - for example when searching for occurences of the literal word TracGuide - begin the query with an exclamation mark (!).

==== Search Links ====
From the Wiki, it is possible to link to a specific search, using
<tt>search:</tt> links:
*<tt>search:?q=crash</tt> will search for the string "crash"
*<tt>search:?q=trac+link&wiki=on</tt> will search for "trac" and "link"
in wiki pages only

----
See also: TracGuide, TracLinks, TracQuery

{{TracNotice|{{PAGENAME}}}}

TracRss

2015-08-26T12:29:21Z

Maintenance script: Created page with " == Using RSS with Trac == TracGuideToc Several of the Trac modules support content syndication using the RSS (Really Simple Syndication) XML format. Using the RSS subscr..."

== Using RSS with Trac ==
[[TracGuideToc]]

Several of the Trac modules support content syndication using the RSS (Really Simple Syndication) XML format.
Using the RSS subscription feature in Trac, you can easily monitor progress of the project, a set of issues or even changes to a single file.

Trac supports RSS feeds in:

*TracTimeline — Use the RSS feed to '''subscribe to project events'''.<br>Monitor overall project progress in your favorite RSS reader.
*TracTickets, TracReports, and TracQuery — Allows syndication of report and ticket query results.<br>Be notified about important and relevant issue tickets.
*TracBrowser and TracRevisionLog — Syndication of file changes.<br>Stay up to date with changes to a specific file or directory.

=== How to access RSS data ===
Anywhere in Trac where RSS is available, you should find a small orange '''XML''' icon, typically placed at the bottom of the page. Clicking the icon will access the RSS feed for that specific resource.

'''Note:''' Different modules provide different data in their RSS feeds. Usually, the syndicated information corresponds to the current view. For example, if you click the RSS link on a report page, the feed will be based on that report. It might be explained by thinking of the RSS feeds as an ''alternate view of the data currently displayed''.

=== Links ===
*''Specifications:''
**http://blogs.law.harvard.edu/tech/rss — RSS 2.0 Specification

*''Multi-platform RSS readers:''
**http://www.rssowl.org/ — Open source, Eclipse-based, RSS reader for Linux, Mac and Windows systems that supports https and authenticated feeds.

*''Linux/BSD/*n*x systems:''
**http://pim.kde.org/users.php — [http://kde.org KDE] RSS Reader for Linux/BSD/*n*x systems
**http://liferea.sourceforge.net/ — Open source GTK2 RSS Reader for Linux
**http://akregator.sourceforge.net/ — Open source KDE RSS Reader (part of KDE-PIM)

*''Mac OS X systems:''
**http://ranchero.com/netnewswire/ — An excellent RSS reader for Mac OS X (has both free and pay versions)
**http://www.utsire.com/shrook/ — An RSS reader for Max OS X that supports https (even with self signed certificates) and authenticated feeds.
**http://vienna-rss.sourceforge.net/ — Open source Feed Reader for Mac OS X with smart folders support
**http://www.mesadynamics.com/Tickershock.html — Non-intrusive "news ticker" style RSS reader for Mac OS X

*''Windows systems:''
**http://www.rssreader.com/ — Free and powerful RSS Reader for Windows
**http://www.sharpreader.net/ — A free RSS Reader written in .NET for Windows

*''Firefox:''
**http://www.mozilla.org/products/firefox/ — Mozilla Firefox supports [http://www.mozilla.org/products/firefox/live-bookmarks.html live bookmarks] using RSS
**http://sage.mozdev.org — Sage RSS and Atom feed aggregator for Mozilla Firefox
**http://www.wizzrss.com/Welcome.php — WizzRSS Feed Reader for Firefox

----
See also: TracGuide, TracTimeline, TracReports, TracBrowser

{{TracNotice|{{PAGENAME}}}}