org.testingisdocumenting.znai.extensions.keyboard.KeyboardShortcutInlinedCodePlugin Maven / Gradle / Ivy
/*
* Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
*
* Licensed 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.testingisdocumenting.znai.extensions.keyboard;
import org.testingisdocumenting.znai.core.ComponentsRegistry;
import org.testingisdocumenting.znai.extensions.PluginParams;
import org.testingisdocumenting.znai.extensions.PluginResult;
import org.testingisdocumenting.znai.extensions.inlinedcode.InlinedCodePlugin;
import org.testingisdocumenting.znai.parser.docelement.DocElement;
import org.testingisdocumenting.znai.search.SearchScore;
import org.testingisdocumenting.znai.search.SearchText;
import java.nio.file.Path;
public class KeyboardShortcutInlinedCodePlugin implements InlinedCodePlugin {
private String shortcut;
@Override
public String id() {
return "kbd";
}
@Override
public InlinedCodePlugin create() {
return new KeyboardShortcutInlinedCodePlugin();
}
@Override
public PluginResult process(ComponentsRegistry componentsRegistry, Path markupPath, PluginParams pluginParams) {
shortcut = pluginParams.getFreeParam();
return PluginResult.docElement(new DocElement("KeyboardShortcut", "shortcut", shortcut));
}
@Override
public SearchText textForSearch() {
return SearchScore.STANDARD.text(shortcut);
}
}