Scilab Home Page | Wiki | Bug Tracker | Forge | Mailing List Archives | Scilab Online Help | ATOMS
File : Details
Please login or create an account

Notepad++ styles for Scilab 5.5 syntax colorization + functions completion & args reminder

(4376 downloads for this version - 14044 downloads for all versions)
Details
Version
6.0
Author
Samuel Gougeon
Maintainer
Samuel Gougeon
Category
License
Supported Scilab Version
5.4
Creation Date
April 18, 2014
Description
            Built with & Updated for Scilab 5.5.0
Works for any Scilab release.
 
.sce .sci .tst .start files are considered as Scilab ones.

Syntax colorization and completion for ~5000 functions and their parameters.
In addition to Scilab 5.5.0, functions of the most used ATOMS external modules
are supported:
 * Advanced Neural Network (ANN)
 * apifun
 * CelestLab (no colorization)
 * Image Processing Design (IPD)
 * Lycee (educational, pour les élèves français)
 * Matrix Market
 * Metanet
 * Plotting library (for former Matlabers) (plotlib)
 * PortAudio
 * SciFreeFEM
 * Scidoe : Design Of Experiment
 * Scilab Image & Video Processing (SIVP)
 * serial (RS-232 communications)
 * socket (IP communications)
 * Sound files management (sndfile)
 * Stixbox (statistics)(no colorization)
 * Time Frequency toolbox (stftb)
 * Wavelet Toolbox (swt)

 PLEASE NOTE:
 * Colorization and completions occur for these ATOMS modules even if the 
   modules are not installed in Scilab. This will help you preventing
   any potential conflicts with your own variables and functions.

 * ANN toolbox: Only syntax colorization is supported. Completion is not 
       provided for this module (its XML help files do not comply with Scilab
       5.5 standard)

 * plotlib: has several functions with same names as native Scilab functions
        (plot, subplot...). => arguments completion is provided for both
        Scilab and plotlib syntaxes ; plotlib syntaxes are then displayed at
        the bottom of the list of possible syntaxes.

----------
The free high level Notepad++ external editor can propose an advanced feature
(unavailable in the embedded Scilab editor): All calling sequences of a function
-- also called synopses -- can be displayed when typing the opening
"(". This feature is enabled by the scilab.xml file provided
here-below. It greatly helps in reminding on-the-fly the expected lists of
arguments.

scilab.xml also enables completion of function names through the full list of
functions for Scilab and some ATOMS modules.

Other Notepad++ features such as syntax colorization, folding / unfolding of
block of statements, parentheses or brackets or braces matching, etc.. are
defined and proposed for Scilab through the UserDefineLang.xml file.
The two main subsets of reserved Scilab keywords (built-in functions, and
macros) are extensively given for syntax highlightment, including undocumented
utility functions.

REMARKS about syntax parsing rules
----------------------------------
* The single quote _'_ cannot be declared as an alternative string delimiter.
Otherwise, Notepad++ would parse the ' transposition operator as the opening of
a string, making a big part of the following code wrongly parsed.

HOW TO SET Notepad++ to autocomplete Scilab functions and parameters:
====================------------------------------------------------
In Notepad++ : 
In the menu Settings => Preferences => Tab: Auto-completion:
In the Auto-completion frame: check "enable auto-completion on each
input" and "Function and word completion".

Management of files provided through this module is described below.
            
Files (2)
[814.00 kB]
Miscellaneous file
scilab.xml enables the completion of Scilab functions and the display of ~4900
calling sequences (when typing the opening parenthesis).

scilab.xml must be stored in the ~\plugins\APIs\scilab.xml Notepad++
installation directory (most often in C:\Program files\Notepad++\plugins\APIs)
scilab.xml is built with the synopses extracted from the Scilab official help
pages.

The extensive set of native Scilab calling sequences is proposed. In addition, 
calling sequences for included ATOMS modules are also provided (list in the
Description hereabove).

For each completed function, all allowed calling sequences are displayed.
[50.09 kB]
Miscellaneous file
UserDefineLang.xml : Syntax colorization for Scilab in Notepad++ (~5000
functions)

File defining extended sets of all reserved Scilab keywords (for Scilab 5.5.0),
rules and styles for Scilab syntax highlighting.
UserDefineLang.xml must be stored in the user profile (%appdata%\Notepad++\ ,
often = C:\Users\\AppData\Roaming\Notepad++\UserDefineLang.xml).

Your own UserDefineLang.xml file may contain rules for customized languages
other than Scilab. This is why it is preferable to properly import this release
for Scilab with the Import command (Menu Language => Define your language:
Import button), or to edit it and copy/paste the <="" userlang=""> block for
Scilab in it.
News (0)
Comments (6)     Leave a comment 
Comment from Adrien Vogt-schilb -- May 23, 2014, 01:55:10 AM    
Samuel, what is Matrix Market?
Comment from Adrien Vogt-schilb -- May 23, 2014, 01:58:15 AM    
Hey Samuel, would you share the script you use to do this?
Answer from Samuel Gougeon -- May 29, 2014, 01:43:50 PM    
Hello Adrien,

