Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/help/configure-home-view.md

86 lines
2.8 KiB
Markdown
Raw Normal View History

settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
# Configure home view
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
The home view in Zulip is the view you reach after logging in
to the Zulip web app. You can also navigate to the home view via
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
keyboard shortcuts.
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
The home views available in Zulip are
help: Document Inbox view. - Adds desktop/web instructions. - Adds #inbox relative link for logged-in users. - Moves Inbox up in the left sidebar just under "Reading strategies". - Moves Inbox article content to Markdown include. - Adds "From the Inbox view" section to "Finding a topic to read", "Getting started with Zulip", and "Reading strategies". - Documents Inbox as a new option for the default web app view. - Removes unused Markdown link. - Tweaks subheading to better match help center patterns. - Add Inbox option in "Configure default settings for new users". - Adds new tabbed section and instructions for marking messages as read and reading topics via the Inbox view. Fixes #26903. Co-authored-by: Alya Abbott <alya@zulip.com>
2023-09-30 02:21:16 +02:00
[**Inbox**](/help/inbox),
[Recent conversations](/help/recent-conversations), and
help: Change URL from all-messages to combined-feed. Changes url from /help/all-messages to /help/combined-feed. Also renames files "all-messages.md" and "go-to-all-messages.md" to "combined-feed.md" and "go-to-combined-feed.md" respectively. Fixes #27802.
2024-04-23 20:59:38 +02:00
[Combined feed](/help/combined-feed). See
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
[Reading strategies](/help/reading-strategies) for recommendations
on how to use these views.
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
You can configure which view is set as your home view, and whether
the <kbd>Esc</kbd> key navigates to the home view. Also, you can
keyboard-shortcuts: Display "Ctrl" for Vim "Esc" keybinding behavior. For all users, we want to display "Ctrl" for the "Ctrl" "[" keyboard shortcuts that match the "Esc" Vim keybinding behavior. We use the "data-mac-key" attribute to override the default mapping of "Ctrl" to "Cmd" for Mac users in the documentation of these keyboard shortcuts. Fixes #20107.
2024-11-01 12:42:55 +01:00
always reach the home view by using the
<kbd data-mac-key="Ctrl">Ctrl</kbd> + <kbd>[</kbd> shortcut.
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
## Change home view
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
Organization administrators can [configure the home view for their
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
organization](/help/configure-default-new-user-settings) to
help: Document Inbox view. - Adds desktop/web instructions. - Adds #inbox relative link for logged-in users. - Moves Inbox up in the left sidebar just under "Reading strategies". - Moves Inbox article content to Markdown include. - Adds "From the Inbox view" section to "Finding a topic to read", "Getting started with Zulip", and "Reading strategies". - Documents Inbox as a new option for the default web app view. - Removes unused Markdown link. - Tweaks subheading to better match help center patterns. - Add Inbox option in "Configure default settings for new users". - Adds new tabbed section and instructions for marking messages as read and reading topics via the Inbox view. Fixes #26903. Co-authored-by: Alya Abbott <alya@zulip.com>
2023-09-30 02:21:16 +02:00
[**Inbox**](/help/inbox),
[**Recent conversations**](/help/recent-conversations), or
help: Change URL from all-messages to combined-feed. Changes url from /help/all-messages to /help/combined-feed. Also renames files "all-messages.md" and "go-to-all-messages.md" to "combined-feed.md" and "go-to-combined-feed.md" respectively. Fixes #27802.
2024-04-23 20:59:38 +02:00
[**Combined feed**](/help/combined-feed).
help: Convert default view recommendations into bullets.
2023-10-12 20:09:50 +02:00
- The **Inbox** view works best if you regularly clear all unread messages in
help: Rename remaining 'stream' to 'channel' in '/help' docs.
2024-05-06 09:20:58 +02:00
channels you follow.
help: Convert default view recommendations into bullets.
2023-10-12 20:09:50 +02:00
- **Recent conversations** works well for getting an overview of recent activity.
left_sidebar: Rename All messages to Global Feed. Fixes part of #27802.
2024-04-02 13:10:48 +02:00
- **Combined feed** is convenient for low-traffic organizations, or for skimming
help: Convert default view recommendations into bullets.
2023-10-12 20:09:50 +02:00
messages as they come in.
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
You can customize your personal home view regardless of
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
organization settings:
{start_tabs}
settings: Change "Display settings" to "Preferences". This includes changing the URL to #settings/preferences, with a transparent redirect so that existing links, like the one from Welcome Bot, continue to work.
2023-06-29 15:28:38 +02:00
{settings_tab|preferences}
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
docs: Replace `Advanced` with relevant section for user Preferences. This is a followup commit to #30824. Fixes https://chat.zulip.org/#narrow/stream/9-issues/topic/.F0.9F.8E.AF.20help.20not.20updated.20for.20new.20preferences.20sections/near/1899330. git grep in the help directory will still show up results for `Advanced` but those are mostly used in either plain english language instructions or refer to some other part of the app. At the point of writing this commit, there were 6 results for `Advanced`, 4 of which were plain english, 1 refers to the Advanced settings in chrome for desktop notifications, and another one refers to `Advanced configurations` for channel settings.
2024-07-23 05:08:17 +02:00
1. Under **Navigation**, click on the **Home view** dropdown
help-docs: Use `<kbd>` HTML elements for references to keyboard keys. Updates references to keyboard keys in the help center docs to use `<kbd>` HTML elements, which also means updating them to be as the key would appear on a keyboard. Previously, uppercase and lowercase letters were used to indicate when/if the `Shift` key was being used, and even that was not consistent throughout the documentation. For CSS styling, adds a similar rule for `<kbd>` elements that is used in `/static/styles/app_components.css`. And updates the CSS class used in `/static/js/portico/help.js` for `adjust_mac_shortcuts` accordingly. Also, takes advantage of revising these pages for making small updates for current help center documentation practices.
2022-06-02 01:56:59 +02:00
and select a view.
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
1. To see your changes in action, open a new Zulip tab, or use a keyboard
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
shortcut twice to exit the settings and navigate to your home view
keyboard-shortcuts: Display "Ctrl" for Vim "Esc" keybinding behavior. For all users, we want to display "Ctrl" for the "Ctrl" "[" keyboard shortcuts that match the "Esc" Vim keybinding behavior. We use the "data-mac-key" attribute to override the default mapping of "Ctrl" to "Cmd" for Mac users in the documentation of these keyboard shortcuts. Fixes #20107.
2024-11-01 12:42:55 +01:00
(<kbd data-mac-key="Ctrl">Ctrl</kbd> + <kbd>[</kbd> or <kbd>Esc</kbd>
if enabled).
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
help: Document changing home view from left sidebar. Documents this new feature as a tip for the existing instructions. Fixes #27655.
2023-11-16 02:48:33 +01:00
!!! tip ""
You can also hover over your desired home view in the left sidebar, and
choose the option to **make it your home view** in the **ellipsis**
(<i class="zulip-icon zulip-icon-more-vertical"></i>) menu.
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
{end_tabs}
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
## Configure whether <kbd>Esc</kbd> navigates to the home view
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
Zulip has a number of [keyboard shortcuts](/help/keyboard-shortcuts)
designed to enhance the user experience in the app.
help-docs: Use `<kbd>` HTML elements for references to keyboard keys. Updates references to keyboard keys in the help center docs to use `<kbd>` HTML elements, which also means updating them to be as the key would appear on a keyboard. Previously, uppercase and lowercase letters were used to indicate when/if the `Shift` key was being used, and even that was not consistent throughout the documentation. For CSS styling, adds a similar rule for `<kbd>` elements that is used in `/static/styles/app_components.css`. And updates the CSS class used in `/static/js/portico/help.js` for `adjust_mac_shortcuts` accordingly. Also, takes advantage of revising these pages for making small updates for current help center documentation practices.
2022-06-02 01:56:59 +02:00
By default, the <kbd>Esc</kbd> key shortcut will ultimately navigate to
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
your home view. You can disable this key binding if you would prefer.
help-docs: Use `<kbd>` HTML elements for references to keyboard keys. Updates references to keyboard keys in the help center docs to use `<kbd>` HTML elements, which also means updating them to be as the key would appear on a keyboard. Previously, uppercase and lowercase letters were used to indicate when/if the `Shift` key was being used, and even that was not consistent throughout the documentation. For CSS styling, adds a similar rule for `<kbd>` elements that is used in `/static/styles/app_components.css`. And updates the CSS class used in `/static/js/portico/help.js` for `adjust_mac_shortcuts` accordingly. Also, takes advantage of revising these pages for making small updates for current help center documentation practices.
2022-06-02 01:56:59 +02:00
This will not disable other <kbd>Esc</kbd> key shortcuts used in Zulip,
keyboard-shortcuts: Display "Ctrl" for Vim "Esc" keybinding behavior. For all users, we want to display "Ctrl" for the "Ctrl" "[" keyboard shortcuts that match the "Esc" Vim keybinding behavior. We use the "data-mac-key" attribute to override the default mapping of "Ctrl" to "Cmd" for Mac users in the documentation of these keyboard shortcuts. Fixes #20107.
2024-11-01 12:42:55 +01:00
and will not affect the behavior of the
<kbd data-mac-key="Ctrl">Ctrl</kbd> + <kbd>[</kbd> shortcut.
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
### Toggle whether <kbd>Esc</kbd> navigates to the home view
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
{start_tabs}
settings: Change "Display settings" to "Preferences". This includes changing the URL to #settings/preferences, with a transparent redirect so that existing links, like the one from Welcome Bot, continue to work.
2023-06-29 15:28:38 +02:00
{settings_tab|preferences}
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
docs: Replace `Advanced` with relevant section for user Preferences. This is a followup commit to #30824. Fixes https://chat.zulip.org/#narrow/stream/9-issues/topic/.F0.9F.8E.AF.20help.20not.20updated.20for.20new.20preferences.20sections/near/1899330. git grep in the help directory will still show up results for `Advanced` but those are mostly used in either plain english language instructions or refer to some other part of the app. At the point of writing this commit, there were 6 results for `Advanced`, 4 of which were plain english, 1 refers to the Advanced settings in chrome for desktop notifications, and another one refers to `Advanced configurations` for channel settings.
2024-07-23 05:08:17 +02:00
1. Under **Navigation**, toggle **Escape key navigates to
settings: Rename "default" views to "home" views in settings and docs. This commit renames "default" views to "home" views in the setting labels, keyboard shortcuts list, help documentation and its urls. This commit does not do changes in variable and class names, setting field in database, API docs and changelog. Fixes part of #27251.
2023-10-18 11:30:32 +02:00
home view**, as desired.
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
{end_tabs}
## Related articles
help-docs: Use `<kbd>` HTML elements for references to keyboard keys. Updates references to keyboard keys in the help center docs to use `<kbd>` HTML elements, which also means updating them to be as the key would appear on a keyboard. Previously, uppercase and lowercase letters were used to indicate when/if the `Shift` key was being used, and even that was not consistent throughout the documentation. For CSS styling, adds a similar rule for `<kbd>` elements that is used in `/static/styles/app_components.css`. And updates the CSS class used in `/static/js/portico/help.js` for `adjust_mac_shortcuts` accordingly. Also, takes advantage of revising these pages for making small updates for current help center documentation practices.
2022-06-02 01:56:59 +02:00
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
* [Reading strategies](/help/reading-strategies)
recent-topics: Rename to "Recent conversations" in web-app and docs. Replaces instances of "recent topics" in the web-app and documentation to be "recent conversations". Renames both `recent-topics.md` files in the help center to be `recent-conversations.md` and updates/redirects links to new URL. Does not update instances of "recent topics" in frontend code comments and does not update the main overview changelog, for now. Does not change case study text where "recent topics" was referenced in a quote, but does change generic text references to be "recent conversations".
2022-10-12 19:54:34 +02:00
* [Recent conversations](/help/recent-conversations)
help: Change URL from all-messages to combined-feed. Changes url from /help/all-messages to /help/combined-feed. Also renames files "all-messages.md" and "go-to-all-messages.md" to "combined-feed.md" and "go-to-combined-feed.md" respectively. Fixes #27802.
2024-04-23 20:59:38 +02:00
* [Combined feed](/help/combined-feed)
user_settings: Add option to disable escape key navigation to default view. Add `escape_navigates_to_default_view` as a bool setting in UserBaseSettings model and implement it as a checkbox that toggles the hotkey implementation of escape to the default view in the advanced user display settings. With /help/ documentation edits from Alya Abbott. Fixes #20043.
2021-10-25 19:17:19 +02:00
* [Keyboard shortcuts](/help/keyboard-shortcuts)