Difference between revisions of "Constructive Edits"

m (Undo.)
Line 1: Line 1:
−
{{MainPageNav1}}
+
Form Editing
  
 +
    *
  
−
[[Image:Policy.png|left]]All constructive edits are welcome. We depend on visitors to share their knowledge. The concept of making constructive edits goes along with the fact that we [[Assume Good Faith]]. We believe that everyone who makes an edit or creates a page is doing so to provide informative, educational and accurate information.
+
      When the procedure includes a step that requires you to edit the form, open the form using an editor of your choice. You can use as a Windows text editor (such as TextPad or NotePad), an HTML editor, or a UNIX editor. Use a word processor only if it allows you to see the HTML code and it allows you to save files in plain text format. Save the form with an .htm or .html extension, whichever is the convention for your Web site.
 +
    * The items to modify in the form appear in a box like this:
  
−
''Any edit should always be able to answer '''"Yes"''' to the question: '''"Does this edit make it better for the next reader?"'''''
+
<!-- Begin library hidden input field -->
 +
<!-- Replace the value attribute "1" with your library's QuestionPoint institution ID, supplied by OCLC, in the library hidden input field -->
 +
<input type=hidden name="library" value="1" >
 +
<!-- End library hidden input field -->
  
−
Some examples of constructive edits include:
+
    with the code to modify highlighted, such as this: value="1".
−
* Creating a better representation of the website on its AboutUs [[domain page]]:
 
−
* Mentioning something interesting about the site that others might not know.
 
−
* Fixing an out of date address, email or phone number is very helpful!
 
−
* Letting the community know what your edit is and why you made it via your [[EditSummary|edit summary]].
 
−
* Letting the community know if a page is [[Template:NoWebsite|no longer a website]], [[PossibleAdultContent|adult content]], a [[Template:PossibleSpamSite|spam site]], etc.
 
−
* Adding a Review.  If you have experience with the website or company, use the [[Influence Us]] feature to give them constructive feedback to improve.
 
−
* Defining a term so it can be referenced by many pages.
 
  
−
'''Of course:'''
+
    *
−
* Don't write anything untrue.  If you state a fact that might be controversial, reference it to clear up any confusion.
 
−
* Don't write anything threatening, expletive, or defamatory.
 
−
* [[Edit wars]] are not helpful.
 
  
−
Also, see our [[Portal:AboutUsPolicy/Editing|editing]] policies or the [[Help]] section.
+
      Unless a procedure step directs to you modify the JavaScript, do not modify or remove anything between these tags:
  
−
Constructive edits can also enter into the realm of clarifying or reorganizing, leading to [[Self_Organize| self organization]]. This is very important because there is so much information to read that less is most often more. Reading various comments and summarizing them into a more concise presentation takes time, but readers appreciate it. [[wiki| Wiki]] technology does this very well, anyone reading an article is welcome to reorganize, add to, subtract from or otherwise improve the text. Constructive editing is like polishing a pearl.
+
          <script language="JavaScript">
−
The more polished the pearl - the more people will love it.
+
              and
 +
          </script>
  
−
[[Category:Organic Community Building]]
+
Back to top
−
[[Category: Whitelist]]
+
 
 +
Overall Procedure
 +
 
 +
This procedure takes an incremental approach, where you frequently test modifications to the form and ensure that they are working correctly before moving on to subsequent modifications.
 +
Step Action
 +
1 Make a backup copy of the form you downloaded.
 +
2 Open the form file in a text editor.
 +
3
 +
 
 +
Are you planning on modifying the form text so that it is in a language other than English?
 +
 
 +
    * Yes. Go to step 4.
 +
    * No. Go to step 5.
 +
 
 +
4
 +
 
 +
To allow your patrons to see QuestionPoint messages in your language, follow these steps:
 +
 
 +
    * Find the section of the form that looks like this:
 +
 
 +
<!-- Begin language hidden input field -->
 +
<!-- If this form will be in a language other than English, replace the value attribute "1" with the appropriate value for your language, as described in
 +
http://questionpoint.org/web/members/
 +
addingchatform.html. -->
 +
<input type=hidden name="language" value="1">
 +
<!-- End language hidden input field -->
 +
 
 +
    * Use this table to find the value that corresponds to your language:
 +
 
 +
      Language Value
 +
      French (Français)
 +
      2
 +
      Spanish (Español)
 +
      3
 +
      Chinese-Traditional (中文(繁體))
 +
      4
 +
      Chinese-Simplified (中文(简体))
 +
      5
 +
      Dutch (Nederlands)
 +
      7
 +
      Slovene (Slovensko)
 +
      8
 +
      German (Deutsch)
 +
      10
 +
      Korean (한국어)
 +
      12
 +
 
 +
    * Change value="1" so that it contains your library's language value, like this:
 +
 
 +
<input type=hidden name="language" value="3">
 +
5
 +
 
 +
Add your library's institution ID to the form's hidden "library" field:
 +
 
 +
    * Find the section of the form that looks like this:
 +
 
 +
