[Master Index] [Index for Toolbox]

# help_editing_brainstorm

## (Toolbox/help_editing_brainstorm.m in BrainStorm 2.0 (Alpha))

### Function Synopsis

    helptext = help_editing_brainstorm;

### Help Text

    HELP_EDITING_BRAINSTORM - Information on how to update and edit your version of BrainStorm
     function helptext = help_editing_brainstorm;

     In this Alpha version of BrainStorm, you should expect frequent updates at
      our website,

      http://neuroimage.usc.edu/brainstorm/Downloads.php

     We recommend that you adhere to the following approaches to editing any files
      in BrainStorm, as well as updating with each new copy.

     EDITING:
      If you want to edit a BrainStorm file in the Toolbox folder, you should first
        place a copy of it in the BrainStorm folder "Custom". At startup, the
        Custom folder is always placed higher in precedence, so that any m-file
        with the same name in both folders is always run from Custom. Type "path"
        to confirm, and "which <mfilename> -all" to see all copies of the a
        particular mfile. Edit only the copy in your Custom folder.

     UPDATING:
      When you download a new zip file from our website, we recommend you delete
      the folders in your BrainStorm folder:

        Toolbox
        PublicToolbox
        Documents
        html

      and replace them with the contents of the new zip file.

      If you have not placed any of your own default data in the default_database,
       then we recommend you delete that folder as well and let the new version of
       BrainStorm build you a new one at the next startup.

      Then run a difference on each m-file in your custom folder. Windows users
      could use WinDiff (it's in your system utilities folder of your original
      Windows installation disk, not installed automatically), or we particularly
      like the free software CSDiff, available from:

        http://www.componentsoftware.com/products/csdiff/download.htm

      Determine if the changes we made in our new versions replace your edits, and
       delete your old Custom version. Or, replicate the new version into your
       Custom folder and re-add your original edit. Or just leave your original
       version in place. Because of the path precedence, your Custom version will
       always be run instead of the Toolbox version.

### Cross-Reference Information

This function calls

    brainstorm                         C:\BrainStorm_2001\Toolbox\brainstorm.m

This function is called by

    bst_static_taskbar                 C:\BrainStorm_2001\Toolbox\bst_static_taskbar.m

### Listing of function C:\BrainStorm_2001\Toolbox\help_editing_brainstorm.m

    function helptext = help_editing_brainstorm;
    %HELP_EDITING_BRAINSTORM - Information on how to update and edit your version of BrainStorm
    % function helptext = help_editing_brainstorm;
    %
    % In this Alpha version of BrainStorm, you should expect frequent updates at
    %  our website,
    %
    %  http://neuroimage.usc.edu/brainstorm/Downloads.php
    %
    % We recommend that you adhere to the following approaches to editing any files
    %  in BrainStorm, as well as updating with each new copy.
    %
    % EDITING:
    %  If you want to edit a BrainStorm file in the Toolbox folder, you should first
    %    place a copy of it in the BrainStorm folder "Custom". At startup, the
    %    Custom folder is always placed higher in precedence, so that any m-file
    %    with the same name in both folders is always run from Custom. Type "path"
    %    to confirm, and "which <mfilename> -all" to see all copies of the a
    %    particular mfile. Edit only the copy in your Custom folder.
    %
    % UPDATING:
    %  When you download a new zip file from our website, we recommend you delete
    %  the folders in your BrainStorm folder:
    %
    %    Toolbox
    %    PublicToolbox
    %    Documents
    %    html
    %
    %  and replace them with the contents of the new zip file.
    %
    %  If you have not placed any of your own default data in the default_database,
    %   then we recommend you delete that folder as well and let the new version of
    %   BrainStorm build you a new one at the next startup.
    %
    %  Then run a difference on each m-file in your custom folder. Windows users
    %  could use WinDiff (it's in your system utilities folder of your original
    %  Windows installation disk, not installed automatically), or we particularly
    %  like the free software CSDiff, available from:
    %
    %    http://www.componentsoftware.com/products/csdiff/download.htm
    %
    %  Determine if the changes we made in our new versions replace your edits, and
    %   delete your old Custom version. Or, replicate the new version into your
    %   Custom folder and re-add your original edit. Or just leave your original
    %   version in place. Because of the path precedence, your Custom version will
    %   always be run instead of the Toolbox version.

    %<autobegin> ---------------------- 26-May-2004 11:30:27 -----------------------
    % --------- Automatically Generated Comments Block Using AUTO_COMMENTS ---------
    %
    % CATEGORY: Help
    %
    % At Check-in: $Author: Mosher $  $Revision: 4 $  $Date: 5/26/04 9:59a $
    %
    % This software is part of BrainStorm Toolbox Version 2.0 (Alpha) 24-May-2004
    %
    % Principal Investigators and Developers:
    % ** Richard M. Leahy, PhD, Signal & Image Processing Institute,
    %    University of Southern California, Los Angeles, CA
    % ** John C. Mosher, PhD, Biophysics Group,
    %    Los Alamos National Laboratory, Los Alamos, NM
    % ** Sylvain Baillet, PhD, Cognitive Neuroscience & Brain Imaging Laboratory,
    %    CNRS, Hopital de la Salpetriere, Paris, France
    %
    % See BrainStorm website at http://neuroimage.usc.edu for further information.
    %
    % Copyright (c) 2004 BrainStorm by the University of Southern California
    % This software distributed  under the terms of the GNU General Public License
    % as published by the Free Software Foundation. Further details on the GPL
    % license can be found at http://www.gnu.org/copyleft/gpl.html .
    %
    % FOR RESEARCH PURPOSES ONLY. THE SOFTWARE IS PROVIDED "AS IS," AND THE
    % UNIVERSITY OF SOUTHERN CALIFORNIA AND ITS COLLABORATORS DO NOT MAKE ANY
    % WARRANTY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
    % MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, NOR DO THEY ASSUME ANY
    % LIABILITY OR RESPONSIBILITY FOR THE USE OF THIS SOFTWARE.
    %<autoend> ------------------------ 26-May-2004 11:30:27 -----------------------

    % This help file template was generated by 'make_help' on 24-Sep-2003 13:58:29
    %
    % This help file is callable as "help help_editing_brainstorm" (at the command line),
    %  "help_editing_brainstorm" (in the Matlab help window), or
    %  "txt = help_editing_brainstorm;" (no display, return only txt).

    if nargout,
       helptext = help(mfilename); % return help block to output variable
    else
       helpwin(mfilename); % no output variable, display in help window
    end

    % invoke the downloads page at BrainStorm
    web('http://neuroimage.usc.edu/brainstorm/Downloads.php','-browser')

Produced by color_mat2html, a customized BrainStorm 2.0 (Alpha) version of mat2html on Tue Nov 2 16:17:59 2004
Cross-Directory links are: ON