Skip to content

Commit

Permalink
Merge pull request michaelmcandrew#2 from joannechester/master
Browse files Browse the repository at this point in the history
Formating corrections
  • Loading branch information
joannechester committed Jun 17, 2015
2 parents 3dd1b86 + f408f12 commit 2d9a887
Show file tree
Hide file tree
Showing 140 changed files with 3,084 additions and 3,362 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* [Getting prepared](/getting-prepared/README.md)
* [Initial set up](/initial-set-up/README.md)
* [Advanced configuration](/advanced-configuration/README.md)
* [The user interface](/the-user-interface/README.md)
* [Organising your data](/organising-your-data/README.md)
* [Common workflows](/common-workflows/README.md)
* [Contributions](/contributions/README.md)
Expand Down
314 changes: 158 additions & 156 deletions SUMMARY.md

Large diffs are not rendered by default.

4 changes: 0 additions & 4 deletions advanced-configuration/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Advanced configuration
* [Email System Configuration](./email-system-configuration.md)
* [Logging](./logging.md)
* [Menu, Dashboard and Dashlets](./menu-dashboard-and-dashlets.md)
* [Keyboard shortcuts](./keyboard-shortcuts.md)
* [Searching](./searching.md)
* [Undelete](./undelete.md)
120 changes: 63 additions & 57 deletions advanced-configuration/email-system-configuration.md

Large diffs are not rendered by default.

33 changes: 13 additions & 20 deletions advanced-configuration/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,36 @@ Logging
=======

CiviCRM keeps an eye on the various changes that you make to contacts,
memberships and so on.  Each contact has a change log tab which is
populated each time a contact is added or edited.  The change log shows
who changed the record, and when the change was made.  This light-weight
memberships and so on. Each contact has a change log tab which is
populated each time a contact is added or edited. The change log shows
who changed the record, and when the change was made. This light-weight
logging is turned on by default and many users find it detailed enough.

One key missing piece, however, is information about *what* was
changed.  Detailed logging adds information on what has changed and
changed. Detailed logging adds information on what has changed and
provides many other features.

Detailed logging
----------------

When enabled, detailed logging tracks all changes made to data in
CiviCRM.  Each time something is updated, CiviCRM keeps a note of
CiviCRM. Each time something is updated, CiviCRM keeps a note of

- what the value was before
- what the value is after
- when the change was made
- who made the change

When you turn on detailed logging, the screen will look something like
the below.  Clicking on update on the left hand side will show details
the below. Clicking on update on the left hand side will show details
of the change.

![](/images/change-log.png)

This logging extends to almost all data that exists in CiviCRM,
including your contact, membership, event, etc. data, and also all of
the 'meta data' in your install, such as Activity Types, Case types,
Contribution Types, etc. 
Contribution Types, etc.

With detailed logging turned on, any changes made to your data can be
reverted which means you can worry less about unwanted changes to the
Expand All @@ -40,7 +40,7 @@ interacting via your website - either maliciously or accidentally.

As you can imagine, logging all changes to the database can result in
the collection of quite a lot of data and will have a small performance
impact on your database.  For this reason, we turn of logging by default
impact on your database. For this reason, we turn of logging by default
in CiviCRM and let people turn it one if they require it. Before you
decide whether you want to turn on logging, you might want to have a
look at other ways in which time based logging happens in CiviCRM.
Expand All @@ -49,11 +49,11 @@ Activities vs. logging
----------------------

The use of activities to record data in CiviCRM is often useful as an
alternative to logging.  Since each activity happens at a specific point
alternative to logging. Since each activity happens at a specific point
in time, you can view the activity tab on a contact record as a log of
changes to that contact over time.  This isn't to suggest that each time
changes to that contact over time. This isn't to suggest that each time
you make a change to a contact in CiviCRM, you should record an
activity.  Rather that, in some use cases, the data collected in the
activity. Rather that, in some use cases, the data collected in the
activity log provides a good enough log of changes to contacts over
time, and supplementing that with a couple of manually recorded
activities may cater adequately enough for your logging needs.
Expand All @@ -63,15 +63,15 @@ Membership logs

