it-edit Documentation

Table of Contents

Next: , Up: (dir)   [Contents]

it-edit Documentation

it-edit 2.0, March 02, 2016

Brüggemann Eddie

Copyright © 2016, Brüggemann Eddie

Contents:


Next: , Previous: , Up: Top   [Contents]

1 Motivation for writing it-edit

They are 2 sort of programmers in their habits of writing programs:

Because i’am an programmer from the second category and because i remark that i often use an additional other tools.

I decide to write my own text editor program which provide me all the functionalities that i need to get a development environment fully adapt to my requirement.

Which consist of a terminal integrated text-editor with which you can access all you require directly from the editor: documentation, GUI applications, ...


Next: , Previous: , Up: Top   [Contents]

2 it-edit presentation

*it-edit* provide a text editor with syntax highlight, line numbering and with the basics text editing functionalities:

And an files managing interface for:

*it-edit* provide *terminals in the same window as the editor*, as a sidebar, which can easily *shown*, *hidden* and *resized*.

You can *add* and *remove* as many terminals as you want to the sidebar...

*it-edit* provide a *big terminal* occupying the full interface, *dividable* into *4 resizable terminals*, to which you can *easy toggle* from the main window.

For executing commands like compilation, debugging, and so soon directly from the editor.

 

I intend to implement an manpages reading interface, in an *toplevel terminal window* (so it can be *resize*, *minimize*, *maximize* and *closed*),

but i remark by implementing it that i restrict the command to execute the man [section] page command.

So i decide to provide the same functionality but without restricting it to the manpage displaying, to expand it to execute any command you want in an toplevel terminal.

It result in a functionality to execute a command in a toplevel terminal, which can be resize, minimize, maximize and close.

After the execution of the command the toplevel terminal is yours and can continue to enter commands...

 

I intend to implement launching of registered offline HTML documentation in a toplevel window,

but i remark by implementing it that i restrict it to offline *HTML* pages.

So i decide to provide the same functionality with registering any file you like.

The registered files are launched with the default program for this filetype.

After registering the files, you can easy launch it and access them all directly from *it-edit*.

 

I want to launch necessary *GUI tools* directly from the editor.

So *it-edit* permit to register the application you want to get direct access to it from your editor.

Like: A *GUI* diff tool, A *GUI* debugger, a smart python interpreter, a calculator, a color picker, a dictionary, and so soon...


Next: , Previous: , Up: Top   [Contents]

3 Files

You can start *it-edit* from the command line with a space delimited files list, as argument, which will be opened in the editor at start.

Or use the *it-edit* icon with your files-manager you can select files to open with *it-edit*.

To know for files managing:

You can easily navigate into your open files by using the pop-up menu or by clicking on the file tab.

You can reorder your open files as wanted by drag and drop the files tabs.


Next: , Previous: , Up: Top   [Contents]

4 Edition

To know about edition:


Next: , Previous: , Up: Top   [Contents]

5 Editor

*Go to line number* use the menu item, the button or the shortcut: *Ctrl + g*.

Enter an valid line number and press *Enter* or the *Apply* button to move the editor to the wanted line, which will be highlight.

 

*Find and replace* functionality.

You can _show_ | _hide_ the find and replace bar by using the toggle button.

The search and replace bar has following functionalities:


note: if you select some text with the mouse and use the *Ctrl + f* shortcut.


Next: , Previous: , Up: Top   [Contents]

6 Actions

*Command execution*: use the menu item, the *Cmd* button or the shortcut: *Ctrl + e*.

This will display a little toplevel in which you can enter a command.

Then press the *Enter* key or the *Apply* button to execute the command in a terminal include in a toplevel window (so you can resize, minimize, maximize and close the window).

After the execution from the command the toplevel terminal is yours so can continue to enter commands and use it.

*Sidebar Terminals adding*: You can add some terminals, 2 per item, to the sidebar, reorder them, and remove it.

Use the menu item or the shortcut *Ctrl + Maj + T*.

*Big terminal(s) switch*: You can switch between a very big terminal and a very big terminal divided into 4 terminals.

Use the menu item or the shortcut *Ctrl + Maj + B*.

*File Handler*: use the menu item or the shortcut: *Ctrl + H*.

For using this features you must register files from the *Files handler manager* tab interface reachable through the settings->Configure program menu item.

For registering a file you must give it a title which will appears as the button text in the *File Handler* window and selecting the corresponding file.

Then when you press the button in the *File Handler* window, the file will be launched with the default application for this filetype.

This features was thinking for fast access to offline HTML documentation but it’s being expanded to any filetype, so you can consult pdf documentation too, but not only, this features can be use for any use you want.