<!-- Begin library hidden input field -->
 +
<!-- Replace the value attribute "1" with your library's QuestionPoint institution ID, supplied by OCLC, in the library hidden input field -->
 +
<input type=hidden name="library" value="1" >
 +
<!-- End library hidden input field -->
 +
 
 +
    * Change value="1" so that it contains your library's institution ID, like this:
 +
 
 +
<input type=hidden name="library" value="10097" >
 +
 
 +
    How can I find my library's institution ID?
 +
 
 +
        * Log into QuestionPoint.
 +
        * If you do not see the Home screen, click the Home link in the black bar at the top of the screen.
 +
        * Your institution ID appears under your institution's name.
 +
 
 +
6 Save and close the form file.
 +
7 Add the form to your library Web site test or staging area. This is wherever you test additions to your site before moving them into your live Web site, the one accessible to patrons and other users.
 +
8 Use the form to open a chat session. Make sure that the session shows up on the QuestionPoint chat monitor.
 +
9
 +
 
 +
Open the form in an editor and make any modifications you wish to the form's page title, image, or introductory text. You are also free to add more images and text elsewhere on the page. The code shown below is from the chat form with minimal formatting. The other forms may be slightly different but the changes you make will be similar.
 +
 
 +
Page Title
 +
<html>
 +
<head>
 +
<!--Modify the next line to insert your page title-->
 +
<title>Chat Form Example #2 [QuestionPoint] - Change to your page title</title>
 +
 
 +
Image
 +
<table width="95%" cellpadding="3" cellspacing="0" align="center">
 +
  <tr>
 +
    <td colspan="2">
 +
    <!-- This is a placeholder for a graphic of your choice. -->
 +
    <img src="images/image_placeholder.gif"
 +
      width="200" height="110">
 +
  </td>
 +
  </tr>
 +
 
 +
Introductory Text
 +
<td colspan="2">
 +
<!-- Modify the data in this table cell (down through the </td> tag) as needed.-->
 +
<p>&nbsp;<br>
 +
Welcome to the QuestionPoint Ask a Librarian service, a Web-based reference service that helps libraries deliver reference services via e-mail and chat. QuestionPoint is brought to you by your library. </p>
 +
<p>To chat with a librarian, enter your name and e-mail address, and if you wish, your question; then click Chat. Another browser window opens for the chat session.
 +
&nbsp; </p>
 +
</td>
 +
 
 +
Save and close the form file.
 +
10 Repeat steps 7 and 8 to test your modifications.
 +
11
 +
 
 +
Would you like to:
 +
 
 +
    * remove the Question field from the form? See Removing the Question Field.
 +
    * make the Question field required? See Making the Question Field Required.
 +
    * keep the Question field as an optional field? Go to step 13.
 +
 
 +
12 Repeat steps 7 and 8 to test your modifications (removing the Question field or making it required).
 +
13 Apply your library Web site's formatting (style sheet, top and bottom navigation links, colors, fonts, and so on) to the form.
 +
14 Add links to the form from other pages on your Web site in your test or staging area.
 +
15 Repeat steps 7 and 8 to test any modifications you made in steps 13 and 14.
 +
16 When you are satisfied with the form's appearance and functioning, add the form to your library's live Web site.
 +
 
 +
Back to top
 +
Removing the Question Field
 +
 
 +
To remove the Question field from your form, perform these steps:
 +
Step Action
 +
1
 +
 
 +
Delete these lines from the file:
 +
<!-- Start of question field -->
 +
<tr>
 +
  <th width="20%" align="right">
 +
    <label for="question"
 +
    accesskey="Q">Question:</label>
 +
  </th>
 +
  <td width="80%">
 +
    <textarea name="question" rows="7"
 +
      cols="50"></textarea>
 +
  </td>
 +
</tr>
 +
<!-- End of question field -->
 +
2 Save and close the file.
 +
3 Return to step 12 of the overall procedure.
 +
Back to top
 +
Making the Question Field Required
 +
 
 +
To make the Question field required, follow these steps:
 +
Step Action
 +
1 Go to the JavaScript section at the top of the file, between these lines:
 +
 
 +
    <script language="JavaScript">
 +
        and
 +
    </script>
 +
 
 +
