mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-03 21:43:21 +00:00 
			
		
		
		
	help: Add comma to all uses of "e.g." in help center docs.
This commit is contained in:
		
				
					committed by
					
						
						Tim Abbott
					
				
			
			
				
	
			
			
			
						parent
						
							41fbb5e263
						
					
				
				
					commit
					f325a7667a
				
			@@ -62,7 +62,7 @@ A few more details:
 | 
			
		||||
 | 
			
		||||
* **Generic**: A generic bot is like a normal Zulip user account that
 | 
			
		||||
  cannot log in via a browser.  Note that if you truly want to
 | 
			
		||||
  impersonate yourself (e.g. write messages that come from your Zulip
 | 
			
		||||
  impersonate yourself (e.g., write messages that come from your Zulip
 | 
			
		||||
  account), you'll need to use your **personal API key**.
 | 
			
		||||
 | 
			
		||||
* **Outgoing webhook**: The bot can read direct messages where the bot is a
 | 
			
		||||
 
 | 
			
		||||
@@ -1,7 +1,7 @@
 | 
			
		||||
# Change the time format
 | 
			
		||||
 | 
			
		||||
Based on your preference, Zulip can display times either in a 12-hour
 | 
			
		||||
format (e.g. 5:00 PM) or a 24-hour format (e.g. 17:00).
 | 
			
		||||
format (e.g., 5:00 PM) or a 24-hour format (e.g., 17:00).
 | 
			
		||||
 | 
			
		||||
### Change the time format
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -53,7 +53,7 @@ administrator can access private channel messages:
 | 
			
		||||
* Owners and administrators can change the ownership of a bot. If a
 | 
			
		||||
  bot is subscribed to a private channel, then an administrator can get
 | 
			
		||||
  access to that channel by taking control of the bot, though the
 | 
			
		||||
  access will be limited to what the bot can do. (E.g. incoming
 | 
			
		||||
  access will be limited to what the bot can do. (e.g., incoming
 | 
			
		||||
  webhook bots cannot read messages.)
 | 
			
		||||
 | 
			
		||||
## Detailed permissions
 | 
			
		||||
 
 | 
			
		||||
@@ -106,7 +106,7 @@ blocks, which will be used whenever the code block has no tag.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
When a default language is configured, one can use ````text` to display code
 | 
			
		||||
blocks without any syntax highlighting (E.g. to paste an error message).
 | 
			
		||||
blocks without any syntax highlighting (e.g., to paste an error message).
 | 
			
		||||
 | 
			
		||||
## Code playgrounds
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -13,7 +13,7 @@ A few settings to highlight:
 | 
			
		||||
 | 
			
		||||
* If your organization uses code repositories, [set up
 | 
			
		||||
  linkifiers](/help/add-a-custom-linkifier) to make it easy to link to
 | 
			
		||||
  issues (e.g. just by typing #1234 for issue 1234).
 | 
			
		||||
  issues (e.g., just by typing #1234 for issue 1234).
 | 
			
		||||
 | 
			
		||||
* [Add custom emoji](/help/custom-emoji), including your organization's logo.
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -4,7 +4,7 @@
 | 
			
		||||
 | 
			
		||||
1. *(optional)* **View and update** billing information included on
 | 
			
		||||
   receipts so that they are different from the information entered for
 | 
			
		||||
   the payment method, e.g. in case you would prefer that the company's
 | 
			
		||||
   the payment method, e.g., in case you would prefer that the company's
 | 
			
		||||
   name be on receipts instead of the card holder's name.
 | 
			
		||||
 | 
			
		||||
1. Click the **Purchase** button to complete your purchase.
 | 
			
		||||
 
 | 
			
		||||
@@ -2,7 +2,7 @@ To get the full benefits of Zulip's topic model, when starting a new
 | 
			
		||||
conversation, you should start a new topic!
 | 
			
		||||
 | 
			
		||||
Starting a topic is like a lighter weight version of giving your email a subject.
 | 
			
		||||
Topic names should be brief but specific, e.g.:
 | 
			
		||||
Topic names should be brief but specific, e.g.,:
 | 
			
		||||
 | 
			
		||||
* **Good topic names:** "question about topics", "welcome Anna Smith!", "issue #1234"
 | 
			
		||||
* **Not so good topic names:** "question", "hi", "help", "this topic is about
 | 
			
		||||
 
 | 
			
		||||
@@ -208,7 +208,7 @@ Use <kbd>Enter</kbd> to engage with elements.
 | 
			
		||||
 | 
			
		||||
* **Delete selected draft**: <kbd>Backspace</kbd>
 | 
			
		||||
 | 
			
		||||
Keyboard navigation (e.g. arrow keys) works as expected.
 | 
			
		||||
Keyboard navigation (e.g., arrow keys) works as expected.
 | 
			
		||||
 | 
			
		||||
## Menus
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -58,7 +58,7 @@ Zulip message.
 | 
			
		||||
  text (like signatures). With this option enabled, Zulip will include all footers.
 | 
			
		||||
 | 
			
		||||
* **Quoted original email**: In many email clients, when you reply to a message
 | 
			
		||||
  (e.g. a message notification email), a copy of the original message is
 | 
			
		||||
  (e.g., a message notification email), a copy of the original message is
 | 
			
		||||
  automatically added to the bottom of your reply. By default, Zulip tries
 | 
			
		||||
  to remove that copied message. With this option enabled, Zulip will include it.
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -113,7 +113,7 @@ UI, though they may access it via the Zulip API.
 | 
			
		||||
 | 
			
		||||
* Name
 | 
			
		||||
* Avatar
 | 
			
		||||
* Role (e.g. Administrator)
 | 
			
		||||
* Role (e.g., Administrator)
 | 
			
		||||
* Join date
 | 
			
		||||
 | 
			
		||||
The following additional information is not available in the UI for
 | 
			
		||||
 
 | 
			
		||||
@@ -8,7 +8,7 @@ investigation, or notification.
 | 
			
		||||
 | 
			
		||||
Marking a topic as resolved:
 | 
			
		||||
 | 
			
		||||
* Puts a ✔ at the beginning of the topic name, e.g. `example topic`
 | 
			
		||||
* Puts a ✔ at the beginning of the topic name, e.g., `example topic`
 | 
			
		||||
  becomes `✔ example topic`.
 | 
			
		||||
* Triggers an automated notice from the [notification
 | 
			
		||||
  bot](/help/configure-automated-notices) indicating that
 | 
			
		||||
 
 | 
			
		||||
@@ -122,7 +122,7 @@ An organization is considered to be a new customer if:
 | 
			
		||||
 | 
			
		||||
1. *(optional)* Update the billing details included on receipts so that
 | 
			
		||||
   they are different from the information entered for the payment method,
 | 
			
		||||
   e.g. in case you would prefer that the company's name be on receipts
 | 
			
		||||
   e.g., in case you would prefer that the company's name be on receipts
 | 
			
		||||
   instead of the card holder's name.
 | 
			
		||||
 | 
			
		||||
1. Click **Start 30-day trial** to start your free trial.
 | 
			
		||||
 
 | 
			
		||||
@@ -65,7 +65,7 @@ ensure you can always move from our hosting to yours (and back).
 | 
			
		||||
  [back up][back-up-zulip], and [maintain][maintain-zulip] a self-hosted
 | 
			
		||||
  Zulip installation.
 | 
			
		||||
* Retain full control over your data. If cloud hosting is not an
 | 
			
		||||
  option due to stringent data and privacy requirements (e.g. in the
 | 
			
		||||
  option due to stringent data and privacy requirements (e.g., in the
 | 
			
		||||
  European Union), self-hosting is the option for you.
 | 
			
		||||
* Customize Zulip for all your needs.
 | 
			
		||||
 | 
			
		||||
@@ -82,12 +82,12 @@ There are a few ways to set up Zulip, and different ones may be convenient for y
 | 
			
		||||
  you will probably find it easiest to just add your class to
 | 
			
		||||
  it. Advantages:
 | 
			
		||||
    - Students and staff can use a single Zulip account for all classes.
 | 
			
		||||
    - You can create department-wide channels, e.g. for announcing talks or other events.
 | 
			
		||||
    - You can create department-wide channels, e.g., for announcing talks or other events.
 | 
			
		||||
    - You don’t need to set up a separate server if you’re self-hosting Zulip.
 | 
			
		||||
 | 
			
		||||
* You can **set up a separate Zulip organization for each class**
 | 
			
		||||
  you’re teaching. Advantages:
 | 
			
		||||
    - This makes it simple to manage permissions. e.g. if you want to
 | 
			
		||||
    - This makes it simple to manage permissions, e.g., if you want to
 | 
			
		||||
      make sure TAs from one class cannot moderate discussion from a
 | 
			
		||||
      different class.
 | 
			
		||||
    - Students can’t see who is in channels for other classes.
 | 
			
		||||
@@ -98,7 +98,7 @@ There are a few ways to set up Zulip, and different ones may be convenient for y
 | 
			
		||||
* You can **use a single Zulip organization for several classes**
 | 
			
		||||
  you’re teaching, perhaps re-purposing a Zulip organization from a
 | 
			
		||||
  prior term. Advantages:
 | 
			
		||||
    - Information from your classes is all in one place, e.g. if you
 | 
			
		||||
    - Information from your classes is all in one place, e.g., if you
 | 
			
		||||
      want to re-post a response to a question that was also asked
 | 
			
		||||
      last time you taught the class.
 | 
			
		||||
 | 
			
		||||
@@ -131,7 +131,7 @@ A few settings to highlight:
 | 
			
		||||
 | 
			
		||||
* If your class uses code repositories, [set up
 | 
			
		||||
  linkifiers](/help/add-a-custom-linkifier) to make it easy to link to
 | 
			
		||||
  issues (e.g. just by typing #1234 for issue 1234).
 | 
			
		||||
  issues (e.g., just by typing #1234 for issue 1234).
 | 
			
		||||
 | 
			
		||||
* [Add custom emoji](/help/custom-emoji) that your class will enjoy.
 | 
			
		||||
 | 
			
		||||
@@ -234,10 +234,10 @@ For most classes, the following channels are recommended:
 | 
			
		||||
  ([administrators and moderators](/help/roles-and-permissions)) are
 | 
			
		||||
  allowed to post.
 | 
			
		||||
- **#staff (private)**: For discussions among course staff.
 | 
			
		||||
- **#general**: For random topics, e.g. students forming study groups.
 | 
			
		||||
- A channel for each **lecture** or **unit**, e.g. “Lecture 1: Course
 | 
			
		||||
- **#general**: For random topics, e.g., students forming study groups.
 | 
			
		||||
- A channel for each **lecture** or **unit**, e.g., “Lecture 1: Course
 | 
			
		||||
  intro” or “Unit 3: Sorting algorithms”.
 | 
			
		||||
- A channel for each **section**/**tutorial group** (e.g. “Section 1”)
 | 
			
		||||
- A channel for each **section**/**tutorial group** (e.g., “Section 1”)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
!!! tip ""
 | 
			
		||||
@@ -251,7 +251,7 @@ A few notes:
 | 
			
		||||
- Small classes may need just one discussion channel for all lectures.
 | 
			
		||||
- If you are [using a single Zulip organization][separate-orgs] for
 | 
			
		||||
  more than one class, all channel names should be prefixed with the
 | 
			
		||||
  name of the class, e.g. “CS101 > Lecture 1: Course intro”.
 | 
			
		||||
  name of the class, e.g., “CS101 > Lecture 1: Course intro”.
 | 
			
		||||
 | 
			
		||||
[separate-orgs]: /help/setting-up-zulip-for-a-class#do-i-need-a-separate-zulip-organization-for-each-class
 | 
			
		||||
 | 
			
		||||
@@ -292,7 +292,7 @@ to [Getting started with Zulip][getting-started] and the guide to
 | 
			
		||||
 | 
			
		||||
    If you create new channels later on, you can add users
 | 
			
		||||
    [by group][create-user-groups] or copy membership from another
 | 
			
		||||
    channel (e.g. from Lecture 5 to Lecture 6).
 | 
			
		||||
    channel (e.g., from Lecture 5 to Lecture 6).
 | 
			
		||||
 | 
			
		||||
[create-user-groups]: /help/setting-up-zulip-for-a-class#create-user-groups
 | 
			
		||||
 | 
			
		||||
@@ -329,12 +329,12 @@ product.
 | 
			
		||||
If you plan to use the same Zulip organization in future terms (either
 | 
			
		||||
for your own classes or for your department), you will likely want to:
 | 
			
		||||
 | 
			
		||||
- Rename all channels to indicate the class and term in which they were used, e.g.:
 | 
			
		||||
- Rename all channels to indicate the class and term in which they were used, e.g.,:
 | 
			
		||||
    - **#announcements** → **#FA21 - CS101 - announcements**
 | 
			
		||||
    - **#CS101 > Lecture 1: Course intro** → **#FA21 - CS101 > Lecture 1: Course
 | 
			
		||||
      intro**
 | 
			
		||||
- If you do *not* want students from future classes to see messages
 | 
			
		||||
  from the prior term (e.g. because you posted homework solutions),
 | 
			
		||||
  from the prior term (e.g., because you posted homework solutions),
 | 
			
		||||
  [make all the channels from the class private][make-private]. You’ll
 | 
			
		||||
  be able to find and reuse content yourself, and [invite course
 | 
			
		||||
  staff][add-to-channel] to these private channels as needed.
 | 
			
		||||
 
 | 
			
		||||
@@ -20,14 +20,14 @@ single place for:
 | 
			
		||||
    [Subscribe to email notifications](/help/channel-notifications) for
 | 
			
		||||
    channels such as **#announcements** to make sure you never miss an important message.
 | 
			
		||||
 | 
			
		||||
Many classes use a dedicated channel to post general announcements, e.g.:
 | 
			
		||||
Many classes use a dedicated channel to post general announcements, e.g.,:
 | 
			
		||||
 | 
			
		||||
* **\#announcements** > **office hours**: My office hours this week
 | 
			
		||||
will be rescheduled from `Mon, Oct 11 2021, 1:00 PM` to `Thu, Oct 14 2021, 3:30 PM`.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Share lecture notes and reading materials with [drag-and-drop file
 | 
			
		||||
uploads](/help/share-and-upload-files), e.g.:
 | 
			
		||||
uploads](/help/share-and-upload-files), e.g.,:
 | 
			
		||||
 | 
			
		||||
* **\#Unit 3: Sorting algorithms** > **lecture notes**: Here are the notes
 | 
			
		||||
from today’s lecture. [lecture notes 10/2.pdf]() You can view a recording of the lecture [here]().
 | 
			
		||||
@@ -70,7 +70,7 @@ staff to see which conversations still require their attention.
 | 
			
		||||
 | 
			
		||||
## Coordination among teaching staff
 | 
			
		||||
 | 
			
		||||
Use private channels to coordinate among course staff, e.g.:
 | 
			
		||||
Use private channels to coordinate among course staff, e.g.,:
 | 
			
		||||
 | 
			
		||||
* **\#staff** > **homework 2 exercise 3b**: How many points should I
 | 
			
		||||
  take off for this? The assignment says clearly to use Python 3 syntax.
 | 
			
		||||
 
 | 
			
		||||
@@ -100,7 +100,7 @@ discount instead.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Non-profit educational pricing applies to online purchases with no additional
 | 
			
		||||
legal agreements, for use at registered non-profit institutions (e.g. colleges
 | 
			
		||||
legal agreements, for use at registered non-profit institutions (e.g., colleges
 | 
			
		||||
and universities).
 | 
			
		||||
 | 
			
		||||
To arrange discounted pricing for your organization, please [apply for
 | 
			
		||||
@@ -198,7 +198,7 @@ tool.
 | 
			
		||||
 | 
			
		||||
## Temporary users and guests
 | 
			
		||||
 | 
			
		||||
### How will I be charged for temporary users (e.g. limited-time clients)?
 | 
			
		||||
### How will I be charged for temporary users (e.g., limited-time clients)?
 | 
			
		||||
 | 
			
		||||
Users [can be deactivated](/help/deactivate-or-reactivate-a-user) any time.
 | 
			
		||||
Deactivating a user frees up their license for reuse.
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user