In a similar way to activities, over time a membership will grow into a
historical record of the membership, with a record of any contributions
that went toward that membership and any renewals, up-sells. etc.  It
that went toward that membership and any renewals, up-sells. etc. It
might be that this out-of-the-box logging meets your needs and means
that you don't need to turn on detailed logging.

Reverting changes
-----------------

One of the great benefits of turning on detailed logging is the ability
to revert any changes that you make to you data.  For a lot of contact
to revert any changes that you make to you data. For a lot of contact
fields we make this easy by creating a revert button at the bottom of
the screen that shows details of the change.

Expand All @@ -82,10 +82,3 @@ still being recorded behind the scenes. If you do need to revert data
that cannot be reverted via the user interface, you should contact your
system administrator or get help from someone that is familiar with
CiviCRM's detailed logging functionality.



The user interface
------------------

CiviCRM: CiviCoreMenuDashboard
2 changes: 1 addition & 1 deletion appendices/credits.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
CREDITS
Credits
=======

About this book
Expand Down
4 changes: 2 additions & 2 deletions appendices/free-software.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ and licensed in a generous way so you can use it for free for whatever
you want.

Free Software (sometimes also referred to as**Free and Open Source
Software**,  **FLOSS**, **FOSS**, **Software Libre**, or **Open
Software**, **FLOSS**, **FOSS**, **Software Libre**, or **Open
Source**) is software that anyone can download, share, and --
significantly -- change in any way they want. Practically speaking, you
might never want to change the software, or even have a staff person who
Expand Down Expand Up @@ -106,7 +106,7 @@ focus on the most important highlights:
failure." With FOSS projects, if the main organisation behind a
specific piece of software shuts down or changes their focus, the
community takes over, a new organisation is formed and the software
development and support continues. 
development and support continues.

Apart from the practical advantages listed above, there is also a more
philosophical approach to answering the question of importance of FOSS
Expand Down
34 changes: 17 additions & 17 deletions appendices/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,15 +138,15 @@ A web cache holds copies of recently visited web page files. Sometimes a
user may need to clear their web cache in order to see updated
information on a web page.

Canvassing 
Canvassing
-----------

Is the systematic initiation of direct contact with a target group of
individuals commonly used during political campaigns. A campaign team
(and during elections a candidate) will knock on doors of private
residences within a particular geographic area, engaging in face-to-face
personal interaction with voters. Canvassing may also be performed by
telephone, where it is referred to as telephone canvassing. 
telephone, where it is referred to as telephone canvassing.

Captcha
-------
Expand All @@ -158,14 +158,14 @@ CiviCase

The case management **component** of **CiviCRM**. CiviCase provides
service organisations with tools for structuring, scheduling and
recording case activities.  
recording case activities.

CiviContribute
--------------

CiviContribute is an online fundraising and donor management
**component** which enables you to track and manage contributions to
your organisation. 
your organisation.

**CiviCRM**
-----------
Expand All @@ -188,7 +188,7 @@ non-profits focused on community organizing groups and civic engagement
work. CiviEngage provides a package of custom fields, reports and
features to track the history of engagement, involvement, and activities
of constituents over time. This package also integrates Campaigns and
Surveys to provide WalkLists and PhoneBank Lists. 
Surveys to provide WalkLists and PhoneBank Lists.

CiviEvent
---------
Expand All @@ -202,12 +202,12 @@ CiviMail
CiviMail is a mass-mailing **component** which allows you to engage
**constituents** with personalised email blasts and newsletters.

CiviPledge 
CiviPledge
-----------

CiviPledge is a component that allows the flexibility to create various
types of fundraisers. Allows to individuals to donate daily, weekly,
monthly or yearly.   
monthly or yearly.

Client
------
Expand Down Expand Up @@ -308,14 +308,14 @@ non-governmental organisations, so the term "customer" is replaced with
"**constituent**". Outside the USA it is often referred to as Contact
Relationship Management.

Cron 
Cron
-----

Cron is the time-based job scheduler in Unix-like computer operating
systems. Cron enables users to schedule jobs (commands or shell scripts)
to run periodically at certain times or dates. It is commonly used to
automate system maintenance or administration. Cron is used to
in **CiviCRM** to trigger specific tasks, such as sending membership
in **CiviCRM** to trigger specific tasks, such as sending membership
renewal reminders or processing ongoing payments, or to run all jobs
enabled under the Scheduled Jobs page at their configured frequency.

