The Permissions for anonymous users section under Installation and basic set up doesn't make much sense. I'm not sure if it's needed as it is covered under Permissions and access control.

See this se question.

Need to update

1. Schedule

You can either choose to send the email immediately or schedule a date and
time for it to be sent. Finally click on Submit Mailing. By default,
CiviMail checks every 15 minutes for any emails that are ready to be sent,
so the start of the mailing could be delayed by up to 15 minutes.

Mailings sent to large numbers of recipients are sent in batches of
about 400 to reduce the likelihood of the emails being caught in spam filters.
Therefore, the actual sending of your mass mailing can take several hours
depending on your server configuration.

to fit with Michael's comment

Neither of those are set in stone - both can and should be adjusted by as sys admin. I would make them both more generic and have a sentence like consult with your system admin to find out how your civicrm is set up.

Also something just above that is dodgy, but I can't remember what,

May tie in well to #187.

Noticed that on https://docs.civicrm.org/user/en/4.7/advanced-configuration/email-system-configuration/#configuring-outbound-email-service there's a missing image.

Seems to be resolved by getting rid of the spaces in the filenames, so here's a list of other images with spaces we might need to clean up.

img/4.5 Add Relationship.png
img/4.5 Menubar.png
img/AB Testing Compose Screen1.png
img/AB Testing Metrics.png
img/AB Testing Results Page_1.png
img/AB Testing Targeting.png
img/AB Testing by Subject1.png
img/AB Testing by email1.png
img/AB Testing.png
img/Batch Update Contribution Via Profile.png
img/CiviCRM 4.5 CiviCase Activities.png
img/CiviCRM 4.5 CiviCase Standard Timeline.png
img/CiviReport_required fields.PNG
img/Contact Dashboard.png
img/Contact Search.png
img/Contribution Summary report grouping view.PNG
img/Contribution Summary report grouping.PNG
img/Custom Field Set.png
img/Editing Contacts.png
img/Event Badges UIv2.png
img/Event Badges UIv2.png.1
img/Event Price set v3.PNG
img/From email.PNG
img/GOTV tracking.jpg
img/Groups&tags_actions Update.png
img/Groups&tags_edit Smart Group criteria.png
img/Import Options.png
img/Mailing Basic Search.png
img/Membership Pricesets non-member field_1.PNG
img/Membership priceset final.PNG
img/New Contribution by Contact.png
img/New Data Entry.png
img/PCP owner notificationV2.PNG
img/Pledge including editing.PNG
img/Pledge payments batch entry cropped.PNG
img/Print contribution receipt options.PNG
img/QA Audit Screen.PNG
img/Repeated Event.png
img/Repeating Events.png
img/Repeting Event Page.png
img/SMS types.PNG
img/Screen Shot 2015-04-25 at 3.06.40 PM.png
img/Screen Shot 2015-04-29 at 3.54.21 PM.png
img/Screen shot 2011-08-27 at 16.28.28.png
img/Search Action.PNG
img/Search Builder.png
img/Search Setting.png
img/Simple housing case.PNG
img/Tag Set - Create.png
img/Tag Set - Creating tags on the fly.png
img/Thank-you letters as table template.PNG
img/Thank-you letters as table_1.PNG
img/Thank-you letters as with smarty enabled_2.PNG
img/Title settings 1 .jpg
img/Viewing Contacts.png
img/activity cf.png
img/activity report 1.jpg
img/activity report 2.jpg
img/advanced search schedule mass mailing.png
img/advanced search.PNG
img/civiengage custom data sets small.jpg
img/civimail_Insert image 6.jpg
img/civimail_file directory 3.jpg
img/civimail_window to browse server 2.jpg
img/contact Screen -inline edit.png
img/contact report listing.PNG
img/contribution amounts.jpg
img/create custom data sets.jpg
img/create walklist survey p2.jpg
img/create walklist survey.jpg
img/custom data for walklists.jpg
img/custom profile for walklist.jpg
img/dedupe config _1.png
img/email-dedupe config _1.png
img/engagement index.jpg
img/event location with warning.PNG
img/gift membership.PNG
img/joomla permissions_1.PNG
img/membership contribution report.PNG
img/membership detail from summary report.PNG
img/membership detail report sorting criteria.PNG
img/membership detail report sorting view.PNG
img/membership detail report.PNG
img/membership everyday for limited inherited.png
img/membership everyday for limited inheritedp2.png
img/membership lapsed report.PNG
img/membership page receipt 1.jpg
img/membership page receipt 2.jpg
img/membership report list_1.PNG
img/membership signup 1.jpg
img/membership summary report.PNG
img/memberships add membership new contact.JPG
img/memberships add membership via menu.JPG
img/memberships create new membership report_1.JPG
img/memberships export memberships screen.JPG
img/memberships find memberships.JPG
img/memberships select fields to export.JPG
img/new pledge batch_1.PNG
img/phonebank record responses.jpg
img/pledge batch edit.PNG
img/pledge table.png
img/record survey responses.jpg
img/scheduled_reminders_other three.PNG
img/survey report columns.PNG
img/survey report cover.jpg
img/survey report detail.jpg
img/survey report p2.jpg
img/survey set filters.jpg
img/tell a friend.jpg
img/walklist cover sheet.jpg
img/walklist p2.jpg
img/z-Sprint14 multi record old style table.png
img/z-Sprint2014 copy multli record.png
img/z-sprint14-membership status.png
img/z-sprint154 - new_membership_type.png
img/z-sprint15ipartial-payment view.png
img/z_sprint14_Deleting memberships.png
img/z_sprint14_Joomla!_Menu Item Type.png
img/z_sprint14_display Results as_1.png
img/z_sprint14_shortcode insert.png

