Rain 0.28.0 Documentation

Welcome! This is the documentation for Rain 0.28.0

Getting started

• Installing RAIN
  • Installing node.js & npm
  • RAIN SDK
  • RAIN from source
• RAIN SDK Tutorial
  • RAIN SDK Basic usage
  • RAIN SDK Create project
  • RAIN SDK Debug mode
  • RAIN SDK Generate Localization files from source
• Server and component configuration
  • Server configuration
  • Component configuration
  • Sensitive information configuration
  • Language configuration
• RAIN component descriptor
  • Complete descriptor example
  • Module definition
  • Views definition
  • Intents definition
  • Permissions definition
• Coding Guidelines
  • Identifiers
  • Style
  • Best Practices
  • Classes
  • Patterns
  • Error Handling
• Documenting Rain
  • Revealing module pattern
  • The constructor pattern
  • Document your code
  • Documenting parameters
  • Documenting errors
  • Document return values
  • Adding usage examples
• Node programming best practices
  • Should do
  • Shouldn’t do

Client side modules

• Messaging API
  • Intents
  • Intents lifecycle
  • Intents Usage
  • Publish / Subscriber
• Intents Client API
  • Intents technical details
• Client runtime dependencies
  • Client side controller
  • Including other modules
  • Why do we even use requirejs?
• Client side websockets API
  • Websockets example
• Client rendering
  • Usage
• Rendering
  • Transport Layer
  • Component lifecycle
• Text localization
  • Text localization on the client-side

APIs

• Class AsyncController
• Class ClientRenderer
• Class ClientStorage
• Class Context
• Class CssRegistry
• Class CssRenderer
• Class EventEmitter
• Class FlowLayout
• Class LanguageSelector
• Class Layout
• Class RuleSet
• Class SocketHandler
• Class Stylesheet
• Class Util

Server side modules

• Intents
  • Defining intents
  • Intents mapped on views
  • Intents mapped on server side code
• RAIN Websockets
  • RAIN Websockets Interface
• RAIN component descriptor
  • Complete descriptor example
  • Module definition
  • Views definition
  • Intents definition
  • Permissions definition
• Component Versioning
  • Introduction
  • Describing versions
  • Version matching
• Component Helper
  • Usage
  • HTML Output
  • Error Cases
• CSS Helper
  • Usage
  • HTML output
• Guidelines for writing a Handlebars helper
  • Helper structure
  • Helper location
  • Documentation
• Authorization
  • Permissions based
  • Intents
  • Dynamic Conditions
  • Authentication condition
• Platform language
  • Configuration
  • Using the language
• RAIN Localization
  • Text localization
  • Resource URLs
  • Views localization
• Logging guidelines
  • Logging levels
  • What to log
  • Component logging
• RAIN SDK Architecture
• RAIN Clustering
  • Cluster module deficeincies

APIs

• Class Appender
• Namespace Authorization
• Class BaseSession
• Class BaseSessionStore
• Class ComponentHelper
• Class ComponentRegistry
• Class Configuration
• Class Configurator
• Class ConsoleAppender
• Class ContainerHelper
• Class CssHelper
• Class DataLayer
• Class DemoIdentityProvider
• Class Environment
• Class ErrorHandler
• Class Event
• Class FileAppender
• Namespace Identity
• Class IdentityProvider
• Class IntentsRegistry
• Namespace Internationalisation
• Class ItemHelper
• Class Layout
• Class Logger
• Class MemoryStore
• Class ModuleLoader
• Class Monitoring
• Class MonitoringAdapter
• Class ParsedObject
• Class PartialHelper
• Class PatternLayout
• Class PoUtils
• Class PrecompileLess
• Class Renderer
• Class Server
• Class Session
• Namespace SocketHandlers
• Class SocketWatcher
• Class StackTraceFormatter
• Class SyslogAppender
• Class Translation
• Class TranslationHelper
• Class TranslationPluralHelper
• Class URLHelper
• Class User

Components

• Error component
  • Usage
• Placeholder
  • Configuration

Feature Proposals

• Client Side Contexts
• Client Language Runtime (Proposal A)
• Client Language Inline Editing
• Client Runtime: Messaging API (Proposal A)
• Client Runtime (Proposal A)
• Client Runtime Storage
• CSS Transformation
• Dashboard Component Model
• Automatic Deployment
• Elastic architecture
• Error Handling
• Features proposal template
• Fragments Configuration Introduction
• Hijax introduction
• View Instances
• Logging
• RAIN authorization
• RAIN Cloud In Action
• Remote aggregation
• Rendering Process
• Server Translations System
• Text transport
• View authorization
• View modes
• RAIN IDE
• Code Coverage
• CSS Rendering
• Distributed Rendering
• Distributed Websockets
• JavaScript and CSS Minification
• NginX static routes server

Changelog

• Changelog