Home

Pi Engine Documents

Notation

• Status
  • NULL - Continuously in edit but ready for use
  • V - Complete and ready for use
  • R - Content ready for review
  • E - Edit in process
  • S - Structure ready, call for content contributors
  • C - Call for comments and contributors
  • ? - Not decided or not started
  • X - Deprecated

  • • External link

• i18n
  • NULL - English
  • en - English
  • fa - Persian
  • fr - French
  • zh-cn - Simplified Chinese
  • zh-tw - Traditional Chinese
• Documentation Team and Task [E]
• Wishlist and TODO

Introduction

• Pi Project [V]
• Pi Git Structure [V]
• Pi Team [V]
• Pi VI [E]

User Guide

Installation and Setup

• Installation [V]
• Deployment [C]

Operation Guide

• Nginx Deployment [>]
• Nginx Virtual Host [>]

Developer Guide

Best Practices

• Coding Standards [V]
• Database Schema [V]
• Code Review [C]
• Pi Security [E]
• Variable Filtering [E]
• Development Tools [C]

Framework/Engine Development

• Pi Engine Architecture Diagram (PDF) [>]
• Role Oriented Architecture (PPT) [>]
• Back-office Readme [>]

Module Development

• Module Workflow [E]
• Module Structure [V]
• Kernel APIs [E]
• Configuration [V]
• Authorization [E]
• Customization for installation [V]
• Route [E]
• I18n [E]
• Pagination [V]
• Session [V]
• Parameters [V]
• Database [V]
• Form [E]

Front-end Development

• Course Schedule [E]
• Front-end summary [E]

Theme Development

• Mechanism [E]
• File skeleton and structure [E]
• Step by step [C]
• Advanced [E]
• Theme Structure [E]

Module Template

• Mechanism [E]
• File skeleton and structure [E]
• Step by step [C]
• Advanced [E]

Front API

• Template API [C]
• View Helper [C]

Advanced

• AJAX and JSON request [C]
• Form validate with Backbone [E]

Readme Readings

• Permission [>]
• Route [>]
• Taxonomy [>]
• Template [>]

API Index

• Pi API Index [S]

Translator (I18n) Guide

• I18n Skeleton [>]
• Translate a file [C]
• Make a translatable file [C]

Design

• UI Guide [C]
• UE Guide [C]
• View Components [C]
• Avatar size [V]

Tutorials

Courses

• Course Schedule [zh-cn|V]
• Course 1: Introduction and Setup [zh-cn|V]
• Course 2: Module Design [zh-cn|V]
• Course 3: Form Generation and Validation [zh-cn|V]
• Course 4: Database Operation [zh-cn|V]
• Course 5: Theme and Block [zh-cn|V]
• Course 6: Navigation and Custom Navigation [zh-cn|V]
• Course 7: Custom Route [zh-cn|V]
• Course 8: Authentication Management [zh-cn|V]
• Course 9: Others (APIs/Localization/Updating/Cache) [zh-cn|V]
• Course 11: Pi Engine Mechanism [zh-cn|V]