From 56c86b656788aa48f88fca54c2a9dc1c86558db4 Mon Sep 17 00:00:00 2001 From: Andrew Manning Date: Mon, 21 Mar 2016 06:33:02 -0400 Subject: [PATCH 1/5] Override navbar help button to open contextual help panel. Contextual help for mail written. --- doc/context/admin/security/help.html | 3 ++ doc/context/mail/combined/help.html | 10 ++++++ doc/context/mail/help.html | 10 ++++++ doc/context/mail/inbox/help.html | 10 ++++++ doc/context/mail/new/help.html | 10 ++++++ doc/context/mail/outbox/help.html | 10 ++++++ include/nav.php | 11 +++++-- view/tpl/nav.tpl | 49 ++++++++++++++++++++++++++-- 8 files changed, 108 insertions(+), 5 deletions(-) create mode 100644 doc/context/admin/security/help.html create mode 100644 doc/context/mail/combined/help.html create mode 100644 doc/context/mail/help.html create mode 100644 doc/context/mail/inbox/help.html create mode 100644 doc/context/mail/new/help.html create mode 100644 doc/context/mail/outbox/help.html diff --git a/doc/context/admin/security/help.html b/doc/context/admin/security/help.html new file mode 100644 index 000000000..e9a741a5e --- /dev/null +++ b/doc/context/admin/security/help.html @@ -0,0 +1,3 @@ +

Security Settings

+

This page contains various administrator settings related to security.

+

To save any changes you make to these settings, you must press the Submit button.

