Sebastian Wiesner avatar Sebastian Wiesner committed 7997ffd

Document classes used by issuetracker extension to style HTML output

Comments (0)

Files changed (1)

issuetracker/doc/index.rst

    instance, you might use ``:issue:`{issue.title} (#{issue.id}) <10>``` to use
    the title and the id of the issue ``10`` as reference title.
 
-The extension fetches information about referenced issues from the configured
-tracker, and so marks closed issues by striking them through in HTML output.
-Moreover you can use parts of this issue information (e.g. the issue title) in
-the reference title.
+Information about the issue (like the title) is retrieved from the configured
+issue tracker.  Aside of providing it for reference titles, the extension also
+uses this information to mark closed issues in HTML output by striking the
+reference text through.  For this purpose, a stylesheet is added to the
+generated HTML.
+
+You can provide your own styles for issue references by adding them to the
+``.xref.issue`` and ``.xref.issue.closed`` selectors (the latter are closed
+issues).  For instance, the following stylesheet uses red color for open, and
+green color for closed issues::
+
+   .xref.issue {
+       color: green;
+   }
+
+   .xref.issue.closed {
+       color: red;
+   }
+
 
 Issue ids in plain text
 ~~~~~~~~~~~~~~~~~~~~~~~
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.