Expand Down Expand Up @@ -512,7 +512,7 @@ integrate CiviCRM with external systems.
Household
---------

Is a family or group of people who share a physical location. 
Is a family or group of people who share a physical location.

Hosting Service
---------------
Expand Down Expand Up @@ -564,7 +564,7 @@ A **CMS** that can integrate with **CiviCRM** to provide a user
interface and additional website functionality
([http://www.joomla.org](http://www.joomla.org/)).

LAMP 
LAMP
-----

Is an acronym for a solution stack of free, open source software,
Expand Down Expand Up @@ -699,7 +699,7 @@ Someone given the responsibility to keep their eye on a certain issue.
PhoneBank List
--------------

A list created using CiviReport  to make it easy for volunteers to call
A list created using CiviReport to make it easy for volunteers to call
constituents en masse. This is often done to invite them to vote,
request that they volunteer, take action, or donate.

Expand Down Expand Up @@ -811,10 +811,10 @@ software**.
Server
------

1. Software that "serves" content to a **client**. See **Apache**, or
1. Software that "serves" content to a **client**. See **Apache**, or
**Mail Server** for two examples.

2. A computer that is used primarily to serve content. Any computer can
2. A computer that is used primarily to serve content. Any computer can
be set up this way, but the term traditionally refers to those that
deliver web content. See also **client** computer.

Expand Down Expand Up @@ -843,7 +843,7 @@ Soft Credit

Allows you to credit a **contact** for a donation made by someone, for
example the person who inspired the actual donor to make a donation. See
**Personal Campaign Pages**. 
**Personal Campaign Pages**.

Software
--------
Expand Down Expand Up @@ -949,7 +949,7 @@ are referred to as a version of the software. There are different types
of version, for example the most recent release of a software which has
been tested and is intended for general use is referred to as the
**stable version**, while a very new untested version is the **alpha
version**. 
version**.

VPN (Virtual Private Network)
-----------------------------
Expand Down Expand Up @@ -1004,7 +1004,7 @@ WordPress
---------

The most popular CMS in use on the internet today, WordPress integrates
as of CiviCRM version 4.1 and WordPress version 3.3.1.  Prior to these
as of CiviCRM version 4.1 and WordPress version 3.3.1. Prior to these
versions, CiviCRM didn't work directly with WordPress, although a
Drupal/CiviCRM installation could be installed in parallel on the same
server as WordPress.
Expand Down
12 changes: 6 additions & 6 deletions appendices/history-of-this-book.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
History of this book
====================

This book is the result of the collaborative effort of many people.  A
This book is the result of the collaborative effort of many people. A
lot of the content was written during two book sprints held in 2009 and
2010 in Tahoe, USA. Many contributions have also been made by
individuals in the times between and following these sprints.
Expand All @@ -13,12 +13,12 @@ The fifth edition was written at the Woolman Sierra Friends Centre
(woolman.org) in April 2012. Woolman use and contribute to CiviCRM. We
are grateful for their hospitality.

Fourth edition 
Fourth edition
---------------

The forth edition was written in Bourne, Lincolnshire, UK in September
2011. We were too busy writing this edition to say much about how it was
put together. 
put together.

Third edition
-------------
Expand All @@ -40,7 +40,7 @@ Open Society Institute
We are especially grateful to Janet Haven for pushing this forward.

The second edition includes new sections on CiviReports, CiviCase,
CiviEngage and Extending CiviCRM.  This edition also included an
CiviEngage and Extending CiviCRM. This edition also included an
extensive rewrite of nearly every section of the text, including a
reorganization of all sections to break up information into
Introduction, Planning, Configuration and Everyday Tasks sections, the
Expand Down Expand Up @@ -136,8 +136,8 @@ Our office for the week was Dave and Bob's house.

![civi1](/images/Blog-CiviCRM-civi1-en.png "civi1")

 We mitigated the hardship of late-night work with some tasty beverages.
We mitigated the hardship of late-night work with some tasty beverages.

![log](/images/Blog-CiviCRM-log-en.png "log")

 And occasionally they let us out for a bit....
And occasionally they let us out for a bit....
Loading

0 comments on commit 2d9a887

Please sign in to comment.