CompanyProfiles(2)

COMPANY PROFILES

This section describes how a company profile should be incorporated into MicroEmacs '99. A company profile defines a set of extensions to MicroEmacs which encapsulate settings which are used on a company wide basis. This type of configuration is typically used with a networked (shared) installation. The company profile would typically include:-

• Name of the company.
• Standard header files including company copyright statements.
• Standard file layouts
• Company defined language extensions.

Location Of The Company Information

It is suggested that all of the company extensions applied to MicroEmacs '99 are performed in a separate directory location which shadows the MicroEmacs standard macro file directory. This enables the original files to be sourced if a user does not want to include the company files. This method also allows MicroEmacs to be updated in the future, whilst retaining the company files. For our example, we shall use a company called JASSPA, you should replace references to jasspa with your own company name. The steps involved are laid out as follows:-

Create a new company directory


You may skip this step if you are going to modify the standard installation.

Create a new directory to hold the company information. i.e.

/usr/local/microemacs/jasspa - UNIX
c:\Program Files\JASSPA\MicroEmacs\jasspa - Microsoft

Modify the $MEPATH(5) of the (of all users) to include the company directory on the search path i.e.

UNIX


Users edit their local $MEPATH or a base $MEPATH is added to the system .login or .profile scripts.

MEPATH=/usr/local/microemacs
MEPATH=/usr/local/microemacs/jasspa:$MEPATH

Microsoft Windows Platforms


Edit the me32.ini file and modify the mepath entry to reflect the location of the company directory:-

mepath=C:\Prog....\Mic...\macros\jasspa;C:\Prog...\Mic...\macros

DOS Platforms


Edit the autoexec.bat file and modify MEPATH to include the company directory location.

SET MEPATH=c:\me\jasspa;c:\me

Content Of The Company Information

Company macro file


The company file is typically called by the company name (i.e. jasspa.emf) create a new company file. The file includes your company name and hook functions for any new file types that have been defined for the company, an example company file for Jasspa might be defined as:-

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 
; 
;  Author        : Jasspa 
;  Created       : Thu Jul 24 09:44:49 1997 
;  Last Modified : <190698.2225> 
; 
;  Description     Extensions for Jasspa 
; 
;  Notes 
; 
;  History 
; 
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 
; Define the name of the company. 
set-variable %company-name "Jasspa" 
; Add Jasspa specific file hooks 
; Make-up foo file hook 
add-file-hook ".foo"    fhook-foo 
1 add-file-hook "-!-[ \t]*foobar.*-!-" fhook-foo ; -!- foobar -!- 
; Override the make with localised build command 
set-variable %compile-com "build" 

The file contains company specific file hooks and the name of the company.

Other Company Files


Files defined on behalf of the company are included in the company directory. These would include:-

• Template header files etf(8).
• Hook file definitions (hkXXX.emf) for company specific files, see add-file-hook(2).
• Extensions to the standard hook definitions (myXXX.emf) for company specific language extensions to the standard hook files. See File Hooks and File Language Templates.

SEE ALSO

$MENAME(5), $MEPATH(5), File Hooks, File Language Templates, Installation, user-setup(3), User Profiles.

(c) Copyright JASSPA 1999
Last Modified: 1998/08/30
Generated On: 1999/12/01