Git commit 8aed7c99a53b8755a08186bb2495e5689843dc97 by Carl Schwan. Committed on 11/09/2022 at 11:25. Pushed by carlschwan into branch 'master'.
Fix doc xml file Signed-off-by: Carl Schwan <[email protected]> M +17 -13 doc/index.docbook https://invent.kde.org/accessibility/kontrast/commit/8aed7c99a53b8755a08186bb2495e5689843dc97 diff --git a/doc/index.docbook b/doc/index.docbook index 3e2e21c..2f1a690 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -96,38 +96,42 @@ There are five main ways in which colors can be selected for comparison. These a <sect2 id="hex-values"> <title>Input Hex Values</title> -</sect2> <para>If you know the hex values of the colors that you would like to check, then you can input them directly. To do so, click on the hex value of the sample color currently on the screen and type in the desired value.</para> +</sect2> <sect2 id="color-picker"> <title>Color Picker</title> -</sect2> <para>If there is a color that you currently have on the screen - for example, from a sample image - then you can use the color picker tool to input this color directly into the application. To do so, click the color picker icon to the right of the hex value of the currently selected color, and click the color anywhere on the screen that you would like to sample. The color will then be selected in the application.</para> +</sect2> <sect2 id="hue"> <title>Hue, Saturation and Lightness</title> -</sect2> <para>If you would like to tweak your current selection to see if certain changes have an effect on the contrast, then you can do so by using the hue, saturation and lightness sliders. These are located underneath the hex value of the current selection. The color selection will automatically update as you make changes to these sliders.</para> +</sect2> <sect2 id="invert"> <title>Invert</title> -</sect2> <para>The <guimenuitem>Invert</guimenuitem> button will swap the two currently selected colors, setting the background color as the text color and vice versa.</para> +</sect2> <sect2 id="randomize"> <title>Randomize</title> -</sect2> <para>The <guimenuitem>Randomize</guimenuitem> button will assign random colors to both the background and the text colors.</para> +</sect2> </sect1> <sect1 id="result"> <title>Contrast Result</title> +<para> The contrast ratio resulting from your selection will be shown on the top of the screen, together with a short note explaining how well this contrast is suited to text of varying sizes. This text will be updated automatically as changes are made to the color values. +</para> </sect1> <sect1 id="favorite"> <title>Favorites</title> +<para> &kmyapplication; allows the user to save favourite color combinations for future reference. To do so, press the <guimenuitem>Mark as favourite</guimenuitem> located at the bottom of the screen. These color combinations can be accessed again through the <guimenuitem>Favorite Colors</guimenuitem> menu item, as more particularly described in the next chapter. +</para> </sect1> </chapter> @@ -138,33 +142,33 @@ The contrast ratio resulting from your selection will be shown on the top of the This chapter describes all application features accessible after clicking the <guimenu>Menu</guimenu> icon in the top left corner. </para> -<sect2 id="contrast-checker"> +<sect1 id="contrast-checker"> <title>Contrast Checker</title> <para> This is the default screen of the application, allowing the user to select colors and view their contrast ratio. The functionality is described in the previous chapter. </para> -</sect2> +</sect1> -<sect2 id="fave-colors"> +<sect1 id="fave-colors"> <title>Favorite Colors</title> <para> This screen will contain all color combinations saved as "favorite" in the <guimenuitem>Contrast Checker</guimenuitem> screen. Color combinations may be deleted by pressing the <guimenuitem>Remove</guimenuitem> button. </para> -</sect2> +</sect1> -<sect2 id="help"> +<sect1 id="help"> <title>Help</title> <para> This screen contains a brief summary of the theory behind this application, with an explanation of how contrast works and how best to interpret the contrast ratio in line with the WCAG standard. </para> -</sect2> +</sect1> -<sect2 id="about"> +<sect1 id="about"> <title>About</title> <para> This screen contains some general information relating to the application, such as the authors and the libraries used. There is also a button that allows users to submit any bug that they may encounter to the developers. </para> -</sect2> +</sect1> </chapter>
