Changeset 133 for trunk/SRC/Colors/newpalette.pro

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Colors

Files:

• . (added)
• newpalette.pro (moved) (moved from trunk/SRC/ToBeReviewed/COULEURS/newpalette.pro) (2 diffs)

trunk/SRC/Colors/newpalette.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:newpalette
 ;
-; PURPOSE:permet de stocker la palette qui est a l''ecran dans un
-; fichier du meme type que celui fournit par defaut dans IDL:
+; @file_comments 
+; Allows to stock the palette which is on the screen
+; in a same type file than the one gave by default in IDL
 ; 'colors1.tbl'.
 ;
-; CATEGORY:pour garder ses jolies palettes perso.
+; @categories graphic, color specification
 ;
-; CALLING SEQUENCE:newpalette,nom_de_palette
+; @param namepal {in}{required} It is a string containing the name of the new palettte we want to write.
 ;
-; INPUTS:nom_de_palette: c'est un string qui contient le nom de la
-; nouvelle palette que l''on veut ecrire.
+; @keyword  OVER It is a whole number which designate the number of the palette
+;               we want to replace the palette on the screen 
 ;
-; KEYWORD PARAMETERS: 
+; @keyword FILE {default=palette.tbl} is not specified, we are looking  a file containing 
+;              palettes named palette.tbl.
+;              This file can be in any directory of the !path
+;              On the other hand it must be writable
 ;
-; OVER: c''est un entier qui designe le numero de la palette que l''on
-; veut remplacer par la palette a l''ecran.
-; 
-; + ceux de modifyct
+; @keyword _extra Used to pass your keywords
 ;
-; rq: si le mot cle file n''est pas specifie, on cherche un fichier
-; contenant les palettes du nom de palette.tbl.
-; Ce fichier peut etre dans n''importe quel repertoire du !path
-; Par contre il doit etre en droit d''ecriture
+; @history Guillaume Roulet (gr@lodyc.jussieu.fr)
+;                       30/3/1999 s.masson, add _extra, research of the full name, OVER
+;                       5/5/1999 s.masson
 ;
-; MODIFICATION HISTORY: Guillaume Roulet (gr@lodyc.jussieu.fr)
-;                       30/3/1999 s.masson, ajout de _extra, de le
-;                       recherche du nom complet, de OVER et du blabla
-;                       5/5/1999 s.masson, va copie eventuelle du
-;                       fichier contenant les palettes
+; @version $Id$
+;
+; @todo seb cleaning + traduction
 ;-
 ;------------------------------------------------------------
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-pro newpalette,nom, OVER = over, _extra = ex
-; le mot cle file est passe par l''intermediere de EXTRA?
-; definition du mon du fichier qui contient les palettes de couleur
+pro newpalette,namepal, FILE = file, OVER = over, _extra = ex
 ;
   compile_opt idl2, strictarrsubs
 ;
-   if n_elements(ex) NE 0 then BEGIN 
-      if (where(tag_names(ex) EQ 'FILE'))[0] NE -1 then nompal=ex.FILE ELSE nompal='palette.tbl'
-   ENDIF ELSE nompal = 'palette.tbl'
-   nomcourt = nompal
-; quelle est l''adresse complete de nompal?
-   nompal = find(nompal)
-   if nompal[0] NE 'NOT FOUND' then begin
-      nompal = nompal[0]
-; nompal nous appartient???
+; definition of the name of the file containing colors palettes.
+   if keyword_set(file) then nametbl = file ELSE nametbl = 'palette.tbl'
+   nomcourt = nametbl
+; What is the full adress of nametbl?
+   nametbl = find(nametbl)
+   if nametbl[0] NE 'NOT FOUND' then begin
+      nametbl = nametbl[0]
+; does nametbl is our?
       spawn, 'whoami', login
-      appartient = strpos(nompal, login[0])
+      appartient = strpos(nametbl, login[0])
       if appartient EQ -1 then begin
-         ouinon = report('Le fichier '+nompal+' ne vous appartient pas, Voulez-vous copier le fichier '+nomcourt+' dans le repertoire courant: '+current+' ?', /default_no, /question)
+         ouinon = report('Le fichier '+nametbl+' ne vous appartient pas, Voulez-vous copier le fichier '+nomcourt+' dans le repertoire courant: '+current+' ?', /default_no, /question)
          if ouinon then return ELSE BEGIN 
-            spawn, 'cp '+nompal+' '+nomcourt ; on copie
-            nompal = nomcourt
-            spawn,  'chmod u+w '+nompal ; on se donne les droits d''ecriture
+            spawn, 'cp '+nametbl+' '+nomcourt ; copy
+            nametbl = nomcourt
+            spawn,  'chmod u+w '+nametbl ; give writing rights
          ENDELSE
       endif
-   ENDIF ELSE BEGIN             ; aucun fichier nompal a ete trouve
-      nompal = nomcourt         ; on recupe le nompal d''origine
-      ouinon = report('le fichier de palettes demande '+nompal+' n''existe pas ds les repertoires !path. Voulez-vous cree un fichier '+nompal+' dans le repertoire courant', /default_no, /question)
+   ENDIF ELSE BEGIN             ; no file nametbl found
+      nametbl = nomcourt         ; we reclaim the nametbl source
+      ouinon = report('le fichier de palettes demande '+nametbl+' n''existe pas ds les repertoires !path. Voulez-vous cree un fichier '+nametbl+' dans le repertoire courant', /default_no, /question)
       if NOT ouinon then return
       nomfichsource = filepath('colors1.tbl', subdir=['resource', 'colors']) 
-      spawn,'cp '+nomfichsource+' '+nompal ; on copie
-      spawn,  'chmod u+w '+nompal ; on se donne les droits d''ecriture
+      spawn,'cp '+nomfichsource+' '+nametbl ; copy
+      spawn,  'chmod u+w '+nametbl ; give writing rights
    ENDELSE 
 
    if n_elements(ex) NE 0 then $ 
-    if (where(tag_names(ex) EQ 'FILE'))[0] NE -1 then ex.FILE = nompal
+    if (where(tag_names(ex) EQ 'FILE'))[0] NE -1 then ex.FILE = nametbl
 ;
    tvlct,r,g,b,/get
@@ -79 +73 @@
    b=congrid(b,256)
    IF n_elements(over) EQ 0 then over = 255
-   modifyct,over,nom,r,g,b,file=nompal, _extra = ex
+   modifyct,over,namepal,r,g,b,file=nametbl, _extra = ex
 ;
    return