diff --git a/bin/publish.py b/bin/publish.py
index 3cfa5a3..997f265 100644
--- a/bin/publish.py
+++ b/bin/publish.py
@@ -354,9 +354,15 @@ class Publisher:
pageFile = file(pageFileName)
pageContent = pageFile.read()
pageFile.close()
- # Extract the page title
- i, j = pageContent.find(''), pageContent.find('')
- pageTitle = pageContent[i+7:j]
+ # Extract the page title (excepted for the main page, we don't
+ # need this title, to save space.
+ pageTitle = ''
+ if pageName != 'index.html':
+ i, j = pageContent.find(''), \
+ pageContent.find('')
+ pageTitle = '
%s
' % pageContent[i+7:j]
# Extract the body tag content from the page
pageContent = self.pageBody.search(pageContent).group(1)
pageFile = open(pageFileName, 'w')
@@ -489,7 +495,7 @@ class Publisher:
self.uploadOnPypi(tarball)
if self.askQuestion('Publish on appyframework.org?', default='no'):
AppySite().publish()
- if self.askQuestion('Delete locally generated site ?', default='yes'):
+ if self.askQuestion('Delete locally generated site ?', default='no'):
FolderDeleter.delete(self.genFolder)
# ------------------------------------------------------------------------------
diff --git a/doc/AppyManifesto.odt b/doc/AppyManifesto.odt
new file mode 100644
index 0000000..6930749
Binary files /dev/null and b/doc/AppyManifesto.odt differ
diff --git a/doc/appy.css b/doc/appy.css
new file mode 120000
index 0000000..1c2b021
--- /dev/null
+++ b/doc/appy.css
@@ -0,0 +1 @@
+../gen/ui/appy.css
\ No newline at end of file
diff --git a/doc/gen.html b/doc/gen.html
index 85eceed..f96524b 100644
--- a/doc/gen.html
+++ b/doc/gen.html
@@ -12,32 +12,6 @@
gen generates code that will run on Plone 2.5. Soon, the code will also be compatible with the latest Plone version. In my point of view, Plone 2.5 has reached the maximum level of complexity a Python developer may tolerate. Plone 2.5 heavily relies on Zope 2. While Plone 3 still runs on Zope 2, it has become heavily based on Zope 3 through the use of the "Five" product (=Zope 2 + Zope 3), that allows to use Zope 3 functionalities within Zope 2. Some people began to be angry about how complex certain tasks (like creating a portlet) became with Plone 3 (consult this, for instance.) In order to fight against this trend, we decided to create a new code generator (a kind of concurrent to ArchGenXML so) that already makes sense for Plone 2.5 and will be more and more relevant for the current and future Plone versions, as the Plone community took the debatable decision to move to Zope 3.
-
Before starting, let's get bored by some (counter-)principles that underlie gen
-
-
If you have strict deadlines, skip this.
-
-
The code-centric approach. Other approaches for generating code like the idea of starting from some abstract vision like a (graphical) model (boxes, arrows, things like that); from it, tools generate code skeletons that need to be completed in a subsequent "development" phase. Such "transformational" approaches (I vaguely know some buzzwords for it: MDA, MDD I think) may even count more than two phases and manipulate different models at different abstraction levels before producing code (I am not joking: I've learned that at the university). Such approaches spread the information in several places, because every model or representation has limited expressivity. It produces redundancy and eventually leads to maintenance problems. It violates the DRY principle, which is closely related to our null-IT principle. On the contrary, gen knows only about code. The "model" you write is a simple Python file or package. Being written in a high-level programming language, it does not constrain your expressivity in any way. More important: this code *is* the running code, and thus the only place where you describe your software. Simply, "wrappers" are added to it in order to plug him into the low-level Plone and Zope machinery. A gen-powered Python program acts like a comedian manipulating a tuned marionette: simple moves from the comedian produce complex, cascading and funny behaviours at the puppet level. Moreover, a code-based approach has the following benefits:
-
-
when using a graphical model, you are emprisoned into a poorly expressive notation. Let's take an example. If you express a state machine with a UML state diagram, how will you be able to define another state machine based on the previous one? If you express it with code, it is as simple as using class inheritance. Typically, with appy.gen, you may achieve nice results like workflow inheritance; it is completely impossible with ArchGenXML. Of course, using graphical models for communicating or focusing on some parts of your program may be very valuable; this is why we foresee to implement model generation (class diagrams, statecharts, etc) from a appy.gen application. This is our way to see how to use graphical models: as views generated from the code. We don't believe at all in approaches like generating code from models or round-trip engineering.
-
when using some centralized code repository like subversion, a UML model, for example, is typically stored as a binary file. So it is impossible to work concurrently on various parts of it; nor is it possible to view who has changed what in it, etc;
-
factoring similar groups of attributes or doing other intelligent treatment on a graphical model is not possible;
-
there is no need to write and maintain a model parser (like XMI);
-
yes, you can use cut-and-paste with any text editor! If you want to do similar things with a model, you will probably need to buy some expensive UML editor;
-
-
Violating the model-view-controller pattern (and a lot of other patterns, too). Design patterns are elegant low-level constructs used to overcome the limitations of programming languages (ie statically-typed languages like Java) or frameworks. Using them implies adding classes just for making the plumbery work; it augments code complexity and, again, spreads information at several places. Separating code describing data from code presenting it produces the same problem. appy.gen takes the approach of grouping everything at the same place. For example, information that dictates how a given field will be displayed is part of the field definition.
-
-
All-in-one objects. As a consequence of the two previous bullets, gen objects (which are Plain Old Python Objects: you do not even have to inherit from a base gen class!) are self-sufficient. If you want to understand some (group of) functionality within a well-designed gen Python program, you will not loose yourself walking through an intricate web of Python classes and XML definition files.
-
-
Building complex and shared web applications. While Plone and related tools are mainly targeted at building CMS websites (Content Management Systems = websites whose content may be edited by normal human beings), they provide poor support for those who want to build complex and shared web applications.
-
-
-
By "complex", I mean real "business applications" (or "information systems", like accounting systems, HR systems or online booking systems) whose interfaces are web interfaces; a "CMS" website being a particular case whose main purpose is to provide information (the website of a city or a company, etc) with some limited degree of interaction with the user. Web business applications are characterized by (1) a rich conceptual model featuring a complex web of inter-related classes. Moreover, such applications also need (2) complex querying and reporting facilities, be it through-the-web or within generated documents. Standard Plone provides little support for both (1) and (2). For instance, the basic reference fields and widgets are embryonic (ie no built-in notion of order among references): creating complex inter-related objects is tedious. Standard Plone does not provide any standard document-generation solution and provides limited through-the-web querying facilities. appy.gen comes with a brand new ordered Reference field/widget that automates a lot of repetitive programming tasks and yields unexpected recurrent visualization possibilities. Through its integration with appy.pod, any gen-powered app is by default ready for document generation. gen also generates paramerized through-the-web views and queries.
-
-
Currently, free software is widespread within the "IT infrastructure" (operating systems, networking components, web servers, application servers...) and contaminates more and more general-purpose software applications, like word processors, spreadsheets or multimedia players. For the most of it, the free movement currently reaches domains where requirements are either perfectly known by the developers themselves, deduced from observing proprietary software or part of some general cultural background. In order to raise freedom at the higher levels of business and innovation, we need new mechanisms allowing to tackle (business-)specific requirements, while maintaining the possibility to spread and share software from one organization to the other. appy.gen was built to cope with this new scale of challenges and proposes a set of built-in constructs for creating generic business kernels implementing common requirements and allowing to tailor it to the specific needs of a given organization. This work results from experience gained from a deep involvement in the PloneGov community, an international group of public administrations developing and sharing free software for their own needs. It also benefits from a close collaboration with several research initiatives (the PRECISE research center and the MoVES project) exploring Software Product Lines Engineering and inventing new ways to manage variability among software systems.
-
-
-
-
Getting started with gen
Read only this if you want to run a "Hello world" gen application on your machine. This section is dedicated to Joel, a tremedous application and framework tester that ignores the essence of his gift.
diff --git a/doc/img/gen.png b/doc/img/gen.png
new file mode 100644
index 0000000..e6616ce
Binary files /dev/null and b/doc/img/gen.png differ
diff --git a/doc/img/pod.png b/doc/img/pod.png
new file mode 100644
index 0000000..52e6480
Binary files /dev/null and b/doc/img/pod.png differ
diff --git a/doc/img/star.png b/doc/img/star.png
new file mode 100644
index 0000000..2e1b02f
Binary files /dev/null and b/doc/img/star.png differ
diff --git a/doc/index.html b/doc/index.html
index 8d37cec..2cb9f0d 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -4,24 +4,55 @@
-
Appy (Applications in python) is a bunch of tools distributed under the GPL license for developing applications in the Python programming language. The framework features two main modules: gen and pod.
-
-
Developers, too, have the right to (h)appyness !
-
-
Developers are often guys that live on another planet. Some think this is because software development is so exciting that everything else is poorly considered. At Null-IT software, we are deeply convinced that most developers do not enjoy themselves. They spend their lives together with complex problems that never go away from their minds. Nobody understands them. Their family? Their managers? Their clients? Their friends? No. Nobody. Nobody is able to imagine how huge and complex their tasks are. Consequently, what they do is underestimated. Worst: they can't communicate. Don't believe this is due to some intrinseque geek attitude. Their geekness results from the global incapacity to apprehend the very nature of their abilities. So they are forced to work harder while experiencing the true impossibility to share their permanent software experience. Of course, it may lead to social disasters.
-
-
By publishing this high-level, easy-to-use software construction kit, itself based on the tremendously productivity-boosting Python programming language, our crazy hope is to empower developers in such a way that they can leave more often their software prison and spend more time to discover real life.
-
-
But (h)appyness has a price. Appy developers themselves accepted to pay. They have dealed their social life for one of the highest forms of social denial (sorry we can't reveal their working conditions), hoping their sacrifice will free the users of their work. So if one day you meet one of them, please be gentle and patient. But they will probably not discuss with you.
-
-
The null-IT principle
-
-
Our action is guided by the following principle:
-
-
Information Technology (IT) should be as transparent and invisible as possible.
-
-
While this may seem obvious, this principle is largely ridiculed by a great number of widespread technologies. I will mention here JEE and XSL-FO which were taken as counter-examples while developing pod. In the Python world, Zope 3, by trying to mimick the ridiculous JEE component-model where code is viciously chopped into undersized chunks interconnected by obscure XML declarations, falls unfortunately into this category as well. This is a pity seeing Zope guys trying to abandon the elegant, simple, powerful (in a word: Pythonic) design of Zope 2. But don't be scared! Many people think that Zope 2 will last for many years... Null-IT, with others, is working hard to fight against the generalized Balkanization attitude that undermine IT innovation. If you believe there is still place for hope, you came at the right site. It is time to discover gen!
+ gen - Create web apps without knowing anything about web technologies. Just pure Python.
+ You are a small team? A one-man-show? You are bored with technicals details preventing you
+ from being creative and productive? You think conceptual but prefer coding over drawing? You want to do more
+ with less effort? You consider code as an art? You know that beauty comes with simplicity?
+ gen is made for you.
+
+ Some people say I will kill my business by publishing my secret weapon.
+ What more soothing suicide could I dream than Appy's wide adoption?
+
+ pod - Create dynamic documents in .pdf, .doc, .odt or .rtf in a few minutes.
+ Producing dynamic reports can be SO simple. Use Libre/OpenOffice to create a document template, write some Python
+ expressions in it, launch pod and you're done. pod (Python Open Document)
+ wants to be as smaller as possible. Use your word processor as much as you can. Then switch to
+ pod only for the tricky things.
+
+ During the dark ages of software development, creating a single page of report with JEE and XSL-FO
+ could took up to 2 weeks. Since Gaëtan made pod, the same task can be done in ten minutes.
+
+