The registered files can be removed from the *File handler* list through the same interface with which you add it.

*Application launcher*: use the menu item or the shortcut: *Ctrl + A*.

This will display an application chooser. By selecting an application you will launch it.


Next: , Previous: , Up: Top   [Contents]

7 Applications

You can set different GUI tools launcher from *it-edit*:

Under the section *programming* you can set:

Under the *utilities* section you can set:

Else you can register the application you want under the *others* section.

This is very practice to launch an application directly from *it-edit* instead of:

  1. Minimize *it-edit*
  2. Go to the menu.
  3. Find the application you want to launch.
  4. Launch your application.

Next: , Previous: , Up: Top   [Contents]

8 View

*Big term* _Show_ | _hide_: use the menu item, the toggle button or the shortcut: *Ctrl + B*.

*Terminals* _show_ | _hide_: use the menu item, the toggle button or the shortcut: *Ctrl + T*.

*Button bar* _show_ | _hide_: use the menu item.

*Fullscreen* toggle: use the menu item.


Next: , Previous: , Up: Top   [Contents]

9 Settings

*Syntax highlight*: use the menu item.

To set the syntax highlight on, on the current edited text from the supported language.

 

*Editor schemes*: use the menu item.

To set the appearance from the text editor.

Currently they are 13 different schemes available in *it-edit*:

Each time you change the scheme your choice is registered so that you don’t have to change it every time you start *it-edit*.

 

*Configure program*: use the menu item.

To access to the program configuration window which is divide into 3 part:

*Editor settings*:

*Terminal settings*:

*File handler manager*:

Here you can add and remove files for the *File handler* feature.

*Applications*:

Here you can define shortcuts for the applications you want.

*Settings*


Next: , Previous: , Up: Top   [Contents]

10 Shortcuts memo

+--------------------+----------------------+------------------+
|    Shortcut        |    functionality     |    Mnemonic      |
+====================+======================+==================+
| Ctrl + n           | New file             | n = new          |
+--------------------+----------------------+------------------+
| Ctrl + o           | Open file            | o = open         |
+--------------------+----------------------+------------------+
| Ctrl + s           | Save file            | s = save         |
+--------------------+----------------------+------------------+
| Ctrl + Maj + S     | Save all files       | S = Save         |
+--------------------+----------------------+------------------+
| Ctrl + r           | Reload file          | r = reload       |
+--------------------+----------------------+------------------+
| Ctrl + i           | File informations    | i = Informations |
+--------------------+----------------------+------------------+
| Ctrl + z           | Undo                 | None             |
+--------------------+----------------------+------------------+
| Ctrl + Maj + Z     | Redo                 | None             |
+--------------------+----------------------+------------------+
| Ctrl + f           | Search               | f = find         |
+--------------------+----------------------+------------------+
| Ctrl + Enter       | Replace              | none             |
+--------------------+----------------------+------------------+
| Ctrl + Maj + Enter | Replace all          | none             |
+--------------------+----------------------+------------------+
| Ctrl + +           | Next                 | none             |
+--------------------+----------------------+------------------+
| Ctrl + -           | Previous             | none             |
+--------------------+----------------------+------------------+
| Ctrl + g           | Go to line number    | g = go to        |
+--------------------+----------------------+------------------+
| Ctrl + x           | Cut                  | None             |
+--------------------+----------------------+------------------+
| Ctrl + c           | Copy                 | c = copy         |
+--------------------+----------------------+------------------+
| Ctrl + v           | Paste                | None             |
+--------------------+----------------------+------------------+
| Ctrl + d           | Duplicate text       | d = duplicate    |
+--------------------+----------------------+------------------+
| Ctrl + p           | Use tabs             | none             |
+--------------------+----------------------+------------------+
| Ctrl + e           | Execute command      | e = execute      |
+--------------------+----------------------+------------------+
| Ctrl + b           | Show|Hide big term   | b = big term     |
+--------------------+----------------------+------------------+
| Ctrl + Maj + B     | big term switch      | B = Big term     |
+--------------------+----------------------+------------------+
| Ctrl + t           | Show | Hide terminal | t = terminal     |
+--------------------+----------------------+------------------+
| Ctrl + Maj + T     | Add new terminals    | T = Terminals    |
+--------------------+----------------------+------------------+
| Maj + Copy         | Copy from terminal   | none             |
+--------------------+----------------------+------------------+
| Maj + Insert       | Paste to terminal    | none             |
+--------------------+----------------------+------------------+
| Ctrl + h           | File handler         | h = handler      |
+--------------------+----------------------+------------------+
| Ctrl + a           | Application launcher | a = application  |
+--------------------+----------------------+------------------+
| Ctrl + q           | Quit application     | q = quit         |
+--------------------+----------------------+------------------+

