Added support for additional geshi options using an extendable options array (PR-2). #1985

lpaulsen93 · 2017-05-23T18:42:59Z

Also see the feature request in issue #1625.

I extended the syntax for the code and file tags in the following way:

additional options for geshi can be specified in square brackets
options have to be separated by commas
values should be enclosed in "

The actually implemented additional options are named after their corresponding Geshi functions:

enable_line_numbers
start_line_numbers_at
highlight_lines_extra
enable_keyword_links

Here are some syntax examples:

Example 1, normal code tag, unchanged behaviour:

<code C Hello.c>
void main () {
    printf ("Hello World 123!");
    exit 0;
}
</code>

Example 2, enable line numbers:

<code C Hello.c [enable_line_numbers]>
void main () {
    printf ("Hello World 123!");
    exit 0;
}
</code>

Example 3, highlight a specific line:

<code C Hello.c [highlight_lines_extra="2"]>
void main () {
    printf ("Hello World 123!");
    exit 0;
}
</code>

Example 4, start at specific line number (requires two options):

<code C Hello.c [enable_line_numbers, start_line_numbers_at="42"]>
void main () {
    printf ("Hello World 123!");
    exit 0;
}
</code>

Example 5, highlight specific lines:

<code C Hello.c [highlight_lines_extra="2,3"]>
void main () {
    printf ("Hello World 123!");
    exit 0;
}
</code>

Implementation details:
In function code in file handler.php options get cut off the match and are parsed in function parse_highlight_options. The function searches for key=value pairs separated by commas. Each found pair is added to the options array like $options[$key] = $value;.

The options array is passed through as a additional parameter in functions code, file and _highlight in file xhtml.php. And finally its passed to p_xhtml_cached_geshi which calls the corresponding functions.

…s array.

mention-bot · 2017-05-23T18:43:03Z

@LarsGit223, thanks for your PR! By analyzing the history of the files in this pull request, we identified @splitbrain, @andyboeh and @Chris--S to be potential reviewers.

lpaulsen93 · 2017-08-27T11:51:10Z

@splitbrain: maybe you also want to merge this. We've already worked on that some time ago (also see the changes/work done in #1625).

lpaulsen93 · 2018-04-06T18:43:29Z

@splitbrain: little reminder ping. It would be cool if this could become part of the next release if it's acceptable/planned to add it. Just want to make sure it's not forgotten maybe.

splitbrain

@micgro42 what do you think?

Klap-in · 2018-04-09T13:32:17Z

inc/parser/handler.php

