Bug 121161 - A help dialog with label syntax is needed
Summary: A help dialog with label syntax is needed
Status: RESOLVED FIXED
Alias: None
Product: kst
Classification: Applications
Component: general (show other bugs)
Version: 1.x
Platform: unspecified Solaris
: NOR wishlist
Target Milestone: ---
Assignee: kst
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-02-01 16:50 UTC by Nicolas Brisset
Modified: 2006-06-18 18:00 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Nicolas Brisset 2006-02-01 16:50:18 UTC
Version:           1.2.0_devel (using KDE 3.4.0, compiled sources)
Compiler:          gcc version 3.4.3
OS:                SunOS (sun4u) release 5.8

Labels can contain Latex-like formatting commands, but:
1) not all commands are supported, and it is hard to predict what can be used
2) (more important IMHO) not everybody is a Latex guru who knows Latex syntax

I think a tooltip or some sort of help dialog ("What's this ?") describing available formatting commands would be nice to have. 
Probably not for 1.2.0 because it will introduce new strings for i18n...
Comment 1 Andrew Walker 2006-02-22 19:16:26 UTC
I think once we start down the path of providing such help in Kst it will be difficult to stop. The place to look for this information is in the documentation, which is already easily accessible from within Kst.
Comment 2 George Staikos 2006-02-23 15:08:53 UTC
On Wednesday 22 February 2006 13:16, Andrew Walker wrote:
> ------- I think once we start down the path of providing such help in Kst
> it will be difficult to stop. The place to look for this information is in
> the documentation, which is already easily accessible from within Kst.


  I was planning to put a syntax highlighter in here.  It will help catch 
mistakes, partially solve this problem, and is nearly free with KDE.
Comment 3 Netterfield 2006-06-17 01:37:27 UTC
I think that this could fruitfully be put into the "what's this".
Comment 4 George Staikos 2006-06-18 18:00:47 UTC
SVN commit 552632 by staikos:

Add whatsthis text to the label editor.  It's a good first step, though the
syntax highlighter will probably be more useful in the long term.
FEATURE: 121161


 M  +3 -0      viewlabelwidget.ui.h  


--- trunk/extragear/graphics/kst/src/libkstapp/viewlabelwidget.ui.h #552631:552632
@@ -22,6 +22,7 @@
     _vertical->insertItem(i18n("Bottom"));
     _vertical->insertItem(i18n("Center"));
 
+    QWhatsThis::add(_text, i18n("<qt>The syntax for labels is a derivative of a subset of LaTeX.  Supported syntax is: <b>\\[greeklettername]</b> and <b>\\[Greeklettername]</b>, <b>\\approx</b>, <b>\\cdot</b>, <b>\\ge</b>, <b>\\geq</b>, <b>\\inf</b>, <b>\\int</b>, <b>\\le</b>, <b>\\leq</b>, <b>\\ne</b>, <b>\\n</b>, <b>\\partial</b>, <b>\\prod</b>, <b>\\pm</b>, <b>\\textcolor{color name}{colored text}</b>, <b>\\textbf{bold text}</b>, <b>\\textit{italicized text}</b>, <b>\\t</b>, <b>\\sum</b>, <b>\\sqrt</b>, <b>\\underline{underlined text}</b>, <b>x^y</b>, <b>x_y</b>.  Data references and embedded expressions should be enclosed in square brackets.  Example: <i>[=[MyScalar]/2]</i>"));
 }
 
 
@@ -29,3 +30,5 @@
 {
     _text->insert("["+S+"]");
 }
+
+// vim: ts=8 sw=4 noet