Skip to content

Commit

Permalink
oniro-ide-docs: Initial Commit
Browse files Browse the repository at this point in the history
Adding the initial part of the oniro ide documentation with the user-interface.

Signed-off-by: Mariz Samir Mounir Awad <[email protected]>
  • Loading branch information
marzi333 authored and Stefan-Schmidt committed Feb 6, 2024
1 parent a225392 commit 5920123
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 3 deletions.
5 changes: 2 additions & 3 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,9 @@ GEM
rexml (3.2.6)
rouge (4.2.0)
safe_yaml (1.0.5)
sass-embedded (1.69.5-arm64-darwin)
google-protobuf (~> 3.23)
sass-embedded (1.69.5-x86_64-linux-gnu)
sass-embedded (1.69.5)
google-protobuf (~> 3.23)
rake (>= 13.0.0)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.5.0)
Expand Down
Binary file added assets/images/Main Layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/view-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions oniro-ide-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: home
title: Oniro IDE Documentation
nav_order: 4
has_children: true
---

<!-- User Interface -->
49 changes: 49 additions & 0 deletions user-interface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: User Interface
layout: home
nav_order: 1
parent: Oniro IDE Documentation
---
# User Interface

At its heart, Oniro IDE is a code editor. Like many other code editors, Oniro IDE adopts a common user interface and layout of an explorer on the left, showing all of the files and folders you have access to, and an editor on the right, showing the content of the files you have opened.

![](assets/images/Main%20Layout.png)

## Basic Layout
The basic layout consists of 8 main areas:
1. **Menu Bar**: that contains the main menus such as File, Edit, View, Run..etc.
1. **Tool Bar**: for going home, and toggling the explorer and debugging side bars.
1. **Layout Bar**: for changing the layout and positioning of the tool bar.
1. **Editor Groups**: with all the different files you are editing. You open as many files as you want and stack them horizontally and vertically.
1. **Primary Side Bar**: usually hosts the `Explorer` view to assist you in navigating and working on your project.
1. **Panel**: space for views below the editor area. It typically has the integrated terminal, output and errors. You can also stack multiple views in the panel or have it as a pop out in a separate window.
1. **Status Bar**: shows the status of the file you are currently editing such as the language used in the file.
1. **Secondary Side Bar**: hosts an extra view on the right hand side such as a `Debugging` side bar.


## Explorer
The explorer is used to browse, open, and manage all the files and folders in your project. You can create a new file or folder at any time in your project. You can also switch to a different project previously opened in the IDE by selecting it from the active project menu.

You can do many things to files and folders in the explorer:

* Create, delete, rename files and folders by right click.
* Move files and folders by drag and drop.
* Duplicate, copy and paste files into a folder.

{: .note }
> You could run commands in a folder by right clicking on the folder itself or a file in the folder and choosing `Open in Terminal` from the pop out menu.

### Open Editors
On the top of the `Explorer` side view you can find a pane called `Open Editors` that shows all the files that you currently have open. This allows for quick navigation between the opened editor tabs.

## Views

The `Explorer` is one of multiple other views available in Oniro IDE.
![](assets/images/view-menu.png)
By navigating to `View` from the menu bar, you can see the multiple views that can be opened, such as:
* **Search** Provides global search and replace across your open folder.
* **Debug** for debugging tools displaying the `Call Stack`, `Variables`, `Breakpoints` throughout the code, and a `Watch` monitoring select variables.
* **Outline** shows a symbol tree of the currently active editor showing the variables in your code.

0 comments on commit 5920123

Please sign in to comment.