[open-ils-commits] [GIT] Evergreen ILS branch master updated. 950eea16afdd75ca6d3937a8680fbfa1cd866376
Evergreen Git
git at git.evergreen-ils.org
Wed Sep 27 17:01:24 EDT 2017
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Evergreen ILS".
The branch, master has been updated
via 950eea16afdd75ca6d3937a8680fbfa1cd866376 (commit)
via 76de06c36640939f304b38ad1245ca3f434b46cc (commit)
from 967458ed37347e4f623997c2e9fb512620098b83 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 950eea16afdd75ca6d3937a8680fbfa1cd866376
Author: Kathy Lussier <klussier at masslnc.org>
Date: Wed Sep 27 16:39:04 2017 -0400
Docs: Adding information on using native browser functionality
The section on setting a home page seemed out of place in the Log in section.
I moved it to a new section that covers best practices for using the browser,
which also includes earlier documentation on using tabs and new documentation
on disabling popup blockers.
Signed-off-by: Kathy Lussier <klussier at masslnc.org>
diff --git a/docs/admin/web-client-browser-best-practices.adoc b/docs/admin/web-client-browser-best-practices.adoc
new file mode 100644
index 0000000..f930366
--- /dev/null
+++ b/docs/admin/web-client-browser-best-practices.adoc
@@ -0,0 +1,63 @@
+Best Practices for Using the Browser
+------------------------------------
+
+Pop-up Blockers
+~~~~~~~~~~~~~~~
+Before using the web client, be sure to disable pop-up blockers for your
+Evergreen system's domain.
+
+- In Chrome, select _Settings_ from the Chrome menu and click on _Content
+settings_ in the advanced section. Select _Popups_ and then add your domain to
+the _Allowed_ list.
+- In Firefox, select _Preferences_ from the Firefox menu and then select the
+_Content_ panel. Click the _Exceptions_ button and add your domain to the
+_Allowed Sites_ list.
+
+
+Setting Browser Defaults for Web Client
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To ensure that staff can easily get to the web client portal page on login
+without additional steps, you can set the browser's home page to default to the
+web client.
+
+Setting the Web Client as the Home Page in Chrome
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+. In the top-right corner of your browser, click the Chrome menu.
+. Select *Settings*.
+. In the _On startup_ section, select _Open a specific page or set of pages._
+. Click the *Set Pages* link.
+. Add _https://localhost/eg/staff/_ to the _Enter URL_ box and click *OK*.
+
+Setting the Web Client as the Home Page in Firefox
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+. In the top-right corner of your browser, click the menu button.
+. Click *Options*.
+. In the _When Firefox starts:_ dropdown menu, select _Show my home page_.
+. In the _Home Page_ box, add _https://localhost/eg/staff/_ and click *OK*.
+
+Tab Buttons and Keyboard Shortcuts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Now that the client will be loaded in a web browser, users can use browser-based
+tab controls and keyboard shortcuts to help with navigation. Below are some
+tips for browser navigation that can be used in Chrome and Firefox on Windows
+PCs.
+
+- Use CTRL-T or click the browser's new tab button to open a new tab.
+- Use CTRL-W or click the x in the tab to close the tab.
+- Undo closing a tab by hitting CTRL-Shift-Tab.
+- To open a link from the web client in a new tab, CTRL-click the link or
+right-click the link and select *Open Link in New Tab*. Using this method, you
+can also open options from the web client's dropdown menus in a new tab
+- Navigate from one tab to another using CTRL-Tab on the keyboard.
+
+Setting New Tab Behavior
+^^^^^^^^^^^^^^^^^^^^^^^^
+Some users may want to automatically open the web client's portal page in a new
+tab. Neither Chrome nor Firefox will open your home page by default when you
+open a new tab. However, both browsers have optional add-ons that will allow you
+to set the browsers to automatically open the home page whenever open opening a
+new tab. These add-ons may be useful for those libraries that want the new tab
+to open to the web client portal page.
+
+
diff --git a/docs/admin/web_client-browser-tab-shortcuts.adoc b/docs/admin/web_client-browser-tab-shortcuts.adoc
deleted file mode 100644
index bbdf908..0000000
--- a/docs/admin/web_client-browser-tab-shortcuts.adoc
+++ /dev/null
@@ -1,23 +0,0 @@
-Tab Browser-Based Tab Buttons and Keyboard Shortcuts
-----------------------------------------------------
-Now that the client will be loaded in a web browser, users can use browser-based
-tab controls and keyboard shortcuts to help with navigation. Below are some
-tips for browser navigation that can be used in Chrome and Firefox on Windows
-PCs.
-
-- Use CTRL-T or click the browser's new tab button to open a new tab.
-- Use CTRL-W or click the x in the tab to close the tab.
-- Undo closing a tab by hitting CTRL-Shift-Tab.
-- To open a link from the web client in a new tab, CTRL-click the link or
-right-click the link and select *Open Link in New Tab*. Using this method, you
-can also open options from the web client's dropdown menus in a new tab
-- Navigate from one tab to another using CTRL-Tab on the keyboard.
-
-Setting New Tab Behavior
-~~~~~~~~~~~~~~~~~~~~~~~~
-Some users may want to automatically open the web client's portal page in a new
-tab. Neither Chrome nor Firefox will open your home page by default when you
-open a new tab. However, both browsers have optional add-ons that will allow you
-to set the browsers to automatically open the home page whenever open opening a
-new tab. These add-ons may be useful for those libraries that want the new tab
-to open to the web client portal page.
diff --git a/docs/admin/web_client-login.adoc b/docs/admin/web_client-login.adoc
index c96ec40..de2d0b6 100644
--- a/docs/admin/web_client-login.adoc
+++ b/docs/admin/web_client-login.adoc
@@ -36,27 +36,7 @@ indexterm:[staff client, logging in]
. Verify that the correct workstation is selected and click *Sign In*.
[[browser_defaults]]
-Setting Browser Defaults for Web Client
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-To ensure that staff can easily get to the web client portal page on login
-without additional steps, you can set the browser's home page to default to the
-web client.
-
-Setting the Web Client as the Home Page in Chrome
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-. In the top-right corner of your browser, click the Chrome menu.
-. Select *Settings*.
-. In the _On startup_ section, select _Open a specific page or set of pages._
-. Click the *Set Pages* link.
-. Add _https://localhost/eg/staff/_ to the _Enter URL_ box and click *OK*.
-
-Setting the Web Client as the Home Page in Firefox
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-. In the top-right corner of your browser, click the menu button.
-. Click *Options*.
-. In the _When Firefox starts:_ dropdown menu, select _Show my home page_.
-. In the _Home Page_ box, add _https://localhost/eg/staff/_ and click *OK*.
Logging Out
~~~~~~~~~~~
diff --git a/docs/root.adoc b/docs/root.adoc
index 695967a..b6a8f49 100644
--- a/docs/root.adoc
+++ b/docs/root.adoc
@@ -180,7 +180,7 @@ For information about the XUL client, consult the http://docs.evergreen-ils.org/
include::admin/web_client-login.adoc[]
-include::admin/web_client-browser-tab-shortcuts.adoc[]
+include::admin/web-client-browser-best-practices.adoc[]
include::admin/staff_client-column_picker.adoc[]
commit 76de06c36640939f304b38ad1245ca3f434b46cc
Author: Kathy Lussier <klussier at masslnc.org>
Date: Wed Sep 27 16:03:44 2017 -0400
Docs: Update login chapter
Some things have changed in the web client since this documentation was
first created. Removing the note that workstation registration is not required
and updating the caution on what happens when exiting the browser.
Previously, workstation registration was part of installing the staff client,
but since we have nothing to install, I added it to the logging in section. I
also removed a xul client feature from the main root.adoc.
Signed-off-by: Kathy Lussier <klussier at masslnc.org>
diff --git a/docs/admin/web_client-login.adoc b/docs/admin/web_client-login.adoc
index c464a0d..c96ec40 100644
--- a/docs/admin/web_client-login.adoc
+++ b/docs/admin/web_client-login.adoc
@@ -1,7 +1,32 @@
Logging into Evergreen
-----------------------
-Basic Login
+Registering a Workstation
+~~~~~~~~~~~~~~~~~~~~~~~~~
+anchor:register_workstation[]
+indexterm:[staff client, registering a workstation]
+
+Before logging into Evergreen, you must first register a workstation from your
+browser.
+
+[NOTE]
+===============
+You will need the permissions to add workstations to your network. If you do
+not have these permissions, ask your system administrator for assistance.
+===============
+
+. When you login for the first time, you will arrive at a screen asking that you
+register your workstation
++
+image::media/web_client_workstation_registration.png[]
++
+. Create a unique workstation name.
+. Click _Register_
+. After confirming the new workstation is listed in the _Workstations Registered
+With This Browser_ menu, click _Use Now_ to return to the login page. Your
+newly-registered workstation should be selected by default on the login page.
+
+Basic Login,
~~~~~~~~~~~
indexterm:[staff client, logging in]
@@ -9,12 +34,6 @@ indexterm:[staff client, logging in]
. The default URL to log into the client is _https://localhost/eg/staff/login_
. Enter your _Username_ and _Password_.
. Verify that the correct workstation is selected and click *Sign In*.
-[NOTE]
-Although workstation registration is not required in the web client, it is
-highly recommended that you register the workstation for all web client features
-to work correctly. If you have not yet registered a workstation, you need to log
-in with the workstation field unset, then answer the prompts to register and use
-a new workstation.
[[browser_defaults]]
Setting Browser Defaults for Web Client
@@ -51,5 +70,6 @@ of the window.
. Select *Log Out*
[CAUTION]
-Exiting the browser will not log you out of the web client.
+Exiting all browser windows will automatically log you out of the web client. If
+you only close the tab where the web client is loaded, you will remain logged in.
diff --git a/docs/media/web_client_workstation_registration.png b/docs/media/web_client_workstation_registration.png
new file mode 100644
index 0000000..7224672
Binary files /dev/null and b/docs/media/web_client_workstation_registration.png differ
diff --git a/docs/root.adoc b/docs/root.adoc
index 5c36a06..695967a 100644
--- a/docs/root.adoc
+++ b/docs/root.adoc
@@ -186,8 +186,6 @@ include::admin/staff_client-column_picker.adoc[]
include::admin/staff_client-recent_searches.adoc[]
-include::admin/staff_client-return_to_results_from_marc.adoc[]
-
include::admin/workstation_admin.adoc[]
// Push titles down one level.
-----------------------------------------------------------------------
Summary of changes:
docs/admin/web-client-browser-best-practices.adoc | 63 ++++++++++++++++++++
docs/admin/web_client-browser-tab-shortcuts.adoc | 23 -------
docs/admin/web_client-login.adoc | 58 +++++++++---------
docs/media/web_client_workstation_registration.png | Bin 0 -> 16702 bytes
docs/root.adoc | 4 +-
5 files changed, 93 insertions(+), 55 deletions(-)
create mode 100644 docs/admin/web-client-browser-best-practices.adoc
delete mode 100644 docs/admin/web_client-browser-tab-shortcuts.adoc
create mode 100644 docs/media/web_client_workstation_registration.png
hooks/post-receive
--
Evergreen ILS
More information about the open-ils-commits
mailing list