Difference between pages "User:Mathieu/bot" and "User:Pascal/Collections/Deploy Deliverable D23"

From Event-B
< User:Mathieu(Difference between pages)
Jump to navigationJump to search
imported>Mathieu
m (Add a category to the last uploaded images)
 
imported>Pascal
 
Line 1: Line 1:
A bot may be a useful tool to help a wiki maintenance.
+
== Introduction ==
 +
The purpose of this page is to provide a template to define the common content for all sections of the DEPLOY Deliverable D23 (Model Construction and Analysis Tool II), as mentioned in the [http://bscw.cs.ncl.ac.uk/bscw/bscw.cgi/d103646/D23_Writing_Plan.pdf writing plan] for this document.
  
I tried to use the python framework provided by http://pywikipediabot.sourceforge.net/. Hereafter are some guidelines to make it work on this wiki.
+
This template takes into consideration the review feedback for the DEPLOY Deliverable D6 (Model Construction and Analysis Tool I).
  
== Requirements ==
+
== Template ==
* Python >2.5
+
For each item covered in this document (see the writing plan), a section shall be created to provide a description of work and describe the role of the WP9 partners during the passed year.  
  
== Getting pywikipedia framewok ==
+
=== Overview ===
Get the source code from subversion:
+
This first paragraph shall identify the involved partners and give an overview of the contribution. More precisely, it shall provide answers to the following questions:
<pre><nowiki>
+
* What are the common denominations?
(prompt) svn co http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia pywikipedia
+
* Is it a new feature or an improvement?
</nowiki></pre>
+
* What are the main purposes?
== Configuring the framework for this wiki ==
+
* Who is in charge of the tasks?
Add the following <tt>families/eventb_family.py</tt> file (be careful with the indentation):
+
* Who is involved among the academic and industrial partners? Who is involved as developer? Who is involved as user?
<pre><nowiki>
 
# -*- coding: utf-8  -*-
 
  
import family
+
=== Motivations ===
# The event-b family
+
This paragraph shall first indicate the state before the work and highlight the encountered problems. Then, it shall express the motivation for each tool extension and improvement (requirements of industrial partners).
# user-config.py: usernames['event-b']['event-b'] = 'User name'
 
class Family(family.Family):
 
    def __init__(self):
 
        family.Family.__init__(self)
 
        self.name = 'eventb'
 
        self.langs = {
 
            'eventb': 'wiki.event-b.org',
 
        }
 
  
        self.namespaces[4] = {
+
=== Design Decisions ===
            '_default': [u'Event-B', self.namespaces[4]['_default']],
 
        }
 
  
        self.namespaces[5] = {
+
=== Available Documentation ===
          '_default': [u'Event-B talk', self.namespaces[5]['_default']],
+
This paragraph shall give pointers to the available wiki pages or related publications. These documents may contain:
        }
+
* Requirements.
 +
* Technical details (specifications).
 +
* Teaching materials (tutorials).
 +
* User's guides.  
  
    def version(self, code):
+
A distinction shall be made between these categories and between documentation for developpers and documentation for end-users.
        return '1.11'
 
  
    def path(self, code):
+
=== Corrective and Evolutive Maintenance ===
        return '/index.php' #The path of index.php, look at your wiki address.  
+
This paragraph describes how bugs and feature requests are addressed.
  
    def scriptpath(self,code):
+
=== Planning ===
        return ''
+
This paragraph shall give a timeline.
   
+
More precisely, it shall give the current status of the new features (still under development, available prototype, available since release <math>M.m</math>), the current version of the features, describe the tasks which have already been completed and announce planned further work and deadlines (release versions of the Rodin platform).
#    def shared_image_repository(self, code):
 
#        return ('commons', 'commons')
 
      '_default': [u'Event-B talk', self.namespaces[5]['_default']],
 
</nowiki></pre>
 
  
Then add the following <tt>user-config.py</tt> file:
+
== Formatting rules ==
<pre><nowiki>
+
In order to homogeneize the contributions and to ensure consistent spelling the following formatting rules shall be enforced:
family='eventb'
+
* See §4 of [http://wiki.event-b.org/images/Llncsdoc.pdf How to Edit Your Input File] for LLNCS formatting rules.
mylang='eventb'
+
* Contractions shall not be used (eg. write "does not" instead of "doesn't", "let us" instead of "let's", etc).
usernames['eventb']['eventb'] = 'your_bot_user_name'
+
* "plug-in" shall be preferred to "plugin".
</nowiki></pre>
 
  
== Usage ==
+
== Example ==
=== Login ===
 
First you should log in:
 
<pre><nowiki>
 
(prompt) python login.py
 
</nowiki></pre>
 
=== Upload Images ===
 
<pre><nowiki>
 
(prompt) python upload.py -noverify -keep file.png "Image description"
 
</nowiki></pre>
 
 
 
For uploading several images from a directory, I use the following ''sh'' command:
 
<pre><nowiki>
 
for i in /tmp/imagedir/* ; do (yes | python upload.py -v -noverify -keep $i "Import of image $i"); done
 
</nowiki></pre>
 
 
 
 
 
=== Add a category to the last uploaded images ===
 
For the last 20 images, do :
 
<pre><nowiki>
 
python category.py -v add -newimages:20
 
</nowiki></pre>
 

Revision as of 15:20, 2 November 2009

Introduction

The purpose of this page is to provide a template to define the common content for all sections of the DEPLOY Deliverable D23 (Model Construction and Analysis Tool II), as mentioned in the writing plan for this document.

This template takes into consideration the review feedback for the DEPLOY Deliverable D6 (Model Construction and Analysis Tool I).

Template

For each item covered in this document (see the writing plan), a section shall be created to provide a description of work and describe the role of the WP9 partners during the passed year.

Overview

This first paragraph shall identify the involved partners and give an overview of the contribution. More precisely, it shall provide answers to the following questions:

  • What are the common denominations?
  • Is it a new feature or an improvement?
  • What are the main purposes?
  • Who is in charge of the tasks?
  • Who is involved among the academic and industrial partners? Who is involved as developer? Who is involved as user?

Motivations

This paragraph shall first indicate the state before the work and highlight the encountered problems. Then, it shall express the motivation for each tool extension and improvement (requirements of industrial partners).

Design Decisions

Available Documentation

This paragraph shall give pointers to the available wiki pages or related publications. These documents may contain:

  • Requirements.
  • Technical details (specifications).
  • Teaching materials (tutorials).
  • User's guides.

A distinction shall be made between these categories and between documentation for developpers and documentation for end-users.

Corrective and Evolutive Maintenance

This paragraph describes how bugs and feature requests are addressed.

Planning

This paragraph shall give a timeline. More precisely, it shall give the current status of the new features (still under development, available prototype, available since release M.m), the current version of the features, describe the tasks which have already been completed and announce planned further work and deadlines (release versions of the Rodin platform).

Formatting rules

In order to homogeneize the contributions and to ensure consistent spelling the following formatting rules shall be enforced:

  • See §4 of How to Edit Your Input File for LLNCS formatting rules.
  • Contractions shall not be used (eg. write "does not" instead of "doesn't", "let us" instead of "let's", etc).
  • "plug-in" shall be preferred to "plugin".

Example