+    protected function parse_highlight_options ($options) {
+        $result = array();
+        preg_match_all('/(\w+(?:="[^"]*"))|(\w+[^=,\]])(?:,*)/', $options, $matches, PREG_SET_ORDER);
+        foreach ($matches as $match) {


Is this parser needed? At first glance the syntax looks like json. What about using the json parser?

Good point. It never occured to me that this is basically JSON.

What's the consensus here? Do we keep the parser or do we swap to JSON (means a change is requested)?

I think it makes sense to replace this by json_decode() it makes the code less complex and easier to understand.

Klap-in · 2018-04-09T13:35:04Z

For normal applications of code blocks, I guess that most users will experience this syntax as quite complex. Therefore I recommend to describe these options only at a separate wikipage (and not as addition on the syntax wikipage). Such that an unexperienced user is not overwhelmed by details.

micgro42

There is a bug when highlighting lines, it eats the newline:

lpaulsen93 · 2018-04-09T16:21:55Z

@micgro42: true, but it's OK if you use highlight and line numbers together:

As this seems to be a Geshi issue what can we do about it? Which version of Geshi does DokuWiki run?

lpaulsen93 · 2018-04-09T16:38:03Z

It's still there in the latest version and has already been reported some time ago, see https://sourceforge.net/p/geshi/bugs/190/.

splitbrain · 2018-04-09T17:32:06Z

we're using https://github.com/GeSHi/geshi-1.0

splitbrain · 2018-04-11T10:34:25Z

I submitted GeSHi/geshi-1.0#104 to address this.

lpaulsen93 · 2018-04-12T17:27:01Z

Below some examples with the new JSON encoding:

<code JavaScript {"enable_line_numbers":true,"highlight_lines_extra":[2]}>
var de = function() {
	return (typeof(window.de) == 'object') ? window.de : {};
}();
</code>

<code C {"enable_line_numbers":false, "start_line_numbers_at":4}>
void main () {
    printf ("Hello World!");
    exit 0;
}
</code>

<code C {"enable_keyword_links":false,"enable_line_numbers":true, "highlight_lines_extra":[2,4]}>
void main () {
    printf ("Hello World!");
    exit 0;
}
</code>

splitbrain · 2018-04-13T06:28:45Z

You're gonna hate me… but now that I actually see the syntax in JSON I do not really like it 😞 Sorry, I should have actually thought this through.

My fault. I'll clean this up and merge. Thank you @LarsGit223

lpaulsen93 · 2018-04-13T16:43:09Z

@splitbrain: never mind.

lpaulsen93 · 2018-04-14T09:39:02Z

Closed in favor of #2307.

Added support for additional geshi options using an extendable option…

e2d8815

…s array.

lpaulsen93 mentioned this pull request May 23, 2017

Added support for additional geshi options using an extendable options array. #1961

Closed

Klap-in mentioned this pull request May 31, 2017

HTML ordered list not displaying correctly #1995

Closed

splitbrain added this to the 🐱 Greebo milestone Apr 6, 2018

splitbrain approved these changes Apr 9, 2018

View reviewed changes

splitbrain requested a review from micgro42 April 9, 2018 13:13

splitbrain added the ToDo: needDocUpdate label Apr 9, 2018

Klap-in reviewed Apr 9, 2018

View reviewed changes

micgro42 requested changes Apr 9, 2018

View reviewed changes

lpaulsen93 added 2 commits April 12, 2018 18:52

Additional geshi options are now expected in JSON encoding.

cd1203d

Adjusted test code for additional geshi options.

dc6988f

splitbrain mentioned this pull request Apr 13, 2018

Geshi Option parsing #2307

Merged

lpaulsen93 closed this Apr 14, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for additional geshi options using an extendable options array (PR-2). #1985

Added support for additional geshi options using an extendable options array (PR-2). #1985

lpaulsen93 commented May 23, 2017

mention-bot commented May 23, 2017

lpaulsen93 commented Aug 27, 2017

lpaulsen93 commented Apr 6, 2018

splitbrain left a comment

Klap-in Apr 9, 2018

splitbrain Apr 9, 2018

lpaulsen93 Apr 11, 2018

splitbrain Apr 12, 2018

lpaulsen93 Apr 12, 2018

Klap-in commented Apr 9, 2018 •

edited

micgro42 left a comment

lpaulsen93 commented Apr 9, 2018

lpaulsen93 commented Apr 9, 2018

splitbrain commented Apr 9, 2018

splitbrain commented Apr 11, 2018

lpaulsen93 commented Apr 12, 2018

splitbrain commented Apr 13, 2018

lpaulsen93 commented Apr 13, 2018

lpaulsen93 commented Apr 14, 2018

Added support for additional geshi options using an extendable options array (PR-2). #1985

Added support for additional geshi options using an extendable options array (PR-2). #1985

Conversation

lpaulsen93 commented May 23, 2017

mention-bot commented May 23, 2017

lpaulsen93 commented Aug 27, 2017

lpaulsen93 commented Apr 6, 2018

splitbrain left a comment

Choose a reason for hiding this comment

Klap-in Apr 9, 2018

Choose a reason for hiding this comment

splitbrain Apr 9, 2018

Choose a reason for hiding this comment

lpaulsen93 Apr 11, 2018

Choose a reason for hiding this comment

splitbrain Apr 12, 2018

Choose a reason for hiding this comment

lpaulsen93 Apr 12, 2018

Choose a reason for hiding this comment

Klap-in commented Apr 9, 2018 • edited

micgro42 left a comment

Choose a reason for hiding this comment

lpaulsen93 commented Apr 9, 2018

lpaulsen93 commented Apr 9, 2018

splitbrain commented Apr 9, 2018

splitbrain commented Apr 11, 2018

lpaulsen93 commented Apr 12, 2018

splitbrain commented Apr 13, 2018

lpaulsen93 commented Apr 13, 2018

lpaulsen93 commented Apr 14, 2018

Klap-in commented Apr 9, 2018 •

edited