Documentation

Web Notes Framework is a web application framework that is buit on Python and Javascript. It contains:

• Meta-data modelling
• Object-Relational Mapper (like Django)
• Admin / Developer web-interface to build the application
• Roles based permission structure
• Form Rendering
• Report Builder
• Built-in AJAX and navigation widgets

The server and client sides are tightly integrated for maximum abstraction and efficiency.

For corrections / suggestions / contributions for the documentation, please mail me at rushabh@iwebnotes.com

Contents:

• 1. Introduction
  • Web Notes Framework
    • Why Web Notes Framework?
    • See it in action
    • Setting Up and Installing
  • Concepts
    • Structure
    • Developing an Application
• 2. Building an Application
  • Using the Administrator Interface
    • What is an Application?
    • Administrator Login
    • Creating Entities
    • Managing Roles
    • Creating Users (Profile)
  • Creating A Form (DocType)
    • Database Table
    • Naming DocTypes
    • Giving Permissions
    • Setting Fields
    • Adding Tables to the form
    • Single DocTypes (Singleton pattern)
    • Adding Attachments
    • Other Properties
  • Save-Submit-Cancel Pattern
  • Creating Pages
    • Page Elements
    • Scripting Pages
  • Creating Reports
    • Filters
    • Saving a Report
    • Seeing the Query
    • Adding Joins
    • Over-riding the query
    • Adding Scripts
  • Writing Scripts
    • Server Side Scripts
      • Introduction
      • Declaring a Class
      • validate method
      • on_update, on_submit, on_cancel methods
      • Adding Child Records
      • Debugging
    • Client Side Scripts
      • Introduction
      • cur_frm Object
      • onload event
      • refersh event
      • Server Calls
      • Field Level Triggers
      • Fetch Pattern
    • Server Side Cookbook
      • Create a name by using a prefix selected by the user
      • Stop duplicate entries in a child table based on a key
      • Add an event to the calendar
      • Send HTML Email based on certain condition
    • Client Side Cookbook
      • Fetch customer cell no and email id based on name
      • Form Events (Triggers)
      • Accessing / Updating Field Objects
      • Field Events (Triggers)
      • Overloading Link Field queries
      • Setting contextutal help (Tips)
      • Custom UI using the HTML Field
      • Useful API Methods
      • Using Templates
    • Report Cookbook
      • Modify Report Filters (Client)
      • Remove Paging for a Report (Client)
      • Hide Column Picker (Client)
      • Validate fitler values (Server)
      • Append a column to the report (Server)
      • Add data to a column (Server)
      • Append rows to the report (Server)
• 3. Server Side API
  • Database API Functions
  • doc — Document (ORM)
    • Document object
    • Standard methods for API
    • Naming
    • Inheritance
    • Example
  • utils — Utilities Module
    • Date and Time Functions
    • Datatype Conversions
    • Defaults
    • File (BLOB) Functions
    • Email Functions
    • Other Functions
  • email_lib — Email
    • Email object
    • Example
  • profile — Profile
    • Profile object
  • webservice — Remote Framework Access via HTTP
    • Framework Server Class
    • Example
  • Server Side Internals
    • auth — Authentication
      • Authentication object
    • webnotes — Webnotes Module
      • Global Attributes
      • Global Functions
    • doclist — Doclist Module
      • functions for internal use
    • doctype — DocType
      • _DocType object
    • code — Code Execution Module
      • Global Properties / Methods (generally) used in server side scripts
      • Module Methods
    • db_schema — Database Schema Management Module
      • Standard fields of a record
    • db — Database
      • database object — conn
    • page_body — Page Body Serverside Module
    • form — Form Module
    • page — Page Module
      • Internal Methods
    • menus_server — Menus Serverside Module
    • module — Module Module
• 4. Client Side API
  • Accessing Local Data
  • Form Widget API
    • Scripting Forms
    • Form Container Class
    • Form Class
    • Field Class
    • Grid Class
    • Examples
  • Report Builder
    • Search Criteria
    • Customizing Filters
    • Scrubbing / modifying data from the query
    • Adding style to the result
    • Generating a query by script from client side
    • Report Builder API
    • Report Builder Container
    • Report Builder Class
    • Datatable Class
  • Dialog Boxes
    • Dialog Class
    • Example
  • Listing
    • Listing Options
    • Listing Class
    • Creating a Listing
    • Examples
  • Tree
    • Tree & TreeNode Classes
    • Example
  • Tabbed Page
    • TabbedPage Class
    • Example
  • Autosuggest
    • Overriding the default call
    • Example
  • Javascript Utilities
    • AJAX - Server Calls
    • Title
    • Events
    • String
    • Lists
    • Dictionaries
    • Datatype Conversion
    • DOM Manipulation
    • Style
    • Tables
    • Select Element
    • Positioning
    • URL
    • User Image
    • Miscelleanous
  • Page Structure and Navigation
    • Page Structure
    • Opening existing resources (Pages, Forms etc)
    • History
• 5. Generating Sitemaps
  • Example
• Glossary

Indices and tables

• Index
• Module Index
• Search Page