\ No newline at end of file diff --git a/doc/context/mail/combined/help.html b/doc/context/mail/combined/help.html new file mode 100644 index 000000000..a2361a135 --- /dev/null +++ b/doc/context/mail/combined/help.html @@ -0,0 +1,10 @@ +
+
General
+
The messages displayed in private mail are visible only to you and the single recipient.
+
Combined View
+
Complete conversations can be viewed in a continuous thread by selecting Combined View. Available conversations are displayed beneath the menu in the side panel.
+
Inbox/Outbox
+
Individual sent messages are viewed by selecting Outbox, and incoming messages are viewed using the Inbox filter.
+
New Message
+
Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message if they have not already read it.
+
\ No newline at end of file diff --git a/doc/context/mail/help.html b/doc/context/mail/help.html new file mode 100644 index 000000000..a2361a135 --- /dev/null +++ b/doc/context/mail/help.html @@ -0,0 +1,10 @@ +
+
General
+
The messages displayed in private mail are visible only to you and the single recipient.
+
Combined View
+
Complete conversations can be viewed in a continuous thread by selecting Combined View. Available conversations are displayed beneath the menu in the side panel.
+
Inbox/Outbox
+
Individual sent messages are viewed by selecting Outbox, and incoming messages are viewed using the Inbox filter.
+
New Message
+
Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message if they have not already read it.
+
\ No newline at end of file diff --git a/doc/context/mail/inbox/help.html b/doc/context/mail/inbox/help.html new file mode 100644 index 000000000..a2361a135 --- /dev/null +++ b/doc/context/mail/inbox/help.html @@ -0,0 +1,10 @@ +
+
General
+
The messages displayed in private mail are visible only to you and the single recipient.
+
Combined View
+
Complete conversations can be viewed in a continuous thread by selecting Combined View. Available conversations are displayed beneath the menu in the side panel.
+
Inbox/Outbox
+
Individual sent messages are viewed by selecting Outbox, and incoming messages are viewed using the Inbox filter.
+
New Message
+
Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message if they have not already read it.
+
\ No newline at end of file diff --git a/doc/context/mail/new/help.html b/doc/context/mail/new/help.html new file mode 100644 index 000000000..a2361a135 --- /dev/null +++ b/doc/context/mail/new/help.html @@ -0,0 +1,10 @@ +
+
General
+
The messages displayed in private mail are visible only to you and the single recipient.
+
Combined View
+
Complete conversations can be viewed in a continuous thread by selecting Combined View. Available conversations are displayed beneath the menu in the side panel.
+
Inbox/Outbox
+
Individual sent messages are viewed by selecting Outbox, and incoming messages are viewed using the Inbox filter.
+
New Message
+
Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message if they have not already read it.
+
\ No newline at end of file diff --git a/doc/context/mail/outbox/help.html b/doc/context/mail/outbox/help.html new file mode 100644 index 000000000..a2361a135 --- /dev/null +++ b/doc/context/mail/outbox/help.html @@ -0,0 +1,10 @@ +
+
General
+
The messages displayed in private mail are visible only to you and the single recipient.
+
Combined View
+
Complete conversations can be viewed in a continuous thread by selecting Combined View. Available conversations are displayed beneath the menu in the side panel.
+
Inbox/Outbox
+
Individual sent messages are viewed by selecting Outbox, and incoming messages are viewed using the Inbox filter.
+
New Message
+
Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message if they have not already read it.
+
\ No newline at end of file diff --git a/include/nav.php b/include/nav.php index 5f630745c..c7483deef 100644 --- a/include/nav.php +++ b/include/nav.php @@ -151,9 +151,14 @@ EOT; $help_url = z_root() . '/help?f=&cmd=' . $a->cmd; - if(! get_config('system','hide_help')) - $nav['help'] = array($help_url, t('Help'), "", t('Help and documentation'),'help_nav_btn'); - + if(! get_config('system','hide_help')) { + require_once('mod/help.php'); + $context_help = load_doc_file('doc/context/' . $a->cmd . '/help.html'); + if (! $context_help) { + $context_help = ''; + } + $nav['help'] = array($help_url, t('Help'), "", t('Help and documentation'),'help_nav_btn',$context_help); + } if(! UNO) $nav['apps'] = array('apps', t('Apps'), "", t('Applications, utilities, links, games'),'apps_nav_btn'); diff --git a/view/tpl/nav.tpl b/view/tpl/nav.tpl index 3d6809c22..dc5dd27f3 100755 --- a/view/tpl/nav.tpl +++ b/view/tpl/nav.tpl @@ -1,4 +1,44 @@ -
+ + + +
From 61bef7d4b083c9c794469137798176b62c2f21cb Mon Sep 17 00:00:00 2001 From: Andrew Manning Date: Wed, 23 Mar 2016 21:16:21 -0400 Subject: [PATCH 2/5] Network page help with auto-scroll and element highlighting --- doc/context/network/help.html | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 doc/context/network/help.html diff --git a/doc/context/network/help.html b/doc/context/network/help.html new file mode 100644 index 000000000..9d9031af8 --- /dev/null +++ b/doc/context/network/help.html @@ -0,0 +1,26 @@ + +
+
General
+
The network page displays a stream of posts and conversations, typically ordered by the most recently updated. This page is highly customizable.
+
Create a Post
+
At the top of the page there is a text box that says "Share". Clicking this box opens a new post editor. The post editor is customizable, but the basic editor provides fields for a post body and an optional post Title. Buttons below the text area to the left provide shortcuts to text formatting and inserting links, images, and other data into the post. The buttons to the right provide a post preview, the post permissions setting, and a Submit button to send the post.
+
Privacy Groups
+
The privacy groups you have created are displayed in the side panel. Selecting them filters posts to those created by channels in the chosen group.
+
Post Permissions
+
+
\ No newline at end of file From 661b0084f3d819532c4c97c840a189d7e0c7a93d Mon Sep 17 00:00:00 2001 From: Andrew Manning Date: Sat, 26 Mar 2016 14:17:53 -0400 Subject: [PATCH 3/5] Added help for post permissions --- doc/context/network/help.html | 4 ++-- view/tpl/nav.tpl | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/context/network/help.html b/doc/context/network/help.html index 9d9031af8..956af7380 100644 --- a/doc/context/network/help.html +++ b/doc/context/network/help.html @@ -21,6 +21,6 @@
At the top of the page there is a text box that says "Share". Clicking this box opens a new post editor. The post editor is customizable, but the basic editor provides fields for a post body and an optional post Title. Buttons below the text area to the left provide shortcuts to text formatting and inserting links, images, and other data into the post. The buttons to the right provide a post preview, the post permissions setting, and a Submit button to send the post.
Privacy Groups
The privacy groups you have created are displayed in the side panel. Selecting them filters posts to those created by channels in the chosen group.
-
Post Permissions
-
+
Post Permissions
+
The access control list (ACL) is what you use to set who can see your new post. Pressing the ACL button beside the Submit button will display a dialog in which you can select what channels and/or privacy groups can see the post. You can also select who is explicitly denied access. For example, say you are planning a surprise party for a friend. You can send an invitation post to everyone in your Friends group except the friend you are surprising. In this case you "show" the Friends group but "don't show" that one person.
\ No newline at end of file diff --git a/view/tpl/nav.tpl b/view/tpl/nav.tpl index dc5dd27f3..886f73947 100755 --- a/view/tpl/nav.tpl +++ b/view/tpl/nav.tpl @@ -19,11 +19,12 @@ top: 50px; left: -80%; width: 80%; + height: 60%; padding: 20px; transition: left 300ms cubic-bezier(0.17, 0.04, 0.03, 0.94); - overflow: hidden; box-sizing: border-box; border: #CCC thin solid; + overflow: auto; } .help-content-open { From c25ef1d9a86193eb5b96484d9bfaae0bd4166653 Mon Sep 17 00:00:00 2001 From: Andrew Manning Date: Sat, 26 Mar 2016 14:31:41 -0400 Subject: [PATCH 4/5] Search docs/context/ hierarchically for help.html files to reduce redundancy --- doc/context/channel/help.html | 20 ++++++++++++++++++++ doc/context/mail/combined/help.html | 10 ---------- doc/context/mail/inbox/help.html | 10 ---------- doc/context/mail/new/help.html | 10 ---------- doc/context/mail/outbox/help.html | 10 ---------- include/nav.php | 9 +++++++-- 6 files changed, 27 insertions(+), 42 deletions(-) create mode 100644 doc/context/channel/help.html delete mode 100644 doc/context/mail/combined/help.html delete mode 100644 doc/context/mail/inbox/help.html delete mode 100644 doc/context/mail/new/help.html delete mode 100644 doc/context/mail/outbox/help.html diff --git a/doc/context/channel/help.html b/doc/context/channel/help.html new file mode 100644 index 000000000..8c3d1e422 --- /dev/null +++ b/doc/context/channel/help.html @@ -0,0 +1,20 @@ + +
+
General
+
This is the home page of a channel. It is similar to someone's "wall" in a social network context.
+
\ No newline at end of file diff --git a/doc/context/mail/combined/help.html b/doc/context/mail/combined/help.html deleted file mode 100644 index a2361a135..000000000 --- a/doc/context/mail/combined/help.html +++ /dev/null @@ -1,10 +0,0 @@ -
-
General
-
The messages displayed in private mail are visible only to you and the single recipient.
-
Combined View
-
Complete conversations can be viewed in a continuous thread by selecting Combined View. Available conversations are displayed beneath the menu in the side panel.
-
Inbox/Outbox
-
Individual sent messages are viewed by selecting Outbox, and incoming messages are viewed using the Inbox filter.
-
New Message
-
Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message if they have not already read it.
-
\ No newline at end of file diff --git a/doc/context/mail/inbox/help.html b/doc/context/mail/inbox/help.html deleted file mode 100644 index a2361a135..000000000 --- a/doc/context/mail/inbox/help.html +++ /dev/null @@ -1,10 +0,0 @@ -
-
General
-
The messages displayed in private mail are visible only to you and the single recipient.
-
Combined View
-
Complete conversations can be viewed in a continuous thread by selecting Combined View. Available conversations are displayed beneath the menu in the side panel.
-
Inbox/Outbox
-
Individual sent messages are viewed by selecting Outbox, and incoming messages are viewed using the Inbox filter.
-
New Message
-
Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message if they have not already read it.
-
\ No newline at end of file diff --git a/doc/context/mail/new/help.html b/doc/context/mail/new/help.html deleted file mode 100644 index a2361a135..000000000 --- a/doc/context/mail/new/help.html +++ /dev/null @@ -1,10 +0,0 @@ -
-
General
-
The messages displayed in private mail are visible only to you and the single recipient.
-
Combined View
-
Complete conversations can be viewed in a continuous thread by selecting Combined View. Available conversations are displayed beneath the menu in the side panel.
-
Inbox/Outbox
-
Individual sent messages are viewed by selecting Outbox, and incoming messages are viewed using the Inbox filter.
-
New Message
-
Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message if they have not already read it.
-
\ No newline at end of file diff --git a/doc/context/mail/outbox/help.html b/doc/context/mail/outbox/help.html deleted file mode 100644 index a2361a135..000000000 --- a/doc/context/mail/outbox/help.html +++ /dev/null @@ -1,10 +0,0 @@ -
-
General
-
The messages displayed in private mail are visible only to you and the single recipient.
-
Combined View
-
Complete conversations can be viewed in a continuous thread by selecting Combined View. Available conversations are displayed beneath the menu in the side panel.
-
Inbox/Outbox
-
Individual sent messages are viewed by selecting Outbox, and incoming messages are viewed using the Inbox filter.
-
New Message
-
Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message if they have not already read it.
-
\ No newline at end of file diff --git a/include/nav.php b/include/nav.php index c7483deef..d449718b8 100644 --- a/include/nav.php +++ b/include/nav.php @@ -154,8 +154,13 @@ EOT; if(! get_config('system','hide_help')) { require_once('mod/help.php'); $context_help = load_doc_file('doc/context/' . $a->cmd . '/help.html'); - if (! $context_help) { - $context_help = ''; + $parentdir = dirname($a->cmd); + while (! $context_help && $parentdir !== '.') { + $context_help = load_doc_file('doc/context/' . $parentdir . '/help.html'); + $parentdir = dirname($parentdir); + } + if (! $context_help ) { + $context_help = ''; } $nav['help'] = array($help_url, t('Help'), "", t('Help and documentation'),'help_nav_btn',$context_help); } From 99d9456b3addc651a68874ddd391d25684252c4d Mon Sep 17 00:00:00 2001 From: Andrew Manning Date: Sat, 26 Mar 2016 14:55:16 -0400 Subject: [PATCH 5/5] More help content for channel pages. Channel, photos, files, about. --- doc/context/channel/help.html | 6 +++++- doc/context/cloud/help.html | 22 ++++++++++++++++++++++ doc/context/photos/help.html | 22 ++++++++++++++++++++++ doc/context/profile/help.html | 22 ++++++++++++++++++++++ 4 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 doc/context/cloud/help.html create mode 100644 doc/context/photos/help.html create mode 100644 doc/context/profile/help.html diff --git a/doc/context/channel/help.html b/doc/context/channel/help.html index 8c3d1e422..810913ff3 100644 --- a/doc/context/channel/help.html +++ b/doc/context/channel/help.html @@ -16,5 +16,9 @@
General
-
This is the home page of a channel. It is similar to someone's "wall" in a social network context.
+
This is the home page of a channel. It is similar to someone's profile "wall" in a social network context. Posts created by the channel are displayed according to the observer's viewing permissions.
+
Create a Post
+
If you have permission to create posts on the channel page, then you will see the post editor at the top.
+
Channel Content Tabs
+
The channel content tabs are links to other content published by the channel. The About tab links to the channel profile. The Photos tab links to the channel photo galleries. The Files tab links to the general shared files published by the channel.
\ No newline at end of file diff --git a/doc/context/cloud/help.html b/doc/context/cloud/help.html new file mode 100644 index 000000000..105947517 --- /dev/null +++ b/doc/context/cloud/help.html @@ -0,0 +1,22 @@ + +
+
General
+
This page displays a channel's "cloud" files. The files visible to the observer depend on the individual file permissions set by the channel owner. If you have permission to create/upload files you will see control buttons above the file list.
+
Channel Content Tabs
+
The channel content tabs are links to other content published by the channel. The About tab links to the channel profile. The Photos tab links to the channel photo galleries. The Files tab links to the general shared files published by the channel.
+
\ No newline at end of file diff --git a/doc/context/photos/help.html b/doc/context/photos/help.html new file mode 100644 index 000000000..f41611f8d --- /dev/null +++ b/doc/context/photos/help.html @@ -0,0 +1,22 @@ + +
+
General
+
This page displays a channel's photo albums. The images visible to the observer depend on the individual image permissions.
+
Channel Content Tabs
+
The channel content tabs are links to other content published by the channel. The About tab links to the channel profile. The Photos tab links to the channel photo galleries. The Files tab links to the general shared files published by the channel.
+
\ No newline at end of file diff --git a/doc/context/profile/help.html b/doc/context/profile/help.html new file mode 100644 index 000000000..0d4abb8cb --- /dev/null +++ b/doc/context/profile/help.html @@ -0,0 +1,22 @@ + +
+
General
+
This is the profile page of a channel. It typically displays information describing the channel. If the channel represents a person in a social network, for example, then the profile might provide contact information and other personal details about the person. Channels can have multiple profiles, where the displayed profile depends on the observer.
+
Channel Content Tabs
+
The channel content tabs are links to other content published by the channel. The About tab links to the channel profile. The Photos tab links to the channel photo galleries. The Files tab links to the general shared files published by the channel.
+
\ No newline at end of file