Browse Source

Update non-existent and incomplete (template-only) help handbook to new default format.

tags/r14.0.0
Darrell Anderson 5 years ago
parent
commit
6abe8f7692
5 changed files with 72 additions and 8 deletions
  1. 3
    0
      doc/Makefile.am
  2. 2
    0
      doc/en/Makefile.am
  3. 65
    0
      doc/en/index.docbook
  4. 1
    7
      ksystemlog/src/ksystemlog.desktop
  5. 1
    1
      subdirs

+ 3
- 0
doc/Makefile.am View File

@@ -0,0 +1,3 @@
1
+KDE_LANG = en
2
+KDE_DOCS = AUTO
3
+SUBDIRS = $(AUTODIRS)

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

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

+ 65
- 0
doc/en/index.docbook View File

@@ -0,0 +1,65 @@
1
+<?xml version="1.0" ?>
2
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
3
+  <!ENTITY ksystemlog "<application>KSystemlog</application>">
4
+  <!ENTITY kappname "&ksystemlog;">
5
+  <!ENTITY % addindex "IGNORE">
6
+  <!ENTITY % English "INCLUDE">
7
+]>
8
+
9
+<!-- Note: When updating this empty handbook, remember that usually most handbooks -->
10
+<!-- use the book model rather than article. Feel free to use article if the new handbook -->
11
+<!-- remains really short. -->
12
+
13
+<article lang="&language;">
14
+<title>The &ksystemlog; Handbook</title>
15
+
16
+<articleinfo>
17
+<title>The &ksystemlog; Handbook</title>
18
+
19
+<authorgroup>
20
+<corpauthor>&tde-team;</corpauthor>
21
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
22
+</authorgroup>
23
+
24
+<releaseinfo>&tde-release-version;</releaseinfo>
25
+<date>Reviewed: &tde-release-date;</date>
26
+
27
+<copyright>
28
+<year>&tde-copyright-date;</year>
29
+<holder>&tde-team;</holder>
30
+</copyright>
31
+
32
+<!-- <legalnotice>&FDLNotice;</legalnotice> -->
33
+
34
+<abstract>
35
+<para>
36
+&ksystemlog; is a system log viewer for &tde;.
37
+</para>
38
+</abstract>
39
+
40
+<keywordset>
41
+<keyword>TDE</keyword>
42
+</keywordset>
43
+
44
+</articleinfo>
45
+
46
+<sect1 id="apologies">
47
+<title>We Apologize</title>
48
+<para>No documentation has yet been written for &ksystemlog;.</para>
49
+
50
+<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde;
51
+web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php">
52
+&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/">
53
+&tde; bug tracker</ulink>.</para>
54
+
55
+<para>If you are interested in helping, please consider writing the help file.
56
+Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para>
57
+
58
+<para>Thank you for helping and thank you for your patience.</para>
59
+
60
+&underFDL;
61
+
62
+</sect1>
63
+
64
+&documentation.index; 
65
+</article>

+ 1
- 7
ksystemlog/src/ksystemlog.desktop View File

@@ -6,13 +6,7 @@ Name[tr]=KSistemGünlüğü
6 6
 Exec=tdesu ksystemlog %i %m -caption "%c"
7 7
 Icon=ksystemlog
8 8
 Type=Application
9
-# Restore the following key and remove this comment when a help handbook
10
-# is written. Disabling this key prevents populating the main handbook
11
-# table of contents with a non-existent document, which results in a
12
-# main handbook error message of
13
-# 'There is no documentation available for /xyz/index.html.'
14
-# Also disable this key when there exists only a useless template handbook.
15
-# DocPath=ksystemlog/ksystemlog.html
9
+DocPath=ksystemlog/index.html
16 10
 Comment=System log viewer tool
17 11
 Comment[da]=Værktøj til at vise systemlog
18 12
 Comment[el]=Εργαλείο προβολής καταγραφής συστήματος

+ 1
- 1
subdirs View File

@@ -1 +1 @@
1
-ksystemlog
1
+doc ksystemlog

Loading…
Cancel
Save