2 new revisions:
Revision: 7ce1b50773c7
Author: Pekka Klärck
Date: Mon Jun 20 08:19:19 2011
Log: regen
http://code.google.com/p/robotframework/source/detail?r=7ce1b50773c7
Revision: 34f161f8bb95
Author: Pekka Klärck
Date: Mon Jun 20 08:19:49 2011
Log: documented current behavior of --tagdoc and --tagstatlink
http://code.google.com/p/robotframework/source/detail?r=34f161f8bb95
==============================================================================
Revision: 7ce1b50773c7
Author: Pekka Klärck
Date: Mon Jun 20 08:19:19 2011
Log: regen
http://code.google.com/p/robotframework/source/detail?r=7ce1b50773c7
Modified:
/doc/userguide/RobotFrameworkUserGuide.html
=======================================
--- /doc/userguide/RobotFrameworkUserGuide.html Sun Jun 19 12:50:50 2011
+++ /doc/userguide/RobotFrameworkUserGuide.html Mon Jun 20 08:19:19 2011
@@ -10304,10 +10304,10 @@
option are given in the format <span class="opt">tag:link:name</span>,
where <span class="opt">tag</span>
specifies the tags to assign the link to, <span class="opt">link</span> is
the link to
be created, and <span class="opt">name</span> is the name to give to the
link.</p>
-<p><span class="opt">tag</span> may be a single tag, but more commonly a
<a class="reference internal" href="#option-value-as-simple-pattern">simple
-pattern</a> where <span class="code">*</span> matches anything and <span
class="code">?</span> matches any
-single character. When <span class="opt">tag</span> is a pattern, the
matches to
-wildcards may be used in <span class="opt">link</span> with the syntax
<span class="code">%N</span>,
+<p><span class="opt">tag</span> may be a single tag, but more commonly a
<a class="reference internal" href="#option-value-as-simple-pattern">simple
pattern</a>
+where <span class="code">*</span> matches anything and <span
class="code">?</span> matches any single
+character. When <span class="opt">tag</span> is a pattern, the matches to
wildcards may
+be used in <span class="opt">link</span> and <span
class="opt">title</span> with the syntax <span class="code">%N</span>,
where "N" is the index of the match starting from 1.</p>
<p>The following examples illustrate the usage of this option, and the
figure below shows a snippet of the resulting <span
class="name">Statistics by
@@ -10326,13 +10326,15 @@
<h4><a class="toc-backref" href="#id519">Adding documentation to
tags</a></h4>
<p>Tags can be given a documentation with the command line option
<span class="opt">--tagdoc</span>, which takes an argument in the format
-<span class="opt">tag:doc</span>. "tag" is the name of the tag
to assign
-the documentation to, and it can also be a <a class="reference internal"
href="#option-value-as-simple-pattern">simple pattern</a> matching
-multiple tags. "doc" is the assigned
-documentation. Underscores in it are converted to spaces automatically,
-and it can also contain <a class="reference internal"
href="#documentation-formatting">HTML formatting</a>. The given
documentation is
-shown with matching tags in the <span class="name">Test Details by
Tag</span> table, and as
-a tool tip for these tags in the <span class="name">Statistics by
Tag</span> table.</p>
+<span class="opt">tag:doc</span>. <span class="opt">tag</span> is the name
of the tag to assign the
+documentation to, and it can also be a <a class="reference internal"
href="#option-value-as-simple-pattern">simple pattern</a> matching
+multiple tags. <span class="opt">doc</span> is the assigned documentation.
Underscores
+in it the documentation are automatically converted to spaces and it
+can also contain <a class="reference internal"
href="#documentation-formatting">HTML formatting</a>.</p>
+<p>The given documentation is shown with matching tags in the <span
class="name">Test
+Details by Tag</span> table, and as a tool tip for these tags in the
+<span class="name">Statistics by Tag</span> table. If one tag gets
multiple documentations,
+they are combined together and separated with an ampersand.</p>
<p>Examples:</p>
<pre class="literal-block">
--tagdoc mytag:My_documentation
@@ -14121,7 +14123,7 @@
<div class="footer">
<hr class="footer" />
<p>Generated by <a class="reference external"
href="http://docutils.sourceforge.net/rst.html";>reStructuredText</a>.
Syntax highlighting by <a class="reference external"
href="http://pygments.org/";>Pygments</a>.</p>
-<p>Generated on: 2011-06-19 19:49 UTC.
+<p>Generated on: 2011-06-20 15:18 UTC.
</p>
</div>
==============================================================================
Revision: 34f161f8bb95
Author: Pekka Klärck
Date: Mon Jun 20 08:19:49 2011
Log: documented current behavior of --tagdoc and --tagstatlink
http://code.google.com/p/robotframework/source/detail?r=34f161f8bb95
Modified:
/doc/userguide/src/ExecutingTestCases/OutputFiles.txt
/src/robot/rebot.py
/src/robot/runner.py
=======================================
--- /doc/userguide/src/ExecutingTestCases/OutputFiles.txt Sat Jun 18
16:37:52 2011
+++ /doc/userguide/src/ExecutingTestCases/OutputFiles.txt Mon Jun 20
08:19:49 2011
@@ -373,10 +373,10 @@
specifies the tags to assign the link to, :opt:`link` is the link to
be created, and :opt:`name` is the name to give to the link.
-:opt:`tag` may be a single tag, but more commonly a `simple
-pattern`_ where :code:`*` matches anything and :code:`?` matches any
-single character. When :opt:`tag` is a pattern, the matches to
-wildcards may be used in :opt:`link` with the syntax :code:`%N`,
+:opt:`tag` may be a single tag, but more commonly a `simple pattern`_
+where :code:`*` matches anything and :code:`?` matches any single
+character. When :opt:`tag` is a pattern, the matches to wildcards may
+be used in :opt:`link` and :opt:`title` with the syntax :code:`%N`,
where "N" is the index of the match starting from 1.
The following examples illustrate the usage of this option, and the
@@ -397,13 +397,16 @@
Tags can be given a documentation with the command line option
:opt:`--tagdoc`, which takes an argument in the format
-:opt:`tag:doc`. "tag" is the name of the tag to assign
-the documentation to, and it can also be a `simple pattern`_ matching
-multiple tags. "doc" is the assigned
-documentation. Underscores in it are converted to spaces automatically,
-and it can also contain `HTML formatting`_. The given documentation is
-shown with matching tags in the :name:`Test Details by Tag` table, and as
-a tool tip for these tags in the :name:`Statistics by Tag` table.
+:opt:`tag:doc`. :opt:`tag` is the name of the tag to assign the
+documentation to, and it can also be a `simple pattern`_ matching
+multiple tags. :opt:`doc` is the assigned documentation. Underscores
+in it the documentation are automatically converted to spaces and it
+can also contain `HTML formatting`_.
+
+The given documentation is shown with matching tags in the :name:`Test
+Details by Tag` table, and as a tool tip for these tags in the
+:name:`Statistics by Tag` table. If one tag gets multiple documentations,
+they are combined together and separated with an ampersand.
Examples::
=======================================
--- /src/robot/rebot.py Fri Jun 17 07:00:12 2011
+++ /src/robot/rebot.py Mon Jun 20 08:19:49 2011
@@ -141,19 +141,18 @@
Documentation is shown in 'Test Details' and
also as
a tooltip in 'Statistics by Tag'. Pattern can
contain
characters '*' (matches anything) and '?'
(matches
- any char). If one tag matches multiple patterns,
its
- docs are catenated with spaces. Documentation can
- contain formatting similarly as with --doc
option.
+ any char). Documentation can contain formatting
+ similarly as with --doc option.
Examples: --tagdoc mytag:My_documentation
--tagdoc
regression:*See*_http://info.html
--tagdoc owner-*:Original_author
--tagstatlink pattern:link:title * Add external links
into 'Statistics by
Tag'. Pattern can contain characters '*' (matches
anything) and '?' (matches any char). Characters
- matching to wildcard expressions can be used in
the
- resulting link with syntax %N, where N is the
index
- of the match (starting from 1). In the 'title'
- underscores are automatically converted to
spaces.
+ matching to wildcard expressions can be used in
link
+ and title with syntax %N, where N is index of the
+ match (starting from 1). In title underscores are
+ automatically converted to spaces.
Examples: --tagstatlink
mytag:http://my.domain:Link
--tagstatlink
bug-*:http://tracker/id=%1:Bug_Tracker
--removekeywords all|passed Remove keyword data from generated
outputs.
=======================================
--- /src/robot/runner.py Fri Jun 17 07:00:12 2011
+++ /src/robot/runner.py Mon Jun 20 08:19:49 2011
@@ -186,19 +186,18 @@
Documentation is shown in 'Test Details' and
also as
a tooltip in 'Statistics by Tag'. Pattern can
contain
characters '*' (matches anything) and '?'
(matches
- any char). If one tag matches multiple patterns,
its
- docs are catenated with spaces. Documentation can
- contain formatting similarly as with --doc
option.
+ any char). Documentation can contain formatting
+ similarly as with --doc option.
Examples: --tagdoc mytag:My_documentation
--tagdoc
regression:*See*_http://info.html
--tagdoc owner-*:Original_author
--tagstatlink pattern:link:title * Add external links
into 'Statistics by
Tag'. Pattern can contain characters '*' (matches
anything) and '?' (matches any char). Characters
- matching to wildcard expressions can be used in
the
- resulting link with syntax %N, where N is the
index
- of the match (starting from 1). In the 'title'
- underscores are automatically converted to
spaces.
+ matching to wildcard expressions can be used in
link
+ and title with syntax %N, where N is index of the
+ match (starting from 1). In title underscores are
+ automatically converted to spaces.
Examples: --tagstatlink
mytag:http://my.domain:Link
--tagstatlink
bug-*:http://tracker/id=%1:Bug_Tracker
--listener class * A class for monitoring test execution. Gets
