<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE document PUBLIC "-//CNX//DTD CNXML 0.5 plus MathML//EN" "http://cnx.rice.edu/cnxml/0.5/DTD/cnxml_mathml.dtd">
<document xmlns="http://cnx.rice.edu/cnxml" xmlns:md="http://cnx.rice.edu/mdml/0.4" xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:bib="http://bibtexml.sf.net/" id="Module.2004-02-02.4407">
  <name>Suggest Edits</name>
  <metadata>
  <md:version>1.5</md:version>
  <md:created>2004/02/02 16:44:07 US/Central</md:created>
  <md:revised>2004/06/25 15:40:23.312 GMT-5</md:revised>
  <md:authorlist>
      <md:author id="mhusband">
      <md:firstname>Mark</md:firstname>
      <md:othername>S.</md:othername>
      <md:surname>Husband</md:surname>
      <md:email>mhusband@rice.edu</md:email>
    </md:author>
  </md:authorlist>

  <md:maintainerlist>
    <md:maintainer id="mhusband">
      <md:firstname>Mark</md:firstname>
      <md:othername>S.</md:othername>
      <md:surname>Husband</md:surname>
      <md:email>mhusband@rice.edu</md:email>
    </md:maintainer>
    <md:maintainer id="jago">
      <md:firstname>Adan</md:firstname>
      
      <md:surname>Galvan</md:surname>
      <md:email>jago@rice.edu</md:email>
    </md:maintainer>
  </md:maintainerlist>
  
  <md:keywordlist>
    <md:keyword>patch</md:keyword>
    <md:keyword>suggest edits</md:keyword>
    <md:keyword>collaborate</md:keyword>
  </md:keywordlist>

  <md:abstract>Instructions for using the Suggest Edits function to recommend changes in a module and how to apply or reject those changes.</md:abstract>
</metadata>

  <content>
    
    <para id="para1">
      The Suggest Edit function in 
      <link src="http://cnx.rice.edu">Connexions</link> allows anyone with a
      Connexions account to suggest changes to the maintainers of a module.
      The maintainers are the persons whose names appear in the "Maintained By"
      line at the end of the module. Permission to change the content is not
      necessary because Suggest Edits only recommends the changes to the 
      maintainers of the module. It does not actually change the content. 
      And the person suggesting the changes does not have to know the 
      maintainers. All the maintainers receive notice of the suggested edits 
      and have the option to incorporate them into the content or to ignore 
      them. This document describes how a Connexions user can suggest edits 
      and what the maintainers' options are for dealing with those changes.  
       <note type="note">
       You cannot use Suggest Edit on modules on which you have the 
       maintainer role. You already have the ability to edit this content. 
    </note>
    </para>

    <section id="suggesteditssection">
      <name>Suggesting Edits to Maintainers</name>
      <para id="suggestpara1">
	The Suggest Edits function is a form of collaboration. It allows 
        you to participate in the content of a module. Your edits could 
        be as simple as correcting a spelling error, adding a link, and 
        changing a keyword, or they could be as substantial as the addition 
        of new material to expand the the module topic.
      </para>

      <para id="separa2">
	To suggest edits for a module in connections, use
	the following steps:
	<list id="selist1" type="enumerated">
	  <item>Check out the module into a workspace.</item>
	  <item>Access the module in the module editor and make the
	  necessary changes. These edits can be changes to the text,
	  images, links, roles, or metadata.</item> 
          <item>(Optional) Click the <emphasis>Changes</emphasis> link under 
          the View heading in the "Status" sidebar to display a summary of 
          your changes to the module. </item>
	  <item>Click the <emphasis>Suggest Edit</emphasis> link under the 
	  "Actions" heading in the "Status" sidebar.  The "Suggest Edits" 
	  screen appears.</item>
	  <item>Type an explanation of your changes in the "Description 
          of Edits" text box.  This should be a general description and 
          your reason for suggesting the changes. It will be forwarded 
          to the maintainers.</item>
	  <item>Click <code>Send Edits</code>.  The "Manage Files"
	    screen reappears with the message that the edits were
	    submitted to the maintainers. They have the option to use
	    or ignore your suggestions. When they act on the suggestion, 
	    they must enter a description of their action that will be 
	    available to you when you check the status of your submission.
	  </item>
	 </list>
         </para>

      <para id="separa3">
	If you try to publish the module after you have edited it, the
	"Publish module" page displays a note that you do not have
	permission to publish a new version of this module. The page
	lists two options available to you: Suggest your edits to
	the module's maintainers or Create a new module of your own
	based on this one. If you choose the "Suggest your changes"
	option, the same "Suggest Edits" screen in step 3 above
	appears. If you choose the "Create your own module" option, the 
        <cnxn document="m11804">Derive a Copy</cnxn> screen appears.
      </para>
    </section>

    <section id="acceptsec">
      <name>Accepting or Rejecting the Suggested Edits</name>
      
      <para id="arpara1">
	The Suggest Edit function can be a tool for collecting changes
	and suggestions from many different sources for your content. 
        No longer will content suggestions arrive in the form
	of a cryptic e-mail. You can view a summary of exactly what
	the changes are and where they go. When someone submits a
	suggested edit for one of your modules, you are notified the 
	next time you log into Connexions. The 
        <cnxn target="SuggestEditPending">Pending sidebar</cnxn> in the
	upper right of the Connexions home page displays a 
	<emphasis>Suggested Edit</emphasis> link. You can view the 
	changes from this link. Since these are suggested edits, you 
	do have the option to use them or reject them.
      
