]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - docs/en/User_documentation/Save_your_first_article.html
upgrade documentation
[github/wallabag/wallabag.git] / docs / en / User_documentation / Save_your_first_article.html
index a3a89efa5430c9a5f7e512e964a1a2795442c3ce..180691c5a0c857d71e19c0c8b798961422bea2e2 100644 (file)
@@ -5,7 +5,7 @@
 <!--[if gt IE 8]><!-->  <html class="no-js" lang="en"> <!--<![endif]-->
 <head>
     <title>Save your first article</title>
-    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+    <meta charset="utf-8">
     <meta name="description" content="Documentation for wallabag" />
     <meta name="author" content="Nicolas Lœuillet">
     <link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
@@ -14,7 +14,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
     <!-- Font -->
-    <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'>
+    
     <!-- CSS -->
     <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
 </head>
@@ -39,7 +39,7 @@
                     </div>
                     <div id="sub-nav-collapse" class="sub-nav-collapse">
                         <!-- Navigation -->
-                        <ul class="nav nav-list"><li><a href="../../en/Getting_started.html">Getting started</a></li><li><a href="../../en/Help_wallabag.html">Help wallabag</a></li><li class="open"><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="../../en/User_documentation/Download_and_install.html">Download and install</a></li><li class="active"><a href="../../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="../../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li><li><a href="#" class="aj-nav folder">Technical documentation</a><ul class="nav nav-list"></ul></li></ul>                                                    <div class="well well-sidebar">
+                        <ul class="nav nav-list"><li><a href="../../en/Getting_started.html">Getting started</a></li><li><a href="../../en/Help_wallabag.html">Help wallabag</a></li><li class="open"><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="../../en/User_documentation/Download_and_install.html">Download and install</a></li><li class="active"><a href="../../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="../../en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li><a href="../../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul>                                                    <div class="well well-sidebar">
 
                                 <!-- Links -->
                                 <a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>                                
                     <div class="content-page">
                         <article>
                                                             <div class="page-header sub-header clearfix">
-                                    <h1>Save your first article                                                                            </h1>
+                                    <h1>Save your first article                                                                                <a href="https://github.com/wallabag/documentation/blob/master/en/02_User_documentation/03_Save_your_first_article.md" class="btn">Fix this page</a>                                    </h1>
                                     <span style="float: left; font-size: 10px; color: gray;">
-                                        Sunday, October 26, 2014                                    </span>
+                                        Sunday, November 16, 2014                                    </span>
                                     <span style="float: right; font-size: 10px; color: gray;">
-                                        9:34 PM                                    </span>
+                                        9:22 PM                                    </span>
                                 </div>
                             
-                            <p>Once connected, you have many ways to save an article.</p>
+                            <h1>Save your first article</h1>
+<p>Once connected on wallabag, you have many ways to save an article.</p>
 <h2>From the web application</h2>
-<h2>Thanks to the bookmarklet</h2>
-<p><a href="http://en.wikipedia.org/wiki/Bookmarklet">From Wikipedia</a></p>
-<pre><code>A bookmarklet is a bookmark stored in a web browser that contains JavaScript commands to extend the browser's functionality.</code></pre>
+<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>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 Bag it ! 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>From your smartphone</h2>
+<h3>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>Android</h3>
 <h4>Installation and configuration</h4>
-<p>TODO</p>
-<h4>Saving an article</h4>
-<p>TODO</p>
+<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>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>Reading</h4>
-<p>TODO</p>
+<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>iOS</h3>
 <h4>Installation and configuration</h4>
 <p>TODO</p>
-<h4>Use</h4>
+<h4>Utilization</h4>
 <p>TODO</p>
 <h3>Windows Phone</h3>
 <h4>Installation and configuration</h4>
-<p>TODO</p>
-<h2>From your browser</h2>
+<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>From your web browser</h2>
 <h3>Firefox</h3>
-<p>TODO</p>
+<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>Chrome</h3>
-<p>TODO</p>                                                    </article>
+<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>                            
+                        </article>
                     </div>
                 </div>
             </div>