acs.geomaticien.org

Glossary

Daniel FAIVRE — 2009-07-08T03:04:49Z

Component : an ACS component is made with zero, one or more little parts of SPIP templates with an administration user interface.
Models : an ACS model is a SPIP templates set (a templates directory) with ACS components.
Nut : a nut is a small SPIP template part.
Pencil : little icon of a pencil to edit components from public pages of the website.
Template : pages are made from templates which formats contents read in database.

Module

Daniel FAIVRE — 2009-07-08T02:56:00Z

Module is a container for other components. From administration panel, just drag and drop a component in a Module and validate to change a Module content. Pages from Cat model contains differents Modules with seperate configurations, to customize any page content.


Module: (Cat version 0.5)

Margins and orientation are customizable. A vertical Module is a customizable column, and an horizontal one is an customizable horizontal block.

Pages pane of ACS control panel show which Module is in which page : just click on the Module in the page schema to edit the right Module.

Module

Daniel FAIVRE — 2009-06-07T02:22:25Z

Le composant Module est un conteneur pour d'autres composants. Depuis l'interface d'administration, il suffit de faire glisser un composant dans un Module puis de valider pour modifier le contenu d'un Module. Les pages du Modèle Cat contiennent différents Modules qui peuvent être configurés séparément, afin de personnaliser le contenu de chaque page.


Module: (Cat version 0.5)

On peut également régler les marges de chaque Module, ainsi que son orientation. Un Module vertical est une colonne personnalisable, et un Module horizontal une "ligne", un bloc horizontal personnalisable.

Il n'est pas nécessaire de mémoriser quel Module se trouve dans quelle page : il suffit d'aller sur l'onglet "Pages" d'ACS et de visualiser le schéma d'une page pour voir les Modules inclus dans cette page. Un clic sur un Module inclus amène directement sur la page d'édition de ce Module.

Migration to new ACS version

Daniel FAIVRE — 2008-08-27T20:49:21Z

0.4 => 0.5

(and 0.5 versions updates) Two cases :
Cat is not customized a lot : the most simple is to disable ACS plugin with the small icon to delete all ACS variables (in plugins administration page), and to re-enable ACS plugin.
if your ACS model Cat is fully customized, as many components changes with 0.5 version, you must insert components in Modules. This can be done in administration area, page by page and Module instance by Module instance.

0.3 => 0.4

0.3 was the first ACS release. Migration of parameters was NOT automated. Please go to administration interface, display all variables, and copy/paste this part in a text file. So, you get a backup of your 0.3 configuration values. After the upgrade of ACS from 0.3 to 0.4, you can configure new 0.4 components with old values.

Migration vers une nouvelle version d'ACS

Daniel FAIVRE — 2008-08-27T20:42:48Z

0.4 => 0.5

(et mises à jour de versions 0.5) Deux cas de figure peuvent se présenter :
vous avez peu personnalisé Cat : le plus simple est de désactiver le plugin ACS avec la petite icône permettant d'effacer ses variables (dans la page d'administration des plugins), puis de remettre en place le plugin : ACS sera ainsi automatiquement configuré avec les valeurs par défaut de la nouvelle distribution ACS-Cat. C'est de loin la méthode la plus facile et la plus rapide.
votre site est totalement personnalisé par ACS et ses pinceaux : beaucoup de composants ont changés de numéro d'instance en version 0.5, et il faut alors insérer les composants dans les Modules qui vous conviennent. On fait celà à partir de l'onglet pages de l'interface d'administration, en cliquant sur les Modules présents dans une page pour aller éditer le contenu de chaque Module, un par un.

0.3 => 0.4

La version 0.3 a été la première distribution d'ACS. La migration des paramètres lors d'un changement de version n'était pas automatisé. Rendez-vous dans l'interface d'administration, affichez toutes les variables, et copiez/collez cette partie dans un fichier texte. Vous aurez ainsi une sauvegarde des valeurs de tous vos anciens paramètres, permettant de configurer les nouveaux composants du modèle Cat d'ACS 0.4 avec les anciennes valeurs.

Lexique

Daniel FAIVRE — 2008-08-27T19:54:10Z