<figure id="SuggestEditPending">
	<media type="image/png" src="SuggestEditPending.png"/>
	<caption>Pending Sidebar with one Suggested Edit</caption>
      </figure>
</para>

    <section id="reviewsect">
      <name>Reviewing Suggested Edits</name>
      
      <para id="reviewsuggestpara">
	To review the suggested edits for your content, use the
	following steps:
	<list id="reviewlist" type="enumerated">
	  <item>Click the <emphasis>Suggested Edit</emphasis> link in the 
	  "Pending" sidebar. The "Suggested Edits" screen displays. This 
	  screen identifies all the current suggested edits for your
	  modules and any suggested edits that you have submitted. For 
	  your modules, this screen lists who submitted the edit, the 
	  date and time, the submitter's message, and the status of the 
	  submission.</item>
	  <item>Click <emphasis>View</emphasis> in the "Edit" column to 
	  review the suggested edit. A 
	  <cnxn target="SuggestedEditsDetails">detail</cnxn> of the edits 
	  displays on the screen. This display contains the same 
	  information as the previous screen, plus the details of the 
	  changes to the files, metadata, roles, and links. 
	  
      <figure id="SuggestedEditsDetails">
	<media type="image/png" src="SuggestedEditDetails.png"/>
	<caption>Details of a suggested edit to a module</caption>
      </figure>
	  The details identify any files in the module that were changed, 
	  removed, or added.</item> 
	  <item>Click the filename link to view the contents of the file. 
	  Any deleted lines are marked with a "-" on the left. Any new lines 
	  are marked with a "+" on the left. The lines of text that were 
	  hanged are shown twice. The first line is marked with a "-" on the 
	  left and contains the original text. The second line is marked with 
	  a "+" on the left and contains the changes. 
          </item>
          <item>Decide if you want to use the suggested edits or 
          to ignore them.  If you want to use the edits, go to 
          <cnxn target="applyedit">Applying Suggested Edits</cnxn>. 
          If you want to ignore the edits, go to 
          <cnxn target="ignoresec">Rejecting Suggested Edits.</cnxn>
          </item>
	</list>
      </para>

    </section>

    <section id="applyedit">
      <name>Applying Suggested Edits</name>

      <para id="applysuggetpara">
	To apply the suggested edits to your content, use the
	following steps: 
	<list id="applylist" type="enumerated">
	  <item>Select the radio button for the workspace in which you
	    want the changes applied.  The Workspaces table lists the
	    locations where the module already exists. You can select "Other"
	    and specify a different workspace and Connexions will
	    check out the module to that workspace.</item> 
	  <item>Click <code>Apply In</code>. The "Accept Suggested Edits" 
          screen displays.</item>
	  <item>Type a message about accepting the edits in the 
          "Comments" text box and click <code>Update</code>.  The submitter 
          will see this message the next time he or she displays the 
          "Suggested Edits" screen. The module edit screen 
          displays a message that the suggested edits were applied.
	  </item>
	  <item>Publish the module.
	  </item>
	</list>
	
	<note type="note">
	You must publish the module to make the changes visible	to all. 
	</note>
	</para>
    </section>

    <section id="ignoresec">
      <name>Rejecting Suggested Edits</name>
      <para id="igpara">
	To reject the suggested edits for your content, use the
	following steps: 
	<list id="ignorelist" type="enumerated">
	  <item>Click <code>Reject</code>. 
	    The "Reject Suggested Edits" screen displays.
	  </item>
	  <item>Type a message about rejecting the edits in 
          the "Comments" text box and click <code>Update</code>. 
          The submitter will see this message the next time he or 
          she displays the "Suggested Edits" screen. The module edit 
          screen displays a message that the suggested edits were 
          rejected. 
	  </item>
	</list>
      </para>

    </section>

    </section>

  </content>
  
</document>
