Readme and build scripts updated

.hgignore

@@ -9,3 +9,4 @@ packages/**
 WebLibraryDownloader/WebLibraryDownloader.csproj.user
 WebLibraryDownloader/obj/**
 WebLibraryDownloader/bin/**
+WebLibrary-x64.zip

BuildAndPack.bat

@@ -8,6 +8,8 @@ rmdir /q /s Release
 del WebLibrary-x64.zip
 md Release
 md Release\locales
+md Release\WebLibraryExt
+md Release\WebLibraryExt\icons
 
 copy WebLibraryApp\bin\x64\Release\locales\en-US.pak Release\locales\
 copy WebLibraryApp\bin\x64\Release\cef.pak Release\
@@ -37,6 +39,9 @@ copy WebLibraryDownloader\SingleFile-master.zip Release\
 copy WebLibraryDownloader\bin\Release\WebLibraryDownloader.exe Release\
 copy WebLibraryDownloader\bin\Release\WebLibraryDownloader.exe.config Release\
 
+copy WebLibraryExt\*.* Release\WebLibraryExt\
+copy WebLibraryExt\icons\*.* Release\WebLibraryExt\icons\
+
 copy SetupWebLibrary.bat Release\
 
 powershell.exe -nologo -noprofile -command "& { Add-Type -A 'System.IO.Compression.FileSystem'; [IO.Compression.ZipFile]::CreateFromDirectory('Release', 'WebLibrary-x64.zip'); }"

Readme.md

@@ -16,12 +16,35 @@ These are the things you can do:
 WebLibrary supports keyboard shortcuts, so many basic operations can be perfomed quickly and without annoying mouse clicks. The content of the library is updated automatically, so when files appear or get deleted in the library folder, the main applicaton screen is updated accordingly.
 
 ## Content saving and synchronization
-WebLibrary does not yet provide its own capabilities for saving web pages. For now, I recommend using a great browser extension [SingleFile](https://github.com/gildas-lormeau/SingleFile). To access your documents from different devices, simply place your library into a cloud-synchronized folder.
+To facilitate content saving, WebLibrary provides two additional tools: a Chrome-compatible browser extension for saving web pages, and a GUI app for choosing the current save location. To access your documents from different devices, simply place your library into a cloud-synchronized folder.
 
 ## Alternatives
 There are other, much more function-rich systems like [TagSpaces](https://www.tagspaces.org/) or [myBase](http://www.wjjsoft.com/mybase.html). I tried using them several times on daily basis, but always had to face with problems like poor page rendering, lack of hotkeys or synchronization issues. However, your experience might be very different.
 
+## Setup
+WebLibrary is being developed in very scarce periods of free time and thus heavily relies on third-party components. Unfortunately, it means that its setup is a relatively complicated process at the moment. Note also that only a 64-bit Windows build is currently available.
+
+### Prerequisites
+1. [Node.js](https://nodejs.org/en/) runtime.
+1. Any Chrome-compatible web browser.
+1. [External Application Button](https://chrome.google.com/webstore/detail/external-application-butt/bifmfjgpgndemajpeeoiopbeilbaifdo) Chrome extension. Make sure to click the extension button once and install the "native client" component as instructed.
+
+### Installing WebLibrary and WebLibraryDownloader
+1. Depack `WebLibrary-x64.zip` into any folder of your choice.
+1. Add this folder into your `PATH` environment variable.
+1. Run `SetupWebLibrary.bat` script to install additional dependencies.
+1. Run `WebLibraryApp.exe` and choose the location of your library folder. As noted above, it is a good idea to keep it in a cloud-synchronized place.
+1. Run `WebLibraryDownloader.exe` and choose the library folder once again. Also provide a path to your Chrome-compatible browser.
+
+### Installing the Chrome Extension
+1. Open `chrome://extensions` location in your browser.
+1. Enable "Developer mode" in the top-right corner.
+1. Press "Load unpacked" button and choose `WebLibraryExt` folder inside your installation path. Extension button should appear in the browser toolbar.
+
 ## Tech details
 WebLibrary is written in C# and uses [CefSharp](https://github.com/cefsharp/CefSharp/) library to display HTML documents. Metainformation, such as "Favorite" and "Read" flags is encoded in file names (a file `doc.html` becomes `doc{R,S}.html` when it is marked as both read and favorite/starred). 
 
-The project can be built with MS Visual Studio 2017. Open `Developer Command Prompt for VS 2017`, navigate to the project folder and run `BuildAndPack.bat`.
+The project can be built with MS Visual Studio 2017. Open `Developer Command Prompt for VS 2017`, navigate to the project folder and run `BuildAndPack.bat`. Make sure to have NuGet installed, since it is used to restore missing `CefSharp` packages.
+
+Web pages are saved with the help of a third-party tool [SingleFile](https://github.com/gildas-lormeau/SingleFile). WebLibrary Chrome extension uses [External Application Button](https://add0n.com/external-application-button.html) to call `WebLibraryDownloader.exe` and pass it the URL of the current page to be saved.
+

WebLibraryApp/MainForm.cs

@@ -62,9 +62,12 @@ public MainForm()
  mArticles = new ArticleList(settings.SortByColumn, settings.ReverseSort, lvArticles, fsWatcher);
  mArticles.InitializeColWidths(colWidths);
 
- if (!Directory.Exists(settings.LibHome)) // $mm TODO: exit if no folder is chosen
+ while (!Directory.Exists(settings.LibHome))
+ {
+ MessageBox.Show("Please select a valid library folder", "WebLibraryDownloader", MessageBoxButtons.OK, MessageBoxIcon.Information);
  ChooseLibFolder();
-
+ }
+
  updateLibTree();
  fsWatcher.Path = settings.LibHome;
  }
@@ -105,6 +108,7 @@ private void ChooseLibFolder()
  {
  using (var fbd = new FolderBrowserDialog())
  {
+ fbd.Description = "Choose Library Folder";
  if (fbd.ShowDialog() == DialogResult.OK && !string.IsNullOrWhiteSpace(fbd.SelectedPath))
  Properties.Settings.Default.LibHome = fbd.SelectedPath;
  }

WebLibraryDownloader/MainForm.cs

@@ -24,14 +24,22 @@ public MainForm()
  Top = settings.MainForm_Top;
  Width = settings.MainForm_Width;
  Height = settings.MainForm_Height;
+
+ cbAutoSave.CheckedChanged -= cbAutoSave_CheckedChanged;
  cbAutoSave.Checked = settings.AutoSave;
- // $mm TODO: save current dir 
+ cbAutoSave.CheckedChanged += cbAutoSave_CheckedChanged;
 
- if (!Directory.Exists(settings.LibHome)) // $mm TODO: exit if no folder is chosen
+ while (!Directory.Exists(settings.LibHome))
+ {
+ MessageBox.Show("Please select a valid library folder", "WebLibraryDownloader", MessageBoxButtons.OK, MessageBoxIcon.Information);
  ChooseLibFolder();
+ }
 
- if (!File.Exists(settings.ChromePath))
+ while (!File.Exists(settings.ChromePath))
+ {
+ MessageBox.Show("Please select a valid path to a Chrome-compatible browser", "WebLibraryDownloader", MessageBoxButtons.OK, MessageBoxIcon.Information);
  ChooseChromePath();
+ }
 
  updateLibTree();
  }
@@ -41,6 +49,7 @@ public void SetUrl(string url)
  tbUrl.ReadOnly = false;
  tbUrl.Text = url;
  tbUrl.ReadOnly = true;
+ btnSave.Enabled = true;
  }
 
  private void MainForm_FormClosing(object sender, FormClosingEventArgs e)
@@ -61,11 +70,11 @@ private void btnChooseLibFolder_Click(object sender, EventArgs e)
  ChooseLibFolder();
  }
 
-
  private void ChooseLibFolder()
  {
  using (var fbd = new FolderBrowserDialog())
  {
+ fbd.Description = "Choose Library Folder";
  if (fbd.ShowDialog() == DialogResult.OK && !string.IsNullOrWhiteSpace(fbd.SelectedPath))
  Properties.Settings.Default.LibHome = fbd.SelectedPath;
  }
@@ -75,7 +84,7 @@ private void ChooseChromePath()
  {
  using (var fbd = new OpenFileDialog())
  {
- if (fbd.ShowDialog() == DialogResult.OK)// $mm TODO: check options
+ if (fbd.ShowDialog() == DialogResult.OK)
  Properties.Settings.Default.ChromePath = fbd.FileName;
  }
  }
@@ -149,10 +158,9 @@ private void saveUrl(string url, string folder)
  exeProcess.WaitForExit();
  }
  }
- catch(Exception e)
+ catch(Exception)
  {
- ;
- // Log error.
+ // $mm TODO Log error.
  }
 
  Close();
@@ -166,9 +174,15 @@ private void btnChooseChromePath_Click(object sender, EventArgs e)
  private void MainForm_Load(object sender, EventArgs e)
  {
  this.BeginInvoke((MethodInvoker)delegate {
- if (cbAutoSave.Checked && tvLibTree.SelectedNode != null)
+ if (cbAutoSave.Checked && tbUrl.Text.Length > 0 && tvLibTree.SelectedNode != null)
  btnSave.PerformClick();
  });
  }
+
+ private void cbAutoSave_CheckedChanged(object sender, EventArgs e)
+ {
+ if(cbAutoSave.Checked)
+ MessageBox.Show("Note: to uncheck this box later, run WebLibraryDownloader without arguments", "WebLibraryDownloader", MessageBoxButtons.OK, MessageBoxIcon.Information);
+ }
  }
 }