Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Migrate UI & Docs from Private to Direct phrasing #1322

Merged
merged 8 commits into from
Mar 21, 2023
Merged

Migrate UI & Docs from Private to Direct phrasing #1322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dd04047
messages: Rename 'private' to 'direct' in narrow titles and edit error.
theViz343 Mar 12, 2023
0e26cd8
tests: buttons: Add tests for PMButton button text and length.
theViz343 Mar 17, 2023
bbed974
buttons: Rename 'private' to 'direct' in left sidebar button.
theViz343 Mar 17, 2023
5533053
model: Rename 'private' to 'direct' in notifications.
theViz343 Mar 12, 2023
78254e5
keys: Rename 'private' to 'direct' in hotkeys descriptions.
theViz343 Mar 12, 2023
f33b6a3
README/docs: Rename 'private' to 'direct' in docs.
theViz343 Mar 18, 2023
38d5a1c
refactor: developer-file-overview: Reduce description column width.
theViz343 Mar 18, 2023
9e066bc
buttons: Replace 'private' to 'direct' in file docstring.
theViz343 Mar 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The terminal client currently has a number of intentional differences to the Zul
[Hot keys](https://github.com/zulip/zulip-terminal/blob/main/docs/hotkeys.md)
to better support keyboard-only navigation; other than directional movement
these also include:
- <kbd>z</kbd> - zoom in/out, between streams & topics, or all private messages & specific conversations
- <kbd>z</kbd> - zoom in/out, between streams & topics, or all direct messages & specific conversations
neiljp marked this conversation as resolved.
Show resolved Hide resolved
- <kbd>t</kbd> - toggle view of topics for a stream in left panel
(**later adopted for recent topics in web client**)
- <kbd>#</kbd> - narrow to messages in which you're mentioned (<kbd>@</kbd> is already used)
Expand Down
6 changes: 3 additions & 3 deletions docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ In the longer term we may move to multiple servers per session, which is tracked
## What is autocomplete? Why is it useful?

Autocomplete can be used to request matching options, and cycle through each option in turn, including:
- helping to specify users for new private messages (eg. after <kbd>x</kbd>)
- helping to specify users for new direct messages (eg. after <kbd>x</kbd>)
- helping to specify streams and existing topics for new stream messages (eg. after <kbd>c</kbd>)
- mentioning a user or user-group (in message content)
- linking to a stream or existing topic (in message content)
Expand Down Expand Up @@ -192,7 +192,7 @@ As in the example above, a specific prefix is required to indicate which action

### Autocomplete of message recipients

Since each of the stream (1), topic (2) and private message recipients (3) areas are very specific, no prefix must be manually entered and values provided through autocomplete depend upon the context automatically.
Since each of the stream (1), topic (2) and direct message recipients (3) areas are very specific, no prefix must be manually entered and values provided through autocomplete depend upon the context automatically.

![Stream header](https://user-images.githubusercontent.com/55916430/118403323-8e5b7580-b68b-11eb-9c8a-734c2fe6b774.png)

Expand All @@ -204,7 +204,7 @@ Since each of the stream (1), topic (2) and private message recipients (3) areas

![PM recipients header](https://user-images.githubusercontent.com/55916430/118403345-9d422800-b68b-11eb-9005-6d2af74adab9.png)

**NOTE:** If a private message recipient's name contains comma(s) (`,`), they are currently treated as comma-separated recipients.
**NOTE:** If a direct message recipient's name contains comma(s) (`,`), they are currently treated as comma-separated recipients.

## Unable to render symbols

Expand Down
4 changes: 2 additions & 2 deletions docs/developer-feature-tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ You can view these events in the `type` file in your `zulip-terminal` home direc

Now to display if user is typing in the view, we need to check few things:
* The `op` is `start`.
* User is narrowed into private message conversation with a user.
* The `user_id` of the person is present in the narrowed private message conversation recipients.
* User is narrowed into direct message conversation with a user.
* The `user_id` of the person is present in the narrowed direct message conversation recipients.

If all the above conditions are satisfied we can successfully update the footer to display `X is typing` until we receive
a `stop` event for typing.
Expand Down
68 changes: 34 additions & 34 deletions docs/developer-file-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,37 @@

Zulip Terminal uses [Zulip's API](https://zulip.com/api/) to store and retrieve all the information it displays. It has an [MVC structure](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) overall. Here is a description of some of its files:

| Folder | File | Description |
| ---------------------- | ------------------- | ------------------------------------------------------------------------------------------------------ |
| zulipterminal | api_types.py | Types from the Zulip API, translated into python, to improve type checking |
| | core.py | Defines the `Controller`, which sets up the `Model`, `View`, and how they interact |
| | helper.py | Helper functions used in multiple places |
| | model.py | Defines the `Model`, fetching and storing data retrieved from the Zulip server |
| | platform_code.py | Detection of supported platforms & platform-specific functions |
| | server_url.py | Constructs and encodes server_url of messages. |
| | ui.py | Defines the `View`, and controls where each component is displayed |
| | unicode_emojis.py | Unicode emoji data, synchronized semi-regularly with the server source |
| | urwid_types.py | Types from the urwid API, to improve type checking |
| | version.py | Keeps track of the version of the current code |
| | | |
| zulipterminal/cli | run.py | Marks the entry point into the application |
| | | |
| zulipterminal/config | color.py | Color definitions or functions common across all themes |
| | keys.py | Keybindings and their helper functions |
| | markdown_examples.py| Examples of input markdown and corresponding html output (rendered in markdown help) |
| | regexes.py | Regular expression constants |
| | symbols.py | Terminal characters used to mark particular elements of the user interface |
| | themes.py | Styles and their colour mappings in each theme, with helper functions |
| | ui_mappings.py | Relationships between state/API data and presentation in the UI |
| | ui_sizes.py | Fixed sizes of UI elements |
| | | |
| zulipterminal/ui_tools | boxes.py | UI boxes for entering text: WriteBox, MessageSearchBox, PanelSearchBox |
| | buttons.py | UI buttons for narrowing & showing unread counts, eg. All, Stream, Private, Topic |
| | messages.py | UI to render a Zulip message for display, and respond contextually to actions |
| | tables.py | Helper functions which render tables in the UI |
| | utils.py | The `MessageBox` for every message displayed is created here |
| | views.py | UI views for larger elements such as Streams, Messages, Topics, Help, etc |
| | | |
| zulipterminal/scripts | | Scripts bundled with the application |
| | | |
| zulipterminal/themes | | Themes bundled with the application |
| Folder | File | Description |
| ---------------------- | ------------------- | ----------------------------------------------------------------------------------------|
| zulipterminal | api_types.py | Types from the Zulip API, translated into python, to improve type checking |
| | core.py | Defines the `Controller`, which sets up the `Model`, `View`, and how they interact |
| | helper.py | Helper functions used in multiple places |
| | model.py | Defines the `Model`, fetching and storing data retrieved from the Zulip server |
| | platform_code.py | Detection of supported platforms & platform-specific functions |
| | server_url.py | Constructs and encodes server_url of messages. |
| | ui.py | Defines the `View`, and controls where each component is displayed |
| | unicode_emojis.py | Unicode emoji data, synchronized semi-regularly with the server source |
| | urwid_types.py | Types from the urwid API, to improve type checking |
| | version.py | Keeps track of the version of the current code |
| | | |
| zulipterminal/cli | run.py | Marks the entry point into the application |
| | | |
| zulipterminal/config | color.py | Color definitions or functions common across all themes |
| | keys.py | Keybindings and their helper functions |
| | markdown_examples.py| Examples of input markdown and corresponding html output (rendered in markdown help) |
| | regexes.py | Regular expression constants |
| | symbols.py | Terminal characters used to mark particular elements of the user interface |
| | themes.py | Styles and their colour mappings in each theme, with helper functions |
| | ui_mappings.py | Relationships between state/API data and presentation in the UI |
| | ui_sizes.py | Fixed sizes of UI elements |
| | | |
| zulipterminal/ui_tools | boxes.py | UI boxes for entering text: WriteBox, MessageSearchBox, PanelSearchBox |
| | buttons.py | UI buttons for narrowing & showing unread counts, eg. All, Stream, Direct, Topic |
| | messages.py | UI to render a Zulip message for display, and respond contextually to actions |
| | tables.py | Helper functions which render tables in the UI |
| | utils.py | The `MessageBox` for every message displayed is created here |
| | views.py | UI views for larger elements such as Streams, Messages, Topics, Help, etc |
| | | |
| zulipterminal/scripts | | Scripts bundled with the application |
| | | |
| zulipterminal/themes | | Themes bundled with the application |
24 changes: 12 additions & 12 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ This tutorial was designed to be interactive. We highly recommend opening up Zul
+ [Narrow to the Stream or Topic of a Message](#Narrow-to-the-Stream-or-Topic-of-a-Message)
6. [Sending Messages](#Sending-Messages)
+ [Reply to a Message](#Reply-to-a-Message)
+ [Reply via a Private Message](#Reply-via-a-Private-Message)
+ [Send a Private Message to Someone New](#Send-a-Private-Message-to-Someone-New)
+ [Reply via a Direct Message](#Reply-via-a-Direct-Message)
+ [Send a Direct Message to Someone New](#Send-a-Direct-Message-to-Someone-New)
+ [Create a New Topic](#Create-a-New-Topic)
7. [Edit a Message](#Edit-a-Message)
8. [Close Zulip Terminal](#Close-Zulip-Terminal)
Expand Down Expand Up @@ -63,7 +63,7 @@ Sometimes it can take forever to manually move our cursor where we want it - tha

Let's try out a few of these shortcuts!

+ First, type <kbd>shift</kbd><kbd>p</kbd> to view your **Private Messages** (PMs).
+ First, type <kbd>shift</kbd><kbd>p</kbd> to view your **Direct Messages**.

+ Second, type <kbd>#</kbd> to view all messages you were mentioned (@'ed) in.

Expand All @@ -77,7 +77,7 @@ Let's try out a few of these shortcuts!
You'll be hearing the term 'narrow' a lot in Zulip. What does it mean?

+ **Noun**: A narrow is a set of filters for Zulip messages, that can be based on many different factors (like sender, stream, topic, search keywords, etc.).
+ **Verb**: The process of navigating to a different narrow. For example, to go from viewing a stream to a topic within that stream. There are several different ways to 'narrow to a narrow' so to speak. For example, you can use the keyboard shortcuts as we did in the section above. When you used the keyboard shortcut <kbd>shift</kbd><kbd>p</kbd> to view your private messages (PMs), you 'narrowed' to the **Private Messages** narrow.
+ **Verb**: The process of navigating to a different narrow. For example, to go from viewing a stream to a topic within that stream. There are several different ways to 'narrow to a narrow' so to speak. For example, you can use the keyboard shortcuts as we did in the section above. When you used the keyboard shortcut <kbd>shift</kbd><kbd>p</kbd> to view your direct messages, you 'narrowed' to the **Direct Messages** narrow.

### Your Current Narrow

Expand Down Expand Up @@ -124,7 +124,7 @@ You can also type <kbd>z</kbd> to 'zoom in' or 'zoom out.' What do I mean by 'zo

### Reply to a Message

To reply to an existing stream- or private-message in any narrow, rest your cursor on the message you want to reply to and then type <kbd>r</kbd>. Type your message in the Message box that pops up at the bottom of the middle column. Type <kbd>ctrl</kbd><kbd>d</kbd> to send. If you change your mind and don't want to send the message, type <kbd>esc</kbd> to get out of the message editor. Let's try replying to a random message in the **[#test here](https://chat.zulip.org/#narrow/stream/7-test-here)** stream (don't worry about messing anything up, the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream was made for stuff like this).
To reply to an existing stream- or direct-message in any narrow, rest your cursor on the message you want to reply to and then type <kbd>r</kbd>. Type your message in the Message box that pops up at the bottom of the middle column. Type <kbd>ctrl</kbd><kbd>d</kbd> to send. If you change your mind and don't want to send the message, type <kbd>esc</kbd> to get out of the message editor. Let's try replying to a random message in the **[#test here](https://chat.zulip.org/#narrow/stream/7-test-here)** stream (don't worry about messing anything up, the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream was made for stuff like this).

<img src="getting-started-imgs/reply-to-message.png" width="85%">

Expand All @@ -134,21 +134,21 @@ If you want to show you agree with the current message, type <kbd>+</kbd> to add

<img src="getting-started-imgs/thumbs-up.png" width="85%">

### Reply via a Private Message
### Reply via a Direct Message

Let's try sending a private message to the author of a message. Select the message you sent to the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream earlier and press <kbd>shift</kbd><kbd>r</kbd> to send a private message to yourself. Type your message in the message editor that appears at the bottom of the middle column and then type <kbd>ctrl</kbd><kbd>d</kbd> to send. Press the <kbd>shift</kbd><kbd>p</kbd> hotkey as we did earlier in the tutorial to narrow to your private messages and make sure everything worked properly.
Let's try sending a direct message to the author of a message. Select the message you sent to the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream earlier and press <kbd>shift</kbd><kbd>r</kbd> to send a direct message to yourself. Type your message in the message editor that appears at the bottom of the middle column and then type <kbd>ctrl</kbd><kbd>d</kbd> to send. Press the <kbd>shift</kbd><kbd>p</kbd> hotkey as we did earlier in the tutorial to narrow to your direct messages and make sure everything worked properly.

<img src="getting-started-imgs/send-pm.png" width="85%">

### Send a Private Message to Someone New
### Send a Direct Message to Someone New

You can send a private message by moving your cursor to the list of "Users" in the right column and selecting the name of the person you'd like to send a message to.
You can send a direct message by moving your cursor to the list of "Users" in the right column and selecting the name of the person you'd like to send a message to.

From version 0.7.0 you can also use autocomplete to enter people's names from partial information, and easily send one-to-one or group private messages!
From version 0.7.0 you can also use autocomplete to enter people's names from partial information, and easily send one-to-one or group direct messages!

To send a private message using the autocomplete feature:
To send a direct message using the autocomplete feature:
1. Use the <kbd>x</kbd> hotkey. A message editor will pop open at the bottom of the middle column.
2. Type in part of the name of the person you'd like to send a private message to (IMG 1)
2. Type in part of the name of the person you'd like to send a direct message to (IMG 1)
3. Press <kbd>ctrl</kbd><kbd>f</kbd> and a list of potential recipients will appear in the footer (highlighted in red).
4. Press <kbd>ctrl</kbd><kbd>f</kbd> until the name of the person you want to send a message to is highlighted (IMG 2).
5. Press <kbd>tab</kbd> to jump to the message section and type in your message.
Expand Down
Loading