2020-11-16 20:33:18 +02:00
<!doctype html>
< html >
<!--
!!! WARNING !!!
This file was auto-generated from readme/clipper.md and any manual change
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/dev/readme/clipper.md
-->
< head >
< title > Joplin Web Clipper | Joplin< / title >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "https://joplinapp.org/css/bootstrap.min.css" >
< link rel = "shortcut icon" type = "image/x-icon" href = "https://joplinapp.org/favicon.ico" >
<!-- <link rel="stylesheet" href="https://joplinapp.org/css/fontawesome - all.min.css"> -->
< link rel = "stylesheet" href = "https://joplinapp.org/css/fork-awesome.min.css" >
< script src = "https://joplinapp.org/js/jquery-3.2.1.slim.min.js" > < / script >
< style >
body {
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
td, th {
padding: .8em;
border: 1px solid #ccc;
}
.page-markdown table pre,
.page-markdown table blockquote {
margin-bottom: 0;
}
.page-markdown table pre,
.page-markdown table blockquote {
margin-bottom: 0;
}
.page-markdown table pre {
background-color: rgba(0,0,0,0);
border: none;
margin: 0;
padding: 0;
}
h1, h2 {
border-bottom: 1px solid #eaecef;
padding-bottom: 0.3em;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-weight: 600;
font-size: 2em;
margin-bottom: 16px;
}
h2 {
font-size: 1.6em;
}
h3 {
font-size: 1.3em;
}
code {
color: black;
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
2021-01-03 17:55:47 +02:00
/* word-break: break-all; */
2020-11-16 20:33:18 +02:00
}
pre code {
border: none;
}
pre {
font-size: .85em;
}
blockquote {
font-size: 1em;
color: #555;
};
#toc ul {
margin-bottom: 10px;
}
#toc > ul > li {
margin-bottom: 10px;
}
#toc {
padding-bottom: 1em;
}
.title {
display: flex;
align-items: center;
}
.title-icon {
display: flex;
height: 1em;
}
.title-text {
display: flex;
font-weight: normal;
margin-bottom: .2em;
margin-left: .5em;
}
.sub-title {
font-weight: normal;
}
.container {
background-color: white;
padding: 0;
box-shadow: 0 10px 20px #888888;
}
table.screenshots {
margin-top: 2em;
margin-bottom: 2em;
}
table.screenshots th {
height: 3em;
text-align: center;
}
table.screenshots th,
table.screenshots td {
border: 1px solid #C2C2C2;
}
img[align="left"] {
margin-right: 10px;
margin-bottom: 10px;
}
.mobile-screenshot {
height: 40em;
padding: 1em;
}
.cli-screenshot-wrapper {
background-color: black;
vertical-align: top;
padding: 1em 2em 1em 1em;
}
.cli-screenshot {
font-family: "Monaco", "Inconsolata", "CONSOLAS", "Deja Vu Sans Mono", "Droid Sans Mono", "Andale Mono", monospace;
background-color: black;
color: white;
border: none;
}
.cli-screenshot .prompt {
color: #48C2F0;
}
.top-screenshot {
margin-top: 2em;
text-align: center;
}
.header {
position: relative;
padding-left: 2em;
padding-right: 2em;
padding-top: 1em;
padding-bottom: 1em;
color: white;
background-color: #2B2B3D;
}
.header a h1 {
color: white;
}
.header a:hover {
text-decoration: none;
}
.content {
padding-left: 2em;
padding-right: 2em;
padding-bottom: 2em;
padding-top: 2em;
}
.forkme {
position: absolute;
right: 0;
top:0;
}
.nav-wrapper {
position: relative;
width: inherit;
}
.nav {
background-color: black;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
top: 0;
width: inherit;
box-shadow: 0 0 10px #000000;
}
.nav a {
color: white;
display: inline-block;
padding: .6em .9em .6em .9em;
}
.nav ul {
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
padding: 0;
}
.nav li.selected {
background-color: #222;
font-weight: bold;
}
.nav-right {
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
}
.nav-right .small-share-btn {
display: none;
}
.footer {
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
font-size: .9em;
}
a.heading-anchor {
display: inline-block;
opacity: 0;
width: 1.3em;
font-size: 0.7em;
margin-left: 0.4em;
line-height: 1em;
text-decoration: none;
transition: opacity 0.3s;
}
a.heading-anchor:hover,
h1:hover a.heading-anchor,
h2:hover a.heading-anchor,
h3:hover a.heading-anchor,
h4:hover a.heading-anchor,
h5:hover a.heading-anchor,
h6:hover a.heading-anchor {
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
border-top: 1px solid #d4d4d4;
margin-top: 30px;
padding-top: 25px;
}
@media all and (min-width: 400px) {
.nav-right .share-btn {
display: inline-block;
}
.nav-right .small-share-btn {
display: none;
}
}
< / style >
< / head >
< body >
< div class = "container root page-clipper" >
< div class = "header" >
< a class = "forkme" href = "https://github.com/laurent22/joplin" > < img src = "https://joplinapp.org/images/ForkMe.png" / > < / a >
< a href = "https://joplinapp.org" > < h1 class = "title" > < img class = "title-icon" src = "https://joplinapp.org/images/Icon512.png" > < span class = "title-text" > Joplin< / span > < / h1 > < / a >
< p class = "sub-title" > An open source note taking and to-do application with synchronisation capabilities< / p >
< / div >
< div class = "nav-wrapper" >
< div class = "nav" >
< ul >
< li class = "" > < a href = "https://joplinapp.org/" title = "Home" > < i class = "fa fa-home" > < / i > < / a > < / li >
< li > < a href = "https://discourse.joplinapp.org" title = "Forum" > Forum< / a > < / li >
< li > < a class = "help" href = "#" title = "Menu" > Menu< / a > < / li >
<!-- <li><a class="gsod" href="https://joplinapp.org/gsod2020/" title="Google Season of Docs 2020">GSoD 2020</a></li> -->
< / ul >
< div class = "nav-right" >
<!--
< iframe class = "share-btn" src = "https://www.facebook.com/plugins/share_button.php?href=http%3A%2F%2Fjoplinapp.org&layout=button&size=small&mobile_iframe=true&width=60&height=20&appId" width = "60" height = "20" style = "border:none;overflow:hidden" scrolling = "no" frameborder = "0" allowTransparency = "true" > < / iframe >
< iframe class = "share-btn" src = "https://platform.twitter.com/widgets/tweet_button.html?url=http%3A%2F%2Fjoplinapp.org" width = "62" height = "20" title = "Tweet" style = "border: 0; overflow: hidden;" > < / iframe >
-->
< iframe class = "share-btn share-btn-github" src = "https://ghbtns.com/github-btn.html?user=laurent22&repo=joplin&type=star&count=true" frameborder = "0" scrolling = "0" width = "100px" height = "20px" > < / iframe >
< / div >
< / div >
< / div >
< div class = "content" >
< div id = "toc" > < ul >
< li >
< p > Applications< / p >
< ul >
< li > < a href = "https://joplinapp.org/desktop/" > Desktop application< / a > < / li >
< li > < a href = "https://joplinapp.org/mobile/" > Mobile applications< / a > < / li >
< li > < a href = "https://joplinapp.org/terminal/" > Terminal application< / a > < / li >
< li > < a href = "https://joplinapp.org/clipper/" > Web Clipper< / a > < / li >
< / ul >
< / li >
< li >
< p > Support< / p >
< ul >
< li > < a href = "https://discourse.joplinapp.org" > Joplin Forum< / a > < / li >
< li > < a href = "https://joplinapp.org/markdown/" > Markdown Guide< / a > < / li >
< li > < a href = "https://joplinapp.org/e2ee/" > How to enable end-to-end encryption< / a > < / li >
< li > < a href = "https://joplinapp.org/conflict/" > What is a conflict?< / a > < / li >
< li > < a href = "https://joplinapp.org/debugging/" > How to enable debug mode< / a > < / li >
2020-12-10 00:01:02 +02:00
< li > < a href = "https://joplinapp.org/rich_text_editor/" > About the Rich Text editor limitations< / a > < / li >
2020-11-16 20:33:18 +02:00
< li > < a href = "https://joplinapp.org/faq/" > FAQ< / a > < / li >
< / ul >
< / li >
< li >
< p > Joplin API - Get Started< / p >
< ul >
< li > < a href = "https://joplinapp.org/api/overview/" > Joplin API Overview< / a > < / li >
< li > < a href = "https://joplinapp.org/api/get_started/plugins/" > Plugin development< / a > < / li >
< li > < a href = "https://joplinapp.org/api/tutorials/toc_plugin/" > Plugin tutorial< / a > < / li >
< / ul >
< / li >
< li >
< p > Joplin API - References< / p >
< ul >
< li > < a href = "https://joplinapp.org/api/references/plugin_api/classes/joplin.html" > Plugin API< / a > < / li >
< li > < a href = "https://joplinapp.org/api/references/rest_api/" > Data API< / a > < / li >
< li > < a href = "https://joplinapp.org/api/references/plugin_manifest/" > Plugin manifest< / a > < / li >
< li > < a href = "https://joplinapp.org/api/references/plugin_loading_rules/" > Plugin loading rules< / a > < / li >
< / ul >
< / li >
< li >
< p > Development< / p >
< ul >
< li > < a href = "https://github.com/laurent22/joplin/blob/dev/BUILD.md" > How to build the apps< / a > < / li >
< li > < a href = "https://joplinapp.org/spec/e2ee/" > End-to-end encryption spec< / a > < / li >
< li > < a href = "https://joplinapp.org/spec/history/" > Note History spec< / a > < / li >
< li > < a href = "https://joplinapp.org/spec/sync_lock/" > Sync Lock spec< / a > < / li >
< li > < a href = "https://joplinapp.org/spec/plugins/" > Plugin Architecture spec< / a > < / li >
< li > < a href = "https://joplinapp.org/spec/search_sorting/" > Search Sorting spec< / a > < / li >
2021-01-03 17:55:47 +02:00
< li > < a href = "https://joplinapp.org/spec/server_file_url_format/" > Server: File URL Format< / a > < / li >
< li > < a href = "https://joplinapp.org/spec/server_delta_sync/" > Server: Delta Sync< / a > < / li >
2020-11-16 20:33:18 +02:00
< / ul >
< / li >
< li >
< p > Google Summer of Code 2020< / p >
< ul >
< li > < a href = "https://joplinapp.org/gsoc2020/index/" > Google Summer of Code 2020< / a > < / li >
< li > < a href = "https://joplinapp.org/gsoc2020/ideas/" > Project Ideas< / a > < / li >
< / ul >
< / li >
< li >
< p > About< / p >
< ul >
< li > < a href = "https://joplinapp.org/changelog/" > Changelog (Desktop App)< / a > < / li >
< li > < a href = "https://joplinapp.org/changelog_cli/" > Changelog (CLI App)< / a > < / li >
< li > < a href = "https://joplinapp.org/stats/" > Stats< / a > < / li >
< li > < a href = "https://joplinapp.org/donate/" > Donate< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "main" >
< h1 > Joplin Web Clipper< a name = "joplin-web-clipper" href = "#joplin-web-clipper" class = "heading-anchor" > 🔗< / a > < / h1 >
< p > The Web Clipper is a browser extension that allows you to save web pages and screenshots from your browser. To start using it, open the Joplin desktop application, go to the < strong > Web Clipper Options< / strong > and follow the instructions.< / p >
< img src = "https://joplinapp.org/images/WebExtensionScreenshot.png" style = "max-width: 50%; border: 1px solid gray;" >
< h1 > Troubleshooting the web clipper service< a name = "troubleshooting-the-web-clipper-service" href = "#troubleshooting-the-web-clipper-service" class = "heading-anchor" > 🔗< / a > < / h1 >
< p > The web clipper extension and the Joplin application communicates via a service, which is started by the Joplin desktop app.< / p >
2021-01-11 14:19:14 +02:00
< p > However certain things can interfere with this service and prevent it from being accessible or from starting. If something does not work, check the following:< / p >
2020-11-16 20:33:18 +02:00
< ul >
< li > Check that the service is started. You can check this in the Web clipper options in the desktop app.< / li >
< li > Check that the port used by the service is not blocked by a firewall. You can find the port number in the Web clipper options in the desktop Joplin application.< / li >
< li > Check that no proxy is running on the machine, or make sure that the requests from the web clipper service are filtered and allowed. For example < a href = "https://github.com/laurent22/joplin/issues/561#issuecomment-392220191" > https://github.com/laurent22/joplin/issues/561#issuecomment-392220191< / a > < / li >
< / ul >
< p > If none of this work, please report it on the < a href = "https://discourse.joplinapp.org/" > forum< / a > or < a href = "https://github.com/laurent22/joplin/issues" > GitHub issue tracker< / a > < / p >
< h1 > Debugging the extension< a name = "debugging-the-extension" href = "#debugging-the-extension" class = "heading-anchor" > 🔗< / a > < / h1 >
< h2 > In Chrome< a name = "in-chrome" href = "#in-chrome" class = "heading-anchor" > 🔗< / a > < / h2 >
< p > To provide as much information as possible when reporting an issue, you may provide the log from the various Chrome console.< / p >
< p > To do so, first enable developer mode in < a href = "chrome://extensions/" > chrome://extensions/< / a > < / p >
< ul >
< li > Debugging the popup: Right-click on the Joplin extension icon, and select " Inspect popup" .< / li >
< li > Debugging the background script: In < code > chrome://extensions/< / code > , click on " Inspect background script" .< / li >
< li > Debugging the content script: Press Ctrl+Shift+I to open the console of the current page.< / li >
< / ul >
< h2 > In Firefox< a name = "in-firefox" href = "#in-firefox" class = "heading-anchor" > 🔗< / a > < / h2 >
< ul >
< li > Open < a href = "about:debugging" > about:debugging< / a > in Firefox.< / li >
< li > Make sure the checkox " Enable add-on debugging" is ticked.< / li >
< li > Scroll down to the Joplin Web Clipper extension.< / li >
< li > Click on " Debugging" - that should open a new console window.< / li >
< / ul >
< p > Also press F12 to open the regular Firefox console (some messages from the Joplin extension can go there too).< / p >
< p > Now use the extension as normal and replicate the bug you're having.< / p >
< p > Copy and paste the content of both the debugging window and the Firefox console, and post it to the < a href = "https://discourse.joplinapp.org/" > forum< / a > .< / p >
< h1 > Using the Web Clipper service< a name = "using-the-web-clipper-service" href = "#using-the-web-clipper-service" class = "heading-anchor" > 🔗< / a > < / h1 >
< p > The Web Clipper service can be used to create, modify or delete notes, notebooks, tags, etc. from any other application. It exposes an API with a number of methods to manage Joplin's data. For more information about this API and how to use it, please check the < a href = "https://joplinapp.org/api/references/rest_api/" > Joplin API documentation< / a > .< / p >
< div class = "bottom-links" >
< a href = "https://github.com/laurent22/joplin/blob/dev/readme/clipper.md" >
< i class = "fa fa-github" > < / i > Improve this doc
< / a >
< / div >
< script >
function stickyHeader() {
return; // Disabled
if ($(window).scrollTop() > 179) {
$('.nav').addClass('sticky');
} else {
$('.nav').removeClass('sticky');
}
}
$('#toc').hide();
$('.help').click(function(event) {
event.preventDefault();
$('#toc').show();
});
$(window).scroll(function() {
stickyHeader();
});
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-103586105-1', 'auto');
ga('send', 'pageview');
< / script >
< / div > < / div >
< div class = "footer" >
2021-01-03 17:55:47 +02:00
Copyright (C) 2016-2021 Laurent Cozic
2020-11-16 20:33:18 +02:00
< / div >
< / body >
< / html >