This should reference the global style guide and include user guide specific stuff, for example

• how to reference technical materials in an accessible / non intimidating way. See #139. Other thoughts on what to include here welcome.

• no code in the user guide

[please add further thoughts below]

I think it would be nice to put the new Material theme in place in the User Guide? You can see it in action in the Developer Guide.

Is that okay with you @joannechester? I'll wait to get a go-ahead from you before making this change.

Do we have a way of maintning that sort of list, or do we change ot so that we have, say,:

Contributors
v4.7 Michael mcandrew, Joanne Chester, Steve Kessler ...
V4.6 Michael mcandrew, Joanne Chester, Kate Sneed,...

This is based on https://issues.civicrm.org/jira/browse/CRM-16467

Images to change:
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/Search%20Action.PNG -done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/Groups&tags_actions%20Update.png -done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/CiviCRM_update-CiviCore-ExportFromSearch-en.png -done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/Batch%20Update%20Contribution%20Via%20Profile.png - not in current book?
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/advanced%20search%20schedule%20mass%20mailing.png - Done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/CiviCRM_SMS_sending-by-advanced-search.png - not in current book?
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/Batch%20Update%20Contribution%20Via%20Profile.png - not in current book?

and perhaps
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/petition_signatures_email.png

and missing image (../img/CiviCRM_contributions_sendreceipts.png) in Manual receipts and thank you letters. - DONE

Text to update will be near images and also:
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/organising-your-data/relationships/ - done

http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/organising-your-data/profiles/ (batch update via profiles) -Done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/events/keeping-track-of-events-and-participants/ - done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/membership/finding-and-viewing-memberships/ -done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/email/set-up/ (actions associated with smart group) - done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/email/everyday-tasks/ - done

As a result of the SE question Import Contacts with dedupe rules I have seen Dedupe Rules option from Import contacts form isn't documented on Common workflows > Importing Data into CiviCRM > Running an import > Step 1: Setup

Hi,

