Jump to: navigation, search

Difference between revisions of "Orion/Overview for Eclipse Committers"

 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This content has been moved to [[Orion/Getting Started with Orion]]
+
This content has been moved to [[Orion/Documentation/User Guide/Getting started]]
 
+
Welcome to Orion.  This page will get you started with using the Orion demo server, hosted at [http://orion.eclipse.org/ http://orion.eclipse.org].
+
 
+
We are giving existing Eclipse committers access to the demo server to kick the tires, and hopefully to inspire you to become involved in the project.  The demo represents a few months of effort by a handful of developers.  It is not a full-functioning development environment, but we believe it is far enough along to give you an idea of where we would like to go, and to inspire you to think about how Orion could improve your web workflows.
+
 
+
Note that these are very early days for Orion, and it is not usable for real work yet. See the [http://wiki.eclipse.org/Orion/FAQ#Can_Orion_be_used_for_real_work.3F Orion FAQ] for a list of gaping holes in terms of functionality.
+
 
+
==Logging into Orion==
+
When you first attempt to access the Orion server, you'll be prompted for credentials.  All Eclipse committers will receive an Orion id between now and EclipseCon.  Your user name is the email you have registered with the Eclipse Foundation.  Your password will be emailed.  If you have any questions or your credentials are not working, please file a bug against Eclipse/e4/Orion.
+
 
+
==Working with Resources==
+
In Orion, each user has a virtual "workspace" where they can work with various folders and files.  These files are maintained on the Orion server.  '''Please note that for the time being, data may be periodically deleted from the Orion server.''' 
+
 
+
For demo purposes, we currently populate every user's workspace with two folders that contain some of the Orion client source code.  Once you've successfully logged into Orion, you should see two folders:
+
 
+
[[Image:orion-navinitial.png]]
+
 
+
This is the default navigator view for Orion.  To navigate the files, you may either expand the folders (using the triangles), or you may click on the folder links to drill into that folder.  The breadcrumb at the top of the navigator allows you to navigate back up the tree. 
+
 
+
The commands that operate on the navigator are located adjacent to the breadcrumb.  Commands that apply to individual files or folders are located in the "Actions" column next to the item. 
+
 
+
If you prefer a more traditional tree view that uses context menus, you can switch the navigator view to "Tree View" using the button at the top of the page.  (We are currently offering both views as we evolve the overall navigation UI and where contributed commands appear.  See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=334189 Bug 334189] and its dependents for more detail about this work.)
+
 
+
[[Image:orion-navtreebutton.png]]
+
 
+
If you wish to use Orion to edit some of your own code, you can create folders and files using the buttons adjacent to the breadcrumb. 
+
 
+
[[Image:orion-navbreadcommands.png]]
+
 
+
You may also upload zip files containing your work to the server using the import button.  You must first create a folder in which to import the code (the import button is not active from the workspace root).  To import code from Eclipse (or any other IDE) into Orion, you must first zip up the files you wish to import.  Choose this zip file in the file selection prompt offered in the import dialog.  (Choosing a non-zip file may break the import dialog on some browsers, see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=335890 Bug 335890]).
+
 
+
[[Image:orion-navimport.png]]
+
 
+
The contents of the zip file will appear in a new folder in the navigator.
+
 
+
To export code from Orion to your workstation, navigate to the folder you wish to export and choose the "Download as Zip" link.
+
 
+
[[Image:orion-navexport.png]]
+
 
+
You can use the "Favorites" icon to bookmark a folder or file in your navigator. A link to this folder or file will appear in your favorites list and can be used to navigate quickly to that file or folder.
+
 
+
[[Image:orion-favorites.png]]
+
 
+
==Editing code==
+
Once you've navigated to the file you want to work with, click on its link to open the editor.  You'll find that the editor supports the basics (cut/copy/paste, undo/redo) as well as your favorite text-editing features from Eclipse desktop (move up/down, copy up/down, go to line, find, incremental find).  For now, most of these commands are accessible only through keyboard shortcuts, using the default keybindings in Eclipse desktop. 
+
 
+
===JavaScript development===
+
If you are working with JavaScript (a *.js file), the editor will syntax highlight your code and run JSLint on it to show you any problems in your code.  Problems are shown using the familiar markers from Eclipse desktop.  The editor will also match brackets when you click next to a bracket, perform auto indention, and provide keybindings for toggling comments and adding/removing block comments.
+
 
+
[[Image:orion-editjs.png]]
+
 
+
===Firebug Integration===
+
The Orion server is Firebug-savvy, so that recent alpha versions of Firebug, together with a Firebug extension, can invoke the Orion editor to make corrections.  For details about this, see [http://getfirebug.com/wiki/index.php/Editing#Orion_Web_Editor the Firebug wiki].
+
 
+
===CSS development===
+
Syntax highlighting of CSS files is also supported.  We've also implemented a bare-bones content assist based on CSS keywords.
+
 
+
[[Image:orion-editcss.png]]
+
 
+
===HTML development===
+
We've implemented a simple HTML outliner based on DOM ids.  (No syntax highlighting support yet).
+
 
+
[[Image:orion-edithtml.png]]
+
 
+
===Java development===
+
Java syntax highlighting is also supported.  However, we have not implemented any outlining or content assist yet.  Since we are building an integrated web-based toolset, we felt it important to target first the web client languages such as JavaScript, CSS, and HTML, so we can attract members of the JS community to Eclipse.  Since we are [[Orion/Getting the source#Self Hosting |self hosting]] Orion development in Orion, we find that we need the JS features first!
+
 
+
[[Image:orion-editjava.png]]
+
 
+
===Other languages and content types===
+
Would you like to see more support for these languages?  Or another language (PHP, Ruby, etc.) supported?  Or pluggable editors for other content types (images, docs, etc.).  Get involved!  We have implemented these various language features as proof of concept and want to work toward a more structured extension model for the editor.
+
 
+
==Search Support==
+
Once you are actively using Orion, you'll find that you want to move quickly between different resources.  There are several ways to go about this.
+
===Global search===
+
The search box in the Orion navigator will perform a global search on everything in your user workspace.
+
 
+
[[Image:orion-globalsearch.png]]
+
 
+
The "Open resource" dialog will let you search for a file by name.  It can use wildcards similar to the Eclipse desktop Open Resource dialog.
+
 
+
[[Image:orion-openresource.png]]
+
 
+
You can search on a highlighted phrase from inside the editor
+
 
+
[[Image:orion-searchineditor.png]]
+
 
+
The browser history can also be your "Open Resource."  If you find yourself working in the same handful of files, opening a new browser tab and typing in the filename will quickly get you there.
+
 
+
[[Image:orion-browserbar.png]]
+
 
+
 
+
[[Category:Orion|Overview for Eclipse Committers]]
+

Latest revision as of 14:18, 8 February 2013

This content has been moved to Orion/Documentation/User Guide/Getting started