added brief help file

git-svn-id: http://svn.klever.net/kin/fireflix/trunk@191 fe716a7a-6dde-0310-88d9-d003556173a8
author: Michael Krelin <hacker@klever.net> 2006-10-12 00:02:08 (UTC)
committer: Michael Krelin <hacker@klever.net> 2006-10-12 00:02:08 (UTC)
commit: 02372a254dafdfd7564e95c7c6d5cc1b93def7ec (patch) (unidiff)
tree: 2fe911682c4773a5a37702a9ddd95c4181f2b0f4
parent: d1c9236d6eb9ddf777d8e74659b77aac8890f58e (diff)
download: fireflix-02372a254dafdfd7564e95c7c6d5cc1b93def7ec.zip
fireflix-02372a254dafdfd7564e95c7c6d5cc1b93def7ec.tar.gz
fireflix-02372a254dafdfd7564e95c7c6d5cc1b93def7ec.tar.bz2
6 files changed, 83 insertions, 1 deletions
diff --git a/NEWS b/NEWS
index 4c0a8e6..d7a539f 100644
--- a/NEWS
+++ b/NEWS
@@ -1,5 +1,6 @@
 ()
+  - 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
diff --git a/NEWS.xml b/NEWS.xml
index 337ad61..8defd50 100644
--- a/NEWS.xml
+++ b/NEWS.xml
@@ -1,7 +1,8 @@
 <?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">
diff --git a/content/Makefile.am b/content/Makefile.am
index abe3d6d..7d11964 100644
--- a/content/Makefile.am
+++ b/content/Makefile.am
@@ -4,9 +4,10 @@ xpichromecontent_DATA = \
        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 \
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
@@ -30,8 +30,10 @@
  <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">
@@ -104,8 +106,9 @@
    <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">
diff --git a/content/fireflix.css b/content/fireflix.css
index 9e7bf6b..47455f6 100644
--- a/content/fireflix.css
+++ b/content/fireflix.css
@@ -96,4 +96,27 @@ label#search_page {
 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>
author	Michael Krelin <hacker@klever.net>	2006-10-12 00:02:08 (UTC)
committer	Michael Krelin <hacker@klever.net>	2006-10-12 00:02:08 (UTC)
commit	02372a254dafdfd7564e95c7c6d5cc1b93def7ec (patch) (unidiff)
tree	2fe911682c4773a5a37702a9ddd95c4181f2b0f4
parent	d1c9236d6eb9ddf777d8e74659b77aac8890f58e (diff)
download	fireflix-02372a254dafdfd7564e95c7c6d5cc1b93def7ec.zip fireflix-02372a254dafdfd7564e95c7c6d5cc1b93def7ec.tar.gz fireflix-02372a254dafdfd7564e95c7c6d5cc1b93def7ec.tar.bz2

diff --git a/NEWS b/NEWS index 4c0a8e6..d7a539f 100644 --- a/NEWS +++ b/NEWS
@@ -1,5 +1,6 @@
1	()	1	()
		2	- Added brief help file
2	- Fixed HTML generation code	3	- Fixed HTML generation code
3	- Fixed a mistyped flickr url so that the 'Flickr' button works now	4	- Fixed a mistyped flickr url so that the 'Flickr' button works now
4	0.0.1 (October 3rd, 2006)	5	0.0.1 (October 3rd, 2006)
5	- Added ability to paginate through search results	6	- Added ability to paginate through search results


diff --git a/NEWS.xml b/NEWS.xml index 337ad61..8defd50 100644 --- a/NEWS.xml +++ b/NEWS.xml
@@ -1,7 +1,8 @@
1	<?xml version="1.0" encoding="us-ascii"?>	1	<?xml version="1.0" encoding="us-ascii"?>
2	<news>	2	<news>
3	<version version="" date="">	3	<version version="" date="">
		4	<ni>Added brief help file</ni>
4	<ni>Fixed HTML generation code</ni>	5	<ni>Fixed HTML generation code</ni>
5	<ni>Fixed a mistyped flickr url so that the 'Flickr' button works now</ni>	6	<ni>Fixed a mistyped flickr url so that the 'Flickr' button works now</ni>
6	</version>	7	</version>
7	<version version="0.0.1" date="October 3rd, 2006">	8	<version version="0.0.1" date="October 3rd, 2006">


diff --git a/content/Makefile.am b/content/Makefile.am index abe3d6d..7d11964 100644 --- a/content/Makefile.am +++ b/content/Makefile.am
@@ -4,9 +4,10 @@ xpichromecontent_DATA = \
4	generated-content.xul copying.xul \	4	generated-content.xul copying.xul \
5	photoset-props.js fireflix.js flickr.js util.js md5.js \	5	photoset-props.js fireflix.js flickr.js util.js md5.js \
6	generated-content.js \	6	generated-content.js \
7	fireflix.css \	7	fireflix.css \
8	background.jpeg	8	background.jpeg \
		9	help.xml
