Make phorkie search engine friendlier
[phorkie.git] / data / templates / help.htm
1 {% extends "base.htm" %}
2 {% block title %}phorkie help{% endblock %}
3
4 {% block content %}
5 <h1>Help on phorkie</h1>
6
7 <h2 id="remote-forking">Remote forking</h2>
8 <script type="text/javascript">
9 function registerHandler() {
10     navigator.registerProtocolHandler(
11         "web+fork",
12         "{{htmlhelper.fullUrl('fork-remote?remote_url=%s')}}",
13         "phorkie@"
14         + "{{htmlhelper.fullUrl()}}"
15             .replace(/https?:\/\//, '')
16             .replace(/\/$/, '')
17     );
18 }
19 </script>
20
21 <div class="row-fluid">
22  <div class="span8">
23   <p>
24    Phorkie allows cloning/forking of pastes on other servers
25    - other phorkie instances, github gists or simply any remote
26    git repository.
27   </p>
28   <p>
29    You can go to <a href="fork-remote">fork-remote</a> and enter the
30    URL of the paste on the other server.
31   </p>
32   <p>
33    It's way easier to simply click a "fork" button that automatically
34    takes you to this phorkie's remote paste page, prefilled with
35    the correct git URL.
36   </p>
37   <p>
38    To make this work, click the register button on the right.
39    It will register a "protocol handler" for "web+fork:"-URLs,
40    making phorkie chime in whenever a <tt>web+fork</tt> URL is clicked.
41   </p>
42  </div>
43  <div class="span4">
44   <a href="#" onclick="registerHandler(); return false;" class="btn">
45    register web+fork protocol handler
46   </a>
47  </div>
48 </div>
49
50 <h3 id="fork-check">Setup check</h3>
51 <p>
52  You need to activate public clone URLs in your config file.
53  Otherwise forking onto remote systems will not work.
54 </p>
55 {% if publicGitUrl %}
56 <div class="alert alert-success">
57  OK! A public git URL prefix is configured: <tt>{{publicGitUrl}}</tt>
58 </div>
59 {% else %}
60 <div class="alert alert-error">
61  Error! No public git URL prefix configured.
62 </div>
63 {% endif %}
64 {% endblock %}