The KatePart Handbook Thad McGinnis Anne-Marie Mahfouf Anders Lund T.C. Hollingsworth Christoph Cullmann Lauri Watts The KatePart Handbook 2 Contents 1 Introduction 8 2 Some Fundamentals9 2.1 Drag and Drop . .9 2.2 Shortcuts . .9 3 Working with the KatePart editor 12 3.1 Overview . 12 3.2 Navigating in the Text . 13 3.3 Working with the Selection . 13 3.3.1 Using Block Selection . 14 3.3.2 Using Overwrite Selection . 14 3.3.3 Using Persistent Selection . 14 3.4 Copying and Pasting Text . 14 3.5 Finding and Replacing Text . 15 3.5.1 The Search and Replace Bars . 15 3.5.2 Finding Text . 16 3.5.3 Replacing Text . 16 3.6 Using Bookmarks . 17 3.7 Automatically Wrapping text . 17 3.8 Using automatic indenting . 18 3.9 Line Modification Indicators . 18 3.10 The Scrollbar Minimap . 19 4 The Menu Entries 20 4.1 The File Menu . 20 4.2 The Edit Menu . 21 4.3 The View Menu . 23 4.4 The Bookmarks Menu . 25 4.5 The Tools Menu . 25 4.6 The Settings and Help Menu . 29 The KatePart Handbook 5 Advanced Editing Tools 30 5.1 Comment/Uncomment . 30 5.2 The Editor Component Command Line . 30 5.2.1 Standard Command Line Commands . 31 5.2.1.1 Commands for Configuring the Editor . 31 5.2.1.2 Commands for editing . 32 5.2.1.3 Commands for navigation . 37 5.2.1.4 Commands for Basic Editor Functions (These depend on the ap- plication the editor component is used in) . 37 5.3 Using Code Folding . 38 6 Extending KatePart 39 6.1 Introduction . 39 6.2 Working with Syntax Highlighting . 39 6.2.1 Overview . 39 6.2.2 The KatePart Syntax Highlight System . 40 6.2.2.1 How it Works . 40 6.2.2.2 Rules . 41 6.2.2.3 Context Styles and Keywords . 41 6.2.2.4 Default Styles . 41 6.2.3 The Highlight Definition XML Format . 42 6.2.3.1 Overview . 42 6.2.3.2 The Sections in Detail . 44 6.2.3.3 Available Default Styles . 46 6.2.4 Highlight Detection Rules . 47 6.2.4.1 The Rules in Detail . 50 6.2.4.2 Tips & Tricks . 53 6.3 Working with Color Themes . 54 6.3.1 Overview . 54 6.3.2 The KSyntaxHighlighting Color Themes . 55 6.3.3 The Color Themes JSON Format . 56 6.3.3.1 Overview . 56 6.3.3.2 The JSON Structure . 57 6.3.3.3 Main Sections of the JSON Color Theme Files . 57 6.3.3.4 Metadata . 59 6.3.4 Colors in Detail . 59 6.3.4.1 Editor Colors . 60 6.3.4.2 Default Text Styles . 66 6.3.4.3 Custom Highlighting Text Styles . 69 6.3.5 The Color Themes GUI . 70 6.3.5.1 Create a new theme . 71 6.3.5.2 Import or export JSON theme files . 71 4 The KatePart Handbook 6.3.5.3 Editing color themes . 71 6.3.5.3.1 Colors . 71 6.3.5.3.2 Default Text Styles . 71 6.3.5.3.3 Highlighting Text Styles . 71 6.3.6 Tips & Tricks . 72 6.3.6.1 Contrast of Text Colors . 72 6.3.6.2 Suggestions of Consistency with Syntax Highlighting . 72 6.4 Scripting with JavaScript . 72 6.4.1 Indentation Scripts . 72 6.4.1.1 The Indentation Script Header . 73 6.4.1.2 The Indenter Source Code . 73 6.4.2 Command Line Scripts . 74 6.4.2.1 The Command Line Script Header . 75 6.4.2.2 The Script Source Code . 75 6.4.2.2.1 Binding Shortcuts . 76 6.4.3 Scripting API . 77 6.4.3.1 Cursors and Ranges . 77 6.4.3.1.1 The Cursor Prototype . 77 6.4.3.1.2 The Range Prototype . 78 6.4.3.2 Global Functions . 79 6.4.3.2.1 Reading & Including Files . 79 6.4.3.2.2 Debugging . 79 6.4.3.2.3 Translation . 80 6.4.3.3 The View API . 80 6.4.3.4 The Document API . 81 6.4.3.5 The Editor API . 87 7 Configure KatePart 88 7.1 The Editor Component Configuration . 88 7.1.1 Appearance . 88 7.1.1.1 Font . 88 7.1.1.2 General . 88 7.1.1.3 Borders . 89 7.1.2 Color Themes . 90 7.1.3 Editing . 90 7.1.3.1 General . 90 7.1.3.2 Text Navigation . 91 7.1.3.3 Indentation . 92 7.1.3.4 Auto Completion . 93 7.1.3.5 Spellcheck . 93 7.1.3.6 Vi Input Mode . 93 5 The KatePart Handbook 7.1.4 Open/Save . 94 7.1.4.1 General . ..