Repository: incubator-zeppelin
Updated Branches:
  refs/heads/master ae1c06bb1 -> d169284fd


Add documentation on how to add syntax highlighting in the ACE editor

For a new programming language

Author: Felix Cheung <[email protected]>

Closes #297 from felixcheung/interpreterdoc and squashes the following commits:

8a800e5 [Felix Cheung] improve spacing in doc
8174d07 [Felix Cheung] Add doc on how to add syntax highlighting in the ACE 
editor


Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/d169284f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/d169284f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/d169284f

Branch: refs/heads/master
Commit: d169284fd08dcd8259d6173c2004e9630deefebb
Parents: ae1c06b
Author: Felix Cheung <[email protected]>
Authored: Thu Sep 10 16:47:29 2015 -0700
Committer: Lee moon soo <[email protected]>
Committed: Mon Sep 14 15:12:30 2015 +0900

----------------------------------------------------------------------
 docs/docs/manual/interpreters.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/d169284f/docs/docs/manual/interpreters.md
----------------------------------------------------------------------
diff --git a/docs/docs/manual/interpreters.md b/docs/docs/manual/interpreters.md
index ab9fdf4..c74f755 100644
--- a/docs/docs/manual/interpreters.md
+++ b/docs/docs/manual/interpreters.md
@@ -36,3 +36,16 @@ Technically, Zeppelin interpreters from the same group are 
running in the same J
 
 Interpreters belong to a single group a registered together and all of their 
properties are listed in the interpreter setting.
 <img 
src="../../assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png">
+
+### Programming langages for interpreter
+
+If the interpreter uses a specific programming language (like Scala, Python, 
SQL), it is generally a good idea to add syntax highlighting support for that 
to the notebook paragraph editor.  
+  
+To check out the list of languages supported, see the mode-*.js files under 
zeppelin-web/bower_components/ace-builds/src-noconflict or from github 
https://github.com/ajaxorg/ace-builds/tree/master/src-noconflict  
+  
+To add a new set of syntax highlighting,  
+1. add the mode-*.js file to zeppelin-web/bower.json (when built, 
zeppelin-web/src/index.html will be changed automatically)  
+2. add to the list of `editorMode` in 
zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js - it follows 
the pattern 'ace/mode/x' where x is the name  
+3. add to the code that checks for `%` prefix and calls 
`session.setMode(editorMode.x)` in `setParagraphMode` in 
zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js  
+  
+

Reply via email to