Browse Source

Update build rules for documentation:

+ Removed French documentation because it contains nothing.
+ Modified automake rules for documentation in subdirectories.
+ Added cmake rule for installing documentation.

Signed-off-by: Slávek Banko <slavek.banko@axis.cz>
pull/2/head
Slávek Banko 5 months ago
parent
commit
bd2ad7db31
Signed by: Slávek Banko <slavek.banko@axis.cz> GPG Key ID: 608F5293A04BE668
5 changed files with 10 additions and 725 deletions
  1. 5
    57
      doc/Makefile.am
  2. 1
    0
      doc/en/CMakeLists.txt
  3. 2
    0
      doc/en/Makefile.am
  4. 2
    6
      doc/en/index.docbook
  5. 0
    662
      doc/fr/index.docbook

+ 5
- 57
doc/Makefile.am View File

@@ -1,58 +1,6 @@
1
-####### tdevelop will overwrite this part!!! (begin)##########
1
+# the SUBDIRS is filled automatically by am_edit. If files are
2
+# in this directory they are installed into the english dir
2 3
 
3
-
4
-EXTRA_DIST = help_en.docbook help_fr.docbook
5
-
6
-####### tdevelop will overwrite this part!!! (end)############
7
-
8
-MAINTAINERCLEANFILES = ./*.html
9
-CLEANFILES = core *~ .deps/* doc/*~ *.orig changes.docbook
10
-DISTCLEANFILES = Makefile.in Makefile
11
-
12
-LANGUAGES = en fr
13
-SUFFIXES = .docbook .po .pot
14
-SGMLDIR=$(kde_datadir)/ksgmltools2
15
-DOCDIR = $(DESTDIR)${kde_htmldir}
16
-XML2POT = xml2pot
17
-PO2XML = po2xml
18
-MSGMERGE = msgmerge
19
-
20
-
21
-help_en.pot: help_en.docbook
22
-	$(XML2POT) help_en.docbook > help_en.pot
23
-
24
-# --- translated docbook online help ---
25
-
26
-help_fr.po: help_en.pot
27
-	$(MSGMERGE) -o help_fr.po help_fr.po help_en.pot
28
-
29
-help_fr.docbook: help_en.docbook help_en.pot
30
-	${MAKE} help_fr.po
31
-	@echo "converting french help"
32
-	@ $(PO2XML) help_en.docbook help_fr.po | \
33
-	sed s/^\ \ \<\!ENTITY\ %\ English\ /\ \ \<\!ENTITY\ %\ French\ /g \
34
-	> help_fr.docbook
35
-
36
-# ---  ---
37
-
38
-install-data-local:
39
-	echo installing docs in $(DOCDIR)
40
-	for lang in ${LANGUAGES}; do \
41
-	{ \
42
-	    $(mkinstalldirs) ${DOCDIR}/$${lang}/$(PACKAGE); \
43
-	    $(INSTALL_DATA) help_$${lang}.docbook ${DOCDIR}/$${lang}/$(PACKAGE)/index.docbook; \
44
-	    if test ! -e ${DOCDIR}/$${lang}/$(PACKAGE)/common ; then \
45
-	    rm -f ${DOCDIR}/$${lang}/$(PACKAGE)/common ; fi ; \
46
-	    ( cd ${DOCDIR}/$${lang}/${PACKAGE} ; ln -sf ../common . ) ; \
47
-	}; done
48
-	cd ${DOCDIR} ; \
49
-	if test ! -e default/$(PACKAGE) -a -e default ; then ln -sf ../en/$(PACKAGE) default; fi;
50
-
51
-uninstall-local:
52
-	for lang in ${LANGUAGES}; do { \
53
-	    rm -R -f ${DOCDIR}/$${lang}/${PACKAGE} ; \
54
-	    rmdir -p --ignore-fail-on-non-empty $(DOCDIR)/$$lang >/dev/null 2>&1; \
55
-	    if test -L ${DOCDIR}/default/$(PACKAGE); then rm -f ${DOCDIR}/default/$(PACKAGE); fi; \
56
-	}; done
57
-
58
-all:
4
+KDE_LANG = en
5
+KDE_DOCS = knights
6
+SUBDIRS = $(AUTODIRS)

+ 1
- 0
doc/en/CMakeLists.txt View File

@@ -0,0 +1 @@
1
+tde_create_handbook( DESTINATION ${PROJECT_NAME} )

+ 2
- 0
doc/en/Makefile.am View File

@@ -0,0 +1,2 @@
1
+KDE_DOCS = knights
2
+KDE_LANG = en

+ 2
- 6
doc/en/index.docbook View File

@@ -15,18 +15,14 @@
15 15
 				<firstname>Troy</firstname>
16 16
 				<surname>Corbin Jr.</surname>
17 17
 				<affiliation>
18
-					<address>
19
-						<email>tcorbin@users.sf.net</email>
20
-					</address>
18
+					<address><email>tcorbin@users.sf.net</email></address>
21 19
 				</affiliation>
22 20
 			</author>
23 21
 			<othercredit role="developer">
24 22
 				<firstname>Troy</firstname>
25 23
 				<surname>Corbin Jr.</surname>
26 24
 				<affiliation>
27
-					<address>
28
-						<email>tcorbin@users.sf.net</email>
29
-					</address>
25
+					<address><email>tcorbin@users.sf.net</email></address>
30 26
 				</affiliation>
31 27
 				<contrib>Developer</contrib>
32 28
 			</othercredit>

+ 0
- 662
doc/fr/index.docbook View File

@@ -1,662 +0,0 @@
1
-<?xml version="1.0" ?>
2
-<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
3
-  <!ENTITY kappname "Knights">
4
-  <!ENTITY % addindex "IGNORE">
5
-  <!ENTITY % French "INCLUDE" 
6
-> <!-- change language only here -->
7
-]>
8
-
9
-<book lang="&language;">
10
-	<bookinfo>
11
-		<title>
12
-			The Knights Handbook
13
-		</title>
14
-		<authorgroup>
15
-			<author>
16
-				<firstname>Troy</firstname>
17
-				<surname>Corbin Jr.</surname>
18
-				<affiliation>
19
-					<address>
20
-						<email>tcorbin@users.sf.net</email>
21
-					</address>
22
-				</affiliation>
23
-			</author>
24
-			<othercredit role="developer">
25
-				<firstname>Troy</firstname>
26
-				<surname>Corbin Jr.</surname>
27
-				<affiliation>
28
-					<address>
29
-						<email>tcorbin@users.sf.net</email>
30
-					</address>
31
-				</affiliation>
32
-				<contrib>Developer</contrib>
33
-			</othercredit>
34
-		</authorgroup>
35
-		<!-- TRANS:ROLES_OF_TRANSLATORS -->
36
-		<copyright>
37
-			<year
38
->2001, 2002</year>
39
-			<holder
40
-></holder>
41
-		</copyright>
42
-		<legalnotice>
43
-			&FDLNotice;
44
-		</legalnotice>
45
-		<date>
46
-			2003-05-17
47
-		</date>
48
-		<releaseinfo>
49
-			0.6
50
-		</releaseinfo>
51
-		<abstract>
52
-			<para
53
->  </para>
54
-		</abstract>
55
-		<keywordset>
56
-			<keyword
57
-></keyword>
58
-			
59
-			<keyword
60
-></keyword>
61
-			<keyword
62
-></keyword>
63
-			<keyword
64
-></keyword>
65
-			<keyword
66
-></keyword>
67
-			
68
-			
69
-			
70
-		</keywordset>
71
-	</bookinfo>
72
-
73
-	<chapter id="introduction">
74
-		<title
75
-></title>
76
-		<para
77
->  </para>
78
-		<para
79
->  </para>
80
-		<para
81
->  </para>
82
-	</chapter>
83
-
84
-	<chapter id="getting-started">
85
-		<title
86
-></title>
87
-			<para
88
->  </para>
89
-			<sect1 id="interface-chessboard">
90
-				<title
91
-></title>
92
-					<para
93
->  </para>
94
-					<para
95
->  </para>
96
-					<sect2 id="interface-chessboard-move">
97
-						<title
98
-></title>
99
-							<para
100
->  </para>
101
-						<para
102
->  </para>
103
-					</sect2>
104
-					<sect2 id="interface-chessboard-preview">
105
-						<title
106
-></title>
107
-							<para
108
->  </para>
109
-							<para
110
->  </para>
111
-							<tip
112
-> <para
113
->  </para
114
-> </tip>
115
-					</sect2>
116
-					<sect2 id="interface-chessboard-notation">
117
-						<title
118
-></title>
119
-						<para
120
->  </para>
121
-						<note
122
-> <para
123
->  </para
124
-> </note>
125
-					</sect2>
126
-			</sect1>
127
-			<sect1 id="new-match">
128
-				<title
129
-></title>
130
-					<para
131
->  </para>
132
-					<sect2 id="new-match-dialog">
133
-						<title
134
-></title>
135
-							<para
136
->  </para>
137
-							<note
138
-> <para
139
->  </para
140
-> </note>
141
-							<para
142
->  </para>
143
-							<para
144
->  </para>
145
-							<para
146
->  </para>
147
-							<para
148
->  </para>
149
-					</sect2>
150
-			</sect1>
151
-		</chapter>
152
-
153
-	<chapter id="online">
154
-		<title
155
-></title>
156
-		<para
157
->  </para>
158
-		<para
159
->  </para>
160
-		<sect1 id="getting-started-online">
161
-			<title
162
-></title>
163
-			<para
164
->  </para>
165
-			<para
166
->  </para>
167
-			<para
168
->  </para>
169
-			<para
170
->  </para>
171
-			<sect2 id="getting-started-online-connecting">
172
-				<title
173
-></title>
174
-					<para
175
->  </para>
176
-					<para
177
->  </para>
178
-			</sect2>
179
-		</sect1>
180
-		<sect1 id="online-tools">
181
-			<title
182
-></title>
183
-			<para
184
->  </para>
185
-			<sect2 id="online-tools-console">
186
-				<title
187
-></title>
188
-					<para
189
->  </para>
190
-					<para
191
->  </para>
192
-					<para
193
->  </para>
194
-					<para
195
->  </para>
196
-			</sect2>
197
-			<sect2 id="online-tools-sought-list">
198
-				<title
199
-></title>
200
-					<para
201
->  </para>
202
-					<para
203
->  </para>
204
-					<para
205
->  </para>
206
-					<itemizedlist
207
-> <listitem
208
-> <para
209
->  </para
210
-> </listitem
211
-> <listitem
212
-> <para
213
->  </para
214
-> </listitem
215
-> <listitem
216
-> <para
217
->  </para
218
-> </listitem
219
-> <listitem
220
-> <para
221
->  </para
222
-> </listitem
223
-> <listitem
224
-> <para
225
->  </para
226
-> </listitem
227
-> <listitem
228
-> <para
229
->  </para
230
-> </listitem
231
-> </itemizedlist>
232
-			</sect2>
233
-			<sect2 id="online-tools-sought-graph">
234
-				<title
235
-></title>
236
-					<para
237
->  </para>
238
-					<para
239
->  </para>
240
-					<para
241
->  </para>
242
-					<para
243
->  </para>
244
-					<itemizedlist
245
-> <listitem
246
-> <para
247
->  </para
248
-> </listitem
249
-> <listitem
250
-> <para
251
->  </para
252
-> </listitem
253
-> <listitem
254
-> <para
255
->  </para
256
-> </listitem
257
-> <listitem
258
-> <para
259
->  </para
260
-> </listitem
261
-> <listitem
262
-> <para
263
->  </para
264
-> </listitem
265
-> <listitem
266
-> <para
267
->  </para
268
-> </listitem
269
-> </itemizedlist>
270
-			</sect2>
271
-		</sect1>
272
-	</chapter>
273
-
274
-	<chapter id="organizing-tabs">
275
-		<title
276
-></title>
277
-		<para
278
->  </para>
279
-		<para
280
->  </para>
281
-		<para
282
->  </para>
283
-		<note
284
-> <para
285
->  </para
286
-> </note>
287
-	</chapter>
288
-
289
-	<chapter id="configure">
290
-		<title
291
-></title>
292
-		<para
293
->  </para>
294
-		<sect1 id="configure-general">
295
-			<title
296
-></title>
297
-				<para
298
->  </para>
299
-				<para
300
->  </para>
301
-				<para
302
->  </para>
303
-				<para
304
->  </para>
305
-				<para
306
->  </para>
307
-				<note
308
-> <para
309
->  </para
310
-> </note>
311
-				<para
312
->  </para>
313
-				<para
314
->  </para>
315
-		</sect1>
316
-		<sect1 id="configure-display">
317
-			<title
318
-></title>
319
-			<sect2 id="configure-display-general">
320
-				<title
321
-></title>
322
-				<para
323
->  </para>
324
-				<para
325
->  </para>
326
-				<para
327
->  </para>
328
-				<para
329
->  </para>
330
-				<para
331
->  </para>
332
-				<para
333
->  </para>
334
-				<para
335
->  </para>
336
-				<para
337
->  </para>
338
-			</sect2>
339
-			<sect2 id="configure-display-console">
340
-				<title
341
-></title>
342
-				<para
343
->  </para>
344
-				<para
345
->  </para>
346
-			</sect2>
347
-		</sect1>
348
-		<sect1 id="configure-audio">
349
-			<title
350
-></title>
351
-			<para
352
->  </para>
353
-			<para
354
->  </para>
355
-			<para
356
->  </para>
357
-			<para
358
->  </para>
359
-			<note
360
-> <para
361
->  </para
362
-> </note>
363
-			<para
364
->  </para>
365
-		</sect1>
366
-		<sect1 id="configure-engines">
367
-			<title
368
-></title>
369
-			<para
370
->  </para>
371
-			<para
372
->  </para>
373
-			<para
374
->  </para>
375
-			<para
376
->  </para>
377
-			<para
378
->  </para>
379
-			<note
380
-> <para
381
->  </para
382
-> </note>
383
-			<para
384
->  </para>
385
-			<para
386
->  </para>
387
-			<para
388
->  </para>
389
-			<para
390
->  </para>
391
-			<para
392
->  </para>
393
-		</sect1>
394
-		<sect1 id="configure-servers">
395
-			<title
396
-></title>
397
-			<para
398
->  </para>
399
-			<sect2 id="configure-servers-servers">
400
-				<title
401
-></title>
402
-				<para
403
->  </para>
404
-				<para
405
->  </para>
406
-				<para
407
->  </para>
408
-				<para
409
->  </para>
410
-				<para
411
->  </para>
412
-				<para
413
->  </para>
414
-				<para
415
->  </para>
416
-				<para
417
->  </para>
418
-			</sect2>
419
-			<sect2 id="configure-servers-options">
420
-				<title
421
-></title>
422
-				<para
423
->  </para>
424
-				<para
425
->  </para>
426
-				<para
427
->  </para>
428
-				<para
429
->  </para>
430
-				<para
431
->  </para>
432
-				<para
433
->  </para>
434
-				<para
435
->  </para>
436
-				<para
437
->  </para>
438
-				<para
439
->  </para>
440
-			</sect2>
441
-		</sect1>
442
-	</chapter>
443
-
444
-	<chapter id="key-bindings">
445
-		<title
446
-></title>
447
-		<itemizedlist
448
-> <listitem
449
-> <para
450
->  </para
451
-> </listitem
452
-> <listitem
453
-> <para
454
->  </para
455
-> </listitem
456
-> <listitem
457
-> <para
458
->  </para
459
-> </listitem
460
-> <listitem
461
-> <para
462
->  </para
463
-> </listitem
464
-> <listitem
465
-> <para
466
->  </para
467
-> </listitem
468
-> <listitem
469
-> <para
470
->  </para
471
-> </listitem
472
-> <listitem
473
-> <para
474
->  </para
475
-> </listitem
476
-> <listitem
477
-> <para
478
->  </para
479
-> </listitem
480
-> <listitem
481
-> <para
482
->  </para
483
-> </listitem
484
-> </itemizedlist>
485
-	</chapter>
486
-
487
-	<chapter id="credits">
488
-		<title
489
-></title>
490
-		<para
491
->  </para>
492
-		<para
493
->  </para>
494
-		<para
495
->  </para>
496
-		<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
497
-		&underFDL;
498
-		&underGPL;
499
-	</chapter>
500
-
501
-	<appendix id="installation">
502
-		<title
503
-></title>
504
-		<sect1 id="installation-obtain-knights">
505
-			<title
506
-></title>
507
-			<para
508
->  </para>
509
-			<note
510
-> <para
511
->  </para
512
-> </note>
513
-		</sect1>
514
-		<sect1 id="installation-requirements">
515
-			<title
516
-></title>
517
-			<para
518
->  </para>
519
-		</sect1>
520
-		<sect1 id="installation-compilation">
521
-			<title
522
-></title>
523
-			<para
524
->  </para>
525
-			<para
526
->  </para>
527
-			<para
528
-> <userinput
529
-><command
530
-></command
531
-></userinput
532
-> </para>
533
-			<para
534
->  </para>
535
-			<para
536
->  </para>
537
-<informalexample
538
-> <screen width="40">
539
-
540
-</screen
541
-> </informalexample>
542
-			<para
543
->  </para>
544
-		</sect1>
545
-	</appendix>
546
-
547
-	<appendix id="command-line">
548
-		<title
549
-></title>
550
-		<para
551
->  </para>
552
-<screen width="40">
553
-
554
-</screen>
555
-		<para
556
->  </para>
557
-<screen width="40">
558
-
559
-</screen>
560
-		<para
561
->  </para>
562
-	</appendix>
563
-
564
-	<appendix id="kml">
565
-		<title
566
-></title>
567
-		<para
568
->  </para>
569
-		<para
570
->  </para>
571
-		<para
572
->  </para>
573
-		<para
574
->  </para>
575
-		<para
576
->  </para>
577
-		<para
578
->  </para>
579
-		<para
580
->  </para>
581
-		<para
582
->  </para>
583
-		<para
584
->  </para>
585
-		<para
586
->  </para>
587
-		<para
588
->  </para>
589
-		<para
590
->  </para>
591
-		<para
592
->  </para>
593
-		<para
594
->  </para>
595
-		<para
596
->  </para>
597
-		<para
598
->  </para>
599
-		<para
600
->  </para>
601
-		<para
602
->  </para>
603
-		<para
604
->  </para>
605
-		<para
606
->  </para>
607
-		<para
608
->  </para>
609
-		<para
610
->  </para>
611
-		<para
612
->  </para>
613
-		<para
614
->  </para>
615
-		<para
616
->  </para>
617
-		<para
618
->  </para>
619
-		<para
620
->  </para>
621
-		<para
622
->  </para>
623
-		<para
624
->  </para>
625
-		<para
626
->  </para>
627
-		<para
628
->  </para>
629
-		<para
630
->  </para>
631
-		<para
632
->  </para>
633
-		<para
634
->  </para>
635
-		<para
636
->  </para>
637
-		<para
638
->  </para>
639
-		<para
640
->  </para>
641
-		<para
642
->  </para>
643
-		<para
644
->  </para>
645
-		<para
646
->  </para>
647
-		<para
648
->  </para>
649
-		<para
650
->  </para>
651
-	</appendix>
652
-</book>
653
-<!--
654
-Local Variables:
655
-mode: sgml
656
-sgml-omittag: nil
657
-sgml-shorttag: t
658
-End:
659
--->
660
-
661
-
662
-

Loading…
Cancel
Save