From 6336fb0d2dcb9dc3d550e9c82964966653f8288a Mon Sep 17 00:00:00 2001
From: Matthias Mees <mm@yellowled.de>
Date: Thu, 14 Feb 2013 13:14:58 +0100
Subject: [PATCH] Documented where these JS files are referenced.

---
 serendipity_editor.js                  | 16 +++++++++++++---
 templates/2k11/admin/admin_scripts.js  |  8 +++++++-
 templates/2k11/admin/header_spawn.js   |  8 +++++++-
 templates/2k11/admin/image_selector.js |  7 ++++++-
 templates/2k11/admin/imgedit.js        |  3 +++
 templates/2k11/admin/media_pane.tpl    |  2 +-
 6 files changed, 37 insertions(+), 7 deletions(-)

diff --git a/serendipity_editor.js b/serendipity_editor.js
index 249587a6..e606c8b8 100644
--- a/serendipity_editor.js
+++ b/serendipity_editor.js
@@ -1,3 +1,13 @@
+// File referenced in:
+// – include/admin/tpl/category.inc.tpl
+// – include/admin/tpl/comments.inc.tpl
+// – include/admin/tpl/out_stack_loop.tpl
+// – include/functions_entries_admin.inc.php
+// – templates/*/admin/admin_scripts.js
+// – templates/*/admin/entries.tpl
+// – templates/*/admin/media_choose.tpl
+// – templates/*/admin/media_upload.tpl
+
 <!-- // Hide from older browsers
 /* $Id$ */
 /*
@@ -612,7 +622,7 @@ function treeToggleAll() {
 }
 
 // Used internally by fillInput; regexp replace
-function getFilename(value) {
+function getfilename(value) {
     re = /^.+[\/\\]+?(.+)$/;
     return value.replace(re, "$1");
 }
@@ -690,10 +700,10 @@ function fillInput(source, target) {
     useDuplicate = false;
     // First field is a special value for foreign URLs instead of uploaded files
     if (source == 1 && document.getElementById('imageurl').value != "") {
-        sourceval = getFilename(document.getElementById('imageurl').value);
+        sourceval = getfilename(document.getElementById('imageurl').value);
         useDuplicate = true;
     } else {
-        sourceval = getFilename(document.getElementById('userfile_' + source).value);
+        sourceval = getfilename(document.getElementById('userfile_' + source).value);
     }
 
     if (sourceval.length > 0) {
diff --git a/templates/2k11/admin/admin_scripts.js b/templates/2k11/admin/admin_scripts.js
index 09f203ab..ecd63907 100644
--- a/templates/2k11/admin/admin_scripts.js
+++ b/templates/2k11/admin/admin_scripts.js
@@ -1,3 +1,9 @@
+// File referenced in:
+// – include/admin/tpl/entries.inc.tpl
+// – include/admin/tpl/serendipity_plugin_config.fnc.tpl
+// – include/functions_plugins_admin.inc.php
+// – templates/*/admin/media_pane.tpl
+
 // usage: log('inside coolFunc', this, arguments);
 // paulirish.com/2009/log-a-lightweight-wrapper-for-consolelog/
 window.log = function f(){ log.history = log.history || []; log.history.push(arguments); if(this.console) { var args = arguments, newarr; try { args.callee = f.caller } catch(e) {}; newarr = [].slice.call(args); if (typeof console.log === 'object') log.apply.call(console.log, console, newarr); else console.log.apply(console, newarr);}};
@@ -87,7 +93,7 @@ function showFilters()  {
 }
 
 // Add another (image) keyword
-function addKeyword(keyword)  {
+function AddKeyword(keyword)  {
     s = document.getElementById('keyword_input').value;
     document.getElementById('keyword_input').value = (s != '' ? s + ';' : '') + keyword;
 }
diff --git a/templates/2k11/admin/header_spawn.js b/templates/2k11/admin/header_spawn.js
index 193d5af2..af0a6d18 100644
--- a/templates/2k11/admin/header_spawn.js
+++ b/templates/2k11/admin/header_spawn.js
@@ -1,4 +1,10 @@
-// I have no idea what this does. Anybody?
+// File referenced in:
+// – templates/*/admin/index.tpl
+// – templates/*/admin/media_choose.tpl
+
+// Fires functions which are generated dynamically in backend PHP files
+// (i.e. include/functions_entries_admin.inc.php) which load the various
+// WYSIWYG editors in entries editor, HTML nuggets etc.
 function spawn() {
     if (self.Spawnextended) {
         Spawnextended();
diff --git a/templates/2k11/admin/image_selector.js b/templates/2k11/admin/image_selector.js
index d569aa13..bceab441 100644
--- a/templates/2k11/admin/image_selector.js
+++ b/templates/2k11/admin/image_selector.js
@@ -1,8 +1,13 @@
-// Switches preview of image selected from media db
+// File referenced in:
+// – include/admin/tpl/out_stack_loop.tpl
+
+// Switches preview of image selected from media db by changing the
+// container's background image
 function change_preview(id) {
     var text_box = document.getElementById('serendipity[template][' + id + ']');
     var image_box = document.getElementById(id + '_preview'); 
     var filename = text_box.value;
+
     image_box.style.backgroundImage = 'url(' + filename + ')';
     image_box.style.backgroundRepeat = 'no-repeat';
 }
diff --git a/templates/2k11/admin/imgedit.js b/templates/2k11/admin/imgedit.js
index c8fc43d5..1d674ce5 100644
--- a/templates/2k11/admin/imgedit.js
+++ b/templates/2k11/admin/imgedit.js
@@ -1,3 +1,6 @@
+// File referenced in:
+// – templates/*/admin/media_choose.tpl
+
 /**************************************************
  * imgedit.js
  * 2003-10-17
diff --git a/templates/2k11/admin/media_pane.tpl b/templates/2k11/admin/media_pane.tpl
index c32fb88a..f5409d1a 100644
--- a/templates/2k11/admin/media_pane.tpl
+++ b/templates/2k11/admin/media_pane.tpl
@@ -37,7 +37,7 @@
 
                 <div id="keyword_list" class="clearfix">
                 {foreach from=$media.keywords item="keyword"}
-                    <a href="#" onclick="addKeyword('{$keyword|@escape}'); return false">{$keyword|@escape}</a>
+                    <a href="#" onclick="AddKeyword('{$keyword|@escape}'); return false">{$keyword|@escape}</a>
                 {/foreach}
                 </div>
             </div>