2 Remove the comment characters (//) from the line highlighted below:
 +
 
 +
function checkIt(form) {
 +
  var name = form.chat_name.value;
 +
  var email = form.chat_email.value;
 +
  /*Library: To make the question field
 +
  required, remove the comment characters
 +
  (//) from the next line and
 +
  other sections where indicated.*/
 +
  //var ques = form.question.value;
 +
  var lib = form.library.value;
 +
  var msg = '';
 +
3 Remove the comment characters (//) from each of these lines.
 +
 
 +
//if (ques.length < 1) {
 +
// if(msg.length > 0)
 +
// msg+=', ';
 +
// msg += 'Question';
 +
//}
 +
4 To indicate that a field is required, change the field's screen label in a way consistent with your question form's design, such as preceding the field's label with an asterisk.
 +
 
 +
Example:
 +
<!-- Start of question field -->
 +
<tr>
 +
  <th width="20%" align="right">
 +
  <label for="question" accesskey="Q">
 +
    *Question:</label>
 +
  </th>
 +
  <td width="80%">
 +
  <textarea name="question" rows="7"
 +
      cols="50"></textarea>
 +
  </td>
 +
</tr>
 +
<!-- End of question field -->
 +
5 Return to step 12 of the overall procedure.[http://www.example.com link title]

Revision as of 15:36, 14 September 2009

Form Editing 

   *

     When the procedure includes a step that requires you to edit the form, open the form using an editor of your choice. You can use as a Windows text editor (such as TextPad or NotePad), an HTML editor, or a UNIX editor. Use a word processor only if it allows you to see the HTML code and it allows you to save files in plain text format. Save the form with an .htm or .html extension, whichever is the convention for your Web site.
   * The items to modify in the form appear in a box like this:


   with the code to modify highlighted, such as this: value="1".

   *

     Unless a procedure step directs to you modify the JavaScript, do not modify or remove anything between these tags:


Back to top

Overall Procedure

This procedure takes an incremental approach, where you frequently test modifications to the form and ensure that they are working correctly before moving on to subsequent modifications. Step Action 1 Make a backup copy of the form you downloaded. 2 Open the form file in a text editor. 3

Are you planning on modifying the form text so that it is in a language other than English? 

   * Yes. Go to step 4.
   * No. Go to step 5.

4

To allow your patrons to see QuestionPoint messages in your language, follow these steps: 

   * Find the section of the form that looks like this:


   * Use this table to find the value that corresponds to your language:

     Language 	Value
     French (Français)
     2
     Spanish (Español)
     3
     Chinese-Traditional (中文(繁體))
     4
     Chinese-Simplified (中文(简体))
     5
     Dutch (Nederlands)
     7
     Slovene (Slovensko)
     8
     German (Deutsch)
     10
     Korean (한국어)
     12

   * Change value="1" so that it contains your library's language value, like this:

5

Add your library's institution ID to the form's hidden "library" field: 

   * Find the section of the form that looks like this:


   * Change value="1" so that it contains your library's institution ID, like this:


   	How can I find my library's institution ID?

       * Log into QuestionPoint.
       * If you do not see the Home screen, click the Home link in the black bar at the top of the screen.
       * Your institution ID appears under your institution's name.

6 Save and close the form file. 7 Add the form to your library Web site test or staging area. This is wherever you test additions to your site before moving them into your live Web site, the one accessible to patrons and other users. 8 Use the form to open a chat session. Make sure that the session shows up on the QuestionPoint chat monitor. 9

Open the form in an editor and make any modifications you wish to the form's page title, image, or introductory text. You are also free to add more images and text elsewhere on the page. The code shown below is from the chat form with minimal formatting. The other forms may be slightly different but the changes you make will be similar.

Page Title


Chat Form Example #2 [QuestionPoint] - Change to your page title

Image

Introductory Text Save and close the form file. 10 Repeat steps 7 and 8 to test your modifications. 11 Would you like to: * remove the Question field from the form? See Removing the Question Field. * make the Question field required? See Making the Question Field Required. * keep the Question field as an optional field? Go to step 13. 12 Repeat steps 7 and 8 to test your modifications (removing the Question field or making it required). 13 Apply your library Web site's formatting (style sheet, top and bottom navigation links, colors, fonts, and so on) to the form. 14 Add links to the form from other pages on your Web site in your test or staging area. 15 Repeat steps 7 and 8 to test any modifications you made in steps 13 and 14. 16 When you are satisfied with the form's appearance and functioning, add the form to your library's live Web site. Back to top Removing the Question Field To remove the Question field from your form, perform these steps: Step Action 1 Delete these lines from the file: 2 Save and close the file. 3 Return to step 12 of the overall procedure. Back to top Making the Question Field Required To make the Question field required, follow these steps: Step Action 1 Go to the JavaScript section at the top of the file, between these lines: 2 Remove the comment characters (//) from the line highlighted below: function checkIt(form) { var name = form.chat_name.value; var email = form.chat_email.value; /*Library: To make the question field required, remove the comment characters (//) from the next line and other sections where indicated.*/ //var ques = form.question.value; var lib = form.library.value; var msg = ; 3 Remove the comment characters (//) from each of these lines. //if (ques.length 0) // msg+=', '; // msg += 'Question'; //} 4 To indicate that a field is required, change the field's screen label in a way consistent with your question form's design, such as preceding the field's label with an asterisk. Example: 5 Return to step 12 of the overall procedure.link title

 
Welcome to the QuestionPoint Ask a Librarian service, a Web-based reference service that helps libraries deliver reference services via e-mail and chat. QuestionPoint is brought to you by your library.

To chat with a librarian, enter your name and e-mail address, and if you wish, your question; then click Chat. Another browser window opens for the chat session.  

Retrieved from "http://aboutus.com/index.php?title=Constructive_Edits&oldid=19675868"