Difference between revisions of "SAK2018"

From ProgClub
Jump to: navigation, search
(Functional specification)
(Alphabetical key assignments)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
SAK2018 is the ProgClub Standard Access Keys for web browsers specification. That's the specification you can use when implementing access keys for your website. For other projects see [[projects]].
+
SAK2018 is the ProgClub Standard Access Keys for web browsers specification. That's the specification you can use when implementing standard access keys for your website. For other projects see [[projects]].
  
 
= Status =
 
= Status =
  
Released! [http://www.sak2014.com/ www.sak2014.com]
+
Unreleased. Planning is documented below.
  
 
= Administration =
 
= Administration =
Line 13: Line 13:
 
* [[User:John|John Elliot V]]
 
* [[User:John|John Elliot V]]
  
All contributors have agreed to the terms of the [[ProgClub:Copyrights#ProgClub_projects|Contributor License Agreement]]. This excludes any upstream contributors who tend to have different administrative frameworks.
+
All members have agreed to the terms of the [[ProgClub:Copyrights#ProgClub_projects|Contributor License Agreement]]. This excludes any upstream contributors who tend to have different administrative frameworks.
 +
 
 +
=== Collaborators ===
 +
 
 +
Non-members who have contributed ideas to this project. Newest on top.
 +
 
 +
* Klaus Mueller
 +
* Sam
  
 
== Copyright ==
 
== Copyright ==
Line 45: Line 52:
 
== Links ==
 
== Links ==
  
* [http://www.standardaccesskeys.com/ www.standardaccesskeys.com]
+
* [https://www.standardaccesskeys.com/ www.standardaccesskeys.com]
  
 
= Specifications =
 
= Specifications =
Line 84: Line 91:
  
 
{|class="wikitable sortable"
 
{|class="wikitable sortable"
! Key !! Scope !! Location           !! Window/Tab
+
! Key !! Scope !! Location               !! Window/Tab !! Thoughts
 
|-
 
|-
| K  || Site  || Access Keys       || New Window
+
| K  || Site  || Access Keys             || New Window ||
 
|-
 
|-
| P   || Page || Previous Article  ||
+
| T   || Site || Table of Contents      ||            ||
 
|-
 
|-
| N   || Page  || Next Article      ||  
+
| H   || Page  || Back to Top            ||            ||
 
|-
 
|-
| H   || Page  || Back to Top        ||  
+
| N   || Page  || Next Article            ||            ||
 
|-
 
|-
| L   || Site || Login/Logout      ||
+
| P   || Page || Previous Article        ||            ||
 
|-
 
|-
| F   || Site  || Syndication Feed  || New Window
+
| W   || Site  || What's new? Blog / News ||            ||
 
|-
 
|-
| S   || Site  || Save/Send/Submit  ||
+
| F   || Site  || Syndication Feed        || New Window ||
 
|-
 
|-
| M  || Site  || Social Media       ||
+
| M  || Site  || Social Media           ||            ||
 
|-
 
|-
| T   || Site  || Table of Contents  ||
+
| L   || Site  || Login / Logout          ||            ||
 
|-
 
|-
| V   || Page  || Validate          || New Window
+
| A   || Page  || Add / Create / New      ||            ||
 
|-
 
|-
| W   || Site || Blog / News        ||
+
| V   || Page || View / Preview          ||            ||
 
|-
 
|-
| E  || Page  || Edit               ||
+
| E  || Page  || Edit                   ||            ||
 
|-
 
|-
| C   || Page || Create / New      ||
+
| S   || Site || Save / Send / Submit    ||            ||
 
|-
 
|-
| I   || Page  || Inspect / Preview  ||
+
| D   || Page  || Delete                  ||            ||
 
|}
 
|}
  
 
==== Alphabetical key availability ====
 
==== Alphabetical key availability ====
  
  Used:   C EF HI KLMN P  ST VW
+
  Used: A  DEF H  KLMN P  ST VW
  Left: AB D G J   O QR  U  XYZ
+
  Left:  BC  G IJ   O QR  U  XYZ
  
 
== Technical specification ==
 
== Technical specification ==
Line 132: Line 139:
 
If you are interested in incorporating this software into your project, here's what you need to know:
 
If you are interested in incorporating this software into your project, here's what you need to know:
  
Go to [http://www.standardaccesskeys.com/ www.standardaccesskeys.com] and read the latest version of the standard for integrating with your website.
+
Go to [https://www.standardaccesskeys.com/ www.standardaccesskeys.com] and read the latest version of the standard for integrating with your website.
  
 
== Notes for developers ==
 
== Notes for developers ==
Line 146: Line 153:
 
Things to do, in rough order of priority:
 
Things to do, in rough order of priority:
  
* Create /keys page to auto-detect users' modifier keys
+
* Complete SAK2018 documentation
 +
* Ratify SAK2018
 +
* Create /keys page to auto-detect users' modifier keys (see: [https://en.wikipedia.org/wiki/Access_key#Access_in_different_browsers Wikipedia])
  
 
== Done ==
 
== Done ==
Line 152: Line 161:
 
Stuff that's done. Latest stuff on top.
 
Stuff that's done. Latest stuff on top.
  
 +
* [[User:John|JE]] 2018-02-28: fleshed out the functional specification for SAK2018
 
* [[User:John|JE]] 2018-02-28: created SAK2018 project at ProgClub (this page)
 
* [[User:John|JE]] 2018-02-28: created SAK2018 project at ProgClub (this page)
 
* [[User:John|JE]] 2014-10-16: created /SAK2014 for the first version of the standard
 
* [[User:John|JE]] 2014-10-16: created /SAK2014 for the first version of the standard

Latest revision as of 01:40, 1 March 2018

SAK2018 is the ProgClub Standard Access Keys for web browsers specification. That's the specification you can use when implementing standard access keys for your website. For other projects see projects.

Status

Unreleased. Planning is documented below.

Administration

Contributors

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

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

Collaborators

Non-members who have contributed ideas to this project. Newest on top.

  • Klaus Mueller
  • Sam

Copyright

Copyright 2014-2018, Contributors.

License

Licensed under the New BSD license.

Resources

Downloads

N/A.

Source code

The repository can be browsed online:

https://www.progclub.org/pcrepo/standardaccesskeys/branches/0.1

The latest stable released version of the code is available from:

https://www.progclub.org/svn/pcrepo/standardaccesskeys/tags/latest/0.1

Or if you want the latest version for development purposes:

https://www.progclub.org/svn/pcrepo/standardaccesskeys/branches/0.1

Links

Specifications

Functional specification

The functional specification describes what the project does.

The specification nominates specific access keys with particular semantics and can be incorporated into most websites.

Numerical key assignments

Key Scope Location Window/Tab
0 Page Help New Window
1 Site Home
2 Site Sign-up / Create Account
3 Site Site Map
4 Page Search
5 Page License
6 Page Copyright
7 Site Privacy Policy
8 Site Terms & Conditions
9 Site Contact Form and/or Details

Alphabetical key assignments

Key Scope Location Window/Tab Thoughts
K Site Access Keys New Window
T Site Table of Contents
H Page Back to Top
N Page Next Article
P Page Previous Article
W Site What's new? Blog / News
F Site Syndication Feed New Window
M Site Social Media
L Site Login / Logout
A Page Add / Create / New
V Page View / Preview
E Page Edit
S Site Save / Send / Submit
D Page Delete

Alphabetical key availability

Used: A  DEF H  KLMN P  ST VW
Left:  BC   G IJ    O QR  U  XYZ

Technical specification

The technical specification describes how the project works.

The specification rests on the HTML accesskey attribute.

Notes

Notes for implementers

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

Go to www.standardaccesskeys.com and read the latest version of the standard for integrating with your website.

Notes for developers

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

You can discuss features of successive versions of the standard on the ProgClub programming list.

Tasks

TODO

Things to do, in rough order of priority:

  • Complete SAK2018 documentation
  • Ratify SAK2018
  • Create /keys page to auto-detect users' modifier keys (see: Wikipedia)

Done

Stuff that's done. Latest stuff on top.

  • JE 2018-02-28: fleshed out the functional specification for SAK2018
  • JE 2018-02-28: created SAK2018 project at ProgClub (this page)
  • JE 2014-10-16: created /SAK2014 for the first version of the standard
  • JE 2014-10-16: started SAK2014 spec
  • JE 2014-10-16: created project in svn
  • JE 2014-10-16: created project page