[Experimental] Add code highlighting in help panel
Needs ReviewPublic
Actions

Authored by sirgienko on Nov 10 2018, 3:11 PM.

Details

Reviewers

asemke
filipesaraiva

Summary

Supports Maxima, Octave, Sage.
Python technically support, but python help message don't contains any code, so for user nothing changes
R not support, because all R help open in ScriptEditor (it's should be fixed).

Also contains some changes (including API), needed by this feature. Maybe, this changes should moved into separated commits.

Examples:
Maxima

Octave:

Sage:

Diff Detail

Repository

R55 Cantor

Branch

add-highlighting-for-help

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 4802
Build 4820: arc lint + arc unit

sirgienko created this revision.Nov 10 2018, 3:11 PM

Restricted Application added a project: KDE Edu. · View Herald TranscriptNov 10 2018, 3:11 PM

Restricted Application added a subscriber: kde-edu. · View Herald Transcript

sirgienko requested review of this revision.Nov 10 2018, 3:11 PM

Harbormaster completed remote builds in B4802: Diff 45239.Nov 10 2018, 3:11 PM

Maybe it would make sense to use the SyntaxHighlighting framework?

https://api.kde.org/frameworks/syntax-highlighting/html/index.html

(could be out of scope for this patch)

In D16806#358163, @apol wrote:

Maybe it would make sense to use the SyntaxHighlighting framework?

Actually, we already use KSyntaxHighlighting, but still only Repository class. We plan rewrite our highlighting code on KSyntaxHighlighting, but we support adding new variables and functions in runtime for different sessions and backends, and as I know KSyntaxHighlighting don't have features for adding new variables and functions, so it is not very easy and we are planning start work on this after 18.12

Revision Contents
Changeset List

			Path	Packages
M			src/backends/maxima/maximahighlighter.h (2 lines)
M			src/backends/maxima/maximahighlighter.cpp (113 lines)
M			src/backends/octave/octavehighlighter.h (3 lines)
M			src/backends/octave/octavehighlighter.cpp (48 lines)
M			src/backends/python/pythonhighlighter.cpp (4 lines)
M			src/backends/sage/sageexpression.cpp (10 lines)
M			src/backends/sage/sagehighlighter.h (3 lines)
M			src/backends/sage/sagehighlighter.cpp (30 lines)
M			src/cantor_part.h (3 lines)
M			src/cantor_part.cpp (2 lines)
M			src/lib/defaulthighlighter.h (54 lines)
M			src/lib/defaulthighlighter.cpp (262 lines)
M			src/lib/helpresult.cpp (4 lines)
M			src/lib/textresult.h (4 lines)
M			src/lib/textresult.cpp (12 lines)
M			src/panelplugins/helppanel/helppanelplugin.h (4 lines)
M			src/panelplugins/helppanel/helppanelplugin.cpp (29 lines)
M			src/worksheet.h (2 lines)
M			src/worksheet.cpp (27 lines)

Commit	Tree	Parents	Author	Summary	Date
73422179460e	e250390503c0	b4d5e005f7ca	Nikita Sirgienko	[Experimental] Add code highligting in Help panel. Supports Maxima, Octave… (Show More…)	Nov 10 2018, 2:52 PM

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	45239	b4d5e00		Nov 10 2018, 2:56 PM	★	★

[Experimental] Add code highlighting in help panelNeeds ReviewPublicActions

Details

Diff Detail

Revision ContentsChangeset List

Diff 45239

src/backends/maxima/maximahighlighter.h

src/backends/maxima/maximahighlighter.cpp

src/backends/octave/octavehighlighter.h

src/backends/octave/octavehighlighter.cpp

src/backends/python/pythonhighlighter.cpp

src/backends/sage/sageexpression.cpp

src/backends/sage/sagehighlighter.h

src/backends/sage/sagehighlighter.cpp

src/cantor_part.h

src/cantor_part.cpp

src/lib/defaulthighlighter.h

src/lib/defaulthighlighter.cpp

src/lib/helpresult.cpp

src/lib/textresult.h

src/lib/textresult.cpp

src/panelplugins/helppanel/helppanelplugin.h

src/panelplugins/helppanel/helppanelplugin.cpp

src/worksheet.h

src/worksheet.cpp

[Experimental] Add code highlighting in help panel
Needs ReviewPublic
Actions

Revision Contents
Changeset List