Composant : un composant ACS est un ensemble composé de zéro, un, ou plusieurs petits morceaux de squelettes SPIP (zéro, une, ou plusieurs "noisettes") doté d'une interface d'administration.
Modèle : un modèle ACS est un jeu de squelettes SPIP (un dossier squelettes) comprenant des composants ACS.
Noisette : une noisette est un petit morceau de squelette SPIP.
Pinceau : une petite icône en forme de pinceau qui permet d'éditer des composants depuis le site public.
Squelette : les pages "articles" d'un site SPIP sont crées à partir d'un squelette "article" qui met en forme l'article lu en base de données.

Les pinceaux

Daniel FAIVRE — 2008-08-05T03:37:39Z

A partir de sa version 0.4, ACS permet de mettre à jour n'importe quel composant ACS [1] à partir du site public.

Voici une petite vidéo qui en dira plus qu'un long discours [2] :

[1] Un composant ACS est constitué de zéro, une, ou plusieurs noisettes SPIP, pourvues d'une interface d'administration. Et n'importe quelle "noisette" (morceau de squelette) peut être facilement transformée en composant.

[2] Cette fonctionnalité utilise les plugins Crayons et Palette.

Gestion des droits avec ACS

Daniel FAIVRE — 2008-07-25T19:59:42Z

ACS permet une gestion des doits très fine (page par page) et surtout entièrement configurable par l'utilisateur de la partie privée de Spip (pour les droits d'accès aux articles sur la partie publique, voir ici [1]). La page d'administration d'ACS permet de créer des groupes d'administrateurs et de leur donner les droits d'usage exclusifs sur des pages de l'espace privé de SPIP.

Pour créer des groupes d'administrateurs, saisissez leurs noms séparés par des virgules, et validez. Ensuite, vous n'avez plus qu'à choisir les membres de vos groupes, et les pages qu'ils gèrent. Quand vous naviguez dans l'interface privée de SPIP, le nom de page correspond au paramètre exec passé dans l'url : il suffit de le lire dans la barre d'adresse de la page que l'on désire verrouiller.


Administration ACS: Sur cet exemple, on a crée un groupe Brèves qui contient une seule page, la page "breves". Ainsi, seuls les membres du group "breves" peuvent publier des brèves (qui ne sont ni signées ni liables à une traduction, contrairement aux articles).

Développeurs

ACS définit la fonction acs_acces("nomdepage"). Mise en début d'une page, elle en limite l'accès aux administrateurs autorisés, et redirige les autres sur une page "Accès non autorisé". Lorsqu'un administrateur de site SPIP va sur une page d'administration du site, ACS lit la valeur du paramètre exec passé à l'url par spip, qui est le nom de la page de l'espace privé appellée (conformément aux règles de rangement des fichiers dans SPIP).

ACS permet ainsi de limiter l'accès à n'importe quelle(s) page(s) de l'espace privé de SPIP à un groupe d'administrateurs autorisés.

Et comme ACS permet de modifier entièrement design et comportement d'un site, ACS définit un groupe par défaut, celui des administrateurs ACS du site, qui seuls ont accès aux pages de configuration du site. Comme on le voit sur l'exemple ci-dessus, ACS protège par défaut non seulement les pages les plus critiques pour le bon fonctionnement du site, mais aussi celles issues de certains plugins, s'ils sont installés. Cette liste est définie dans le fichier acs_options.php.

Au delà de ces exemples simples, il existe bien d'autres possibilités (controle d'accès aux fichiers action, par exemple, pour contrôler des droits de mise à jour critiques en Ajax, ...). Certains sites existants qui n'ont pas voulu ou pas pu adapter leurs squelettes pour une configuration web par ACS n'utilisent d'ailleurs ACS dans un premier temps que pour gérer des droits d'accès.

Enfin, c'est important, le mécanisme de contrôle d'accès d'ACS est conçu pour ne pas ralentir SPIP. Il rajoute seulement un test quasi instantané sur des valeurs déjà chargées par SPIP, sans aucun appel de page ni requête base de donnée supplémentaire.

[1] Gestion des droits d'accès aux articles : voir composant Articles à partir d'ACS 0.4, et composant Acces pour la version 0.3.

Component

Daniel FAIVRE — 2008-07-11T01:36:15Z

An ACS component is a page or a part of a spip page skeleton you can configure by your website interface, without editing any file.


Composant Fond

Webmaster, web-designer

Webmaster or web-designer configure appearence and working mode of the website by setting ACS and ACS choosen components from private area Configuration menu, submenu Configure website.

