User interface element names like buttons, checkboxes, etc. Inside tables, use | instead of | to prevent escaping problems. Menu paths are wrapped using with pipe characters separating each level: Settings/Preferences | Editor: Settings/Preferences | Editor Menu paths to settings always start with "Settings/Preferences" to cover all platforms. Very long links should also be on a separate line.Ĭonsistent text styles are used to standardize references and keywords: For very long sentences, add additional line breaks after, : or other sensible places. However, only use product names when extensibility or functionality is particular to a product. When referring to JetBrains products always use the full name such as IntelliJ IDEA Ultimate Edition. Once that term is used on a page, authors may use IDEs. IDEs based on the IntelliJ Platform are described as IntelliJ Platform-based IDEs. Use the full phrase in the SDK documentation. The open-source code in the GitHub repository intellij-community is known as the IntelliJ Platform. Content Style TerminologyĬonsistent terminology helps the reader grasp new concepts more quickly: Redirects can be specified in the Table of Contents. : # (title: Contributing to the IntelliJ Platform SDK)
0 kommentar(er)
