chore(windows): cleanup documentation

* Add QR Code help
* Remove unused images and ancient conent
This commit is contained in:
Marc Durdin 2020-02-19 10:11:28 +11:00
parent 8b36e3ccda
commit 148400f756
46 changed files with 70 additions and 71 deletions

View file

@ -17,9 +17,9 @@ XSLSTYLE_PHP=php.xsl
# Main targets
#-------------------------------------------------------
build:
build:
@rem
build-release: chm html php
copy /Y keymandesktop.chm $(ROOT)\bin\desktop
@ -70,7 +70,6 @@ html_cleanbin:
html_images: dirs
-rd /s/q $(ROOT)\bin\help\desktop\desktop_images
xcopy /s/q $(ROOT)\src\desktop\help\desktop_images $(ROOT)\bin\help\desktop\desktop_images\ #
copy $(ROOT)\src\desktop\help\topicresponse.js $(ROOT)\bin\help\desktop
copy $(ROOT)\src\desktop\help\kmhelp.css $(ROOT)\bin\help\desktop
#-------------------------------------------------------
@ -87,7 +86,6 @@ php_cleanbin:
php_images: dirs
-rd /s/q $(ROOT)\bin\help\php\desktop\desktop_images
xcopy /s/q $(ROOT)\src\desktop\help\desktop_images $(ROOT)\bin\help\php\desktop\desktop_images\ #
copy $(ROOT)\src\desktop\help\topicresponse.js $(ROOT)\bin\help\php\desktop
copy $(ROOT)\src\desktop\help\kmhelp.css $(ROOT)\bin\help\php\desktop
#-------------------------------------------------------

View file

@ -9,7 +9,7 @@
</imageobject>
</inlinemediaobject>
</para>
<bridgehead>Opening the Keyboard Layouts Tab</bridgehead>
<para>To open the Keyboard Layouts tab of Keyman Configuration:</para>
<orderedlist>
@ -21,10 +21,10 @@
</listitem>
<listitem>
<para>Select the Keyboard Layouts tab.</para>
<tip>Keyman Configuration opens in the same tab you last closed it in.</tip>
</listitem>
<tip>Keyman Configuration opens in the same tab you last closed it in.</tip>
</listitem>
</orderedlist>
<bridgehead>Installing a Keyboard</bridgehead>
<para>There are two ways to install a Keyman keyboard from the Keyboard Layouts tab of Keyman Configuration:</para>
<itemizedlist>
@ -35,10 +35,10 @@
<para>To install a keyboard layout online, see: <link linkend='install_tav'>Downloading &amp; Installing a Keyman Keyboard within Keyman Desktop</link></para>
</listitem>
</itemizedlist>
<bridgehead>Uninstalling a Keyboard</bridgehead>
<para>To uninstall a Keyman keyboard from the Keyboard Layouts tab of Keyman Configuration, see: <xref linkend='basic_uninstall_keyboard'></xref></para>
<bridgehead>Enabling and Disabling a Keyboard</bridgehead>
<para>To enable or disable a Keyman keyboard from the Keyboard Layouts tab of Keyman Configuration, see: <xref linkend='basic_disable_keyboard'></xref></para>
@ -54,14 +54,14 @@
<imagedata fileref="desktop_images/hotkeys-change.png"></imagedata>
</imageobject>
</inlinemediaobject>
</para>
</para>
</listitem>
<listitem>
<para>Select a default hotkey or click <guibutton>Custom</guibutton> and type the hotkey you wish to use.</para>
<note><para>If you press a single letter or <keycap>Shift</keycap> plus a single letter, the hotkey will default to <keycap>Ctrl</keycap> + <keycap>Alt</keycap> plus the letter you pressed, in order to avoid conflicts with standard keyboard input.</para></note>
<note><para>To clear a hotkey that has been set previously, click <guibutton>Clear Hotkey</guibutton> or press <keycap>Backspace</keycap>.</para></note>
<note><para>Be aware that you can set the hotkey to replace common Windows hotkeys (<keycap>Ctrl</keycap> + <keycap>C</keycap>, <keycap>Ctrl</keycap> + <keycap>V</keycap>, etc).</para></note>
<note><para>Be aware that you can set the hotkey to replace common Windows hotkeys (<keycap>Ctrl</keycap> + <keycap>C</keycap>, <keycap>Ctrl</keycap> + <keycap>V</keycap>, etc).</para></note>
</listitem>
<listitem>
<para>Click <guibutton>OK</guibutton> to save your selection.</para>
@ -78,8 +78,8 @@
<listitem><para>Find a keyboard in the keyboard list.</para></listitem>
<listitem><para>Click on the question mark icon (<inlinemediaobject><imageobject><imagedata fileref="desktop_images/icon-introductory-help.png" /></imageobject></inlinemediaobject>) beside the keyboard name. The keyboard help documentation will be shown.</para>
</listitem>
</orderedlist>
</orderedlist>
<bridgehead>Viewing Keyboard Details</bridgehead>
<para>To view details for a Keyman keyboard from the Keyboard Layouts tab of Keyman Configuration:</para>
<orderedlist>
@ -104,10 +104,25 @@
<listitem><para>Documentation status.</para></listitem>
<listitem><para>Copyright details.</para></listitem>
<listitem><para>Installation details.</para></listitem>
</itemizedlist>
</itemizedlist>
</listitem>
</orderedlist>
<bridgehead>Sharing a keyboard with other users and devices</bridgehead>
<para>If you installed a keyboard layout using the <guibutton>Download keyboard</guibutton> button, then you can share the keyboard with other devices and users using a QR Code.</para>
<orderedlist>
<listitem><para>Expand the keyboard details for the keyboard you wish to share, and click <guibutton>Share keyboard</guibutton>.</para></listitem>
<listitem><para>A popup will appear with a QR Code. This QR Code can be scanned with a mobile phone camera to automatically open a web page with a download link to install the keyboard.</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="desktop_images/keyboard-share.png"></imagedata>
</imageobject>
</inlinemediaobject>
</para>
</listitem>
</orderedlist>
<bridgehead>Associating a keyboard with a Windows language</bridgehead>
<para>All Keyman keyboards are associated with a Windows language by default. To change the association, or add a new association, see the following:</para>
<itemizedlist>
@ -115,7 +130,7 @@
<para><xref linkend="start_configure_computer"></xref></para>
</listitem>
</itemizedlist>
<bridgehead>Related Topics</bridgehead>
<itemizedlist>
<listitem>

