-
Notifications
You must be signed in to change notification settings - Fork 2
/
faq.html
176 lines (166 loc) · 10.3 KB
/
faq.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
---
layout: page
title: FAQ
header: Frequently asked questions
description: Read through the frequently asked questions for the tmplat extension
keywords: tmplat, browser, extension, faq, frequently, asked, questions, answers, support
---
<div class="row-fluid">
<div class="span12">
<h2 id="writing-templates">How do I create my own templates?</h2>
<p>
Either open the <em>Guide</em> tab or click the link under the content text box within the <em>Templates</em> tab
on the options page to view the built-in guide for writing templates. If for some crazy reason you don't yet have
tmplat installed (can't understand why not) you can still learn about <a href="/guide/">writing templates here</a>.
</p>
<h2 id="special-pages">Why can't I use some features on certain pages?</h2>
<p>
Due to <a href="https://google.com/chrome">Chrome's</a> security implementations some features won't work on
certain pages. These pages include anything on the <a href="https://chrome.google.com/webstore">Chrome Web Store</a>
and any URL using something like the <code>chrome://</code> protocol as these are pages internal to the browser
(including pages specific to extensions/apps). In these cases keyboard shortcuts and variables extracted by
parsing the <abbr title="Document Object Model">DOM</abbr> <em>may</em> not work.
</p>
<h2 id="predefined-templates">Why can I not edit some templates?</h2>
<p>
The title and content fields of predefined templates (e.g. URL, Short, Anchor) are read-only and cannot be
changed. Also, you cannot delete these templates but you can still disable them like any other template to prevent
them from being accessible via the menus or keyboard shortcuts.
</p>
<h2 id="context-menu">What URL is used when I right-click on a page?</h2>
<p>
Well, that absolutely depends what it is you right-clicked on. tmplat currently checks what you clicked on in the
following priority;
</p>
<ol>
<li><strong>Link</strong> » Right-clicking on a link</li>
<li>
<strong>Media</strong> » Right-clicking on anything that has a <code>src</code> attribute (e.g. images)
</li>
<li><strong>Frame</strong> » Right-clicking anywhere within an internal frame</li>
<li>
<strong>Page</strong> » Right-clicking anywhere else on the page that doesn't match any of the above
</li>
</ol>
<h2 id="permissions">Why do you need this permission...?</h2>
<p>
We've seen people commenting a lot on extensions in the <a href="https://chrome.google.com/webstore">Chrome Web Store</a>
about the permissions required by that extension. Most of these comments are negative and usually posted by people
who do not fully understand the creation of Chrome extensions. For this reason we have <a href="/permissions">created a breakdown</a>
of the permissions used by tmplat. However, if you have trust issues and don't trust that summary why not <a href="https://github.com/tmplat-extension">look at the code</a>
and see for yourself.
</p>
<h2 id="languages">How can I get tmplat in a different language?</h2>
<p>
We are using an online system powered by <a href="http://crowdin.net">crowdin</a> to manage translations. Please
visit <a href="{{ site.translate_url }}">i18n.tmpl.at</a> if you want to help.
</p>
<h2 id="errors">Why am I seeing this error message...?</h2>
<p>
Due to the extent of customization options available for tmplat it's no surprise that something could go wrong. If
it does, it's nice to know what that error message means;
</p>
<ul>
<li>
<strong>"<em><template></em> output was empty"</strong> » This occurs if the template
being used either has no content or the result after being rendered is empty. If you think about it, you can't
exactly copy an empty string to the clipboard can you? Go on and try, We'll wait... We told you so. What would
you expect to paste after all?
</li>
<li>
<strong>"The URL is not properly encoded"</strong> » This occurs if you are attempting to use
tmplat on a URL that is not properly encoded. This is due to the underlying technology used for extract the
information on each URL (e.g. domain, port, parameters). This should be extremely rare and could probably be
impossible to occur.
</li>
<li>
<strong>"An error occurred while collecting information"</strong> » This occurs when an
unexpected error occurred when building up the template data. Please can you <a href="{{ site.support_url }}">raise a ticket</a>
while providing as much information as possible so we can investigate and fix it.
</li>
<li>
<strong>"An error occurred while deriving the activated template"</strong> » This occurs only in
exceptional cases when the activated template cannot be found. Please can you <a href="{{ site.support_url }}">raise a ticket</a>
while providing as much information as possible so we can investigate and fix it.
</li>
<li>
<strong>"An error occurred while requesting information"</strong> » This occurs if the extension
receives an invalid request. This could either be a bug or another extension sending bad requests.
</li>
<li>
<strong>"There was a problem parsing an expression"</strong> » This occurs if the template
contained an invalid <a href="http://www.w3.org/TR/selectors-api/">CSS selector</a> for a <code>select*</code>
operation or <a href="http://www.w3.org/TR/xpath/">XPath expression</a> for an <code>xpath*</code> operation.
</li>
<li>
<strong>"<em><template></em> could not be copied"</strong> » This occurs when an
unexpected error occurred somewhere during the process. Please can you <a href="{{ site.support_url }}">raise a ticket</a>
while providing as much information as possible so we can investigate and fix it.
</li>
<li>
<strong>"<em><shortener></em> has not been configured correctly"</strong> » This occurs if
the active URL shortener requires a target URL to be specified and this has not been done (e.g. <a href="http://yourls.org">YOURLS</a>).
</li>
<li>
<strong>"<em><shortener></em> experienced a problem while shortening <em><url></em>"</strong>
» This occurs if the tmplat is unable to get a successful response from the active URL shortener. This can
be for multiple reasons but you should check your configuration for that service first.
</li>
<li>
<strong>"<em><shortener></em> experienced a problem"</strong> » This occurs when an
unexpected error occurred during the request to the active URL shortener. Please can you <a href="{{ site.support_url }}">raise a ticket</a>
while providing as much information as possible so we can investigate and fix it.
</li>
</ul>
<h2 id="updating">Why isn't Chrome updating tmplat?</h2>
<p>
<a href="https://google.com/chrome">Chrome's</a> update frequency is slightly unpredictable (at least in our eyes)
and we've found that sometimes it updates my extensions as soon as an update becomes available but we've also seen
it some extensions not getting updated even when using the browser for hours. However, there is a little-known way
(at least to non-developers) to force it to update your extensions;
</p>
<ul>
<li>Open the Extensions page via on of the following methods;</li>
<ul>
<li>Main Menu: Tools > Extensions</li>
<li>Address Bar: <code>chrome://extensions</code></li>
<li>Right-click tmplat's toolbar icon and select <em>Manage extensions...</em></li>
</ul>
<li>Ensure that <em>Developer mode</em> in the top right of the page is checked.</li>
<li>Click the <em>Update extensions now</em> button, et viola!</li>
</ul>
<p>
Your extensions should now be receiving updates (where available) and you may notice some extensions turning off
and on again. If an extension requires any additional permissions that you have not already authorized it will not
be turned back on until you have granted these permissions.
</p>
<h2 id="oauth">Why am I no longer logged in to my URL shortener accounts?</h2>
<p>
This section is only relevant for versions updating to <a href="/changes#1.0.1">1.0.1</a> from a previous version
as the <a href="http://oauth.net">OAuth</a> implementation was upgraded to 2.0 in this release.
</p>
<p>
Unfortunately, the authorization provided by these services were not compatible with the latest version of this
framework so you'll need to re-authorize each affected service in order to associate the links to your account.
The API key and username for the <a href="http://bit.ly">bit.ly</a> service has been replaced with the new
login/logout functionality for easier use and improved security.
</p>
<h2 id="saving">Why are the changes to my templates not being saved?</h2>
<p>
This section is only relevant for versions before <a href="/changes#1.0.0">1.0.0</a> where changes are now saved
automatically on the options page.
</p>
<p>
On the options page be sure that you always press <em>Save & Close</em> button whenever you want to save your
changes. This applies even when you are only adding, deleting, reordering and importing templates.
</p>
<h2 id="url-copy">What happened to <em>URL Copy</em>?</h2>
<p>
This extension was previously named <em>URL Copy</em> but was renamed to <em>Template</em> in version <a href="/changes#0.2.0.0">0.2.0.0</a>
as it had evolved far beyond just doing that so the name no longer did it justice. <em>Template</em> provided a
much more accurate description of the functionality and power of this extension. However, as of version <a href="/changes#2.0.0">2.0.0</a>,
the extension has been rebranded as <em>tmplat</em>. We found this more unique and memorable, not to mention much
easier to find when searching.
</p>
</div>
</div>