canmove, Confirmed users, Bureaucrats and Sysops emeriti
1,093
edits
Labs/Bespin/UserGuide: Difference between revisions
→Disclaimer
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
= | =OUT OF DATE= | ||
This document has been replaced by | |||
https://bespin.mozillalabs.com/docs/userguide/index.html | |||
=What is Bespin?= | =What is Bespin?= | ||
| Line 80: | Line 82: | ||
===Importing=== | ===Importing=== | ||
You can import projects to your Bespin account from the web. To import a project you can | You can import projects to your Bespin account from the web. To import a project you can use the "project" meta command: | ||
import <url with file> <project name> | project import <url with file> <project name> | ||
Projects must be hosted on-line and compressed in ZIP or TAR.GZ formats. | Projects must be hosted on-line and compressed in ZIP or TAR.GZ formats. | ||
| Line 88: | Line 90: | ||
===Exporting=== | ===Exporting=== | ||
To export a project to your computer you can | To export a project to your computer you can use the "project" meta command: | ||
export <project name> <archivetype> | project export <project name> [<archivetype>] | ||
<nowiki><archivetype></nowiki> can be ZIP or TGZ. If archivetype is not passed it defaults to ZIP | <nowiki><archivetype></nowiki> can be ZIP or TGZ. If archivetype is not passed it defaults to ZIP | ||
| Line 266: | Line 268: | ||
==Syntax Highlighting== | ==Syntax Highlighting== | ||
Right now only CSS, JavaScript and HTML syntax highlighting | Right now only CSS, JavaScript and HTML syntax highlighting are supported. This will be improved in the near future. | ||
The syntax highlighter keys in on the file suffix (e.g. .html will cause HTML highlighting). | |||
If you need to manually force a particular highlighter you can run the set command and pass in the particular language: | |||
set language html | |||
If you want to add a new syntax highlighter you can do so by loading highlighter code and registering it: | |||
// load the file first (e.g. dojo.require("....")) | |||
bespin.syntax.simple.Resolver.register("Arduino", ['pde']); | |||
=Command Line= | =Command Line= | ||
| Line 274: | Line 287: | ||
==Commands== | ==Commands== | ||
===Global Commands=== | === Global Commands === | ||
; alias [<font style="color: | ;alias [<font style="color: rgb(136, 136, 255);">command</font>] | ||
:Create an alias between a word and a command. For example: | |||
alias close closefile | alias close closefile | ||
This creates an alias that closes without saving the file you are currently working. | This creates an alias that closes without saving the file you are currently working. | ||
; set [<font style="color: | ;set [<font style="color: rgb(136, 136, 255);">variable</font>] [<font style="color: rgb(136, 136, 255);">value</font>] | ||
:This sets values to variables in the configuration. If parameter is not passed a list with the available variables will be displayed. See [[#Settings|settings]]. For example: | |||
set theme white | set theme white | ||
; | ;project | ||
:Various commands to manage projects | |||
<pre>project [command] [parameters] | |||
</pre> | |||
{| cellspacing="1" cellpadding="1" border="1" style="width: 679px; height: 256px;" | |||
|- | |||
! scope="col" | Command<br> | |||
! scope="col" | Description<br> | |||
! scope="col" | Parameters<br> | |||
|- | |||
| create<br> | |||
| create a new project<br> | |||
| [projectname]<br> | |||
|- | |||
| delete<br> | |||
| delete a project<br> | |||
| [projectname]<br> | |||
|- | |||
| export<br> | |||
| export the given project with an archivetype of zip or tgz<br> | |||
| [project] [archivetype]<br> | |||
|- | |||
| help<br> | |||
| show subcommands for project command<br> | |||
| [search]<br> | |||
|- | |||
| import<br> | |||
| If a URL is given, import that URL (e.g. project import http://foo.com/bar.zip MyProject). If only a project is given, then a file upload dialog will ask to upload a local file (e.g. project import MyProject).<br> | |||
| [url] [project]<br> | |||
|- | |||
| list<br> | |||
| show projects<br> | |||
| <br> | |||
|- | |||
| rename<br> | |||
| rename a project<br> | |||
| [currentProject] [newProject] <br> | |||
|- | |||
| show<br> | |||
| show the current project<br> | |||
| <br> | |||
|} | |||
<br> | |||
===Dashboard Specific Commands=== | ===Dashboard Specific Commands=== | ||
| Line 400: | Line 452: | ||
==Configuration File== | ==Configuration File== | ||
You can access | You can access the configuration by typing in the command line: | ||
editconfig | editconfig | ||