View file

@ -1,5 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="context_activate">
<title>Activate Keyman Desktop</title>
<redirect url="basic_activate" />
</section>

View file

@ -1,5 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="context_langsetup">
<title>Language Configuration Tasks</title>
<redirect url="advanced_language_config" />
</section>

View file

@ -1,5 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="context_splash">
<title>The Keyman Desktop Splash Screen</title>
<redirect url="basic_activate" />
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="desktop_images/setup-click3.png"></imagedata>
</imageobject>
</inlinemediaobject>
</para>
<para>The Splash screen shows information about which keyboards are installed, plus the version of Keyman.</para>
<para>You can stop the splash screen from showing by deselecting the option 'Show this screen at startup'.</para>
<para>Note: when Keyman Desktop starts with Windows, the splash screen is not shown.</para>
</section>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 311 KiB

After

Width:  |  Height:  |  Size: 311 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 313 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 401 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 697 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

View file

@ -6,16 +6,16 @@
<book xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Keyman Desktop User Guide</title>
<!-- About -->
<!-- About -->
<chapter id="about">
<title>About Keyman Desktop</title>
<xi:include href="about/welcome.xml" />
<xi:include href="about/whatsnew.xml" />
<xi:include href="about/requirements.xml" />
<xi:include href="about/history.xml" />
<xi:include href="about/credits.xml" />
<xi:include href="about/license.xml" />
<xi:include href="about/credits.xml" />
<xi:include href="about/license.xml" />
</chapter>
<!-- Getting Started -->
@ -41,7 +41,7 @@
<chapter id="basic">
<title>Basic Help</title>
<xi:include href="basic/newways.xml" />
<xi:include href="basic/engine_tasks/update.xml" />
@ -59,7 +59,7 @@
<xi:include href="basic/toolbox_tasks/charactermap.xml" />
<xi:include href="basic/languageswitcher.xml" />
<xi:include href="basic/text_editor.xml" />
<xi:include href="basic/config_tasks/config_menu.xml" />
@ -82,7 +82,7 @@
<xi:include href="advanced/text_services_framework.xml" />
</chapter>
<!-- FAQ -->
<chapter id="common">
<title>Common Questions</title>
@ -90,7 +90,7 @@
<xi:include href="common/editions.xml" />
<xi:include href="common/os.xml" />
<xi:include href="common/requirements.xml" />
<xi:include href="common/adware.xml" />
<xi:include href="common/adware.xml" />
<xi:include href="common/mac.xml" />
<xi:include href="common/linux.xml" />
<xi:include href="common/osk.xml" />
@ -98,28 +98,28 @@
<xi:include href="common/compatibility.xml" />
<xi:include href="common/old_version.xml" />
<xi:include href="common/support.xml" />
<xi:include href="common/bug.xml" />
<xi:include href="common/bug.xml" />
</chapter>
<!-- KnowledgeBase -->
<chapter id="troubleshooting">
<title>Troubleshooting Index</title>
<xi:include href="troubleshooting/font.xml" />
<xi:include href="troubleshooting/sigma.xml" />
<xi:include href="troubleshooting/font.xml" />
<xi:include href="troubleshooting/sigma.xml" />
<xi:include href="troubleshooting/excel.xml" />
<xi:include href="troubleshooting/securitysoftware.xml" />
<xi:include href="troubleshooting/bootstrapper.xml" />
<xi:include href="troubleshooting/hidden.xml" />
</chapter>
<!-- Contextual help from windows, menus, etc -->
<chapter id="context">
<title>Context Help</title>
@ -128,18 +128,16 @@
<xi:include href="context/tutorial.xml" />
<xi:include href="context/splash.xml" />
<xi:include href="context/proxyconfiguration.xml" />
<xi:include href="context/proxyconfiguration.xml" />
<xi:include href="context/onlineupdate.xml" />
<xi:include href="context/selectlanguage.xml" />
<xi:include href="context/selectlanguage.xml" />
<xi:include href="context/installkeyboard.xml" />
<xi:include href="context/downloadkeyboard.xml" />
<xi:include href="context/langsetup.xml" />
<xi:include href="context/traymenu.xml" />
<xi:include href="context/keyman.xml" />
<xi:include href="context/configuration_keyboards.xml" />
<xi:include href="context/configuration_options.xml" />
@ -152,7 +150,7 @@
<xi:include href="context/fonthelper.xml" />
<xi:include href="context/charactermap.xml" />
<xi:include href="context/langsetup/psrtwindowslanguage.xml" />
<xi:include href="context/langsetup/psrtwindowslanguage.xml" />
<xi:include href="context/langsetup/psrtmsofficelanguage.xml" />
</chapter>

