[linterna-magica-commit] [36] Documentation fixes.

[Ivaylo Valkov]

Revision: 36
          
http://svn.sv.gnu.org/viewvc/?view=rev&root=linterna-magica&revision=36
Author:   valkov
Date:     2011-04-06 12:40:50 +0000 (Wed, 06 Apr 2011)
Log Message:
-----------
Documentation fixes. Closes tasks #11055

Ticket Links:
:-----------
    http://savannah.gnu.org/task/?11055

Modified Paths:
--------------
    trunk/HELP
    trunk/HELP.bg

Added Paths:
-----------
    trunk/utilities/linternamagica_user_config.user.js

Removed Paths:
-------------
    trunk/utilities/linterna_magica_user_config.user.js

Modified: trunk/HELP
===================================================================
--- trunk/HELP  2011-04-06 12:06:14 UTC (rev 35)
+++ trunk/HELP  2011-04-06 12:40:50 UTC (rev 36)
@@ -18,8 +18,21 @@
     "cookies": "restore",
     "wait_dm": "off",
  };
+
+Since version 0.0.10 it is possible to keep your configuration in
+separate userscript file. This way your preferences will stay intact
+when new version is installed. The userscript with your configuration
+must have special structure. If you want this feature, install the
+file "linternamagica_user_condfig.user.js" from the "utilities"
+directory. To change the configuration look for
+"var linterna_magica_user_config". The format is the same as for the
+main userscript file. Have in mind that this file is not going to be
+updated and you will have to add manually newer options for feature
+versions, if you don't like the default ones. If an option is missing
+in this file, the default one provided by the main userscript will be
+used.
+
                
-               
 Available options are:
   debug
       This option sets the debug level. The debug information is
@@ -122,7 +135,7 @@
 Localisation
 
 Since version 0.0.10 the translations are split from the main
-userscript. Every localisation is a separate userscript in the locale
+userscript. Every localisation is a separate userscript in the "locale"
 directory with special structure. If there is translation for your
 language and you want to use it, you will have to install the
 userscript for it. By default Linterna Mágica tries to use the

Modified: trunk/HELP.bg
===================================================================
--- trunk/HELP.bg       2011-04-06 12:06:14 UTC (rev 35)
+++ trunk/HELP.bg       2011-04-06 12:40:50 UTC (rev 36)
@@ -1,4 +1,4 @@
-Възможно е да настроите някои от функционалностите на Linterna Magica.
+Възможно е да настроите някои от функционалностите на Linterna Mágica.
 Единственият начин (за момента), да направите това е да промените кода
 на потребителския скрипт.  Отворете файла с потребителския скрипт и
 потърсете за „var linterna_magica_options“. Това е програмен обект на
@@ -17,8 +17,21 @@
     "cookies": "restore",
     "wait_dm": "off",
  };
+
+От версия 0.0.10 е възможно да запишете настройките си в отделен
+ потребителски скрипт. По този начин настройките Ви ще се запазят,
+ когато бъде инсталирана нова версия. Потребителският скрипт трябва да
+ има специална структура. Ако искате да използвате тази възможност на
+ Linterna Mágica, инсталирайте потребителския скрипт
+ „linternamagica_user_condfig.user.js“ от папката „utilities“. За да
+ промените настройките, потърсете за
+„var linterna_magica_user_config“. Форматът е същия както в основният
+ потребителски скрипт. Имайте предвид, че този файл няма да бъде
+ обновяван. Това означава, че ще трябва самостоятелно да добавяте нови
+ настройки от бъдещи версии, ако не харесвате стандартните им
+ стойности. Ако някоя настройка липсва в този файл, ще се използва
+ стандартната стойност от основния потребителски скрипт.
                
-               
 Възможни са следните настройки:
   debug
       Дали в конзолата да се показват съобщения за отстраняване на
@@ -129,10 +142,10 @@
 От версия 0.0.10 нататък преводите са разделени от основния
 потребителски скрипт в самостоятелни файлове. Преводите са отделни
 потребителски скриптове със специална структура и се намират в папката
-locale. Ако съществува превод за вашият език и желаете да го
+locale. Ако съществува превод за Вашият език и желаете да го
 използвате, трябва да инсталирате потребителския скрипт за
 него. Стандартно Linterna Mágica се опитва да използва езикът на
-интерфейса на браузъра, ако е преводът е наличен. Също така, можете да
+интерфейса на браузъра, ако преводът е наличен. Също така, можете да
 използвате превод по Ваш избор, чрез настройката "locale".
 
 Спиране на изпълнението на всяка страница

