Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "VJET/Overview"
< VJET
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Documentation for VJET JavaScript IDE is available in 2 forms: | Documentation for VJET JavaScript IDE is available in 2 forms: | ||
| − | * [[Wiki Documents]] <nowiki>-</nowiki> Informational and referential documentation; located on the VJET open source site. | + | * [[#Wiki Documents | Wiki Documents]] <nowiki>-</nowiki> Informational and referential documentation; located on the VJET open source site. |
| − | * [[ | + | * [[#Eclipse Cheat Sheets|Eclipse Cheat Sheets, Samples, and Help]] <nowiki>-</nowiki> Tutorial and task related topics available in Eclipse |
Since VJET JavaScript IDE is an Eclipse plugin, most of the documentation will be in Eclipse. With Eclipse Cheat Sheets, you can view documentation, step through tutorials, and code at the same time. | Since VJET JavaScript IDE is an Eclipse plugin, most of the documentation will be in Eclipse. With Eclipse Cheat Sheets, you can view documentation, step through tutorials, and code at the same time. | ||
| − | |||
| − | |||
| − | |||
== Wiki Documents == | == Wiki Documents == | ||
| Line 12: | Line 9: | ||
* Getting Started | * Getting Started | ||
| − | ** [[VJET | + | ** [[VJET/VJET_JavaScript_IDE_Installation_Guide|VJET_JavaScript_IDE_Installation_Guide]] <nowiki>-</nowiki> Installation instructions, brief VJET JavaScript overview, where to find VJET JavaScript documentation |
| − | ** [[ | + | ** [[VJET/Importing_VJET_JavaScript_Type_Libraries|Importing VJET JavaScript Type Libraries]] <nowiki>-</nowiki> Importing VJET JavaScript type libraries and configuring projects to use them |
| − | ** [[VJET | + | ** [[VJET/JS_code_assist_and_validation_for_two_or_more_js_files|Code assist and validation for 2 or more js files]] <nowiki>-</nowiki> How to get assist for variables/ functions defined in other files. |
* Features: | * Features: | ||
| − | ** [[ | + | ** [[VJET/Code_Assistance_Features|Code Assistance Features]] <nowiki>-</nowiki> Overview of code assist features |
| − | ** [[ | + | ** [[VJET/Code_Search_Features|Code Search Features]] <nowiki>-</nowiki> Overview of code search features |
* VJET Docs | * VJET Docs | ||
| − | ** [[VJET | + | ** [[VJET/Type_Declarations_Using_VJETDoc|Type Declarations Using VJETDoc]] <nowiki>-</nowiki> type declarations for JavaScript |
| − | ** [[VJET | + | ** [[VJET/VJETDoc_Quick_Reference|VJETDoc Quick Reference]] |
| − | ** [[VJET | + | ** [[VJET/VJETDoc_Reference_Guide|VJETDoc_Reference_Guide]] |
== Eclipse Cheat Sheets, Samples, and Help == | == Eclipse Cheat Sheets, Samples, and Help == | ||
| Line 36: | Line 33: | ||
* Published outside the VJET JavaScript IDE plugin and can be installed. | * Published outside the VJET JavaScript IDE plugin and can be installed. | ||
| − | Published cheat sheets are available on the [[ | + | Published cheat sheets are available on the [[http://eclipse.org/vjet/download/ VJET JavaScript Download site]]. |
| Line 54: | Line 51: | ||
# If a dialog pops up that indicates that certain actions/commands may not work, dismiss the dialog. | # If a dialog pops up that indicates that certain actions/commands may not work, dismiss the dialog. | ||
# The cheat sheet will open in Eclipse. | # The cheat sheet will open in Eclipse. | ||
| − | [[Category:VJET]] | + | [[Category:VJET|Overview]] |
Latest revision as of 21:58, 28 January 2013
Documentation for VJET JavaScript IDE is available in 2 forms:
- Wiki Documents - Informational and referential documentation; located on the VJET open source site.
- Eclipse Cheat Sheets, Samples, and Help - Tutorial and task related topics available in Eclipse
Since VJET JavaScript IDE is an Eclipse plugin, most of the documentation will be in Eclipse. With Eclipse Cheat Sheets, you can view documentation, step through tutorials, and code at the same time.
Contents
Wiki Documents
- Getting Started
- VJET_JavaScript_IDE_Installation_Guide - Installation instructions, brief VJET JavaScript overview, where to find VJET JavaScript documentation
- Importing VJET JavaScript Type Libraries - Importing VJET JavaScript type libraries and configuring projects to use them
- Code assist and validation for 2 or more js files - How to get assist for variables/ functions defined in other files.
- Features:
- Code Assistance Features - Overview of code assist features
- Code Search Features - Overview of code search features
- VJET Docs
- Type Declarations Using VJETDoc - type declarations for JavaScript
- VJETDoc Quick Reference
- VJETDoc_Reference_Guide
Eclipse Cheat Sheets, Samples, and Help
In Eclipse, select menu item Help > Welcome
- For an overview of VJET JavaScript select the Overview page, then Developing JavaScript
- For the VJET JavaScript Hello World tutorial select the Tutorials page, then Hello VJET JavaScript World
Eclipse Cheat Sheets
Eclipse cheat sheets will be added as an ongoing documentation effort and are delivered in 2 ways:
- Bundled with the VJET JavaScript IDE plugin
- Published outside the VJET JavaScript IDE plugin and can be installed.
Published cheat sheets are available on the [VJET JavaScript Download site].
Select a Cheat Sheet
- Select menu item Help > Cheat Sheets
- Select Select a cheat sheet from the list, then open the JavaScript Development folder
- Double click the cheat sheet you want to view
Install a Cheat Sheet
- Select the menu item Help > Cheat Sheets
- Select Enter the URL of a cheat sheet, and enter the URL of the cheat sheet. Click OK.
- If a dialog pops up that indicates that certain actions/commands may not work, dismiss the dialog.
- The cheat sheet will open in Eclipse.