package org.plantuml.idea.toolwindow;
import javax.swing.*;
public class Usage extends JTextArea {
public static final String TEXT =
"- Open file, put the cursor inside of PlantUML code to render it\n"
+ "- PlantUML code must be inside @startuml and @enduml tags to be rendered\n"
+ "- A new file can be created from template (File | New | select e.g. 'UML Sequence' template)\n"
+ "- PlantUML code can be placed anywhere, '*' are ignored for usage in Java comments\n"
+ "- To render other than sequence diagram types, install Graphviz and set path to it\n"
+ "- About screen tests Graphviz installation\n"
+ "- Image cache size can be tuned in the settings, if you have not enough heap\n"
+ "- You can use intention to reverse arrows (Alt+Enter)\n"
+ "- Cursor on top of @startuml allows to use following intentions:\n"
+ " - disable syntax check\n"
+ " - enable partial rendering - renders each page on it's own, useful for big sequence diagram files\n"
+ "- Performance tips:\n"
+ " - disable automatic rendering and use Update (Alt+D) or Reload (Alt+F) buttons\n"
+ " - do not put @newpage into included files (it prohibits incremental rendering)\n"
+ " - try to enable partial rendering\n"
+ " - disable syntax checking\n"
+ "";
public Usage() {
this("");
}
public Usage(String prefix) {
setOpaque(false);
setText(prefix + TEXT);
setEditable(false);
}
}