View file

@ -1,2 +0,0 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<note>This feature is only available in Keyman Desktop Professional.</note>

View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<section id="start_hotkey_set" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>How To - Set Hotkeys for Keyman Desktop, Keyman Keyboards and Windows Languages</title>
<xi:include href="../pro_feature.xml" />
<para>A hotkey is a keyboard shortcut. In <application>Keyman Desktop</application> these are used to turn on and off Keyman Desktop functions, Keyman keyboards and Windows languages.</para>
<para>To set the hotkey for a <application>Keyman Desktop</application> function, Keyman keyboard or Windows language:</para>
<orderedlist>
@ -26,14 +26,14 @@
<imagedata fileref="desktop_images/hotkeys-change.png"></imagedata>
</imageobject>
</inlinemediaobject>
</para>
</para>
</listitem>
<listitem>
<para>Select a default hotkey or click <guibutton>Custom</guibutton> and type the hotkey you wish to use.</para>
<note><para>If you press a single letter or <keycap>Shift</keycap> plus a single letter, the hotkey will default to <keycap>Ctrl</keycap> + <keycap>Alt</keycap> plus the letter you pressed, in order to avoid conflicts with standard keyboard input.</para></note>
<note><para>To clear a hotkey that has been set previously, click <guibutton>Clear Hotkey</guibutton> or press <keycap>Backspace</keycap>.</para></note>
<note><para>Be aware that you can set the hotkey to replace common Windows hotkeys (<keycap>Ctrl</keycap> + <keycap>C</keycap>, <keycap>Ctrl</keycap> + <keycap>V</keycap>, etc).</para></note>
<note><para>Be aware that you can set the hotkey to replace common Windows hotkeys (<keycap>Ctrl</keycap> + <keycap>C</keycap>, <keycap>Ctrl</keycap> + <keycap>V</keycap>, etc).</para></note>
</listitem>
<listitem>
<para>Click <guibutton>OK</guibutton> to save your selection.</para>
@ -43,7 +43,7 @@
</listitem>
</orderedlist>
<para>The new hotkey will now be available.</para>
<bridgehead>Related Topics</bridgehead>
<itemizedlist>
<listitem>

View file

@ -1,5 +0,0 @@
// Topic Responses
document.write("<div id='topicresponse'>"+
" Copyright &#169; 2014 Tavultesoft Pty Ltd. All Rights Reserved."+
" </div>");

View file

@ -1,8 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<html>
<head>
</head>
<body>
<script src='topicresponse.js' type='text/javascript'></script>
</body>
</html>