acs.geomaticien.org

Documentation du code source

Daniel FAIVRE — 2024-10-03T00:34:24Z

Code source

Daniel FAIVRE — 2021-11-18T01:39:00Z

Code source : git.spip.net/spip-contrib-extensions/acs

Pour demander une nouvelle fonctionnalité, cliquez ici.

Et là pour signaler un bug.

Vous pouvez aussi télécharger les anciennes versions là.

Glossary

Daniel FAIVRE — 2009-07-08T05: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.

Cadre

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

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

Composant Cadre

Le composant Cadre est un conteneur pour d'autres composants.

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

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

Cadre

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

Cadre personnalisable pouvant contenir d'autres composants.

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

Composant Cadre

Le composant Cadre est un conteneur pour d'autres composants.

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

Il n'est pas nécessaire de mémoriser quel Cadre 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 Cadres inclus dans cette page. Un clic sur un Cadre inclus amène directement sur la page d'édition de ce Cadre.

Historique

Ce composant s'appelait "Module" dans les versions de Cat antérieures à la version 0.7.

Migration to new ACS version

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

n.n.n => 4.x.x (spip 4)
As some components changed, a local test is a good idea.
Save your ACS configuration, update Spip, update ACS with the Spip plugins update procedure. This update preserve the ACS configuration.
To update your ACS plugin with new fresh default values, uninstall ACS and re-install it.

- Documentation / Toutes versions

Migration vers une nouvelle version d'ACS

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

n.n.n => 4.x.x (spip 4)
Certains composants ayant changé, un test préalable en local s'impose.
Faites une sauvegarde de votre configuration d'ACS (par précaution), votre mise à jour de Spip, puis la mise à jour d'ACS à l'aide de la procédure d'installation automatique des plugins de SPIP. Cette mise à jour préserve la configuration précédente d'ACS (Pour remplacer la configuration précédente par les valeurs par défaut de la mise à jour, il suffit de désinstaller le plugin ACS (d'un clic (…)

- Documentation / Toutes versions

Lexique

Daniel FAIVRE — 2008-08-27T21: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.
– 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.
– Set : un set ACS est un jeu de squelettes SPIP (un dossier squelettes) comprenant des composants ACS.
– 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-05T05:37:39Z

ACS permet de mettre à jour n'importe quel composant ACS [1] à partir du site public. Le webmestre dispose de pinceaux sur le site public permettant d'éditer les composants.

[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.

Component

Daniel FAIVRE — 2008-07-11T03: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).