6 files changed, 83 insertions, 1 deletions

diff --git a/NEWS b/NEWS
index 4c0a8e6..d7a539f 100644
--- a/NEWS
+++ b/NEWS
@@ -1,9 +1,10 @@
  ()
+  - Added brief help file
   - Fixed HTML generation code
   - Fixed a mistyped flickr url so that the 'Flickr' button works now
 0.0.1 (October 3rd, 2006)
   - Added ability to paginate through search results
   - Fixed packaging bug that omitted packaging license dialog
   - A lot of code cleanup and UI polishing
 0.0 (September 26th, 2006)
   - Initial release
diff --git a/NEWS.xml b/NEWS.xml
index 337ad61..8defd50 100644
--- a/NEWS.xml
+++ b/NEWS.xml
@@ -1,15 +1,16 @@
 <?xml version="1.0" encoding="us-ascii"?>
 <news>
  <version version="" date="">
+  <ni>Added brief help file</ni>
   <ni>Fixed HTML generation code</ni>
   <ni>Fixed a mistyped flickr url so that the 'Flickr' button works now</ni>
  </version>
  <version version="0.0.1" date="October 3rd, 2006">
   <ni>Added ability to paginate through search results</ni>
   <ni>Fixed packaging bug that omitted packaging license dialog</ni>
   <ni>A lot of code cleanup and UI polishing</ni>
  </version>
  <version version="0.0" date="September 26th, 2006">
   <ni>Initial release</ni>
  </version>
 </news>
diff --git a/content/Makefile.am b/content/Makefile.am
index abe3d6d..7d11964 100644
--- a/content/Makefile.am
+++ b/content/Makefile.am
@@ -1,22 +1,23 @@
 xpichromecontent_DATA = \
         autoconf.dtd \
         browser.xul about.xul fireflix-panel.xul photoset-props.xul \
         generated-content.xul copying.xul \
         photoset-props.js fireflix.js flickr.js util.js md5.js \
         generated-content.js \
         fireflix.css \
-        background.jpeg
+        background.jpeg \
+        help.xml
 
 sized_icons = \
         $(addsuffix .png, \
          fireflix \
         )
 
 nobase_xpichromecontent_DATA = \
         $(addprefix icons/, \
          $(addprefix 16x16/,${sized_icons}) \
          $(addprefix 32x32/,${sized_icons}) \
         )
 
 EXTRA_DIST = \
         ${xpichromecontent_DATA} ${nobase_xpichromecontent_DATA}
diff --git a/content/fireflix-panel.xul b/content/fireflix-panel.xul
index 1278621..b961edb 100644
--- a/content/fireflix-panel.xul
+++ b/content/fireflix-panel.xul
@@ -18,32 +18,34 @@
  <script type="application/x-javascript" src="flickr.js" />
  <script type="application/x-javascript" src="fireflix.js" />
 
  <stringbundleset>
   <stringbundle id="loc_strings" src="chrome://fireflix/locale/fireflix.properties" />
  </stringbundleset>
 
  <commandset>
   <command id="cmd_auth_auth" label="&panel.auth.auth.label;"
   oncommand="fireflix.on_cmd_auth()"/>
   <command id="cmd_auth_done" label="&panel.auth.done.label;"
   oncommand="fireflix.on_cmd_auth_done()" disabled="true"/>
   <command id="cmd_auth_open_flickr" label="&panel.auth.flickr.label;"
   oncommand="fireflix.openTab('http://www.flickr.com/')" />
   <command id="cmd_auth_unauth" label="&panel.auth.unauth.label;"
   oncommand="fireflix.on_cmd_auth_unauth()" />
+  <command id="cmd_help" label="?"
+  oncommand="fireflix.openTab('chrome://fireflix/content/help.xml')" />
  </commandset>
  
  <popupset>
   <popup id="auth_menu">
    <menuitem command="cmd_auth_auth"/>
    <menuitem command="cmd_auth_done" hidden="true" id="menu_auth_done"/>
    <menuitem command="cmd_auth_unauth" />
    <menuseparator/>
    <menuitem command="cmd_auth_open_flickr"/>
   </popup>
  </popupset>
 
  <commandset id="cmdset_search">
   <command id="cmd_search" label="&panel.search.cmd_search.label;"
   oncommand="fireflix.foundphotos.search_photos()"/>
   <command id="cmd_search_open" label="&panel.search.cmd_search_open.label;"