Next: , Previous: , Up: Top   [Contents]

11 Supported languages

ActionScript

text/x-actionscript.

Ada:

text/x-ada, text/x-adasrc.

ASP:

text/x-asp, application/x-asp, application/x-asap.

Automake:

awk:

application/x-awk.

BennuGD:

BibTeX:

text/x-bibtex.

Bluespec SystemVerilog:

Boo:

text/x-boo.

C:

text/x-c, text/x-csrc, image/x-xpixmap.

C#:

text/x-csharpsrc, text/x-csharp.

C++:

text/x-c++, text/x-cpp, text/x-c++src.

C/C++/ObjC Header:

text/x-chdr, text/x-c++hdr.

CG Shader Language:

ChangeLog:

text/x-changelog.

CMake:

Cobol:

CSS:

text/css.

CUDA:

D:

text/x-dsrc.

.desktop:

application/x-gnome-app-info, application/x-desktop.

Diff:

text/x-diff, text/x-patch.

DocBook:

application/docbook+xml.

DOS Batch:

DPatch:

text/x-dpatch.

DTD:

text/x-dtd.

Eiffel:

text/x-eiffel.

Erlang:

text/x-erlang.

F#:

text/x-fsharp.

FCL:

Forth:

text/x-forth.

Fortran 95:

text/x-fortran.

GAP:

text/x-gap.

GDB Log:

gettext translation:

text/x-po, text/x-pot, text/x-pox, text/x-gettext-translation, text/x-gettext-translation-template.

Go:

Graphviz Dot:

text/vnd.graphviz.

GtkRC:

text/x-gtkrc.

Haskell:

text/x-haskell.

HTML:

text/html.

IDL:

text/x-idl.

IDL-Exelis:

ImageJ:

.ini:

text/x-ini-file, application/x-ini-file.

J:

Java:

text/x-java.

JavaScript:

application/javascript, application/x-javascript, text/x-javascript, text/javascript, text/x-js.

JSON:

Julia:

LaTeX:

text/x-tex.

libtool:

text/x-libtool.

Literate Haskell:

text/x-literate-haskell.

Lua:

text/x-lua.

m4:

application/x-m4.

Makefile:

text/x-makefile.

Mallard:

Markdown:

text/x-markdown.

Matlab:

text/x-octave, text/x-matlab.

Modelica:

text/x-modelica.

MXML:

Nemerle:

text/x-nemerle.

NetRexx:

text/x-netrexx.

NSIS:

Objective-C:

text/x-objcsrc.

Objective-J:

text/x-objective-j.

OCaml:

text/x-ocaml.

OCL:

text/x-ocl.

Octave:

text/x-octave, text/x-matlab.

OOC:

Opal:

OpenCL:

OpenGL Shading Language:

Pascal:

text/x-pascal,

Perl:

text/x-perl, application/x-perl.

PHP:

text/x-php, application/x-php, text/x-php-source, application/x-php-source.

pkg-config:

text/x-pkg-config.

Prolog:

text/x-prolog.

Protobuf:

text/x-protobuf.

Puppet:

Python:

text/x-python, application/x-python.

Python 3:

R:

text/x-R.

RPM spec:

text/x-rpm-spec.

Ruby:

application/x-ruby, text/x-ruby.

Scala:

text/x-scala.

Scheme:

text/x-scheme.

Scilab:

sh:

text/x-shellscript, application/x-shellscript, text/x-sh.

SPARQL:

application/sparql-query.

SQL:

text/x-sql.

Standard ML:

SystemVerilog:

Tcl:

text/x-tcl, application/x-tcl.

Texinfo:

text/x-texinfo.

txt2tags:

Vala:

text/x-vala.

VB.NET:

text/x-vbnet, text/x-vb.

Verilog:

text/x-verilog-src.

VHDL:

text/x-vhdl.

XML:

application/xml, text/xml.

XSLT:

application/xslt+xml.

Yacc:

text/x-yacc, text/x-bison.


Previous: , Up: Top   [Contents]

12 Credits

Author: Eddie Brüggemann

Contact: mrcyberfighter@gmail.com

License: GPLv3.

version: 2.0

website: www.open-source-projects.net/IT-Edit/IT-Edit_presentation.html

Thank’s to my beloved mother, my family and to the doctors.

Stay away from drugs: drugs destroy your brain and your life.