mirror of
https://github.com/wallabag/wallabag.git
synced 2024-06-02 13:29:22 +00:00
251 lines
20 KiB
HTML
251 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
<title>wallabag - Save your first article</title>
|
|
|
|
<link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
|
|
<link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
|
|
<link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
|
|
<link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
|
|
</head>
|
|
<body>
|
|
|
|
<header class="navbar navbar-default navbar-fixed-top">
|
|
|
|
<a class="navbar-brand" href="http://doc.wallabag.org/">
|
|
wallabag
|
|
<small class="hidden-xs hidden-sm">
|
|
Save your first article
|
|
</small>
|
|
</a>
|
|
<a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
|
|
|
|
|
|
</header>
|
|
|
|
<main class="container-fluid">
|
|
<div class="row">
|
|
|
|
|
|
<nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
|
|
|
|
<ul class="nav nav-pills nav-stacked">
|
|
|
|
<h4 class="text-muted">
|
|
|
|
</h4>
|
|
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/index.html">
|
|
Getting started
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/help_wallabag.html">
|
|
Help us
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="text-muted">
|
|
Administrator
|
|
</h4>
|
|
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
|
|
Download and installation
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Administrator/update.html">
|
|
Update wallabag
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
|
|
Hidden options
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
|
|
Multi users
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="text-muted">
|
|
User
|
|
</h4>
|
|
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li class="test active">
|
|
<a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
|
|
Save your first article
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/User/read_an_article.html">
|
|
Read an article
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/User/organize_articles.html">
|
|
Organize articles
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
|
|
Configure wallabag
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/User/search.html">
|
|
Search
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/User/epub_conversion.html">
|
|
ePub conversion
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/User/issue_with_article.html">
|
|
Issue with article
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/User/rss_feed.html">
|
|
RSS feed
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/User/import_export.html">
|
|
Import export
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
|
|
Framabag account creation
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="text-muted">
|
|
Developer
|
|
</h4>
|
|
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
|
|
Write config files
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
|
|
Create a new theme
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Developer/git_repo.html">
|
|
Git repository
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Developer/docker.html">
|
|
Docker
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Developer/vagrant.html">
|
|
Vagrant
|
|
</a>
|
|
</li>
|
|
<li class="test ">
|
|
<a href="http://doc.wallabag.org/en/Developer/v2.html">
|
|
wallabag v2 / symfony2
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
|
|
<section class="col-lg-10">
|
|
<h1 id="save-your-first-article">Save your first article</h1>
|
|
<p>Once connected on wallabag, you have many ways to save an article.</p>
|
|
<h2 id="from-the-web-application">From the web application</h2>
|
|
<p>Let's see first how to do from the web application. In the menu, you have a link <strong>save a link</strong>. Clicking on it, a form shows up: you simply have to type the web adress of the article you want to save.</p>
|
|
<p>Confirm to store the content of the article.</p>
|
|
<p>By default, only the text is saved. If you want to store a copy of the images on your server, you have to enable the setting <em>DOWNLOAD_PICTURES</em>. Read the chapter on hidden options for more information.</p>
|
|
<h2 id="from-the-bookmarklet">From the bookmarklet</h2>
|
|
<p>From <a href="http://fr.wikipedia.org/wiki/Bookmarklet">Wikipedia's definition</a></p>
|
|
<blockquote>
|
|
<p>A bookmarklet is a <a href="http://en.wikipedia.org/wiki/Internet_bookmark">bookmark</a> stored in a <a href="http://en.wikipedia.org/wiki/Web_browser">web browser</a> that contains <a href="http://en.wikipedia.org/wiki/JavaScript">JavaScript</a>commands to extend the browser's functionality.</p>
|
|
<p>Bookmarklets are unobtrusive scripts stored as the URL of a bookmark in a web browser or as a hyperlink on a web page.</p>
|
|
<p>When clicked, a bookmarklet performs some function, one of a wide variety such as a search query or data extraction. Bookmarklets are usually <a href="http://en.wikipedia.org/wiki/Computer_program">JavaScript programs</a>.</p>
|
|
</blockquote>
|
|
<p>From the wallabag's menu, click on <strong>settings</strong>. On the first part of this page, we have listed all the ways to save an article. You'll find the bookmarklet (it's the <code>Bag it!</code> link) to drag and drop in the bookmarks bar of your web browser.
|
|
From now on, when you want to save the article you are browsing, you just have to click on this bookmarklet and the article will be automatically saved.</p>
|
|
<h2 id="from-your-smartphone">From your smartphone</h2>
|
|
<h3 id="above-all-else">Above all else</h3>
|
|
<p>To use a smartphone application, you have to enable RSS feeds from the settings panel of wallabag. Then some information will be displayed, like your security tokken. Read the chapter on RSS feeds for more information.</p>
|
|
<h3 id="android">Android</h3>
|
|
<h4 id="installation-and-configuration">Installation and configuration</h4>
|
|
<p>You can download the android application from the <a href="https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche">Google Play Store</a> and from <a href="https://f-droid.org/app/fr.gaulupeau.apps.InThePoche">F-droid</a>. It's the exact same application on those two stores.</p>
|
|
<p>Once installed, start the application, go to the <strong>settings</strong> part et fill in the <strong>URL (complete address of your wallabag installation or your Framabag account)</strong> and <strong>User ID (in most cases, you'll have to put 1)</strong> fields. If you have created multiple accounts from wallabag, you will have to to fill the user account you want to connect to your application and your security <strong>Token</strong> (enter properly all the token's letters as seen in the settings part of wallabag).</p>
|
|
<h4 id="saving-of-an-article">Saving of an article</h4>
|
|
<p>Now that everything is correctly set up, as soon as you browse on your smartphone's web browser, you can share an article in wallabag at any time from the <strong>Share</strong> menu: you'll find a <strong>Bag it!</strong> entry which will add your article in wallabag.</p>
|
|
<h4 id="reading">Reading</h4>
|
|
<p>When you open the application, click on Synchronize: your recently saved articles will be downloaded on your smartphone.</p>
|
|
<p>You don't need an internet connection anymore: click on <strong>List articles</strong> to start your reading.</p>
|
|
<p>At the end of each article, a <strong>Mark as read</strong> button allows you to archive the article.</p>
|
|
<p>To date, the synchronisation occurs in one direction (from wallabag to the application), thus preventing mark as read an article on wallabag from your smartphone.</p>
|
|
<h3 id="ios">iOS</h3>
|
|
<h4 id="installation-and-configuration-1">Installation and configuration</h4>
|
|
<p>You can download the iOS application from the <a href="https://itunes.apple.com/app/id828331015">AppStore</a>.</p>
|
|
<p>Once installed, configure the app by filling following fields inside the settings: the <strong>URL (complete address of your wallabag installation or your Framabag account)</strong> and <strong>User ID (in most cases, you'll have to put 1)</strong> field. If you have created multiple accounts from wallabag, you will have to to fill the user account you want to connect to your application and your security <strong>Token</strong> (enter properly all the token's letters as seen in the settings part of wallabag).</p>
|
|
<h4 id="usage">Usage</h4>
|
|
<p>If the app is configured correctly, the app will automatically download the articles from your wallabag (use <strong>pull-to-refresh</strong> to trigger this update manually). Once an article is downloaded, it'll be available offline from your app.</p>
|
|
<p>Unfortunately you can only locally mark an article as read (it will not synchronise to your online wallabag).</p>
|
|
<h3 id="saving-articles">Saving articles</h3>
|
|
<p>If you're browsing a website and want to add the current article to your wallabag, simply tap the <strong>Share</strong>-button and select <strong>Bag it!</strong> (if you don't find the wallabag icon, have a look in the <strong>more</strong>-menu). If everything is set up correctly, your article will be saved (you may have to login from time to time).</p>
|
|
<h3 id="windows-phone">Windows Phone</h3>
|
|
<h4 id="installation-and-configuration-2">Installation and configuration</h4>
|
|
<p>You can download the Windows Phone application from the <a href="http://www.windowsphone.com/fr-fr/store/app/wallabag/ff890514-348c-4d0b-9b43-153fff3f7450">Windows Store</a> or directly from your smartphone's Store.</p>
|
|
<p>Once installed, the application will show you a notification on the first launch, asking the configuration of your wallabag server. Go to the <strong>Settings</strong> part of the application by pressing the three dots menu at the bottom of the screen, then fill in the <strong>URL (complete address of your wallabag installation or your Framabag account)</strong> and <strong>User ID (in most cases, you'll have to put 1)</strong> fields.</p>
|
|
<p>If you have created multiple accounts from wallabag, you will have to to fill the user account you want to connect to your application and your security <strong>Token</strong> (enter properly all the token's letters as seen in the setting part of wallabag).</p>
|
|
<h2 id="from-your-web-browser">From your web browser</h2>
|
|
<h3 id="firefox">Firefox</h3>
|
|
<p>Download the Firefox add-on on <a href="https://addons.mozilla.org/firefox/addon/wallabag/">addons.mozilla.org</a> and install it like any other Firefox add-on.</p>
|
|
<p>In the add-on's settings, fill the complete URL of your installation of wallabag or your Framabag account.</p>
|
|
<p>Personalize the Firefox toolbar to add wallabag (<strong>W</strong> icon). When you find an article you want to save, click on this icon: a new window will open to add the article and will close itself automatically.</p>
|
|
<h3 id="chrome">Chrome</h3>
|
|
<p>Download the Chrome add-on <a href="https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj">on the dedicated website</a> and install it like any other Chrome add-on.</p>
|
|
<p>In the add-on's settings, fill the complete URL of your installation of wallabag or your Framabag account.</p>
|
|
<p>During the addon's installation, a new icon appear in Chrome toolbar (a <strong>W</strong> icon). When you find an article you want to save, click on this icon: a popup will appear to confirm that your article has been saved.</p>
|
|
</section>
|
|
|
|
</div>
|
|
</main>
|
|
|
|
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
|
|
<script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
|
|
<script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
|
|
|
|
<script>
|
|
$(function() {
|
|
$("section>h1").wrap('<div class="page-header" />');
|
|
// Syntax highlighting
|
|
hljs.initHighlightingOnLoad();
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|