9		10
10	sized_icons = \	11	sized_icons = \
11	$(addsuffix .png, \	12	$(addsuffix .png, \
12	fireflix \	13	fireflix \


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
@@ -30,8 +30,10 @@
30	<command id="cmd_auth_open_flickr" label="&panel.auth.flickr.label;"	30	<command id="cmd_auth_open_flickr" label="&panel.auth.flickr.label;"
31	oncommand="fireflix.openTab('http://www.flickr.com/')" />	31	oncommand="fireflix.openTab('http://www.flickr.com/')" />
32	<command id="cmd_auth_unauth" label="&panel.auth.unauth.label;"	32	<command id="cmd_auth_unauth" label="&panel.auth.unauth.label;"
33	oncommand="fireflix.on_cmd_auth_unauth()" />	33	oncommand="fireflix.on_cmd_auth_unauth()" />
		34	<command id="cmd_help" label="?"
		35	oncommand="fireflix.openTab('chrome://fireflix/content/help.xml')" />
34	</commandset>	36	</commandset>
35		37
36	<popupset>	38	<popupset>
37	<popup id="auth_menu">	39	<popup id="auth_menu">
@@ -104,8 +106,9 @@
104	<button id="b_auth" command="cmd_auth_auth"/>	106	<button id="b_auth" command="cmd_auth_auth"/>
105	<button id="b_auth_done" command="cmd_auth_done" hidden="true"/>	107	<button id="b_auth_done" command="cmd_auth_done" hidden="true"/>
106	<button command="cmd_auth_open_flickr"	108	<button command="cmd_auth_open_flickr"
107	tooltiptext="&panel.auth.flickr.tip;"/>	109	tooltiptext="&panel.auth.flickr.tip;"/>
		110	<button command="cmd_help"/>
108	</hbox>	111	</hbox>
109	</groupbox>	112	</groupbox>
110		113
111	<tabbox flex="1" id="fireflix_tabs">	114	<tabbox flex="1" id="fireflix_tabs">


diff --git a/content/fireflix.css b/content/fireflix.css index 9e7bf6b..47455f6 100644 --- a/content/fireflix.css +++ b/content/fireflix.css
@@ -96,4 +96,27 @@ label#search_page {
96	border-width: 1px;	96	border-width: 1px;
97	-moz-border-radius: 1em;	97	-moz-border-radius: 1em;
98	padding: 0.5ex 1ex;	98	padding: 0.5ex 1ex;
99	}	99	}
		100
		101	html body {
		102	font-family: arial, sans-serif;
		103	font-size: 11pt;
		104	margin: 1em 4em;
		105	padding: 1em 4em;
		106	border: double 3px gray;
		107	background: #ffffc0;
		108	}
		109	html h1 {
		110	font-size: 130%; color: maroon;
		111	}
		112	html p {
		113	text-align: justify;
		114	}
		115
		116	html div.copyright {
		117	font-size: 60%;
		118	text-align: right;
		119	}
		120	html div.copyright a {
		121	text-decoration: none;
		122	}


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 @@
		1	<?xml version="1.0" encoding="utf-8"?>
		2	<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
		3	<head>
		4	<title>Fireflix</title>
		5	<link rel="stylesheet" href="fireflix.css" type="text/css"/>
		6	</head>
		7	<body>
		8
		9	<p>This is a brief overview of things you can do with <a href="http://kin.klever.net/fireflix/">fireflix</a>.</p>
		10
		11	<p>First, you should proceed with authorization. If you haven't done it yet,
		12	it should happen automatically once you open fireflix sidebar. To clear
		13	authorization token off of the preferences, right-click on the 'Authorization
		14	info' part of the sidebar and select 'Sign off' from the pop up menu.</p>
		15
		16	<h1>In the 'Search' tab</h1>
		17
		18	<p>Basically, you can search flickr photos here. Either all or yours (keep
		19	'mine' checked to search your own photos).</p>
		20
		21	<p>Once you have acquired search results you can browse through them. To open
		22	any particular picture in a new tab either doubleclick it or hit ENTER.</p>
		23
		24	<p>While moving through the list of pictures found you should have a little
		25	preview at the bottom of the window.</p>
		26
		27	<h1>In the 'Sets' tab</h1>
		28
		29	<p>This is where you can browse your sets. You can edit some sets properties
		30	here and, most importantly, you can generate HTML of linked thumbnails for
		31	sets contents. Use your right mouse button on the photoset.</p>
		32
		33	<h1>In The 'Uploads' tab</h1>
		34
		35	<p>To upload pictures you don't even have to select this tab. Drag'n'drop into
		36	fireflix sidebar should do. There is nothing wrong with going into the tab and
		37	using 'Add' button either.</p>
		38
		39	<p>You can add photos to the list, edit their titles and/or tags and once
		40	you're done with it, trigger upload procedure. Once your images have been
		41	uploaded, you will be prompted to create a photoset for newly uploaded photos.
		42	You don't have to, though.</p>
		43
		44	<h1>Feedback</h1>
		45
		46	<p>As the extension is at the very early stage of development, feel free to
		47	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>
		48
		49	<div class="copyright">
		50	<a href="http://www.klever.net/">© Klever Group</a>
		51	</div>
		52	</body>
		53	</html>