Working down the editing

svn: r1359

doc/gramps-manual/C/gramps.xml

@@ -279,7 +279,7 @@
       points.</para>
 
       <para>XML stands for eXtensible Markup Language, and is a human readable
-      sctructured description of data. It could be easily parsed by other 
+      structured description of data. It could be easily parsed by other 
       programs should the need occur. It stores only the data itself. Its weak 
       point is the relatively low speed of processing large data files. </para>
 
@@ -373,7 +373,7 @@
 
     <!-- ================ Main Window Sub-subsection  -->
       <sect3 id="view-modes">
-        <title>Switching Views and Viewing Modes: Sidebar versus Tabs</title>
+        <title>Switching Views and Viewing Modes</title>
 	<para>Depending on the state of the <menuchoice> 
 	<guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem> 
 	</menuchoice> menu item, the View could be switched either in the 
@@ -663,7 +663,7 @@
       <guibutton>OK</guibutton> to open it. </para>
       
       <para>If you have previously opened files with
-      <application>&app;</application> you can retreive your past selections 
+      <application>&app;</application> you can retrieve your past selections 
       from the drop-down menu by clicking the down arrow button. Finally, if 
       the Revision Control System (RCS) is enabled in the 
       <guilabel>Preferences</guilabel> dialog, the check-box 
@@ -751,7 +751,7 @@
       <para>Type the desired GEDCOM filename into the text entry box or
       click <guibutton>Browse...</guibutton> to evoke 
       <guilabel>Save File</guilabel> dialog. Use <guilabel>Filter</guilabel>
-      popup menu to limit the scope of export according to the stated rule. 
+      pop-up menu to limit the scope of export according to the stated rule. 
       Choose the desired <guilabel>Encoding</guilabel> of the exported file. 
       Use <guilabel>Target</guilabel> to select the desired GEDCOM 
       dialect. Select you copyright statement from the 
@@ -806,9 +806,9 @@
     </sect2>
 
     <!-- ================ Usage Subsection ================================ -->
-    <sect2 id="gramps-edit"> 
+    <sect2 id="gramps-edit-quick"> 
-      <title>Editing Data</title> 
+      <title>Editing Data: Quick Start</title> 
-	<para> Editing of any portion of data allows you to amend and/or 
+	<para> Editing any portion of data allows you to amend and/or 
 	modify information stored in the database. The available editing 
 	options include editing personal data, relationship data, data about
 	children and parents, information about sources, places, and media
@@ -832,8 +832,8 @@
 
       <!-- ================ Usage Sub-subsection ================ -->
       <sect3 id="gramps-spec-rel"> 
-        <title>To Specify a Relashionship</title> 
+        <title>To Specify a Relationship</title> 
-	<para>To specify a relashionship, first switch to the Family View 
+	<para>To specify a relationship, first switch to the Family View 
 	(<xref linkend="view-modes"/>). Then click <guibutton>+</guibutton>
 	button on the right of the spouse box. Select a spouse/partner from the
 	list and specify their relationship using the menu at the bottom. If
@@ -858,7 +858,7 @@
 	
 	<para> The top and bottom lists contain males and females, 
 	respectively. By default, <application>&app;</application> will
