allura-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From john...@apache.org
Subject git commit: [#5040] Improve artifact linking help
Date Thu, 03 Jan 2013 21:56:22 GMT
Updated Branches:
  refs/heads/master d33f09857 -> 8a1e20452


[#5040] Improve artifact linking help


Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/8a1e2045
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/8a1e2045
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/8a1e2045

Branch: refs/heads/master
Commit: 8a1e204522d7bd492dbce901508a22f6e368aa7b
Parents: d33f098
Author: Tim Van Steenburgh <tvansteenburgh@gmail.com>
Authored: Thu Jan 3 15:45:36 2013 +0000
Committer: Cory Johns <johnsca@geek.net>
Committed: Thu Jan 3 21:56:07 2013 +0000

----------------------------------------------------------------------
 Allura/allura/templates/jinja_master/lib.html |   44 ++++++++++++++-----
 1 files changed, 32 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/8a1e2045/Allura/allura/templates/jinja_master/lib.html
----------------------------------------------------------------------
diff --git a/Allura/allura/templates/jinja_master/lib.html b/Allura/allura/templates/jinja_master/lib.html
index 239f66f..a8a5dbf 100644
--- a/Allura/allura/templates/jinja_master/lib.html
+++ b/Allura/allura/templates/jinja_master/lib.html
@@ -207,22 +207,42 @@ showing "[1]: http://url" won't show anything.</p>
 
 <div class="markdown_syntax_section hidden_in_modal md_ex_artlinks{{id}}">
 <h2 id="md_ex_artlinks{{id}}">Artifact Links</h2>
-<p>Any existing forge resource can be linked with surrounding square brackets ie [MyPage]
or [#123].</p>
+<p>Any forge resource (artifact) can be linked with surrounding square brackets, e.g.
[MyPage] or [#123].
+These artifact links can take several forms.</p>
 
-<p>Links to resources in other tools can be explicitly referenced by adding a tool
identifier prefix to the link.
-So for instance `[developerwiki:MyPage]` can refer to a wiki page in a `developerwiki` instance.
-You can also link to tickets with `[tickets:#123]` assuming there's a 123 ticket in a Tracker
instance mounted at `tickets`.
-The same is true for forums, or any of the other tools you have installed.
-You can even link to tickets in a subproject with `[subproject.tickets:#123]`.</p>
+<h3>Simple Links</h3>
+<p>Most commonly, the artifact identifier can simply be surrounded with square brackets.
Here are some examples:</p>
+<div class="codehilite"><pre>
+[MyWikiPage]       # Wiki - name of wiki page
+[#123]             # Tracker - ticket number
+[r10721]           # SVN - revision number
+[3b9d48]           # Git &amp; Mercurial - first 6 characters of revision hash
+[2012/02/my-post]  # Blog - post slug, including YYYY/MM/ prefix
+[a6d38f98]         # Discussion Thread - thread id
+[a6d38f98#42f8]    # Discussion Post - thread_id#post_id
+</pre></div><br>
+
+<h3>Two-part Links</h3>
+<p>To link to an artifact in a specific tool, use the form: `[tool:artifact]`, where
`tool` is the name of the tool
+as it appears in the URL. Two-part links are useful when you have two tools of the same type
installed. For example,
+let's say you have a 'bugs' tracker and a 'features' tracker installed, and you want to link
to the first ticket in each:</p>
+<div class="codehilite"><pre>
+[bugs:#1]
+[features:#1]
+</pre></div><br>
 
+<h3>Three-part Links</h3>
+<p>To link to an artifact in another project, use the form: `[project:tool:artifact]`,
where `project` is the name of the project
+as it appears in the URL. For example:
 <div class="codehilite"><pre>
-[MyPage]
-[developerwiki:MyPage]
-[#123]
-[tickets:#123]
-</pre></div>
+[allura:wiki:Home]
+</pre></div><br>
 
-<p>No example output is available for this one because it only works on real artifacts.
Try it in your project!</p>
+<p>To link to an artifact in a subproject, use the form: `[project/subproject:tool:artifact]`,
where `subproject` is the name of the subproject
+as it appears in the URL. For example:</p>
+<div class="codehilite"><pre>
+[allura/sub:code:3b9d48]
+</pre></div><br>
 </div>
 
 <div class="markdown_syntax_section hidden_in_modal md_ex_text{{id}}">


Mime
View raw message