First, configure general options for all the site (by configuring Fond component, in Cat model), choose which optionnal components to activate, and then insert its in container components like Entete, Col1, or Col3, which respectively define optionnals components inserted as page header, column one, or column three of Cat model, a three-columns model.

Developpers

A component is an object, in programming terms, that comply with:
encapsulation: all about one component is in its component directory.
polymorphism: property names are unified for all components; appearance and functiunalities of one component can vary upon context or container; etc.
inheritage: a component can inherit some properties from another component.

On the public site, a component is a simple piece of Spip skeleton. On the private area, it is an object with web-configurable properties.

Insert an ACS component in a Spip skeleton

All active ACS model components can be included to Spip skeletons pages with the Spip tag : /}>

Components allows parameters:

/}{self=#SELF}{other parameter(s)}>

In these sample, passing #SELF enable Spip to distinguish caching rules. These astuce suits to get isolated Spip cache for "Ajaxified" components in Ajax mode, different from its container's Spip cache.

Create or modify ACS component

Create a skeleton directory with a composants sub-directory, or directly create your customized composants sub-directory in your existing skeleton directory,, and copy/paste one or more components from an existing ACS model directory (/composants). Do not forget to create a composants/config.php file with your personnal list of available components. Declare your skeleton's directory in ACS (Administration pane), and your customized components will be automatically included instead of same-named components from the active ACS model. Your skeletons may use components from the active ACS model, components inherited from these active ACS model modified by your own, and yours genuine new components.

Only one file is really mandatory to define a component, the composants//ecrire/composant.xml file.

Component directories and filel:

composants/composant : root

composants/composant/composant.html : component skeleton
composants/composant/composant.css.html : component stylesheet
composants/composant/lang/ : component lang files (public area)
composants/composant/composant.php : Optionnal class definition to implement pre-defined methods (like insert_head) for the component.
composants/composant/composant_balises.php : Optionnal component's Spip tags

composants/composant/ecrire/ : elements for private area
composants/composant/ecrire/composant.xml : component definition
composants/composant/ecrire/lang/ : component lang files for private area
composants/composant/ecrire/composant.php : Optionnal class definition définition optionnelle d'une classe to implement pre-defined methods (like afterUpdate) for the component.

composants/composant/img_pack/ : images and icon of the component.

composant.xml file

The component "C" is define by its composant.xml file (directory composants/C of active skeleton). Component's characteristics, parameters, and variables are defined in this file. Its syntax is copied from plugin.xml files in Spip.

nom: component name (canonical name in the developper's choosen language, preferentially between french, english, or esperanto)
auteur: component's authors
version: component version
version_acs_min: minimal ACS version.
version_acs_max: version max for ACS.
version_spip_min: minimal Spip version.
version_spip_max: version max of Spip.

param:
optionnel: true (nothing= false, by default), or meta variable name (activation if variable value is "oui"), or plugin plugin_name (activation if plugin plugin_name is active)
preview: true (nothing= false, by default). Preview height if numeric.

variable:
nom: variable name
type: type of variable: img, color, textarea, widget ...
valeur: default value. Can be an ACS variable name: in this case, default value is the ACS variable value.
chemin: "variable path". Default path for image type variable. Relative path from $GLOBALS['ACS_CHEMIN'] (accessible by tag #ACS_CHEMIN{mydir/myimage.png} from a skeleton).
label: "non" to not display a label for this variable.

Variables types	ACS controls
Color	color choice
Img	image choice, upload
LargeurBord	Border width choice
StyleBord	Border style choice
Nombre	Number input
Text	Short text input (text input)
Textarea	Long text input (textarea)
Choix	Choice
Widget	Components choice (container)
Hidden	hidden input

Example:


 
 MyComponent
 
 We © 2008 - licence GPL
 0.3
 0.3
 0.3
 1.9207
 1.9208


 
 optionnel
 true
 


 
 Color
 color

Component MyComponent define a color. These color is now usable everywhere in skeletons, as variable #CONFIG{acsMyComponentColor} (usually, a color will be used in the component's stylesheet (composants/mycomponent/mycomponent.css.html).

Syndic

Daniel FAIVRE — 2008-07-10T22:37:26Z

Composant blocs des sites et articles syndiqués.

Variable	Libellé
SyndicNbSites	Nombre de sites
SyndicNbArt	Nombre d'articles par site