!!! FAQ

What... ? and Why...? Questions

This Page is supposed to help you getting started with the development of KnowWE. Feel free to add your Solutions to this page. If you don't find the Informations you need here, you can post it in the [Forum|http://sourceforge.net/projects/knowwe/forums].

[{TableOfContents }]

!!Creating new projects

Every new project has to be allocated to one of the three main repositories: __d3web-core, d3web-KnowWE or Research.__

!Creating the project in Eclipse

* Do a right click on the main project (one of the three projects mentioned above) → New → Other…. In the window, in the Maven folder, select "Maven Module"
* Check the checkbox called "Skip Archetype selection", give the project a name and hit Next.
* Enter a human-readable name into the field "Name", fill in "Description" as needed.
* Click "Finish".

Now you will see the new project in the Eclipse Project Explorer. Now you can start creating or copying source files. Using the __UTF-8 encoding__ is __mandatory.__
 
! License header

Every {{.java}} file __must__ contain the license header, starting in the first line. Be sure to have an empty line between the license and the {{package}} declaration.

The license is to look like this:
{{{
/*
 * Copyright (C) 2010 Chair of Artificial Intelligence and Applied Informatics
 *                    Computer Science VI, University of Wuerzburg
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
 
}}}
You can do this automatically by adding [codetemplates.xml] in Eclipse: ''Window'' -> ''Preferences'' -> ''Java'' -> ''Code Style'' -> ''Code Templates'' 
!First check-in

You have to perform the first check-in using the chosen main repository (c.f. above).
* Right click the main project → Team → Commit.
* Now __exclude the folders {{target/}} and {{.settings/}}__! (Uncheck the check boxes)
* Enter your commit message → Commit.

Now you can enable SVN access directly for your newly created project: Perform a right click on the new project → Team → Share.
Select SVN, you will find the repository location already set up. Hit Finish.

To complete the process, you have to ignore {{target/}} and {{.settings}} permanently. Select both folders in the Project Explorer with Ctrl/Command, right click → Team → Add to svn:ignore. Click OK in the window that opens.

Finally, commit the ignore settings: right click → Team → Commit. Done.

!!Why isn't Plugin X included in my Build?
[{Image src='attach/Developer%20FAQ/m2eclipse-plugins.png' width='232' height='202' align='right' link='http://d3webwiki.informatik.uni-wuerzburg.de/attach/FAQ/m2eclipse-plugins.png'}]

You need to enable the plug-ins you want to build into KnowWE when using Eclipse. Here's how:

Open your Run Configuration for the KnowWE build and add parameters for the plug-ins you want to have in the goals section.

For instance: You want to enable the Comment plug-in. Here, you have to add a {{comment-plugin}} parameter. List all the profile names for the Plug-ins you want to add in the Profiles Section and build KnowWE.

See the screenshot on the right for another example.

!!Why does Eclipse not catch breakpoints?
This Issue is caused by an outdated JDK. Please update your JDK to the [latest Version | http://www.oracle.com/technetwork/java/javaee/downloads/index.html].

<tags>workspace problems FAQ </tags>

!!Why do i get a java.util.MissingResourceException: Can't find bundle for base name Exception?
This happens after cleaning the workspace.

Solution: For each of the two maven super projects (d3web, d3web-KnowWE), select the project, right click on it, "Run as...", "Maven package".

!!Offline Build (if Artifactory is not available or you have no Internet connection)

Create a second runtime configuration for building KnowWE, just like shown here: [http://d3webwiki.informatik.uni-wuerzburg.de/Wiki.jsp?page=Workspace#section-Workspace-CreateARunConfigurationForBuildingTheWiki], just check the "Offline" checkbox. __Note__: Do not enable this option for your regular build, only use it if Artifactory is down or you are not connected to the internet!

!! Why are Umlauts viewed uncorrectly?

Tomcat can be configured in UTF-8 to handle Umlauts correctlty. Look at [http://www.jspwiki.org/wiki/BugProblemsWithGermanUmlaute]
//End Old

What... ? and Why...? Questions\\
Coordinate with How-To

%%Todo 
Set this page up, add table of contents and some introductory words. Every question is its own small headline with the answer directly below.

@user: Christian Henniger
%

%%Todo 
Developer FAQ
* Define questions
* Answer questions, get the information if unkown
* Get and update/improve stuff from old pages: [http://d3webwiki.informatik.uni-wuerzburg.de/Wiki.jsp?page=FAQ]

@user: Christian Henniger
%

%%Todo 
Developer FAQ
* Some examples:
** What do I need do mvn install, after I change a java file or non-java file?
** Tomcat starts, but wikipages are not loaded -> update Tomcat-Context... this happens when mvn installing while tomcat is running...
** What is an plugin, what is an extension, what is an extension point ([http://d3webwiki.informatik.uni-wuerzburg.de/Wiki.jsp?page=Plugins%20and%20Extensions])
** What is the Scope of an extension

@user: Daniel Zügner
%