6. Developer documentation

If you are a plugins developper, you may want to read the api.

If you are a core developper, you may want to read:

• An architecture overview
• Some how-tos
• the cookbook which contains some useful pieces of code
• modules’ documentation

• 1. Architecture overview
  • 1.1. Main dependencies
  • 1.2. Directories
  • 1.3. plmapp
  • 1.4. Custom applications
• 2. List of how-to’s
  • 2.1. How to add a model (single file)
  • 2.2. How to add a model (django application)
• 3. Cookbook
  • 3.1. Models
  • 3.2. Controllers
  • 3.3. Tests
  • 3.4. Others
• 4. http_api — HTTP-API
  • 4.1. How to make a query
  • 4.2. Returned value
  • 4.3. Authentication
  • 4.4. Object fields
  • 4.5. Query fields
  • 4.6. File fields
  • 4.7. List of available queries
• 5. Modules (openPLM.plmapp package)
  • 5.1. controllers — Controllers
  • 5.2. csvimport — Tools to import data from a CSV file
  • 5.3. decomposers — Utilities to decompose a part
  • 5.4. exceptions — Exceptions
  • 5.5. fileformats — Simple module to test if a file is a CAD file
  • 5.6. filehandlers — Utilities to retrieve informations from a file
  • 5.7. files
  • 5.8. filters – Rendering of text written in a wiki syntax
  • 5.9. forms — Forms used by openPLM
  • 5.10. lifecycle — Utilities to manipulate lifecycle
  • 5.11. mail — Tools to send mails
  • 5.12. models — models for openPLM
  • 5.13. navigate — Tools to generate navigation’s graph
  • 5.14. plmapp_tags — Template tags and filters used by openPLM
  • 5.15. references — module to generate a new reference
  • 5.16. thumbnailers — Utilities to generate a thumbnail from a file
  • 5.17. utils — Utilities
  • 5.18. views — Views
  • 5.19. widgets — Form widgets
• 6. Applications
  • 6.1. Badges
  • 6.2. calendrier – calendar generations
  • 6.3. Document3D
  • 6.4. gdoc – Google Document Application
  • 6.5. pdfgen – PDF outputs
  • 6.6. webdav – WebDAV
• 7. Documenting OpenPLM
  • 7.1. Tools used to write the documention
  • 7.2. Compiling the documentation
  • 7.3. Directories
• 8. Bill of materials – BOM
  • 8.1. Definition
  • 8.2. How the BOM is stored
  • 8.3. Extensions
  • 8.4. BOMs comparison
• 9. Publication
  • 9.1. Publishers
  • 9.2. Model
  • 9.3. Controller
  • 9.4. Views
  • 9.5. Templates
• 10. Rich text | Wiki syntax
  • 10.1. Introduction
  • 10.2. Model: how to enhance a textfield
  • 10.3. How to render a content
  • 10.4. Markdown syntax
  • 10.5. How to add a new syntax
• 11. Testing openPLM
  • 11.1. Overview
  • 11.2. Running tests
  • 11.3. Code coverage
  • 11.4. Tasks (celery)