summaryrefslogtreecommitdiff
path: root/src/site/xdoc/devel-hacking.xml
blob: 554e56f5d6d71fd0447ad539df7161fb2119053c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
	<properties>
		<title>Hacking DHBW Calendar</title>
		<author>Yves Fischer</author>
		<date>24.02.2011</date>
	</properties>

	<body>
		<section name="Dualis">
			<p>
				Der Dualis Scraper mit htmlunit ist im package
				<tt>...calendar.dualis</tt>
				Untergebracht. Vaadin verwendet jedoch für den Login Test noch einen
				eigenen Scraper.
			</p>
		</section>
		<section name="Dokumentation">
			<p>
				Diese Dokumentation wird im Projektverzeichniss unter
				<tt>src/main/site</tt>
				verwaltet.
			</p>
			<p>
				Dabei wird durchgehend das
				<em>xdoc</em>
				Format verwendet.
			</p>
			<p>
				Generiert wird die Dokumentation durch den Befehl
				<tt>mvn site:site</tt>
				und der Befehl
				<tt>mvn site:deploy</tt>
				veröffentlicht - entsprechende Berechtigungen vorrausgesetzt - die
				Seite auf github im
				<em>gh-pages</em>
				des Repositories.
			</p>
			<p>
				Dazu muss in der lokalen Maven Konfiguration (
				<tt>$HOME/.m2/settings.xml</tt>
				) der Benutzer zum Zugriff auf das Repository auf
				<em>git</em>
				eingestellt sein.
			</p>
			<source>
				&lt;settings
				xmlns=&quot;http://maven.apache.org/SETTINGS/1.0.0&quot;
				xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;
				xsi:schemaLocation=&quot;http://maven.apache.org/SETTINGS/1.0.0
				http://maven.apache.org/xsd/settings-1.0.0.xsd&quot;&gt;
				&lt;servers&gt;
				&lt;server&gt;
				&lt;id&gt;github-project-site&lt;/id&gt;
				&lt;username&gt;git&lt;/username&gt;
				&lt;/server&gt;
				&lt;/servers&gt;
				&lt;/settings&gt; </source>
			<p>
				Siehe hierzu auch
				<a href="http://khuxtable.github.com/wagon-gitsite/">die wagon-gitsite Seite</a>
				und ein bestehendes Problem
				<a href="https://github.com/khuxtable/wagon-gitsite/issues/7">issue</a>
				.
			</p>
		</section>
	</body>
</document>