There are literally hundreds of tools and frameworks that have been developed for the purpose of creating websites. Generally, these tools fall into one of two camps:
On the other end of the spectrum are frameworks that are designed for professional programmers. These tools view the creation of complex websites as a programming activity and quickly digress into code editors and class hierarchies. Typical web designers, not well-versed in programming, are shut out of these tools due to their complexity. Typical failings of these tools include:
GenHelm seeks to solve these common problems by providing a tool that bridges the chasm between typical WYSIWYG tools and website frameworks. Let's learn how this is done.
GenHelm embraces the notion that all web pages (or page components) can be classified into a certain category. For example, many websites have similar pages such as Frequently Asked Questions (FAQs), Contact Us, Sitemap, Blogs, etc. GenHelm seeks to develop specialised models for all sorts of pages that are typical across websites and to identify the key "inputs" required to build these pages.
Think of a model as an "expert" in building a certain type of component (be it a form, FAQ page, ordered list, etc.). As a web designer, you need to tell the model "what to build" but not "how to build it". The model gathers textual inputs from you and uses these to create a component or a web page.
Just like a carpenter needs lots of specialised tools to do their job, the models become the tools of a web developer and it becomes important to select the most specialised tool available in your tool kit whenever you embark on the creation of a new web page or component. So when the carpenter needs to cut a 45 degree angle, they will instinctively reach for their mitre saw since this is the most efficient and accurate means by which to cut such an angle. By the same token, if you are building an FAQ page, you will want to launch the FAQ model.
When you embark on the creation of a web page that is very unique or specialised, you may find that no model exists to create such a page. In this case, you are faced with a decision:
Dollar functions make it easy to intermingle textual web content with complex HTML or dynamic content. For example, consider a list of items that you want to show as a bulleted list. GenHelm provides a list model that allows you to enter such lists in pure text format. You simply enter the items and save the list under a descriptive name such as "hobbies". Having created the list, you can later render this list on any page just by inserting $list(hobbies). There are over 100 dollar functions for various purposes and new ones can be developed very easily.
The goal of GenHelm is to maintain websites at a higher level of abstraction than code-based frameworks. Although program code is generated "behind the scenes", this code is not intended to be viewed or maintained. Instead, maintenance is performed on the high-level specification used to generate the code. Unlike other generation tools, where generators are designed to produce some starting code that must then be maintained by hand, with GenHelm you can continually read, modify and save the specifications to affect changes in the generated code. In fact, some models, such as the php_class model even allow you to change the generated code (during debugging for example) while preserving these changes when you later decide to regenerate the component.
Every model in GenHelm has a customised editor designed specifically for the model. This reduces the learning curve since you are only presented with the fields that are applicable to the type of page or component you want to create.
Every website created using GenHelm shares the exact same runtime code. If you are using Cpanel, the simplest way to share the runtime code is to set up all of your websites as add-on domains under the same Cpanel account. In this case, all websites can access the same copy of the runtime components. When websites are defined using separate accounts (on the same server), you can still share the framework code by setting up symbolic file links. This means that whenever you make a change or add a new feature to the framework, this can be leveraged by all of your sites instantly, without having to copy the new feature to replicated environments.
GenHelm promotes the sharing of common components across all of your websites. If you develop a page or a gadget for one website, this can easily be inherited by other websites. All sites inherit from the pseudo site called "system". Additionally, you can specify an alternate site from which to inherit components. This is particularly useful for web developers who specialise in vertical industries. Consider the following diagram that depicts how websites can inherit from pseudo sites:
Site s1 and s2 are "one off" websites that only inherit from system. r1, r2 and r3 are individual restaurant sites that inherit from the restaurant pseudo site. lf1 and lf2 are law firm or attorney sites that inherit from the lawfirm pseudo site. Finally, c1, c2 and c3 are individual chiropractor sites that inherit from the chiropractor pseudo site. These inherited sites are called pseudo sites since they generally not accessed directly from a web browser. Instead, they are used to provide shared components to other sites.
Suppose you add a new page to system. This would tend to be something that is common across many different industries. For example, this could be a contact form. Since this is defined in system, any site can inherit this form. Now suppose one of your restaurant sites, say r2, needs a special reservation form. If you create this form directly within the r2 site you won't be able to use this for other restaurant sites (r1 and r3). On the other hand, if you build this new form within the restaurant pseudo site, any restaurant sites that inherit from restaurant will be able to use the new reservation form without having to recreate it.
In addition to sharing pages in this way, virtually any component can be inherited. This includes lists, layouts, fields, script, etc.
The GenHelm methodology fully supports responsive design. Nevertheless, it recognises that responsive design leaves a lot to be desired when it comes to performance and ease of maintenance. Responsive design promotes the notion of sending everything to the browser and using CSS to adapt the presentation. This often results in mobile sites that are bulky and slow with extremely complex CSS media queries that are difficult to design and maintain.
An alternative approach supported by GenHelm is to allow custom layouts for mobile devices and different layouts for desktop devices while allowing all layouts to share the same content elements. With this approach, it is easy to architect what amounts to two separate sites (each serving the same set of URLs):
With this approach, since the variance of screen sizes for each platform is not so extreme, you don't have to rely on complex CSS media queries to shoehorn bulky content into tiny mobile screens.
Responsive design has largely be promoted as a standard because the existing tools make it too difficult to incorporate server logic to adapt the interface to different devices. This problem has been solved by the GenHelm runtime.
The GenHelm runtime does not require a database. This greatly improves the runtime performance and simplifies the setup and deployment of sites.
For any serious website, updating the live site on-the-fly is a very dangerous and risky approach. This is why GenHelm requires that development and maintenance be performed within a separate sandbox environment and makes it easy to promote groups of components that have been tested and are ready for production. There is even a feature that allows you to back out promotions if you discover unexpected problems in production after promoting your changes.
For simple pages, such as blog articles, GenHelm recognizes that some companies may want to allow not technical users to maintain web content. As such, GenHelm includes a database driven blogging system where new pages can be created without involving your web development team.
In conclusion, GenHelm facilities the rapid development of efficient, error-free websites without the limitations that are typically found in website development platforms. GenHelm is ideally suited for website development firms who need to maintain dozens or even hundreds of websites in a standard way. GenHelm is also extremely beneficial for companies that maintain several internal websites and want to ensure architectural consistency across all of their sites.
|GenHelm Architecture||GenHelm Architecure.|
|Why GenHelm?||Summary of the GenHelm methodology.|
|Getting Started||Learn how to start a new website.|
|Naming Conventions||Naming web pages and other items.|
|Common Web Page Fields||Descriptions of fields that are common to all page models.|
|Layouts||Defining codeframes and layouts.|
|Styles and Scripts||Descriptions of fields that are common to all page models.|
|Meta Tags||How to configure meta tags for your site and specific pages.|
|Dollar Functions||General information about dollar functions.|
|Navigation Tips||Navigation Tips and Techniques|
|Favourite Icons||How to configure favorite icons for your site.|
|Blog Maintenance||Blog and post administration.|
|Direct Command Help||Help for the direct command field.|
|Programming with GenHelm||Writing programs that interact with the GenHelm framework.|