Skip to content
This repository has been archived by the owner on Oct 8, 2020. It is now read-only.

Commit

Permalink
Merge pull request #272 from wmortada/254-add-cross-reference-hyperli…
Browse files Browse the repository at this point in the history
…nks-2

Add cross-references #254
  • Loading branch information
seancolsen committed Mar 23, 2018
2 parents d72ba10 + f139d98 commit 1a5e18b
Show file tree
Hide file tree
Showing 11 changed files with 83 additions and 145 deletions.
15 changes: 7 additions & 8 deletions docs/case-management/reports-and-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ select **Redact (hide) Client and Service Provider Data** then contact
numbers rather than names will be include in the report as shown
here.

![screenshot](../img/qa_audit_screen.png)
![screenshot](/img/qa_audit_screen.png)

The onscreen report displays
information for one activity at a time. Click on the description in the
Expand All @@ -40,7 +40,7 @@ There are four report templates specifically for cases:
3. Contact Demographics Report
4. Case Detail Report

![screenshot](../img/4.5_Case_report_templates.PNG)
![screenshot](/img/4.5_Case_report_templates.PNG)

In addition as cases are made up of activities, the Activity report
template is particularly useful for providing a dashlet for each user
Expand Down Expand Up @@ -68,13 +68,13 @@ Status as well as by client name or email. This is a useful quick search
to identify a few cases that may need specific input if the case
dashboard is quite large and cluttered in your instance.

![screenshot](../img/Case_Find_case_update.PNG)
![screenshot](/img/Case_Find_case_update.PNG)

The Advanced search provides these options combined with all the other
normal search criteria so you can find case types filtered by location
or custom fields applied to the contact.

![Search options within advanced search.](../img/Case_advanced_search_update.PNG)
![Search options within advanced search.](/img/Case_advanced_search_update.PNG)

Also useful can be the Activity Search which is located under **Search > Custom Searches > Activity Search**. Unlike Advanced
search, this is just based on activities and not contacts.
Expand All @@ -88,8 +88,7 @@ When working with DOCx turn off spelling and grammar check for best results.

## Further analysis

If the combination of Case Dashboard, CiviReport and the contact and
activity searches aren't giving you want you want, consider
commissioning a new report or custom search. Read the CiviReport section
and the 'Search and actions' chapter for more information.
If the combination of Case Dashboard, CiviReport and the contact and activity searches aren't giving you want you want, consider commissioning a new report or custom search.

Read the section on [reporting](/reporting/what-is-civireport.md) and the page on [searching](/the-user-interface/searching.md) for more information.

18 changes: 7 additions & 11 deletions docs/initial-set-up/customizing-the-user-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You can change which tabs are available when you are viewing contact
records by checking and un-checking the appropriate boxes next to
**Viewing Contacts**.

![Display Preferences Viewing Contacts](../img/Viewing%20Contacts.png)
![Display Preferences Viewing Contacts](/img/Viewing%20Contacts.png)

For example, if your organization is not using Cases or Grants, you
could uncheck those boxes and those tabs would no longer show up in the
Expand All @@ -66,7 +66,7 @@ You can change which blocks of information appear when you are editing a
contact by checking and unchecking the appropriate boxes next
to **Editing Contacts**:

![Display Preferences Editing Contacts](../img/Editing%20Contacts.png)
![Display Preferences Editing Contacts](/img/Editing%20Contacts.png)

For example, if your organization doesn't collect information
Demographics or Communication Preferences, you could uncheck those boxes
Expand All @@ -85,7 +85,7 @@ screens > display preferences**. Note that CiviCRM will be slower with
this feature disabled as every form will require a complete page load in
the browser.

![Display Preferences Disabling Popup Forms](../img/Contact%20Dashboard.png)
![Display Preferences Disabling Popup Forms](/img/Contact%20Dashboard.png)

### Disabling Activity Assignee Notifications

Expand All @@ -95,7 +95,7 @@ checkbox **Notify Activity Assignees** in **Administer > Customize Data and
Screens > Display Preferences**. You can also selectively disable email
notifications for specific activity types by selecting them in the field below.

![Display Preferences Disabling Activity Assignee Notifications](../img/activity_notif_setting.png)
![Display Preferences Disabling Activity Assignee Notifications](/img/activity_notif_setting.png)

## Customizing search preferences

Expand Down Expand Up @@ -138,7 +138,7 @@ There is one more place to customize search search settings:
**Administer > Customize Data and Screens > Display Preferences** has
a block of **Contact Search** settings:

![Display Preferences Contact Search](../img/Contact%20Search.png)
![Display Preferences Contact Search](/img/Contact%20Search.png)