-	limit both lists to people who could possibly be the parents (jugded
+	limit both lists to people who could possibly be the parents (judged
 	by the date of birth) of the active person. To override this, check
 	the <guilabel>Show all</guilabel> box for each list. 
 	</para>
@@ -877,12 +877,12 @@
 	Family View (<xref linkend="view-modes"/>) and then 
 	click <guibutton>+</guibutton> button on the 
 	right of the children list-box. Select a child from the list and 
-	specify	child's relationship with father and motehr using menus 
+	specify	child's relationship with father and mother using menus 
 	at the bottom. If necessary, you can add a person to the list by 
 	clicking <guibutton>Add...</guibutton> button.</para>
 
 	<para> By default, <application>&app;</application> will
-	limit the list lists to people who could possibly be the child (jugded
+	limit the list lists to people who could possibly be the child (judged
 	by the date of birth) of the active person. To override this, check
 	the <guilabel>Show all</guilabel> box. 
 	</para>
@@ -952,16 +952,21 @@
 	</para>
 
 	<para> To edit information about sources and places already present
-	in the database, switch to the approrpiate view, select an entry
+	in the database, switch to the appropriate view, select an entry
 	you would like to view/modify, and then click
 	<guibutton>Edit</guibutton> on the toolbar. 
 	</para>
 
       </sect3>
+    </sect2>
       
+    <!-- ================ Usage Subsection ================================ -->
+    <sect2 id="gramps-edit-complete"> 
+      <title>Editing Data: Complete Description</title> 
+    
       <!-- ================ Usage Sub-subsection ================ -->
       <sect3 id="adv-pers"> 
-        <title>Advanced: To Edit Personal Information</title> 
+        <title>Edit Personal Information</title> 
 	<para> Editing of personal data can be performed in the 
 	following ways. </para>
 	<variablelist>
@@ -994,13 +999,13 @@
 	notebook tabs containing different categories of available 
 	information. You can bring any tab to the top for viewing
 	or editing by clicking on the appropriate tab heading. 
-	The bottom part has <guilabel>OK</guilabel> and
+	The bottom part has <guibutton>OK</guibutton> and
 	<guibutton>Cancel</guibutton> buttons. Clicking <guibutton>OK</guibutton> 
 	at any time will apply all the changes made in all tabs and close the
-	dialog window. Clicking <guilabel>Cancel</guilabel> at any time will 
+	dialog window. Clicking <guibutton>Cancel</guibutton> at any time will 
 	close the window without applying any changes. If any of the data
 	in any tab was modified, the alert window will appear with the 
-	choices of closing the dialog without saving changes, cancelling the
+	choices of closing the dialog without saving changes, canceling the
 	initial cancel request, or saving the changes. 
 	</para>
 
@@ -1022,7 +1027,7 @@
 	<guilabel>Type</guilabel> of the name (birth name, married name, etc.)
 	and <guilabel>Date</guilabel> and <guilabel>Place</guilabel> of birth 
 	and death. Some of these (<guilabel>Family name</guilabel>,
-	<guilabel>Type</guilabel>, and both <guilabel>Place</guilabel> fileds), 
+	<guilabel>Type</guilabel>, and both <guilabel>Place</guilabel> fields), 
 	in addition to typing the data in, allow to choose the corresponding
 	contents from the drop-down menus by clicking on a down-arrow button
 	located immediately to the right of the text entry field. The 
@@ -1044,8 +1049,8 @@
 	birth and death <guilabel>Date</guilabel> fields allows to edit the
 	corresponding events of birth and death. 
 	The field <guilabel>ID</guilabel> displays internal 
-	<application>&app;</application> ID number which identifies user in the
+	&app; ID number which identifies user in the
-	databse. Finally, the <guilabel>Image</guilabel> area shows the first
+	database. Finally, the <guilabel>Image</guilabel> area shows the first
 	image available in the <guilabel>Gallery</guilabel> of this person.
 	</para>
 		</listitem></varlistentry>
@@ -1094,7 +1099,7 @@
 	the attributes of the person and the controls allowing its
 	modification. These could be any personal attributes of a person whose
 	description naturally fits into Parameter-Value pairs (e.g. enormous
-	generousity can be stored as the parameter "Generousity" with the 
+	generosity can be stored as the parameter "Generosity" with the 
 	value "Enormous", etc.). The bottom part displays the list of all  
 	attributes stored in the database. The top part shows the details 
 	of the currently selected attribute in the list (if any). The buttons
@@ -1130,7 +1135,7 @@
 		<varlistentry><term><guilabel>Notes</guilabel></term>
 		<listitem>
 	<para> <guilabel>Notes</guilabel> tab displays information about 
-	the notes conerning the person. These could be any notes which do not
+	the notes concerning the person. These could be any notes which do not
 	naturally fit into the Parameter-Value pairs available to Attributes. 
 	To add a note or modify existing notes simply edit the text in the 
 	text entry field.
@@ -1143,7 +1148,7 @@
 		<listitem>
 	<para> <guilabel>Gallery</guilabel> tab displays information about 
 	media objects associated with the person and the controls allowing its
-	modification. The central part shows the list of all such meda objects. 
+	modification. The central part shows the list of all such media objects. 
 	For media object which are valid image files previews of images are 
 	displayed. For other objects such as audio files, movie files, etc. 
 	generic &app; icon is displayed instead. Note that the first available
@@ -1151,8 +1156,8 @@
 	<guilabel>Image</guilabel> area in the <guilabel>General</guilabel> 
 	tab. The buttons <guibutton>Add...</guibutton>,
 	<guibutton>Edit...</guibutton>, and <guibutton>Remove</guibutton> allow
-	to correspondingly add,  modify, and remove a media object record from
+	to correspondingly add,  modify, and remove a media object reference 
-	the database. Note that <guibutton>Edit...</guibutton> and 
+	to this person. Note that <guibutton>Edit...</guibutton> and 
 	<guibutton>Remove</guibutton> buttons become available only when 
 	a media object is selected from the list. 
 	</para>
@@ -1184,14 +1189,14 @@
 		<listitem>
 	<para> <guilabel>LDS</guilabel> tab displays information 
 	about LDS ordinances of the person and the controls allowing its
-	modification. These are <guilabel>LDS baptims</guilabel>, 
+	modification. These are <guilabel>LDS baptism</guilabel>, 
 	<guilabel>Endowment</guilabel>, and <guilabel>Sealed to 
 	parents</guilabel> ordinances, as labeled inside the tab. 
 	Each ordinance is described by its date, LDS temple, and Place where 
 	it happened. An additional pop-up menu <guilabel>Parents</guilabel> is
 	available for the <guilabel>Sealed to parents</guilabel> ordinance.
 	Each ordinance can further be described by its status through the 
-	selections available in the <guilabel>Status</guilabel> pop-up menu 
+	selections available in the <guilabel>Status</guilabel> pop-up 
 	menu and can also be referenced by sources and notes via corresponding 
 	<guibutton>Sources...</guibutton> and <guibutton>Note</guibutton>
 	buttons. 
@@ -1203,14 +1208,337 @@
 
       <!-- ================ Usage Sub-subsection ================ -->
       <sect3 id="adv-rel"> 
-        <title>Advanced: To Edit Relationship Data</title> 
+        <title>Edit Relationship Data</title> 
-	<para>  </para>
+	<para> Editing of relationship data is performed in the following 
+	<guilabel>Marriage/Relationship Editor</guilabel> dialog which appears 
+	after double-clicking on the spouse box in the Family View.</para>
+
+ 	<!-- ==== Figure: Edit Relationship dialog ==== -->
+	<figure id="edit-rel-fig"> 
+	<title>Marriage/Relationship Editor dialog</title> 
+	<screenshot><mediaobject><imageobject><imagedata 
+		fileref="figures/edit-rel.png" format="PNG"/></imageobject>
+	<textobject> 
+	<phrase>Shows Marriage/Relationship Editor dialog. </phrase>
+	</textobject></mediaobject></screenshot></figure>
+	<!-- ==== End of Figure ==== -->
+	
+	<para> The top of the window shows the names of the people whose 
+	relationship is being edited. The main part of the window displays 
+	six notebook tabs containing different categories of available 
+	information. You can bring any tab to the top for viewing
+	or editing by clicking on the appropriate tab heading. 
+	The bottom part has <guibutton>OK</guibutton> and
+	<guibutton>Cancel</guibutton> buttons. Clicking <guibutton>OK</guibutton> 
+	at any time will apply all the changes made in all tabs and close the
+	dialog window. Clicking <guibutton>Cancel</guibutton> at any time will 
+	close the window without applying any changes. If any of the data
+	in any tab was modified, the alert window will appear with the 
+	choices of closing the dialog without saving changes, canceling the
+	initial cancel request, or saving the changes. </para> 
+
+	<para>
+	The tabs provide the following information categories of 
+	relationship data:
+	</para>
+
+	<variablelist>
+		<varlistentry><term><guilabel>General</guilabel></term>
+		<listitem><para> 
+	<guilabel>General</guilabel> tab allows editing of the most general
+	information about the relationship: the relationship type. 
+	The available types (such as married, partners, etc.) can be chosen 
+	from the drop-down <guilabel>Relationship type</guilabel> menu. 
+	The non-editable field <guilabel>ID</guilabel> displays internal &app; 
+	ID number which identifies this relationship in the database. 
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+	
+	<variablelist>
+		<varlistentry><term><guilabel>Events</guilabel></term>
+		<listitem>
+	<para> <guilabel>Events</guilabel> tab displays information about 
+	the events relevant to the relationship and the controls allowing 
+	its modification. The bottom part displays the list of all such events 
+	stored in the database. The top part shows the details 
+	of the currently selected event in the list (if any). The buttons
+	<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>, 
+	and <guibutton>Delete</guibutton> allow to correspondingly add, 
+	modify, and remove an event record from the database. 
+	Note that <guibutton>Edit...</guibutton> and 
+	<guibutton>Delete</guibutton> buttons become available only when 
+	an event is selected from the list.  
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>Attributes</guilabel></term>
+		<listitem>
+	<para> <guilabel>Attributes</guilabel> tab displays information about 
+	the attributes of the relationship and the controls allowing its
+	modification. The bottom part displays the list of all such 
+	attributes stored in the database. The top part shows the details 
+	of the currently selected attribute in the list (if any). The buttons
+	<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>, 
+	and <guibutton>Delete</guibutton> allow to correspondingly add, 
+	modify, and remove an attribute record from the database. 
+	Note that <guibutton>Edit...</guibutton> and 
+	<guibutton>Delete</guibutton> buttons become available only when 
+	an attribute is selected from the list.  
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>Notes</guilabel></term>
+		<listitem>
+	<para> <guilabel>Notes</guilabel> tab displays information about the 
+	notes concerning the relationship. These could be any notes which do 
+	not naturally fit into the Parameter-Value pairs available to 
+	Attributes. To add a note or modify existing notes simply edit the 
+	text in the text entry field.
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>Gallery</guilabel></term>
+		<listitem>
+	<para> <guilabel>Gallery</guilabel> tab displays information about 
+	media objects associated with the person and the controls allowing its
+	modification. The central part shows the list of all such media objects. 
+	For media object which are valid image files previews of images are 
+	displayed. For other objects such as audio files, movie files, etc. 
+	generic &app; icon is displayed instead. The buttons 
+	<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>, 
+	and <guibutton>Remove</guibutton> allow	to correspondingly add, modify, 
+	and remove a media object reference to this relationship. 
+	Note that <guibutton>Edit...</guibutton> and 
+	<guibutton>Remove</guibutton> buttons become available only when 
+	a media object is selected from the list. 
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>LDS</guilabel></term>
+		<listitem>
+	<para> <guilabel>LDS</guilabel> tab displays information 
+	about LDS <guilabel>Sealed to spouse</guilabel> ordinance
+	  of the person and the controls allowing its
+	modification. The data can include date, LDS temple, and Place where 
+	it happened. The ordinance can further be described by its status 
+	through the selections available in the <guilabel>Status</guilabel> 
+	pop-up menu and can also be referenced by sources and notes via 
+	corresponding <guibutton>Sources...</guibutton> and 
+	<guibutton>Note</guibutton> buttons. </para>
+		</listitem></varlistentry>
+	</variablelist>
+
+     </sect3>
+
+      <!-- ================ Usage Sub-subsection ================ -->
+      <sect3 id="adv-src"> 
+        <title>Edit Source Data</title> 
+	<para> To edit source data, switch to the Sources View and select the
+	desired entry in the list of sources. Double-clik on that entry or
+	click <guibutton>Edit</guibutton> on the toolbar to invoke the 
+	following <guilabel>Source Editor</guilabel> dialog: </para>
+
+ 	<!-- ==== Figure: Source Editor dialog ==== -->
+	<figure id="edit-src-fig"> 
+	<title>Source Editor dialog</title> 
+	<screenshot><mediaobject><imageobject><imagedata 
+		fileref="figures/edit-src.png" format="PNG"/></imageobject>
+	<textobject> 
+	<phrase>Shows Source Editor dialog. </phrase>
+	</textobject></mediaobject></screenshot></figure>
+	<!-- ==== End of Figure ==== -->
+	
+	<para> The top of the window shows the <guilabel>Source Editor</guilabel>
+	title of the dialog. The main part of the window displays four notebook 
+	tabs containing different categories of available information. You can 
+	bring any tab to the top for viewing or editing by clicking on the 
+	appropriate tab heading. The bottom part has <guibutton>OK</guibutton> 
+	and <guibutton>Cancel</guibutton> buttons. Clicking 
+	<guibutton>OK</guibutton> at any time will apply all the changes made 
+	in all tabs and close the dialog window. Clicking 
+	<guibutton>Cancel</guibutton> at any time will close the window without 
+	applying any changes. If any of the data in any tab was modified, 
+	the alert window will appear with the choices of closing the dialog 
+	without saving changes, canceling the initial cancel request, or saving 
+	the changes. </para> 
+	
+	<para>
+	The tabs provide the following information categories of 
+	source data:
+	</para>
+
+	<variablelist>
+		<varlistentry><term><guilabel>General</guilabel></term>
+		<listitem><para> 
+	<guilabel>General</guilabel> tab allows editing of the most general
+	information about the source: its title, author, and publication
+	information. This information can be typed in the appropriate 
+	text entry fields. 
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>Note</guilabel></term>
+		<listitem>
+	<para> <guilabel>Note</guilabel> tab displays any notes concerning 
+	the source. To add a note or modify existing notes simply edit the 
+	text in the text entry field.
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>Gallery</guilabel></term>
+		<listitem>
+	<para> <guilabel>Gallery</guilabel> tab displays information about 
+	media objects associated with the given source and the controls 
+	allowing its modification. The central part shows the list of all 
+	such media objects. For media object which are valid image files 
+	previews of images are displayed. For other objects such as audio 
+	files, movie files, etc., generic &app; icon is displayed instead. 
+	The buttons <guibutton>Add...</guibutton>,
+	<guibutton>Edit...</guibutton>, and <guibutton>Remove</guibutton> allow
+	to correspondingly add,  modify, and remove a media object reference 
+	to this source. Note that <guibutton>Edit...</guibutton> and 
+	<guibutton>Remove</guibutton> buttons become available only when 
+	a media object is selected from the list. 
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>References</guilabel></term>
+		<listitem>
+	<para> <guilabel>References</guilabel> tab displays information about 
+	database records that refer to this source. If the source is not 
+	referenced from any database record, the tab shows empty list. 
+	If the source is referenced from many records, the tab will list 
+	all of them. The list can be ordered by any of its column headers:
+	<guilabel>Source type</guilabel>, <guilabel>Object</guilabel>, or
+	<guilabel>Value</guilabel>. This information cannot be modified from
+	the <guilabel>Source Editor</guilabel> dialog. Instead, the
+	corresponding database record (e.g. birth event) has to be brought
+	up and its source reference edited.
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
 
       </sect3>
+
+
+      <!-- ================ Usage Sub-subsection ================ -->
+      <sect3 id="adv-plc"> 
+        <title>Edit Place Data</title> 
+	<para> To edit place data, switch to the Places View and select the
+	desired entry in the list of places. Double-clik on that entry or
+	click <guibutton>Edit</guibutton> on the toolbar to invoke the 
+	following <guilabel>Place Editor</guilabel> dialog: </para>
+
+	<!-- ==== Figure: Source Editor dialog ==== -->
+	<figure id="edit-plc-fig"> 
+	<title>Place Editor dialog</title> 
+	<screenshot><mediaobject><imageobject><imagedata 
+		fileref="figures/edit-plc.png" format="PNG"/></imageobject>
+	<textobject> 
+	<phrase>Shows Place Editor dialog. </phrase>
+	</textobject></mediaobject></screenshot></figure>
+	<!-- ==== End of Figure ==== -->
+
+	<para> The top of the window shows the <guilabel>Place Editor</guilabel>
+	title of the dialog. The main part of the window displays seven 
+	notebook tabs containing different categories of available information. 
+	You can bring any tab to the top for viewing or editing by clicking on 
+	the appropriate tab heading. The bottom part has 
+	<guibutton>OK</guibutton> and <guibutton>Cancel</guibutton> buttons. 
+	Clicking <guibutton>OK</guibutton> at any time will apply all the 
+	changes made in all tabs and close the dialog window. Clicking 
+	<guibutton>Cancel</guibutton> at any time will close the window without 
+	applying any changes. If any of the data in any tab was modified, 
+	the alert window will appear with the choices of closing the dialog 
+	without saving changes, canceling the initial cancel request, or saving 
+	the changes. </para> 
+	
+	<para>
+	The tabs provide the following information categories of 
+	place data:
+	</para>
+
+	<variablelist>
+		<varlistentry><term><guilabel>General</guilabel></term>
+		<listitem><para> 
+	<guilabel>General</guilabel> tab allows editing of the most general
+	information about the place: title which labels it in the databse, 
+	city, church parish, county, state, country, longitude, and lattitude. 
+	This information can be typed in the appropriate text entry fields. 
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>Other names</guilabel></term>
+		<listitem><para> 
+	<guilabel>Other names</guilabel> tab displays information concerning 
+	other names by which the place might be known and the controls 
+	allowing its modification. The bottom part displays the list of all 
+	other names of the place stored in the database. The top part shows 
+	the details of the currently selected name in the list (if any). 
+	The buttons <guibutton>Add...</guibutton>, 
+	<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton> allow 
+	to correspondingly add, modify, and remove a name record 
+	from the database. Note that <guibutton>Edit...</guibutton> and 
+	<guibutton>Delete</guibutton> buttons become available only when 
+	a name is selected from the list. </para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>Note</guilabel></term>
+		<listitem>
+	<para> <guilabel>Note</guilabel> tab displays any notes concerning 
+	the place. To add a note or modify existing notes simply edit the 
+	text in the text entry field.
+	</para>
+		</listitem></varlistentry>
+	</variablelist>
+
+	<variablelist>
+		<varlistentry><term><guilabel>Sources</guilabel></term>
+		<listitem><para> 
+	<guilabel>Sources</guilabel> tab displays information about sources 
+	relevant to this place and the controls allowing its modification. 
+	The central part displays the list of all such sources references 
+	stored in the database. The buttons <guibutton>Add...</guibutton>, 
+	<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton> allow 
+	to correspondingly add, modify, and remove a a source reference  
+	to this place. Note that <guibutton>Edit...</guibutton> and 
+	<guibutton>Delete</guibutton> buttons become available only when 
+	a source reference is selected from the list. </para>
+		</listitem></varlistentry>
+	</variablelist>
+
+
+
+      </sect3>
+
 <!--
 [ FIXME: STOPPED HERE ] 
 -->
+      <!-- ================ Usage Sub-subsection ================ -->
+      <sect3 id="adv-media"> 
+        <title>Edit Media Data</title> 
+	<para>  </para>
 
+      </sect3>
 
     </sect2>