1 / 202

Training SIST

Training SIST. Plan. PART I : Presentation of SPIP-Agora PART II : Development of a site PARTIE III : The SIST project. Plan - PART I : Presentation of SPIP Agora. What is a CMS? (Content Management System) The SPIP framework The SPIP-Agora branch. Plan - PART II : Development of a site.

maja
Download Presentation

Training SIST

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Training SIST

  2. Plan • PART I : Presentation of SPIP-Agora • PART II : Development of a site • PARTIE III : The SIST project

  3. Plan - PART I : Presentation of SPIP Agora • What is a CMS? (Content Management System) • The SPIP framework • The SPIP-Agora branch

  4. Plan - PART II : Development of a site • Installation of SPIP-Agora • General Principles of SPIP-Agora • The sources

  5. Plan - PART III : The SIST Project • Presentation • The elements to be manipulated • The specific SIST key words • Creating sections • Creating articles • The federated research engine : Hubble • The OAI harvester : Cyrus • The indexed sites research engine : Magellan • The RSS research engine : Gutenberg • The MySql online research engine : MySQLFinder • The alert management system • The Wiki

  6. Plan • PART I : Presentation of SPIP-Agora • PART II : Development of a site • PART III : The SIST project

  7. Part I Presentation of SPIP Agora

  8. PART I : Presentation of SPIP Agora • What is a CMS (Content Management System) • The SPIP framework • The SPIP-Agora branch

  9. PART I : Presentation of SPIP Agora • What is a CMS (Content Management System) • The SPIP framework • The SPIP-Agora branch

  10. Traditional work on a Website • The use of a software for designing Web pages (graph worksheet, text editor ...). • Manual sending of pages by FTP. • Each page must be created or modified manually. • It is difficult to set up a rich and complex browsing. • The content is part of the form. • The webmaster is the compulsory passage point to put modifications on line.

  11. Working on a Website with an automated system • Separating the content from the form (the content, the appearance). • For the content : • Creating the content by using an interface on line (HTML, Web forms) • Elimination of technical barriers : no need for a specific knowledge • Co-operative work : as many contributors as possible • Management of modification rights : different powers depending upon the contributors • Automating advanced functions : fora, search engines... • For the form : • The way in which all the texts are posted is codified in a single area. • Easy setting up of a complex browsing, which evolves automatically.

  12. Content Management Systems • These are the editorial publication systems for the web, designated under the term junk box of Content Management Systems (abridged in English as CMS). • Current Characteristics : • Thematic Classification and sophisticated browsing • Process of publication : the texts can be prepared in private, and then proposed and put on line • System of internal deliberation (Editorial Committee) • Integrated Search Engine • Syndication (inter-site exchange of news) • The best known ones: • PhpNuke/PostNuke, EzPublish, Typo3, Mambo and obviously SPIP and SPIP-Agora

  13. PART I : Presentation of Agora SPIP • What is a CMS (Content Management System) • The SPIP framework • The SPIP-Agora branch

  14. The SPIP framework • A Publication System for the Internet. • It is about a group of files, installed on your Web account, which enable you to benefit from a certain number of automatic devices • manage multiple sites, • setting up your articles without having to type from HTML, • modify the structure of your site very easily ... • With the same software which helps one visit a site (Netscape, Microsoft Explorer, Mozilla, Opera...) • SPIP allows one to create and update a site, through a user-friendly interface. • SPIP is oriented towards the creation of a site structured like a magazine : • with sections, sub-sections (and so on) • in which articles and briefs are inserted and can be completed with discussion fora.

  15. Why SPIP? • SPIP is a free software distributed under GNU General Public Licence (GPL) • The software and material needs of SPIP are reasonable and are even found free of charge with some hosts. • PHP+MySQL.

  16. The interest of SPIP is to …. • Manage a Website in the form of a magazine, • composed mainly of articles and briefs incorporated in a tree diagram of sections fit into each other. • Separate entirely, and distribute three types of tasks among different people: • the graphic composition, • the editorial contribution through proposing articles and briefs, • and the editorial management of the site (a task which consists of organising sections, the validation of proposed articles ...). • Exempt the webmaster and all the participants, in the life of the site, from some number of tedious aspects of publication on the Website • SPIP limits technical knowledge that is too long to acquire. • The installation of SPIP is done through a simple and a step by step interface, at the end of which you can start to create your sections and articles.

  17. The characteristics of SPIP (1/2) • For the editors and administrators • An intuitive Web interface makes it extremely simple to propose articles and briefs as well as the editorial management of the site. • Typing shortcuts enable the formatting of a text without having to use the HTML language, thereby making the editorial contribution accessible to all, and as simple as the writing of an e-mail. • For the webmaster • The graphic and the browsing aspects are defined by HTML template (or « format types ») each defining a « view » • (for example : a view for the index page, another showing a section and a summary of its content, a third for the detail of an article, a fourth for the detail of a brief). • The way in which the editorial content of the site is incorporated into these pages is defined by some number of HTML pseudo-tags relatively easy to master (loops). • Constraints : • One needs to pay attention to the level of graphics. The ideal thing to do so as not to have to use PHP, is to see to it that you have blocks. A block for the sections, a block for the articles…

  18. The characteristics of SPIP (2/2) • For the visitors • A cache system on the public part of the site • It accelerates the site by avoiding a great number of requests on the database, and it plays an additional role of defence against the crashes of the said base (frequent on « overloaded » servers) • The website remains available transparently, even if any modification of contents is impossible (including contribution to fora). • A Search Engine and an indexation integrated to SPIP • If it is activated by the webmaster, it enables research to be carried out on the entire public content of the site.

  19. The disadvantages of SPIP • A knowledge of HTML is required • For now, the flexibility of SPIP implies that a little effort of learning is required for the webmaster to modify the presentation by default. • It is better for the webmaster under SPIP to know a minimum of HTML to enable him/her to then do almost what he/she wants to do. • Ownership of the SPIP language • In order to create dynamic web pages, SPIP enriches the HTML language with its own markers (the notion of loops tackled later). As time goes on with the versions of SPIP this « language » gets beefed up by certainly becoming much stronger but also more complex. • Use of predefined templates • In terms of its content (sections, articles, briefs) each page is associated with a template. This can make the site less modular.

  20. Some websites created under SPIP • http://www.pays-vignoble-nantais.org • http://www.valvert.org • http://www.synercom-france.com

  21. PART I : Presentation of SPIPAgora • What is Content Management System? • The SPIP framework • The SPIP-Agora branch

  22. Where from SPIP-Agora? • Because the SPIP framework was not completely satisfying the demand, the French Government mandated the CleverAge Company to take care of the development of additional functions, this gave birth to the « Agora » version • SPIP-Agora is based on version 1.8 of SPIP • SPIP-Agora federates its own community, but there are linkages between SPIP and SPIP-Agora and each of the two communities keeps an eye on the other one reciprocally. • It is possible for the 2 versions to converge again.

  23. SPIP-Agora versus SPIP • Agora picks up the whole of the functions of SPIP by enriching them especially on • the management of content, • documentary management, • the validation chain, • the management of profiles. • Agora allows for website structure that is more complex through the management of « key words » in a tree diagram. • Agora can be connected to other types of databases than Mysql. • Complementary modules enlarge the tools at the disposal of the webmaster: • opinion polls, • news letters, • document search engine, • marker type of statistics.

  24. Plan • PART I : Presentation of SPIP Agora • PART II : Development of a website • PART III : The SIST project

  25. Part II Development of a site

  26. PART II : Development of a website • Installation of SPIP-Agora • General Principles of SPIP-Agora • The sources

  27. PART II : Development of a website • Installation of SPIP-Agora • General Principles of SPIP-Agora • The sources

  28. Recovering sources • Recover the ZIP on your machine • Decompress it • Go into the SPIP folder that it contains • Upload the whole list on the web server supporting PHP (extensions .PHP and .PHP3...) and MySQL

  29. Launching the installation • Launch the installation script http://mon_serveur/ecrire/ (mon_serveur is the url of the website that you are going to create) (we presume that SPIP has been installed at the root of the website)

  30. Modification of rights on the documents SPIP-Agora requires the statement of specific rights on some folders for the internet user of your server : • # chmod xxx –R /var/www/html/[MON_SITE]/CACHE • # chmod xxx –R /var/www/html/[MON_SITE]/IMG • # chmod xxx –R /var/www/html/[MON_SITE]/ecrire/include/bd

  31. Installation of the PEAR layer • SPIP-Agora uses the abstraction PEAR layer for access to databases and other functions. The latter must therefore be installed on your server. • # pear install Date • # pear install Log • # pear install DB_NestedSet

  32. Parameterisation of access to data • You now have to specify access to the database: • Get information on the different parameters : type of base, server, name of the base, user of the connection, password, prefix of the tables to be installed

  33. Definition of the administration account • Once the base is created, one has to now specify the « administrator » account, that is the user who will have all the privileges:

  34. For SPIP-Agora, it ’s finished ! • At this stage, the installation is ended. • Click on « Next » to remain there or on « Install complementary data» to install groups of predefined keywords.

  35. Installation of MnoGoSearch (1/2) • SPIP-Agora functions with the document indexation and websites engine : MnoGoSearch. • This is an independent software which must be installed independently • Download the last version of MnoGoSearch in the tar.gz format • Copy the file mnogosearch-x.y.z.tar.gz previously downloaded in publication index of your web server • Proceed with the installation of MnoGoSearch by typing the following commands: • # tar -zxf mnogosearch-x.y.z.tar.gz • # cd mnogosearch-x.y.z • # ./configure --prefix=[PATH_REP_PUBLI]/mnogosearch –with-mysql • # make • # make install • Specify the rights of operations on the mnogosearch/sbin/ index and on the CGI scripts it contains.

  36. Installation of MnoGoSearch (2/2) • Create the mySql database for MnoGoSearch (via phpMyAdmin or via a Unix command) • Parameterise the configuration file mnogosearch/etc/indexer.conf • Specify the DNS of the mySql base dedicated to MnoGoSearch (variable DBAddr) • Indicate the sites that you want to index • Launch the creation of base tables • # ./indexer –Ecreate • Launch the indexation • # ./indexer –a –v • Consult the following url in your browser to check that everything is functioning: • http://mon_serveur/mnogosearch/bin/searchSIST.cgi?q=[MOT_CLEF] • ou [MOT_CLEF] is a word to be looked for.

  37. PART II : Development of a website • Installation of SPIP-Agora • General Principles of SPIP-Agora • The sources

  38. What you should know before any other thing • The whole content of a site managed under SPIP-Agora is installed in a MySQL database. • In order to present this information to visitors of the website, you must carry out the operation which consists of reading the information, organising and typesetting them, in order to post an HTML page in the Web browser. • This operation is normally quite painful: • you must know the PHP and MySQL, programming and write the relatively complex « routines »; • The inclusion of such routines in the development of the HTML typesetting is quite difficult; • you must take into account performance problems: systematic recourse to the MySQL and PHP code is demanding in terms of resources, slows down the visit and, in extreme cases, it provokes crashes of the Web server. • SPIP proposes a complete solution in order to surmount these difficulties : • the typesetting of the website is done through HTML pages called templates, containing simplified instructions that enable one to indicate where and how information drawn from the database is placed on the page; • a cache system allows for the saving of each page and thereby avoiding calling on the database during each visit. • Not only is the load on the server reduced, but the speed is highly improved upon, and in addition a site under SPIP-Agora remains consultable even when the MySQL base is installed.

  39. For each type of document, a couple of files • The interest (and the limit) of a system of automated publication is that one is not going to redefine a different interface in HTML for each isolated page. • For example, all the articles will benefit from the same interface, the system will simply place different information in this graph (one will see later that SPIP-Agora however authorises some flexibility). • The advantage of this way of procedure is obvious: • one defines a format-type (template) for, for instance, all the articles, all the sections… • the system will manufacture each individual page by automatically placing the title, the text, the browsing links... Of each article. • For each type of document, SPIP will ask you for two files : • A .php3 file • A .html. file • During the installation of SPIP, you will therefore find the pairs : « article.php3 / article.html », « rubrique.php3 / rubrique.html », etc. You can naturally modify these pairs, and create others.

  40. The principle of the functioning of a cache • Calling for a specific page is done through the .php3 file • for example, to call for article n°5, the corresponding URL is: http://dev.formation-spip.lnet.fr/article.php3?id_article=5 Remarks : Here we see that each web page is individually put in a cache, and each recalculation is generated by the visits to the site. There is not, in particular, a recalculation of all the pages of the site all at once at regular intervals.

  41. The .php3 file (1/2) • The « .php3 » file is very simple. • For example, article.php3 uniquely contains : • <?php $fond = "article"; $delais = 24 * 3600; include ("inc-public.php3"); ?> • Its aim is to fix two variables ($fond and $delais) and to call for the file which generates the functioning of the SPIP-Agora (inc-public.php3).

  42. The .php3 file (2/2) • The $fond variable • Specifies the name of the file which contains the description typesetting (the template). • Here, since $fond="article", the description file will be in article.html. • Note it well that, in the $fond variable, one does not indicate the ending « .html ». • The $delais variable • this is the maximum age for the use of the file stored in /CACHE. • This time limit is fixed in seconds. • A time limit of 3600 therefore corresponds to one hour; • a time limit of 24*3600 is therefore 24 hours. • We will play in this value in terms of the frequency of additions to site content (new articles, new briefs...).

  43. Some recommendations on…. • … The name of the template file ($fond) • The interest of making one ’s own choice of the name of the template file (which one could automatically deduce from the .php3 file) is, if necessary, to use another name. • This is eventually not to crash the HTML file which would exist from an older version of the website which one would not wish to cancel.. • … The deadline of presence in the cache ($delais) • Fixing a very short deadline enables you to have an updated site much faster in relation to the stored content in the base… BUT, fixing a very short deadline hampers performance, site visits are very much slowed down. • The use of fora on the site does not compulsorily involve the fixing of a very short deadline. • SPIP manages this aspect automatically; when a contribution on a forum is posted, the corresponding page is erased from the cache, and recalculated immediately, no matter the deadline fixed for this page.

  44. The .html file • In SPIP-Agora, we call the .html file « the templates ». • It is they that describe the graphic interface of your pages. • They are written in HTML • They are placed in the index /display • To them, we add instructions indicating to SPIP-Agora where it has to place the information coming from the database: • Place the title here • Indicate here the list of articles on the theme «Africa» • Etc… • Instructions about placing the elements are written in a specific language. • Besides, this language constitutes the «only» difficulty of SPIP. • It is a mark up language, that is a language using markers similar to those of HTML.

  45. A different interface in the same site • It is possible to create a couple of files for the same logical element (articles, sections, ...). • For example, you can create files to visit the same article with different interfaces: • article.php3/html for the normal format , • print .php3/html for the same article in a format adapted to the print, • article-texte.php3/html for the article in a text format (adapted to the partially-sighted for instance), • article-lourd.php/html with a very rich interface adapted to the high output, etc. • A different interface depending on the sections. • You can, for the same type of document, create different templates depending upon the sections of the site. It is a matter of simply creating new files of .html in relation to the sections. • One has to complete the name of the template file of « -number » (a dash followed by the number of the section). • For example, if you create a file: article-60.html, all the articles in the section n°60 will use the template (and no longer the template by default article.html). • Note carefully : the number indicated is that of a section. If this section 60 contains sub sections, the articles contained in these sub sections will equally use a new template article-60.html. • Comment : In our example, we will equally certainly have the interest to create a section-60.html, thus a brief-60.html, etc. to accompany the change in typesetting of these sections.

  46. What can one put in a .HTML file? • The .html files are essentially «text» files, complemented with instructions on placing elements in the database. • SPIP-Agora mainly analyses instructions of placing elements of the database (coded according to the specific language of the SPIP-Agora) ; it does not bother about what is placed in the file and which does not correspond to these instructions. • Their essential content is therefore from HTML. • You will determine the typesetting, the version of the HTML that is desired, etc. • You can obviously include sheets of type (CSS), but also of JavaScript, of Flash... In bold: all that we normally place in a Web page. • All the pages returned to the visitor are drawn from /CACHE by a written page in PHP. • You can therefore include in your templates instructions in PHP, they will be implemented during the visit. • Used in a rather fine way, this possibility enables a great flexibility to SPIP-Agora, you can therefore complete (for instance adding a meter, etc.), or even make some typesetting elements evolve in line with information drawn from the database.

  47. PART II : Development of a website • Installation of SPIP-Agora • General Principles of SPIP-Agora • The sources

  48. The sources • SPIP Documentation • SPIP reference Documentation : http://www.spip.net/fr • Various contributions : http://www.spip-contrib.net/ • SPIP-Agora Documentation • Reference Site : http://www.agora.gouv.fr/

  49. Plan • PART I : Presentation of SPIP Agora • PART II : Development of a site • PART III : The SIST project

  50. Part III The SIST project

More Related