These check boxes modify the **Search > Find Contacts** and **Search >
Advanced Search** screens. Uncheck the boxes to remove the corresponding
Expand Down Expand Up @@ -230,11 +230,7 @@ only the fields they need. This can speed up data entry considerably.
higher numbers.
12. Click on **Save and New** to add more fields, and **Save** when are
finished.
13. You'll be taken to a screen listing all your fields and their
settings. Click **Preview (all fields)** to make sure your form
looks the way you want it to. Click **Use (create mode)** to go to
the page containing your form. Copy the link and use it to create a
navigation menu item (see the previous section for instructions).
13. You'll be taken to a screen listing all your fields and their settings. Click **Preview (all fields)** to make sure your form looks the way you want it to. Click **Use (create mode)** to go to the page containing your form. Copy the link and use it to create a navigation menu item (see [Customizing the navigation menu](#customizing-the-navigation-menu)).

## Customizing search views

Expand All @@ -249,7 +245,7 @@ When conducting your advanced search, use the **Search Views** dropdown
menu in the top right of the page to select your Profile (see image
below).

![Customize Search Views](../img/configure-customize-search-views.png)
![Customize Search Views](/img/configure-customize-search-views.png)

## Using Word Replacement to change terminology

Expand Down
26 changes: 13 additions & 13 deletions docs/initial-set-up/installation-and-basic-set-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ red. After you have visited a page, the links will display in green
(although you may still need to revisit the page to complete or update
the settings).

![Cheklist with several setions. The first section, site configuration, contains the items: localization, organization address and contact info, and enable components.](../img/Configuration_Checklist_4_4.png)
![Cheklist with several sections. The first section, site configuration, contains the items: localization, organization address and contact info, and enable components.](/img/Configuration_Checklist_4_4.png)

### Localization

Expand Down Expand Up @@ -116,7 +116,7 @@ the appropriate range go to **Administer > Localization > Date Formats > Advance
If you were to leave these settings as the default you will see an error such as this:
Please enter a date between 01/01/1994 and 21/31/2024.

![Advanced Date Input Settings](../img/configure-localization-advanced-date-input-settings.png)
![Advanced Date Input Settings](/img/configure-localization-advanced-date-input-settings.png)

### Organization Address and Contact Info

Expand Down Expand Up @@ -249,7 +249,7 @@ Settings screen and make changes as needed.
the Street Address Parsing function. When address parsing is turned on you can edit and or view
the parsed address by clicking on Edit Address Elements when you are editing a address.

![The link "Edit address elements" is next to the street address field.](../img/basic-set-up-address-parsing.png)
![The link "Edit address elements" is next to the street address field.](/img/basic-set-up-address-parsing.png)

You can learn more about USPS' Postal Addressing Standards at [http://pe.usps.com/text/pub28/welcome.htm](http://pe.usps.com/text/pub28/welcome.htm).
- **Address Standardization** - CiviCRM includes an optional feature
Expand Down Expand Up @@ -294,7 +294,7 @@ House" or "Volunteering Opportunities").

- **Automatic Wildcards** - By default, when users search for contacts
by Name, the Search interface treats the text as if it was
surrounded by percent signes. EXAMPLE: Searching for 'ada' will
surrounded by percent signs. EXAMPLE: Searching for 'ada' will
return any contact whose name includes those letters - 'Adams,
Janet', 'Nadal, Jorge', etc. Disabling this feature will speed up
searches significantly for large databases, but will make users
Expand Down Expand Up @@ -347,7 +347,7 @@ House" or "Volunteering Opportunities").
- **InnoDB Full Text Search -** If you are using MySQL 5.6+ you can
enable InnoDB full-text search optimizations.

### Miscellaneous (Undelete, PDFs, Limts, Logging, reCAPTCHA, etc.)
### Miscellaneous (Undelete, PDFs, Limits, Logging, reCAPTCHA, etc.)

Use the Miscellaneous Settings screen to configure and control the
following behaviors:
Expand All @@ -372,7 +372,7 @@ following behaviors:
records using the Contact Logging Report. Go to **Reports > Reports
Listing > Contact Logging Report (Summary)**.
- **Attach PDF copy to receipts** - If enabled, CiviCRM sends PDF
receipt as an attachment during event signup or online contribution.
receipt as an attachment during event sign-up or online contribution.
- **Path to wkhtmltopdf executable -** wkhtmltopdf is an alternative
utility for generating PDF's which may provide better performance
especially if you are generating a large number of PDF letters or
Expand Down Expand Up @@ -418,7 +418,7 @@ following behaviors:
Advanced Settings section in a Profile where you want it used.

If you want to use reCAPTCHA protection for online contribution,
membership signup or event registration forms, you'll need to
membership sign-up or event registration forms, you'll need to
configure a Profile with reCAPTCHA enabled, and then include it in
those forms.

Expand Down Expand Up @@ -448,7 +448,7 @@ screenshot). An email will be sent to the email address associated with
your user login account. The From email address will be the default From
address you've configured in the previous section.

