QuitFirefoxAtTime

From ProgClub
Revision as of 03:31, 8 April 2016 by John (talk | contribs) (→‎Done: if tab is closed timer is canceled...)
Jump to: navigation, search

QuitFirefoxAtTime is the ProgClub Firefox extension which will close your current tab after a timeout. For other projects see projects.

Status

Under way. Not released yet, there's stuff TODO.

Motivation

This software allows you to have a browser tab closed automatically after a timeout (in Firefox). It was particularly created so you could set up a YouTube play-list and go to bed knowing it wouldn't play all night.

Administration

Contributors

Members who have contributed to this project. Newest on top.

All contributors have agreed to the terms of the Contributor License Agreement. This excludes any upstream contributors who tend to have different administrative frameworks.

Copyright

Copyright 2016, Contributors.

License

Licensed under the MIT license.

Resources

Downloads

You can download the latest installer here: quitfirefoxattime-0.1.2.xpi.

Source code

The repository can be browsed online:

https://www.progclub.org/pcrepo/quit-firefox-at-time/branches/0.1

The latest stable released version of the code will be available from:

https://www.progclub.org/svn/pcrepo/quit-firefox-at-time/tags/latest/0.1

Or if you want the latest version for development purposes:

https://www.progclub.org/svn/pcrepo/quit-firefox-at-time/branches/0.1

Links

Specifications

Functional specification

The functional specification describes what the project does.

The project is a Firefox extension that allows you to automatically close the current tab after a number of minutes.

When the Firefox extension (XPI) is installed there is a timer button added to the toolbar.

Clicking the timer button brings up the dialog box that controls our extension. When clicked a dialog appears with:

  1. An input box for the number of minutes to wait before closing the current tab
  2. A Start Timer button, to start the count-down
  3. A Stop Timer button, to stop the count-down
  4. A Hide button, to hide the dialog
  5. A status message showing the time remaining for the count-down

Technical specification

The technical specification describes how the project works.

TODO: Jevan please explain the project architecture and how the XPI works.

Notes

Notes for implementers

If you are interested in incorporating this software into your project, here's what you need to know:

Copy and paste your way to victory! See notes for developers for packaging instructions.

Installation instructions are in the README file.

Notes for developers

If you're looking to set up a development environment for this project here's what you need to know:

svn co https://www.progclub.org/svn/pcrepo/quit-firefox-at-time/branches/0.1/ \
  quit-firefox-at-time-0.1

See the README.md file for instructions for packaging on Linux and/or Windows.

Tasks

TODO

Things to do, in rough order of priority:

  • Allow decimal minutes, e.g. 0.1 minutes is 6 seconds, handy for testing...
  • Get rid of up/down buttons on minutes input.
  • Close tab that was active when the toolbar button was pressed.
  • Update technical specification (how it works)

Done

Stuff that's done. Latest stuff on top.

  • JP 2016-04-08: if tab is closed timer is canceled
  • JE 2016-04-08: explain how to update/package the xpi file
  • JP 2016-04-08: stop timer button next to start timer
  • JP 2016-04-08: show countdown in hours:minutes:seconds
  • JP 2016-04-08: closes current tab rather than all windows
  • JP 2016-04-08: made input box smaller
  • JP 2016-04-08: enter minutes instead of date
  • JP 2016-04-08: changed version to 0.1.2
  • JE 2016-04-03: added notes for implementers
  • JE 2016-04-03: created project page
  • JP 2016-04-02: version 0.0.1