<commit_before><?xml version="1.0" encoding="UTF-8"?>
<!--
  Copyright 2005 The Apache Software Foundation or its licensors,
  as applicable.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
        <title>
          Apache Forrest: Eclipse Plugin
        </title>
      </header>
<body>
<section id="overview">
        <title>
          Eclipse Plugin
        </title>
        <warning>
          The Forrest plugin for Eclipse is new and under rapid development. For up to the minute
          details of available features see the dev list archives.
        </warning>
      </section>
<section id="install">
        <title>
          Installation notes
        </title>
        <p>
          To get you started while the documentation is being developed, see this forrest-dev mail thread:
          <a href="http://marc.theaimsgroup.com/?t=112059632000001">
            [eclipse] How to install?
          </a>
          .
        </p>
      </section>
<section id="siteXMLEditor">
        <title>
          site.xml Editor
        </title>
        <p>
          First, you need to activate the Site.xml view. This can be done by:
          <code>
            Window -> Show View -> Other... -> Forrest -> SiteXML -> OK
          </code>
          Now you will see the the view open up in Eclipse. To view a tree, click on the project you are working and you should see the structure of the site.xml as a tree in the view.
        </p>
        <p>
          There are two ways to add the note to the site.xml file.
        </p>
          <ol>
            <li>
              Drag a document from the Package Explorer to the tree. This will create a new element called NewElement which will allow with references to that new object
            </li>
            <li>
              Right click on an element in the site.xml tree and select "Add Element". A wizard will come up which will allow you to enter the HREF, Description, Label and Element name for the new element that is being added.
            </li>
          </ol>
        <p>
          To delete an element, right click on the element in the tree and click on "Delete Element".
        </p>
        <warning>
          For the changes to show up when you run a test site for your project, you must save the changes. Right click on the tree and select
		  "Save". In a later version of the plugin this step will not be necessary.
        </warning>
        <fixme author="<NAME>">
          Currently there is no easy way to edit an existing element. The element will be linked to the Properties View in Eclipse to allow for easy editing
        </fixme>
      </section>
<section id="tabsXMLEditor">
        <title>
          tabs.xml Editor
        </title>
        <p>
          First, you need to activate the Tab.xml view. This can be done by:
          <code>
            Window -> Show View -> Other... -> Forrest -> TabXML -> OK
          </code>
          Now you will see the the view open up in Eclipse. To view a tree, click on the project you are working and you should see the structure of the tabs.xml as a tree in the view.
        </p>
        <p>
          To add a new element to the tabs.xml file right click on an element in the tabs.xml tree and select "Add Element". 
            A wizard will come up which will allow you to enter the Id, Dir, Label and Index File for the new tab
            element that is being added.
        </p>
        <p>
          To delete an element, right click on the element in the tree and click on Delete Element
        </p>
        <warning>
          For the changes to show up when you run a test site for your project, you must save the changes. Right
          click on the tree and select "Save". In a later version of the plugin this step will not be necessary.
        </warning>
        <fixme author="<NAME>">
          Currently there is no easy way to edit an element. The element will be linked to the Properties View in Eclipse to allow for easy editing
        </fixme>
      </section>
	
	<section id="LocationmapEditor">
        <title>
          Locationmap.xml Editor
        </title>
        <p>
          First, you need to activate the Locationmap view. This can be done by:
        </p>
        <p>
          Window ->  Show View ->  Other... -> Forrest -> Locationmap -> OK
        </p>
        <p>
          Now you will see the the view open up in Eclipse. To view a tree, click on the 
          project you are working and you should see the structure of the Locationmap.xml 
          as a tree in the view.
        </p>
        <p>
          To add a match, you must rich click on the locater element and click on
		      "Add Match". A wizard will come up asking you to enter the Pattern or the Match.
        </p>
        <p>
          Right click on the match you just created and click on "Add Location". This will allow you to enter the Location Source.
        </p>
        <p>
          To delete an element, right click on the element in the tree and click on Delete Element
        </p>
        <p>
          For the changes to show up when you run a test site for your project, you must save the changes. Right click on the tree and select
		  "Save".
        </p>
        <fixme author="<NAME>">
          Currently there is no easy way to edit an element. The element will be linked to the Properties View in Eclipse to allow for easy editing
        </fixme>
      </section>
<section id="Forrest:Views">
        <title>
          Activate Forrest:Views for a project
        </title>
        <p>
          To activate views when seeding a new project:
        </p>
        <p >
          File ->  New -> Project -> Forrest -> Seed New Project -> Next
        </p>
        <p>
          Type in the name of the project and click on Next. To Activate views for the new project, check off
		      "Activate Views"  and click on Finish. When "Activate Views" is selected, the new project has 
          project.skin=leather-dev uncommented and the relevant plugins for views are added to 
          project.required.plugins
        </p>
        <p>
	       To add a new View doc (*.fv), click on New -> Other ->  Forrest -> View Doc. Enter the file name of 
         the view document and click on Finish.
        </p>
      </section>
</body>    
</document><commit_msg>add documentation for the wizards<commit_after><?xml version="1.0" encoding="UTF-8"?>
<!--
  Copyright 2005 The Apache Software Foundation or its licensors,
  as applicable.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
        <title>
          Apache Forrest: Eclipse Plugin
        </title>
      </header>
<body>
<section id="overview">
        <title>
          Eclipse Plugin
        </title>
        <warning>
          The Forrest plugin for Eclipse is new and under rapid development. For up to the minute
          details of available features see the dev list archives.
        </warning>
      </section>