> Hey Samuel, would you share the script you use to do this?

I do not intend to release them for now. But if you would like to have some specific
external modules supported by next XML releases, please do not hesitate to tell here which
one. I would not insure anything. I hesitated to include Grocer. For this 6.0 release, I
have reached some Notepad++ (or may be its main dependency: Scintilla) limits for the
UserDefineLang.xml file. It looks that there is a maximal number of items for which syntax
colorization is supported. This is why colorization is not supported neither for Celestlab
nor for Stixbox in this release. I have tried and fought for hours, and got in touch with
Notepad++'s author, without success. Going beyond blocks Notepadd++ and then requires to
restart Windows!
However, the completion features are not impacted by this limit. IMO, these features are
the most useful. So adding other modules is still possible.

Best regards
Samuel
Comment from Michał; Bodziony -- June 10, 2015, 11:31:44 AM    
I think this is the very good thing and I very enjoy the colorization and autocompletition!
Comment from Diogo Rossi -- November 30, 2016, 02:57:50 AM    
Hi everyone!

This is a very good thing. I came here just to inform that the "args reminder"
have 
stoped working in version 7.2 of Notepad++ (the current version is 7.2.2 in date of this 
comment).

I will keep using Notepad++ v7.1 (where the plugin still works) but it would be very 
nice if the plugin could be updated to work on the current version.

Thankyou for this great tool!!
Answer from Samuel Gougeon -- November 30, 2016, 08:45:41 PM    
Hello Diogo,

> Hi everyone!
> 
> This is a very good thing. I came here just to inform that the "args
reminder"
> have stoped working in version 7.2 of Notepad++ (the current version is 7.2.2 
> in date of this comment).
> 
> I will keep using Notepad++ v7.1 (where the plugin still works) but it would be very 
> nice if the plugin could be updated to work on the current version.
> 
> Thankyou for this great tool!!

Thanks for you support.
There is a strange thing with Notepadd++: Notepad++ 7.1 being installed, clicking on
"Update Notepad++" answers "No update available", while 7.2.2 is
actually released, indeed.
So i downloaded and installed it by hand in another directory (to not overwrite my working
7.1 version).
For some reasons, upgrading Notepad++ does not keep scilab.xml in ~/plugins/API. It used
to keep it, formerly.
But if you restore it by hand (its current version) after upgrading Np++, it works as
formerly.
For some other strange reasons, the syntax highlighting looks to no longer require the
UserDefineLang.xml file.. !? It works even without restoring it! Don't know why. Anyway,
it's better in this way.

Could you please confirm that you get back the argument reminder after restoring
scilab.xml?
Thanks

Answer from Samuel Gougeon -- November 30, 2016, 09:08:05 PM    
OK: there was another former Notepad++ directory containing UserDefineLang.xml on my PC. I
guess that the new Np++ release used it.
After cleaning all, i installed only 7.2 (_x64) and reimported UserDefineLang.xml (menu
Language => Define your language: Import) and restored scilab.xml in ~\plugins\API, and
i
confirm that all Scilab features work in 7.2.

Answer from Diogo Rossi -- December 1, 2016, 11:53:47 AM    
> OK: there was another former Notepad++ directory containing UserDefineLang.xml on 
my PC.
> I
> guess that the new Np++ release used it.
> After cleaning all, i installed only 7.2 (_x64) and reimported UserDefineLang.xml 
(menu
> Language => Define your language: Import) and restored scilab.xml in
~\plugins\API,
> and i
> confirm that all Scilab features work in 7.2.
> 

Hi Samuel!, thanks for your answer!

I've just made some tests here with the three versions of Np++ (v7.1, v7.2, v7.2x64), 
and the args reminder still only worked on v7.1.

In these tests I followed the same procedure:
-donwloaded the portable version (.zip file)
-extracted it on a separated directory
-runned the .exe file, import the UserDefineLang.xml
-closed the program, restored scilab.xml in ~\plugins\API by hand

After doing this, only v7.1 shows the args reminder feature (the calling sequences 
when 
typing the opening parenthesis)

I don't know if some previous installation of Np++ in the system directory lead to 
this 
behaviour, or if I am doing something worng...

Even so, this is a great tool. I am doing a very good use of it in Npp++7.1. Thank 
you 
so much for develop it. I did this 'bug' observation just to let other users know 
about 
it.

Thanks again.
Answer from Samuel Gougeon -- December 1, 2016, 01:08:35 PM    
Did you check that options for auto-completion are still checked?
Menu Setting => Preferences: Auto-completion: "Function parameters hint on
input" must be
checked
Answer from Diogo Rossi -- December 2, 2016, 12:48:30 PM    
... sorry Samuel for wasting your time.

the option was really unchecked

it seems that from Np++7.2 release, the default options checked in 'preferences' on the 
moment of intallation has changed from the predefined options that came in v7.1 and the 
older ones.

thank you for your help, and sorry again.

I am now using the new version (v7.2.2) and the plugin is workin fine.
Leave a comment
You must register and log in before leaving a comment.
Email notifications
Send me email when this toolbox has changes, new files or a new release.
You must register and log in before setting up notifications.