Deleted: trunk/utilities/linterna_magica_user_config.user.js
===================================================================
--- trunk/utilities/linterna_magica_user_config.user.js 2011-04-06 12:06:14 UTC 
(rev 35)
+++ trunk/utilities/linterna_magica_user_config.user.js 2011-04-06 12:40:50 UTC 
(rev 36)
@@ -1,61 +0,0 @@
-//  @licstart The following is the entire license notice for the
-//  JavaScript code in this page (or file).
-//
-//  This file is part of Linterna Mágica
-//
-//  Copyright (C) 2011  Ivaylo Valkov <address@hidden>
-//
-//  The JavaScript code in this page (or file) is free software: you
-//  can redistribute it and/or modify it under the terms of the GNU
-//  General Public License (GNU GPL) as published by the Free Software
-//  Foundation, either version 3 of the License, or (at your option)
-//  any later version.  The code is distributed WITHOUT ANY WARRANTY
-//  without even the implied warranty of MERCHANTABILITY or FITNESS
-//  FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
-//
-//  As additional permission under GNU GPL version 3 section 7, you
-//  may distribute non-source (e.g., minimized or compacted) forms of
-//  that code without the copy of the GNU GPL normally required by
-//  section 4, provided you include this license notice and a URL
-//  through which recipients can access the Corresponding Source.
-//
-//  @licend The above is the entire license notice for the JavaScript
-//  code in this page (or file).
-//
-// @source http://e-valkov.org/linterna-magica
-
-// ==UserScript==
-// @name           Linterna Mágica user config
-// @namespace Linterna Mágica
-// @description  Useful if you want to keep your configuration intact when new 
version of Linterna Mágica is installed.
-// @include        http://*
-// @include        https://*
-
-// ==/UserScript==
-
-var linterna_magica_user_config = {
-    "debug": 0,
-    "log_to": "web",
-    "updates": "1w",
-    "priority": "self",
-    "autostart": "on",
-    "controls": "self",
-    "cookies": "restore",
-    "wait_dm": "off",
-};
-
-var script = document.createElement("script");
-var script_data = "window.linterna_magica_user_config = {" ; 
-for (var o in linterna_magica_user_config)
-{
-    script_data += "'"+o+ "' : '"+linterna_magica_user_config[o]+"',";
-}
-
-script_data += "};";
-
-script.textContent = script_data;
-
-var head = document.getElementsByTagName("head")[0];
-script.setAttribute("type", "text/javascript");
-head.appendChild(script);
-head.removeChild(script);

Copied: trunk/utilities/linternamagica_user_config.user.js (from rev 33, 
trunk/utilities/linterna_magica_user_config.user.js)
===================================================================
--- trunk/utilities/linternamagica_user_config.user.js                          
(rev 0)
+++ trunk/utilities/linternamagica_user_config.user.js  2011-04-06 12:40:50 UTC 
(rev 36)
@@ -0,0 +1,71 @@
+//  @licstart The following is the entire license notice for the
+//  JavaScript code in this page (or file).
+//
+//  This file is part of Linterna Mágica
+//
+//  Copyright (C) 2011  Ivaylo Valkov <address@hidden>
+//
+//  The JavaScript code in this page (or file) is free software: you
+//  can redistribute it and/or modify it under the terms of the GNU
+//  General Public License (GNU GPL) as published by the Free Software
+//  Foundation, either version 3 of the License, or (at your option)
+//  any later version.  The code is distributed WITHOUT ANY WARRANTY
+//  without even the implied warranty of MERCHANTABILITY or FITNESS
+//  FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
+//
+//  As additional permission under GNU GPL version 3 section 7, you
+//  may distribute non-source (e.g., minimized or compacted) forms of
+//  that code without the copy of the GNU GPL normally required by
+//  section 4, provided you include this license notice and a URL
+//  through which recipients can access the Corresponding Source.
+//
+//  @licend The above is the entire license notice for the JavaScript
+//  code in this page (or file).
+//
+// @source http://e-valkov.org/linterna-magica
+
+// ==UserScript==
+// @name           Linterna Mágica user config
+// @namespace Linterna Mágica
+// @description  Useful if you want to keep your configuration intact when new 
version of Linterna Mágica is installed.
+// @include        http://*
+// @include        https://*
+
+// ==/UserScript==
+
+// This userscript is not updated on purpose. You will have to add
+// newer options from future versions manually. If an option is
+// missing, the one provided by the main userscript will be used.
+
+var linterna_magica_user_config = {
+    "debug": 0,
+    "log_to": "web",
+    "updates": "1w",
+    "priority": "self",
+    "autostart": "on",
+    "controls": "self",
+    "locale": "auto",
+    "cookies": "restore",
+    "wait_dm": "off",
+};
+
+// Do NOT edit past this line.
+
+var script = document.createElement("script");
+var script_data = "window.linterna_magica_user_config = {" ; 
+for (var o in linterna_magica_user_config)
+{
+    script_data += "'"+o+ "' : '"+linterna_magica_user_config[o]+"',";
+}
+
+script_data += "};";
+
+script.textContent = script_data;
+
+var head = document.getElementsByTagName("head")[0];
+script.setAttribute("type", "text/javascript");
+head.appendChild(script);
+
+head.removeChild(script);
+script_data = undefined;
+script = undefined;