[
https://issues.apache.org/jira/browse/FLINK-9792?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16546368#comment-16546368
]
ASF GitHub Bot commented on FLINK-9792:
---------------------------------------
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/6312#discussion_r202969620
--- Diff:
flink-core/src/main/java/org/apache/flink/configuration/description/HtmlFormatter.java
---
@@ -0,0 +1,67 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.configuration.description;
+
+/**
+ * Formatter that transforms {@link Description} into Html representation.
+ */
+public class HtmlFormatter extends Formatter {
+
+ @Override
+ protected void formatLink(StringBuilder state, String link, String
description) {
+ state.append(String.format("<a href=\"%s\">%s</a>", link,
description));
+ }
+
+ @Override
+ protected void formatLineBreak(StringBuilder state) {
+ state.append("<br/>");
+ }
+
+ @Override
+ protected void formatText(StringBuilder state, String format, String[]
elements) {
+ String escapedFormat = escapeCharacters(format);
+ state.append(String.format(escapedFormat, elements));
+ }
+
+ @Override
+ protected void formatList(StringBuilder state, String[] entries) {
+ state.append("<ul>");
+ for (String entry : entries) {
+ state.append(String.format("<li>%s</li>", entry));
+ }
+ state.append("</ul>");
+ }
+
+ @Override
+ protected Formatter newInstance() {
+ return new HtmlFormatter();
+ }
+
+ private static final String TEMPORARY_PLACEHOLDER =
"superRandomTemporaryPlaceholder";
--- End diff --
this should be distinct from the placeholder in `Utils`.
> Cannot add html tags in options description
> -------------------------------------------
>
> Key: FLINK-9792
> URL: https://issues.apache.org/jira/browse/FLINK-9792
> Project: Flink
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 1.5.0, 1.6.0
> Reporter: Dawid Wysakowicz
> Assignee: Dawid Wysakowicz
> Priority: Major
> Labels: pull-request-available
>
> Right now it is impossible to add any html tags in options description,
> because all "<" and ">" are escaped. Therefore some links there do not work.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