@@ -92,32 +94,33 @@
    <menuitem command="cmd_uploads_upload"/>
    <menuseparator/>
    <menu label="&panel.uploads.generate_html;" id="uploads_html_menu"/>
   </popup>
  </popupset>
 
  <vbox class="wholething" flex="1">
 
   <groupbox context="auth_menu">
    <caption label="&panel.auth_info;"/>
    <hbox>
     <label id="auth_info" value="&panel.no_auth_info;" flex="1" disabled="true" crop="end"/>
     <button id="b_auth" command="cmd_auth_auth"/>
     <button id="b_auth_done" command="cmd_auth_done" hidden="true"/>
     <button command="cmd_auth_open_flickr" 
     tooltiptext="&panel.auth.flickr.tip;"/>
+    <button command="cmd_help"/>
    </hbox>
   </groupbox>
 
   <tabbox flex="1" id="fireflix_tabs">
 
    <tabs>
     <tab label="&panel.tabs.search;"/>
     <tab label="&panel.tabs.sets;"/>
     <tab label="&panel.tabs.tags;" hidden="true"/> <!-- TODO: -->
     <tab id="tab_upload" label="&panel.tabs.upload;"/>
    </tabs>
 
    <tabpanels flex="1">
 
     <tabpanel id="tabpanel_search" flex="1">
      <vbox flex="1">
diff --git a/content/fireflix.css b/content/fireflix.css
index 9e7bf6b..47455f6 100644
--- a/content/fireflix.css
+++ b/content/fireflix.css
@@ -84,16 +84,39 @@ div#searchresult_description {
  font-family: courier, monospace;
  font-size: 9pt;
  padding: 2px;
  border: dotted 1px gray;
  background: white;
 }
 
 label#search_page {
  font-weight: bold;
  background: white; color: #404040;
  border-color: #c0c0c0 #404040 #404040 #c0c0c0;
  border-style: solid;
  border-width: 1px;
  -moz-border-radius: 1em;
  padding: 0.5ex 1ex;
 }
+
+html body {
+ font-family: arial, sans-serif;
+ font-size: 11pt;
+ margin: 1em 4em;
+ padding: 1em 4em;
+ border: double 3px gray;
+ background: #ffffc0;
+}
+html h1 {
+ font-size: 130%; color: maroon;
+}
+html p {
+ text-align: justify;
+}
+
+html div.copyright {
+ font-size: 60%;
+ text-align: right;
+}
+html div.copyright a {
+ text-decoration: none;
+}
diff --git a/content/help.xml b/content/help.xml
new file mode 100644
index 0000000..e71cd99
--- a/dev/null
+++ b/content/help.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="utf-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+ <head>
+  <title>Fireflix</title>
+  <link rel="stylesheet" href="fireflix.css" type="text/css"/>
+ </head>
+ <body>
+
+  <p>This is a brief overview of things you can do with <a href="http://kin.klever.net/fireflix/">fireflix</a>.</p>
+ 
+  <p>First, you should proceed with authorization. If you haven't done it yet,
+  it should happen automatically once you open fireflix sidebar. To clear
+  authorization token off of the preferences, right-click on the 'Authorization
+  info' part of the sidebar and select 'Sign off' from the pop up menu.</p>
+
+  <h1>In the 'Search' tab</h1>
+
+  <p>Basically, you can search flickr photos here. Either all or yours (keep
+  'mine' checked to search your own photos).</p>
+
+  <p>Once you have acquired search results you can browse through them. To open
+  any particular picture in a new tab either doubleclick it or hit ENTER.</p>
+
+  <p>While moving through the list of pictures found you should have a little
+  preview at the bottom of the window.</p>
+
+  <h1>In the 'Sets' tab</h1>
+
+  <p>This is where you can browse your sets. You can edit some sets properties
+  here and, most importantly, you can generate HTML of linked thumbnails for
+  sets contents. Use your right mouse button on the photoset.</p>
+
+  <h1>In The 'Uploads' tab</h1>
+
+  <p>To upload pictures you don't even have to select this tab. Drag'n'drop into
+  fireflix sidebar should do. There is nothing wrong with going into the tab and
+  using 'Add' button either.</p>
+
+  <p>You can add photos to the list, edit their titles and/or tags and once
+  you're done with it, trigger upload procedure. Once your images have been
+  uploaded, you will be prompted to create a photoset for newly uploaded photos.
+  You don't have to, though.</p>
+
+  <h1>Feedback</h1>
+
+  <p>As the extension is at the very early stage of development, feel free to
+  provide feedback at <a href="http://kin.klever.net/fireflix/feedback" title="click here to proceed to feedback form">http://kin.klever.net/fireflix/feedback/</a>.</p>
+
+  <div class="copyright">
+   <a href="http://www.klever.net/">© Klever Group</a>
+  </div>
+ </body>
+</html>