4:58 a.m.
From: Suresh Babu Angadi <sureshab(a)in.ibm.com>
v2: Added "Code derived from" in copyright for the files
copied from other plugins.
Changed help text as per review comments
Suresh Babu Angadi (2):
Issue #114: Help page for "Settings" tab
made changes in config to add '/help' uri
made Makefile.am and configure.ac changes to
add "help" directory
added makefiles for "help" and "en_Us" directory
Issue #114: Help page for "Settings" tab
added dita-hepl.xsl, css file for help pages and
help page for "Settings" tab
configure.ac | 2 +
src/wok/config.py.in | 6 ++
tests/test_config.py.in | 5 +
ui/pages/Makefile.am | 2 +-
ui/pages/help/Makefile.am | 37 +++++++
ui/pages/help/dita-help.xsl | 45 ++++++++
ui/pages/help/en_US/Makefile.am | 26 +++++
ui/pages/help/en_US/settings.dita | 42 ++++++++
ui/pages/help/wok.css | 209 ++++++++++++++++++++++++++++++++++++++
9 files changed, 373 insertions(+), 1 deletion(-)
create mode 100644 ui/pages/help/Makefile.am
create mode 100644 ui/pages/help/dita-help.xsl
create mode 100644 ui/pages/help/en_US/Makefile.am
create mode 100644 ui/pages/help/en_US/settings.dita
create mode 100644 ui/pages/help/wok.css
--
2.1.0
4:58 a.m.
New subject: [PATCH v2] [Wok 1/2] Issue #114: Help page for "Settings" tab
From: Suresh Babu Angadi <sureshab(a)in.ibm.com>
made changes in config to add '/help' uri
made Makefile.am and configure.ac changes to
add "help" directory
added makefiles for "help" and "en_Us" directory
Signed-off-by: Suresh Babu Angadi <sureshab(a)in.ibm.com>
---
configure.ac | 2 ++
src/wok/config.py.in | 6 ++++++
tests/test_config.py.in | 5 +++++
ui/pages/Makefile.am | 2 +-
ui/pages/help/Makefile.am | 37 +++++++++++++++++++++++++++++++++++++
ui/pages/help/en_US/Makefile.am | 26 ++++++++++++++++++++++++++
6 files changed, 77 insertions(+), 1 deletion(-)
create mode 100644 ui/pages/help/Makefile.am
create mode 100644 ui/pages/help/en_US/Makefile.am
diff --git a/configure.ac b/configure.ac
index 8b35de6..002774d 100644
--- a/configure.ac
+++ b/configure.ac
@@ -143,7 +143,9 @@ AC_CONFIG_FILES([
ui/libs/list-js/Makefile
ui/libs/typeahead/Makefile
ui/pages/Makefile
+ ui/pages/help/Makefile
ui/pages/tabs/Makefile
+ ui/pages/help/en_US/Makefile
ui/config/Makefile
contrib/Makefile
contrib/DEBIAN/Makefile
diff --git a/src/wok/config.py.in b/src/wok/config.py.in
index 1b0e7bd..fd30fd6 100644
--- a/src/wok/config.py.in
+++ b/src/wok/config.py.in
@@ -218,6 +218,12 @@ class WokConfig(dict):
'tools.staticfile.on': True,
'tools.staticfile.filename': '%s/robots.txt' % paths.ui_dir
},
+ '/help': {
+ 'tools.staticdir.on': True,
+ 'tools.nocache.on': True,
+ 'tools.staticdir.dir': os.path.join(paths.ui_dir,
+ 'pages/help')
+ },
}
def __init__(self):
diff --git a/tests/test_config.py.in b/tests/test_config.py.in
index b221d18..9b8c851 100644
--- a/tests/test_config.py.in
+++ b/tests/test_config.py.in
@@ -111,6 +111,11 @@ class ConfigTests(unittest.TestCase):
'tools.staticfile.on': True,
'tools.staticfile.filename': '%s/robots.txt' %
paths.ui_dir
},
+ '/help': {
+ 'tools.staticdir.on': True,
+ 'tools.nocache.on': True,
+ 'tools.staticdir.dir': '%s/pages/help' % paths.ui_dir
+ },
'/libs': {
'tools.wokauth.on': False,
'tools.nocache.on': False,
diff --git a/ui/pages/Makefile.am b/ui/pages/Makefile.am
index 5b8370d..dde6026 100644
--- a/ui/pages/Makefile.am
+++ b/ui/pages/Makefile.am
@@ -17,7 +17,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-SUBDIRS = tabs
+SUBDIRS = help tabs
htmldir = $(datadir)/wok/ui/pages
diff --git a/ui/pages/help/Makefile.am b/ui/pages/help/Makefile.am
new file mode 100644
index 0000000..121f9a8
--- /dev/null
+++ b/ui/pages/help/Makefile.am
@@ -0,0 +1,37 @@
+#
+# Project Wok
+#
+# Copyright IBM Corp, 2016
+#
+# This library 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 2.1 of the License, or (at your option) any later version.
+#
+# This library 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 library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+SUBDIRS = en_US
+
+DITA_HTML_FILES = $(patsubst %.dita,%.html,$(wildcard */*.dita))
+HTML_FILES = $(if $(DITA_HTML_FILES), $(DITA_HTML_FILES), $(wildcard */*.html))
+DITA_XSL_FILE = dita-help.xsl
+
+EXTRA_DIST = $(DITA_XSL_FILE)
+
+helpdir = $(datadir)/wok/ui/pages/help
+
+dist_help_DATA = wok.css
+
+all: $(HTML_FILES) $(wildcard */*.dita)
+
+%.html: %.dita $(DITA_XSL_FILE)
+ xsltproc -o $@ $(DITA_XSL_FILE) $<
+
+CLEANFILES = $(HTML_FILES)
diff --git a/ui/pages/help/en_US/Makefile.am b/ui/pages/help/en_US/Makefile.am
new file mode 100644
index 0000000..f2ab607
--- /dev/null
+++ b/ui/pages/help/en_US/Makefile.am
@@ -0,0 +1,26 @@
+#
+# Project Wok
+#
+# Copyright IBM Corp, 2016
+#
+# This library 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 2.1 of the License, or (at your option) any later version.
+#
+# This library 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 library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+en_US_helpdir = $(datadir)/wok/ui/pages/help/en_US
+
+dist_en_US_help_DATA = $(wildcard *.html) $(NULL)
+
+EXTRA_DIST = $(wildcard *.dita)
+
+CLEANFILES = $(wildcard *.html)
--
2.1.0
4:58 a.m.
New subject: [PATCH v2] [Wok 2/2] Issue #114: Help page for "Settings" tab
From: Suresh Babu Angadi <sureshab(a)in.ibm.com>
added dita-hepl.xsl, css file for help pages and
help page for "Settings" tab
Signed-off-by: Suresh Babu Angadi <sureshab(a)in.ibm.com>
---
ui/pages/help/dita-help.xsl | 45 ++++++++
ui/pages/help/en_US/settings.dita | 42 ++++++++
ui/pages/help/wok.css | 209 ++++++++++++++++++++++++++++++++++++++
3 files changed, 296 insertions(+)
create mode 100644 ui/pages/help/dita-help.xsl
create mode 100644 ui/pages/help/en_US/settings.dita
create mode 100644 ui/pages/help/wok.css
diff --git a/ui/pages/help/dita-help.xsl b/ui/pages/help/dita-help.xsl
new file mode 100644
index 0000000..65352f1
--- /dev/null
+++ b/ui/pages/help/dita-help.xsl
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Project Wok
+Copyright IBM Corp, 2016
+
+Code derived from Project Kimchi
+This library 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 2.1 of the License, or (at your option) any later version.
+
+This library 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 library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+-->
+<xsl:stylesheet version="1.0"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:output method="xml" indent="yes"
encoding="UTF-8" />
+
+ <xsl:template match="/">
+ <html>
+ <head>
+ <title><xsl:value-of select="/cshelp/title"
/></title>
+ <meta charset="UTF-8" />
+ <link rel="shortcut icon"
href="../../images/logo.ico" />
+ <link rel="stylesheet" type="text/css"
href="../wok.css" />
+ </head>
+ <body>
+ <xsl:apply-templates select="//cshelp" />
+ </body>
+ </html>
+ </xsl:template>
+
+ <xsl:template match="cshelp">
+ <h1><xsl:value-of select="title" /></h1>
+ <p class="shortdesc"><xsl:value-of
select="shortdesc" /></p>
+ <p class="csbody"><xsl:copy-of
select="csbody/node()" /></p>
+ </xsl:template>
+</xsl:stylesheet>
diff --git a/ui/pages/help/en_US/settings.dita b/ui/pages/help/en_US/settings.dita
new file mode 100644
index 0000000..bebac17
--- /dev/null
+++ b/ui/pages/help/en_US/settings.dita
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Project Wok
+Copyright IBM Corp, 2016
+
+This library 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 2.1 of the License, or (at your option) any later version.
+
+This library 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 library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+-->
+<!--Arbortext, Inc., 1988-2011, v.4002-->
+<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN"
+ "..\dtd\cshelp.dtd">
+<?Pub Sty _display FontColor="red"?>
+<?Pub Inc?>
+<!--This DITA specialized document type is not supported by the Authoring Tools
development team.
+Press the F1 key for online help on the tags and see the DITA XML Guide and Reference for
how to use this document type.
+For support please see:
+https://w3.opensource.ibm.com/projects/dita-cshelp/-->
+<cshelp id="settings" xml:lang="en-us">
+<title>Settings</title>
+<csbody>
+<dl><dlentry>
+<dt>User Activity Log</dt>
+<dd>This section displays user activity log of Wok and its plugins.</dd>
+<dd>To get any specific log result, please use the 'Advanced Search'
option. You can specify a particular application (such as wok, ginger, gingerbase,
gingers390x, kimchi), an user, request type or even date range.</dd>
+<dd>Select "Reset to Default" option to clear the search
criteria.</dd>
+<dd>Download: Use this option to download user activity log.</dd>
+</dlentry>
+</dl><?Pub Caret 2101?>
+</csbody>
+</cshelp>
+<?Pub *0000003732?>
diff --git a/ui/pages/help/wok.css b/ui/pages/help/wok.css
new file mode 100644
index 0000000..9fb8d01
--- /dev/null
+++ b/ui/pages/help/wok.css
@@ -0,0 +1,209 @@
+/*
+ * Project Wok
+ *
+ * Copyright IBM Corp, 2016
+ *
+ * Code derived from Project Kimchi
+ * 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.
+ */
+BODY {
+ background: #FFFFFF;
+ margin-bottom: 1em;
+ margin-left: .5em;
+}
+
+bold {
+ font-weight: bold;
+}
+
+boldItalic {
+ font-weight: bold;
+ font-style: italic;
+}
+
+italic {
+ font-style: italic;
+}
+
+underlined {
+ text-decoration: underline;
+}
+
+uicontrol {
+ font-weight: bold;
+}
+
+filepath {
+ font-family: monospace, monospace;
+}.option {
+ font-family: monospace, monospace;
+}
+
+cmdname {
+ font-weight: bold;
+ font-family: monospace, monospace;
+}
+
+.defparmname {
+ font-weight: bold;
+ text-decoration: underline;
+ font-family: monospace, monospace;
+}
+
+.kwd {
+ font-weight: bold;
+}
+
+.defkwd {
+ font-weight: bold;
+ text-decoration: underline;
+}
+
+var {
+ font-style : italic;
+}
+
+strongwintitle {
+ font-weight : bold;
+}
+
+parmname {
+ font-weight: bold;
+ font-family: monospace, monospace;
+ white-space: nowrap;
+}
+
+code {
+ font-family: monospace, monospace;
+}
+
+pre {
+ font-family: monospace, monospace;
+}
+
+CITE {
+ font-style: italic;
+}
+
+EM {
+ font-style: italic;
+}
+
+STRONG {
+ font-weight: bold;
+}
+
+VAR {
+ font-style: italic;
+}
+
+dt {
+ font-weight: bold;
+}
+
+/***********************************************************
+ * Basic fonts
+ ***********************************************************/
+body,
+td,
+th,
+caption {
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ font-size: 10pt;
+}
+
+pre, code {
+ font-family: MS Courier New, Courier, monospace;
+}
+
+h1, h2, h3 {
+ font-size: 12pt;
+ font-weight: bold;
+ color: #336699;
+}
+
+h4 {
+ font-size: 10pt;
+ font-weight: bold;
+ color: #336699;
+}
+
+/***********************************************************
+ * Basic indents, padding, and margin
+ ***********************************************************/
+body {
+ color: black;
+ background-color: white;
+ margin: 0;
+ padding-top: 0.2em;
+ padding-left: 0.6em;
+ padding-right: 0.2em;
+ padding-bottom: 1em;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+ padding: 0;
+ margin-top: 1em;
+ margin-bottom: 0.75em;
+ margin-left: 0;
+ margin-right: 0;
+}
+
+address,
+dl,
+li,
+p {
+ padding: 0;
+ margin-top: 0.75em;
+ margin-bottom: 0.75em;
+ margin-left: 0;
+ margin-right: 0;
+ line-height: 125%;
+}
+
+td dl {
+ margin-left: 2em;
+}
+
+pre {
+ padding: 0;
+ margin-top: 0.75em;
+ margin-bottom: 0.75em;
+ margin-left: 2em;
+ margin-right: 0;
+}
+
+ol,
+ul {
+ padding: 0;
+ margin-top: 0.75em;
+ margin-bottom: 0.75em;
+ margin-left: 2.00em;
+ margin-right: 0;
+}
+
+dd {
+ margin-left: 3.00em;
+ margin-top: 0.75em;
+ margin-bottom: 0.75em;
+}
+
+dt {
+ margin-left: 1.00em;
+ margin-top: 0.75em;
+}
--
2.1.0
3143
days inactive
3143
days old
3 comments
2 participants
participants (2)
-
Aline Manera -
sureshab＠linux.vnet.ibm.com