<section id="install">
        <title>
          Installation notes
        </title>
        <p>
          To get you started while the documentation is being developed, see this forrest-dev mail thread:
          <a href="http://marc.theaimsgroup.com/?t=112059632000001">
            [eclipse] How to install?
          </a>
          .
        </p>
      </section>

      <section>
        <title>Wizards</title>
        <p>A number of wizards are provided for perfomring common tasks. This section briefly describes
        the available wizards.</p>
        
        <section id="newProject">
          <title>Creating a new Forrest Project</title>
          <p>To create a new Forrest project select "New Project" from either the context menu in the package explorer or the
          "New" menu and select Forrest -> Seed New Project.</p>
          
          <p>A wizard will ask you for the name of the project and the location in which the project files are to be created
          (by default the files will be in your current workspace). If you click "Finish" at this point a basic project will
          be created. However, if you click "Next" you will be given the opportunity to select which plugins you wish to 
          include in the project.</p>
        </section>
        
        <section id="newXDoc">
          <title>Creating a new XDoc</title>
          <p>To create a new XDoc within yout Forrest project select "New -> Other..." and then select
          "New XDoc" from the Forrest node.</p>
        </section>
      </section>
      
      <section id="editors">
        <title>Editors</title>
        <p>A number of editors are provided for Forrest configuration files. This section describes those editors.</p>
        
        <section id="siteXMLEditor">
          <title>
            site.xml Editor
          </title>
          <p>
            First, you need to activate the Site.xml view. This can be done by:
            <code>
              Window -> Show View -> Other... -> Forrest -> SiteXML -> OK
            </code>
            Now you will see the the view open up in Eclipse. To view a tree, click on the project you are working and you should see the structure of the site.xml as a tree in the view.
          </p>
          <p>
            There are two ways to add the note to the site.xml file.
          </p>
            <ol>
              <li>
                Drag a file from the Package Explorer to the tree. This will create a new element 
                with references to that dropped file(s).
              </li>
              <li>
                Right click on an element in the site.xml tree and select "Add Element". A wizard will come up which will allow you to enter the HREF, Description, Label and Element name for the new element that is being added.
              </li>
            </ol>
          <p>
            To delete an element, right click on the element in the tree and click on "Delete Element".
          </p>
          <warning>
            For the changes to show up when you run a test site for your project, you must save the changes. Right click on the tree and select
        "Save". In a later version of the plugin this step will not be necessary.
          </warning>
          <fixme author="<NAME>">
            Currently there is no easy way to edit an existing element. The element will be linked to the Properties View in Eclipse to allow for easy editing
          </fixme>
        </section>
      <section id="tabsXMLEditor">
        <title>
          tabs.xml Editor
        </title>
        <p>
          First, you need to activate the Tab.xml view. This can be done by:
          <code>
            Window -> Show View -> Other... -> Forrest -> TabXML -> OK
          </code>
          Now you will see the the view open up in Eclipse. To view a tree, click on the project you are working and you should see the structure of the tabs.xml as a tree in the view.
        </p>
        <p>
          To add a new element to the tabs.xml file right click on an element in the tabs.xml tree and select "Add Element". 
            A wizard will come up which will allow you to enter the Id, Dir, Label and Index File for the new tab
            element that is being added.
        </p>
        <p>
          To delete an element, right click on the element in the tree and click on Delete Element
        </p>
        <warning>
          For the changes to show up when you run a test site for your project, you must save the changes. Right
          click on the tree and select "Save". In a later version of the plugin this step will not be necessary.
        </warning>
        <fixme author="<NAME>">
          Currently there is no easy way to edit an element. The element will be linked to the Properties View in Eclipse to allow for easy editing
        </fixme>
      </section>
	
	    <section id="LocationmapEditor">
        <title>
          Locationmap.xml Editor
        </title>
        <p>
          First, you need to activate the Locationmap view. This can be done by:
        </p>
        <p>
          Window ->  Show View ->  Other... -> Forrest -> Locationmap -> OK
        </p>
        <p>
          Now you will see the the view open up in Eclipse. To view a tree, click on the 
          project you are working and you should see the structure of the Locationmap.xml 
          as a tree in the view.
        </p>
        <p>
          To add a match, you must rich click on the locater element and click on
		      "Add Match". A wizard will come up asking you to enter the Pattern or the Match.
        </p>
        <p>
          Right click on the match you just created and click on "Add Location". This will allow you to enter the Location Source.
        </p>
        <p>
          To delete an element, right click on the element in the tree and click on Delete Element
        </p>
        <p>
          For the changes to show up when you run a test site for your project, you must save the changes. Right click on the tree and select
		  "Save".
        </p>
        <fixme author="<NAME>">
          Currently there is no easy way to edit an element. The element will be linked to the Properties View in Eclipse to allow for easy editing
        </fixme>
      </section>

      <section id="Forrest:Views">
        <title>
          Activate Forrest:Views for a project
        </title>
        <p>
          To activate views when seeding a new project:
        </p>
        <p >
          File ->  New -> Project -> Forrest -> Seed New Project -> Next
        </p>
        <p>
          Type in the name of the project and click on Next. To Activate views for the new project, check off
		      "Activate Views"  and click on Finish. When "Activate Views" is selected, the new project has 
          project.skin=leather-dev uncommented and the relevant plugins for views are added to 
          project.required.plugins
        </p>
        <p>
	       To add a new View doc (*.fv), click on New -> Other ->  Forrest -> View Doc. Enter the file name of 
         the view document and click on Finish.
        </p>
      </section>
    </section>
</body>    
</document>
{'fraction_non_alphanumeric': 0.073502722323049, 'fraction_numerical': 0.00388903292714545, 'mean_word_length': 1.9100339494530365, 'pattern_counts': {'":': 0, '<': 225, '<?xml version=': 2, '>': 273, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 26}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5440535', 'n_tokens_mistral': 4024, 'n_tokens_neox': 3856, 'n_words': 2057}