![Three buttons: save, cancel, save and send test email.](../img/CiviCRM-Configuring-Picture_11-en.png "Save and Send Test Email")
![Three buttons: save, cancel, save and send test email.](/img/CiviCRM-Configuring-Picture_11-en.png "Save and Send Test Email")

If CiviCRM is unable to send the test email, you will see a message on
your screen with the specific error and some suggestions for
Expand Down Expand Up @@ -476,7 +476,7 @@ automated emails. If you've already entered an email address in the
Domain Information screen, that address will be listed here (as
illustrated on the leftmost field of the following screenshot).

![screenshot](../img/from_email.png)
![screenshot](/img/from_email.png)

When users send an email using CiviCRM, their primary email address is
used as the From address by default. However, they can also select one
Expand All @@ -487,7 +487,7 @@ of the general email addresses defined here as an alternative.
Payment processors are companies that handle credit card transactions
for merchants and non-profit organizations and then transfer funds to
the organization's bank account. If you plan on using CiviCRM to accept
online contributions, online membership signup and renewal or online
online contributions, online membership sign-up and renewal or online
event registration, you will need to select and configure a payment
processor for your site.

Expand All @@ -507,11 +507,11 @@ information, visit:
### Permissions for anonymous users

This link is only present on Drupal sites. On Joomla! and WordPress
(and Drupal) Sites permissions for anonymous and other users are set
(and Drupal) sites permissions for anonymous and other users are set
after navigating to **Administer > Users and Permissions >
Permissions** > **Drupal (or Joomla! or WordPress) Access Control**.
See the *Permissions and Access Control* chapter in this section for
information on setting permissions.

See [Permissions and access control](/initial-set-up/permissions-and-access-control.md) for information on setting permissions.

### System Workflow Templates

Expand Down
18 changes: 8 additions & 10 deletions docs/reporting/everyday-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To view a report:
2. Select the relevant report type.
3. Identify the report you wish to view. Click on **View Results** to view the report results using the preset criteria. Click on the report name to go to the criteria settings.

![report_selection](../img/Report-selection-screen.png "report_selection")
![report_selection](/img/Report-selection-screen.png "report_selection")

Reports can also be configured to be directly accessible from navigation
menus. For example, an event report can be configured to appear in the
Expand All @@ -23,41 +23,39 @@ When you open a report it will appear on screen as a table. Some reports
can also be viewed as a bar or pie chart. When this is the case, a
dropdown menu will allow you to select the format you want.

![report_graph](../img/CiviCRM_update-CiviReport-report_graph-en.png "report_graph")
![report_graph](/img/CiviCRM_update-CiviReport-report_graph-en.png "report_graph")

The appropriate report should then be displayed.

![past_12_months_income](../img/CiviCRM_update-CiviReport-past_12_months_income-en.png "past_12_months_income")
![past_12_months_income](/img/CiviCRM_update-CiviReport-past_12_months_income-en.png "past_12_months_income")


As well as viewing reports on screen you can create a PDF version of
either tables or graphs, suitable for printing or emailing.

![report_pdf](../img/CiviCRM_update-CiviReport-report_pdf-en.png "report_pdf")
![report_pdf](/img/CiviCRM_update-CiviReport-report_pdf-en.png "report_pdf")

If you want to perform further calculations on your report data, you can
output the data as comma separated variable (CSV) for import into a
spreadsheet by clicking **Export to CSV**.

If you have the appropriate permissions, you will be able to adjust the
report criteria and settings when you view the report. Read the section
configuring reports for detailed information about how to do this.
If you have the appropriate permissions, you will be able to adjust the report criteria and settings when you view the report. Read [Set-up](/reporting/set-up.md) for detailed information about how to do this.

## Reports on your dashboard

Reports can be configured to appear on your dashboard (the first page
you see when you log in to CiviCRM). You can configure this yourself,
although not all reports may be available to put on your dashboard.

![dashboard](../img/CiviCRM_update-CiviReport-resized_600x269_dashboard-en.png "dashboard")
![dashboard](/img/CiviCRM_update-CiviReport-resized_600x269_dashboard-en.png "dashboard")

To display specific reports on your dashboard:

1. From your dashboard, click on **Configure Your Dashboard**.
2. Select a report from the list of available reports.
3. Drag the report onto your dashboard.

![dashboard_config](../img/CiviCRM_update-CiviReport-resized_600x249_dashboard_config-en.png "dashboard_config")
![dashboard_config](/img/CiviCRM_update-CiviReport-resized_600x249_dashboard_config-en.png "dashboard_config")

## Adding report results to a group

Expand All @@ -66,4 +64,4 @@ This functionality isn't available in all reports but where it is, you
can choose the group you want to add the contacts to from the dropdown
menu as shown below.

![report_group](../img/CiviCRM_update-CiviReport-report_group-en.png "report_group")
![report_group](/img/CiviCRM_update-CiviReport-report_group-en.png "report_group")
Loading

0 comments on commit 1a5e18b

Please sign in to comment.