I just started translating the users guide into german and saw that in the glossary (https://docs.civicrm.org/user/en/latest/appendices/glossary/#internationalisation-i8n) you use i8n instead of i18n as abbrevation. According to Wikipedia (and my former experience with software), the abbrevation should be i18n.

Book still refers to Print PDF letters.

The extensions installation page https://docs.civicrm.org/user/en/stable/introduction/extensions/#installing-extensions has instructions on how to install extensions that are approved for automated distribution, but not those that are not approved.

It would be good if it covered how to install extensions manually. (download and extract to your extensions directory, etc.)

These two sections are very similar:

• https://docs.civicrm.org/user/en/latest/membership/manual-entry-of-memberships/#importing-memberships
• https://docs.civicrm.org/user/en/latest/common-workflows/importing-data-into-civicrm/#import-memberships

To resolve:

1. Choose one place for the content
2. Merge content from both sections into that place
3. Provide a link from the place where it was removed

This page needs some updating:
https://docs.civicrm.org/user/en/latest/the-civicrm-community/contributing-to-this-manual/

Offer a one-paragraph summary and then link to content that already exists here:
https://docs.civicrm.org/dev/en/latest/documentation/

At many points in the user guide, we reference out of scope material that can be found in the developer guide or the administrator guide. We do this because we want the user guide to remain accessible to non technical readers. When we reference external material, we should ensure that it is done in a non intimidating way prefaced with an accessible introductory text so we do not alienate users.

Something along the lines of the following is a good starting point, to be modified as we see fit in different parts of the guide.

"X is techical and not something that users of CiviCRM are expected to carry out. Your hosting provider or system administrator should have already set this up for you. If you are having difficulties, contact them to carry out this task. They may find these chapters in the administrator guide useful: [link]".

Since this is a fairly large issue, I suggest creating seperate issues for the specific instances and referencing this task as you find them.

The installation chapter doesn't mention that hosted CiviCRM is an option. It says "Before reading further, please be aware that much of the information contained here is intended for technicians and may be difficult to understand if you have little or no experience in setting up web applications." but doesn't mention that you can bypass all the technical side if you sign up with a host.

Redirecting http://wiki.civicrm.org/confluence/display/CRMDOC/Smarty+in+mail+templates to https://docs.civicrm.org/sysadmin/en/latest/config/message-templates results in infinte redirects.

Looks like it should resolve to https://docs.civicrm.org/sysadmin/en/latest/setup/message-templates/.

Not to sure if this is the right place to report the issue.

Lot's of places in the User Guide have instructions like this:

See the Email section of this book

And most of these places don't have any sort of hyperlinks to help the reader find their way to that section. We should improve this content by adding hyperlinks.

Tips:

• Find offending content with this command

  $ grep -Prin '(see|refer\sto|go\sto|check\sout|read)\sthe\s(.{0,50}\s)?(chapter|section|page)' docs
  

• Follow the internal URL standards when fixing content

The screenshot on the PR (civicrm/civicrm-core#12415) will be helpful. Also the GitLab issue.

The existing Email part (sounds odd, but seems to be the terminolgy I should use according to the style guide) is not laid out logically. It opens with a chapter called What is Civimail? when there is so much more to emailing than CiviMail.

This is something that would benefit from a brainstorming session at a residential sprint, but perhaps it can be sorted out via this issue. I propose the following re-arrangement of exisitng content and addition of new content in the email chapter.

• Overview (open to suggestion for a better title) new content including:

In CiviCRM you can choose to:
• Send receipts automatically after an online transaction (monetary or otherwise) (system workflow messages)
• Schedule emails to be sent to individuals when something you have specified happens (scheduled reminders)
• Send emails individually or to groups of up to 50 contacts (Email - send now action)
• Send out eDMs and other mass emailings to thousands of contacts (CiviMail)

• System workflow messages - new content and Modifying System Workflow Message Templates

• Scheduled reminders - existing chapter

• Email - send now to individuals or to groups of up to 50 contacts - exisiting chapter Everyday tasks

• Mass mailings using CiviMail - existing chapter plus CiviMail A/B Testing

• Message templates - (remains of) existing chapter

• Maintaining Healthy Email Lists - existing chapter

• Reports and analysis - existing chapter

Offending URL: https://docs.civicrm.org/user/en/stable/campaign/set-up/
Section: Set-up > Campaign status
It says:

Assigning a status to your campaign makes it possible to update campaign activities in the database and track how the campaign is proceeding.

What does this mean? If I knew more specifics I would put in a pull request, but unfortunately I'm not sure how 'campaign activities in the database' are affected by the campaign status

As a follow up to #253 we should add a note in this section...

https://docs.civicrm.org/user/en/latest/contributions/key-concepts-and-configurations/#financial-types

which points readers to this section:

https://docs.civicrm.org/user/en/latest/initial-set-up/permissions-and-access-control/#financial-type-permissions

Relevant links:
https://issues.civicrm.org/jira/browse/CRM-16761
https://civicrm.stackexchange.com/questions/18730/transfer-of-fees-from-one-event-to-another
https://civicrm.org/blog/zorga-lina/civievent-self-service-canceltransfer-for-participant

See here: civicrm/civicrm-core#7818
Note a blog post exists here: https://civicrm.org/blog/joe-murray/hiding-sensitive-contributions-from-some-staff

I could see refactoring the "permissions and ACLs" into its own chapter to accommodate this, but it's definitely not necessary.

Following on from civicrm/civicrm-dev-docs#498

civicrm/civicrm-core#11123
https://issues.civicrm.org/jira/browse/CRM-21224

The User Guide seems to have only minimal info about recurring contributions.

Today someone in MM asked about this and ended up on this wiki page. I glanced over the wiki page and it seems a bit out of date. Would be good to get up-to-date info in the User Guide including stuff about iATS which (I think?) has the best support for it.

Migrated from: https://issues.civicrm.org/jira/browse/CRM-18228

Lots of images in the User Guide don't have alt text. We should add alt text to these images to improve accessibility.

Here's a command which finds lots of these grep -Pir '\!\[(image)+\]\([^)]*\)' (currently 251 results)

There was some discussion today about changes made in master not easily making their way into stable. What's our process for this? Currently there appear to be quite a few changes in master that have yet to be ported to stable.

online contributions thank and receipt tab

There are a number of files that have used 'Wordpress' instead of 'WordPress' in the documentation. We should replace 'Wordpress' with 'WordPress' to use correct camel casing according to the WordPress Wordmark and Trademark

Do we want to include this info?

These keyboard shortcuts don't all work https://docs.civicrm.org/user/en/4.6/the-user-interface/keyboard-shortcuts/

Screenshots need updating to current version

Check current accuracy. Eg under "Steps for Mass registration", "Add Contacts to Event" is now "Register participants for Event"

The page at https://docs.civicrm.org/user/en/latest/email/scheduled-reminders/ contains several blockquote elements containing only a string like ".merge_file_ZAZG0Z". Perhaps this is an artifact of some automated process? I don't see equivalent content in the .md file (https://github.com/civicrm/civicrm-user-guide/blob/master/docs/email/scheduled-reminders.md), so creating a PR doesn't seem like it would help here.

The new setting for making custom field sets public/private got committed to core without any documentation.

This page in the User Guide needs to be updated.

https://docs.civicrm.org/user/en/latest/organising-your-data/creating-custom-fields/#custom-field-sets

How exactly does CiviCRM change its behavior based on this setting?

As far as I can tell, this setting has only two effects:

• Custom fields attached directly to events are hidden from the event info page if they are part of a private custom field set
  • from civicrm/civicrm-core#10028
• Custom fields attached to some other entities (e.g. participation, contribution, etc... not sure of comprehensive list) are displayed in the registration email sent to participants, but only when this email comes from a back-office registration. These fields will be hidden if they're part of a private set.
  • from civicrm/civicrm-core#10661

https://github.com/civicrm/civicrm-user-guide/blob/master/docs/initial-set-up/security.md exists in the repo, but it is not used in mkdocs.yml and cannot be viewed anywhere.

According to Sean it was moved to the sysadmin guide, but not cleaned up so it should be deleted.

The scheduled jobs section starts with reference to cron, which is a fairly technical subject. We should instead talk about the scheduled jobs UI first.

The cron references should be prefaced with "this is a job for your host or sys admin". They might want to consult the admin guide for more information.

Migrated from https://issues.civicrm.org/jira/browse/CRM-18160

See https://issues.civicrm.org/jira/browse/CRM-18122

It is much too easy to grant permissions that inadvertently expose data.

Barring improvements to profiles and/or permissions (and even if they were improved) we should have clear documentation on the risk of doing so, and steps you can take to avoid it.

I should be discussed and/or cross referenced in

• http://docs.civicrm.org/user/en/stable/initial-set-up/permissions-and-access-control/ and
• http://docs.civicrm.org/user/en/stable/initial-set-up/security/
• http://docs.civicrm.org/user/en/stable/organising-your-data/profiles/

When working on this, it might be a good time to merge information from the following wiki pages into the book and delete the wiki page:

• https://wiki.civicrm.org/confluence/display/CRMDOC/Default+Permissions+and+Roles
• https://wiki.civicrm.org/confluence/display/CRMDOC/Access+Control+Context+and+Overview

Once complete, it probably makes sense to update UI references to the documentation in appropriate pages like the profiles config pages.

Further recommendations from a comment in the original issue

1. On http://docs.civicrm.org/user/en/stable/initial-set-up/permissions-and-access-control/ in the "Permissions and Access Control" section, add some verbiage stating that ACLs restricting access to contacts can be overridden in a search profile that's configured as "Public Pages and Listings" in 4.6 or "Expose Publicly and for Listings" in 4.7.

2. On http://docs.civicrm.org/user/en/stable/organising-your-data/profiles/ in the "Adding fields and choosing field settings in Profiles" section, item 6 "Visibility," indicate that the "Public Pages and Listings" in 4.6 or "Expose Publicly and for Listings" settings can cause data otherwise restricted by ACLs or to logged-in users to be made public. This should be given extra emphasis and styled as a "black box" warning.

3. civicrm/templates/CRM/UF/Form/Field.hlp should be updated to reflect the possibility of exposure of data publicly.

4. http://docs.civicrm.org/user/en/stable/initial-set-up/security/ deals with physical and network security and, in my opinion, isn't relevant and does not need to be revised.

Admonitions are those colored boxes which say "Note" or "Warning" or other things. It was only a couple months ago that we enabled features inserting admonitions our docs books. So we have lots of content which was written before we started using admonitions. The User Guide would look nicer if we converted this old content to use admonitions.

Here's a command which currently finds 58 occurrences of content which could probably be converted to use admonitions.

grep -PIr '^(> )?(\*\*)?((Note)|(NOTE)|(Warning)|(WARNING)|(Caution)|(CAUTION)|(Tip)|(TIP)|(Important)|(IMPORTANT)|(NB)|(N\.B\.))' .

For each of these things, we want to convert markdown like this...

**Note:** CiviCRM rocks!

to markdown like this...

!!! note
    CiviCRM rocks!

Read more about the syntax for admonitions

This page needs some updating:
https://docs.civicrm.org/user/en/latest/the-civicrm-community/the-civicrm-community/

Lots of outdated content here. Someone who is up-to-date on the latest tools that the community is using should scan through this page and make updates as necessary.

Add some docs for VERP config. Seems to be a bit of a FAQ!

For example, the Importing Data into CiviCRM (line 16 in the page source) says

please read the section on "Organizing your data"

but this section doesn't exist in the book. (I think. I did search for it.)

Obviously we could just go ahead and migrate the wiki page, but short of that is there an interim quick-fix to minimize confusion until that page is migrated?

The User Guide currently caters for both users and administrators. I think these are two distinct audiences and the User Guide would be a lot easier for users to read if the administrative sections were removed.

This links with a related issue to Create "Administrator Guide" book, separate from User Guide and Developer Guide.

Many people use CiviCRM everyday and need simple clear information about how to do so. They don't need to know how to install it and set it up. Yet the User Guide has a section on installation and basic set-up fairly early on.

I think the User Guide would be much more accessible to the many people that are using CiviCRM systems day to day if we could take out the more technical aspects of setting up CiviCRM. The proposed Administrator Guide would be an ideal place for this.

This would mean that the guides are split as follows:

• Administrator Guide - everything that you need to know to install, set up and configure CiviCRM
• User Guide - everything that you need to know to use CiviCRM on a day to day basis (presuming that it has already been set up for you by someone else).

The User Guide can reference the Administrator Guide and vice versa, as required.

I would suggest that the following sections are taken out of the User Guide and used to create the Administrator Guide:

• Initial set up
  • [whole section]
• Advanced configuration
  • [whole section]
• Organising your data
  • Mapping your data
• Contributions
  • Key concepts and configuration
  • Sales tax and VAT
• Pledges
  • Set-up
• Email
  • Set-up
• SMS
  • Set-up
• Case Management
  • Set-up
• Campaign
  • Set-up
• Petition
  • Set-up
• Civic Engagement
  • Set-up
• Grants
  • Set-up
• Website integration
  • [whole section]

I haven't looked through all of these pages in detail, so there may need to be some adjustments, but I hope that you get the general idea.

We can probably take stuff from here: http://forum.civicrm.org/index.php/topic,32465.0/topicseen.html

This ticket was migrated from https://issues.civicrm.org/jira/browse/CRM-14608

Needs to include info on financial type for premiums I think

Migrated from: https://issues.civicrm.org/jira/browse/CRM-16598

Need image from a CiviCRM install that has sent SMS.

Migrated from: https://issues.civicrm.org/jira/browse/CRM-14714

http://wiki.civicrm.org/confluence/display/CRMDOC/Smarty+in+mail+templates could probably now go in the book. Potentially an argument for adding this as a configuration setting now as well.