HowTos explain how to use ERP5 and achieve specific elementary tasks. If you can not find a howto replying to your need here or in the User HowTos, please ask a question in our Forum.

HowTos are grouped by keywords. Click on a keyword for displaying a list of related documents across the full documentation.

AbbreviationSearch

• User Interface Must Use Uppercase Abbreviations - For consistent naming patterns.
• Link Explaining Abbreviation Is Wrapped in Square Bracket And Uses Abbreviation As Link Text - For automatic link formatting.
• Abbreviations Are Not Allowed In ERP5 Code - Code must be understandable.
• Abbreviation Link Title Must Contain Abbreviated Text And Description Split By Semicolon - To create table of document abbreviations.

AccessSearch

• A Documentation Document Must Have Group And Classification Defined - This determines accessibility.

AcquisitionSearch

• Prevent Acquisition From Acquiring Restricted Properties In Python - To prevent acquisition errors.

ActionSearch

• Set Content Permission To Fast Input - Fast Inputs usually create sub documents or modify content.
• Define Document Actions As Global Actions - Global actions will automatically be present.
• Define Action Name Explicitly For Users - They are visible on the user interface.
• A Fast Input Must Use object_fast_input Action - Never configure as object_exchange action.
• Define Module Default Actions On Portal Action Tool - And not as portal type actions.
• Set At Least View Action On Module Action Tab - Only actions required should be set by default.
• Define Report Actions As object_report Linked With View Permission - To enable fast report button.

ActivitiesSearch

• Set Priorities On Important Activities - To allow these activities to be executed faster.
• Use Activities For Heavy Computations - To maintain responsive system.

AnchorSearch

• Reference Anchor Uses Uppercase Group, Project, Publication Section Or Business - Document name reference options.

AttributeSearch

• Attribute Must Be Assigned Only To Object Or Class - For consistent patterns across ERP5.

Business ReferenceSearch

• Business Reference Is An Uppercase Id And Number Sequence Separated By Hyphen - Used as document name anchor.

Business TemplateSearch

• Semantic Field Is Named Using My Prefix, Technical Context And Semantic Name - Differentiate between semantic and technical template fields.
• Technical Template Fields Are Defined In Base_viewFieldLibrary - Non semantic fields should not be duplicated.
• Unset Acquire Local Roles On Document Portal Type Configuration If Applicable - sub and parent document security may differ.
• Include Module Base Categories In Business Template - They will not be created automatically.
• Semantic Field Should Be Used In Favor Of Technical Field - Semantic fields are more specific and descriptive.
• Only Use Proxy Fields In Non Field Library Forms - To prevent excessive customisation.
• Include Module Local Roles In Business Template - They will not be created automatically.
• Proxy Fields Should Share Semantics - To keep consistency across fields.
• Use My Prefix and Class Name For Template Field Name - To prevent creating multiple technical template fields.
• A Business Template Has Only One Field Library - Field libraries share semantic configuration.
• A Proxy Field Never Links To An External Field Library - Business templates must work standalone.
• Modify Correct Changelog On Business Template Commits - Differentiate major changes and purpose changelog.
• Inside The Roles Tab, Assignor, Assignee, Associate And Auditor Must Be Defined - Follow 5A security model.
• Use Glossary Defined Prefix For Specific Semantics - Field libraries should be consistent within.

CategorySearch

• Never Name A Base Category The Same As A Property In ERP5 - They form a global vocabulary.
• Group Reference Is Uppercase And Uses Category Value - Group determines viewing permission.
• Never Hardcode Category In Scripts Or Classes - Reduces code flexibility and portability.

ClassSearch

• A Python Class Is Defined Inside ERP5 Product Only - For consistent patterns across ERP5.
• Never Hardcode Category In Scripts Or Classes - Reduces code flexibility and portability.

ClassificationSearch

• Documentation Document Is Classified Using Publication Section - For categorising documentation.

CodeSearch

• Code Snippet Uses Code Tag Wrapped In Pre Tag - Code section convention.

CodingSearch

• A Non Anonymous JavaScript Method Must Be Declared Before Use - Jslint will throw on this, too.
• Never Modify 100 Objects In A Transaction - Use activities instead.
• Never Use GetPath To Retrieve A Url In ERP5 - Absolute and physical path may differ.
• Sessions Are Not Allowed - Sessions are incompatible with clustering.
• Use Methods To Access Properties In ERP5 - ERP5 is method based.
• Never Use aq_parent To Get Document Parent In Python - Use getParentValue()
• Never Hide Exceptions - It may lead to system corruption.
• Abbreviations Are Not Allowed - Context is lost quickly.
• JavaScript Closing Bracket Is At Indent Of Function Call - Consistent coding patterns.
• Never Override Python Builtin Names - Debugging will be much harder.
• JavaScript Opening Brace Is On Line Of Current Statement - Consistent coding patterns.
• Python Class Method Should Have Security Declaration - Don't forget security declaration on class methods.
• Never Never Use Reindex In ERP5 - Reindexing is for debugging only.
• Prevent Acquisition From Acquiring Restricted Properties In Python - To prevent acquisition errors.
• Cookies Are Not Allowed - Cookies have limitations and should not be used in ERP5.
• FailUnless Should Not Be Used In Python Unit Tests To Test Identity - Use assertEqual.
• JavaScript Constructor Starts With Captial Letter - Consistent Javascript patterns.
• Method Name Is Camelcase Starting With Lowercase Letter - Consistency across languages
• Never Store Calculation Result In Python Property - Only store original content.
• Private Method Starts With Underscore - Consistent patterns.
• Never Hardcode Interactions - Use interaction workflows instead.
• Code Must Be Validated With JsLint - To ensure consistent syntax and quality.
• Use Two Space Indentation - Consistent code indentation across languages.
• Use Of JavaScript Globals Is Discouraged - Better never declare any globals anyway.
• Comments Should Be Used Wisely - Don't make unnecessary comments.
• Never Hardcode If Not Necessary - Hard code is hard to maintain.
• Use Of JavaScript Id Attribute Is Not Allowed - Duplicate ids will beak a page.
• Never Name A Base Category The Same As A Property In ERP5 - They form a global vocabulary.
• Plural Is Not Allowed - They can be amiguous.
• Never Access State_change Object In ERP5 Workflow Scripts - Use state_change["attribute_name"].
• Never Use DoActionFor In ERP5 - Use transition methods to manually trigger workflow transitions.
• Never Use ContentValues or ObjectValues On More Than 50 Documents In ZODB - Folders may contain million of documents.
• JavaScript Class Name And Id Attribute Are Lowercase With Underscore Separator - General coding convention.
• Code Should Work If All Else Fails - Always assume a part your code is depending on may not work.
• Never Write To ZODB If Not Required - ZODB is an incremental storage and every write creates more data.
• Never Use Python If Obj if Obj Is Not A Simple Type - Truth testing in Zope/ERP5 can be surprising.
• Call Parent Method For Zope Hook Method Override In Python - Needs an explanation.
• Never Use ZODB Temp Folder Across Multiple Requests - Incompatible with ZEO and clustering.

CommitSearch

• Create Resonable Log Messages - The code will be read in many contexts.
• Logs Must Contain Their Cause - Test report must contain info on the cause of a log
• Log Clear Enough To Disable Easily - It should be easy to track logs in the code.
• Live Tests Should Not Be Run On Production - Create and remove data is dangerous in production.
• Read Patch Before Commit - Read your patch before committing.
• Never Commit Debugger Code - No pdb-related code (import, call to set_trace, ...).
• Fix Whitespace In A Separate Commit - It is a motivation to fix unneeded whitespace.
• Commits Are Atomic - Changes from a motivation must be committed together.
• Never Log Level Info Or More In Execution Path - Avoid trivial logs.
• Use Log Levels - Log levels help understand the importance of a log.
• Commits Are Purpose Based - A change in code must have a motivation (like fixing a bug).
• End A File With Empty Line - Some tools cannot handle, display file as truncated.
• Test Changes Before Committing - Verify that system is usable after your change.
• Modify Correct Changelog On Business Template Commits - Differentiate major changes and purpose changelog.
• Never Create Interdependent Test Methods - It makes finding broken tests much harder.

ConfigurationSearch

• Never Use Multiple Modules For Person Or Organisation - Use roles for classification.

ConstantSearch

• Pseudo Constant Uses Uppercase In ERP5 - Consistent naming patterns.

ContentSearch

• In Document Name Publication Section Is Written In Camelcase - Publication Section convention.
• Link Text On Applicable And Referenced Documents Is AD/RD - Counters are added automatically.
• Use gender neutral writing in documentation - Make text consistent.
• Image Must Have Alt Attribute - Required for certain templates. Add manually or dynamically.
• Content Should Be Served By Cdn If Anonymous< - Hosting guideline.
• Document Title Uses Capitalized Keywords Prefixed By Publication Section - Convention for Documentation title.
• Link To Applicable Or Referenced Document Uses Title And Is Wrapped In Square Brackets - To flag links for auto tables.
• Image Must Have Alt Attribute For Automatic Captioning - Always add manually or dynamically.
• Link Explaining Abbreviation Is Wrapped in Square Bracket And Uses Abbreviation As Link Text - For automatic link formatting.
• Documentation Document Anchor Uses Software And Publication Section Split By Hyphen - Documentation reference convention.
• Document Theme Is Set Using Follow Up Software Product - For predicate and themeing.
• Web Section And Exportable Document Should Have Short Title Specified - Used in exports.
• Png Is Saved In Image And Svg In Web Page Module - SVGs are written in xml.
• External Link Should Have Target Attribtue Specified - To make sure user stays on the current page.
• Document Should Have Follow-Up Defined - Follow-Up handles theming and relation to other objects
• SVG Image Must Have Format Specified In Url - Format should always be defined.
• Use Path Links For Linking To Images Or Assets - Convention for working with inks in document content
• Documentation Document Should Have License Specified - Determining how this document may be used.
• Documentation Document Must Have Introduction Paragraph - Explain WHY document was written.
• Document Content Is Written In British English - General principle in ERP5 regarding language.
• Beware of Editor Autoformat - Patterns to avoid when creating document content.
• A Screeshot Displays Full Screen Without Bars - Patterns for working with screenshots.
• Image Format Must Be SVG Or PNG - No other formats are allowed (jpg/gif)
• Document Content Does Not Contain $Macros - Macros introduce dependencies and reduce portability of a document.
• Table Uses Thead Tbody And Caption Tags - For consistent appearance.
• SVG images must not have duplicate PNG image - Set correct references.
• A Link Between Internal Documents Uses A Relative Url - General link pattern convention.
• Headers Start At Level 1 And Are Not Numbered - Numbers and downgrades are made automatically.
• Sentence Starts With Capital Letter And Finishes With Semi-Colon Or Full-Stop - Make text consistent.
• Never Use Zodb Path In Url - Use front-end friendly url.
• Images Inside SVG Must Be Embedded Using Reference Not With The Actual Image - Set correct references.
• Image Must Have Format And Display Parameter In Url - To not render images in original format and size.
• Content Should Be Served Using Asset And Blob Subdomains - Convention for working with urls.
• Link Title Should Be Defined On Documentation Document Links - Required for certain templates.
• Text From The User Interface Is Written In Italic - To highlight text to interact with.
• Image Uses Publication Section As Anchor Reference - Patterns for working with images.
• Image Should Not Be Wrapped By Hand For Fullsize Viewing - It will be done automatic.
• Code Snippet Uses Code Tag Wrapped In Pre Tag - Code section convention.
• Use Path Links For Links To Large Files - Security and portability matter.
• Short Title On Documentation Documents Uses Title Without Publication Section - Short title convention.
• Image Should Have Publication Section Defined - To make images more easy to discover.
• Document Keywords Are Lowercase Singular And Line Separated - Keywords are used.
• Never Use Relative Url As Embedded Reference Inside SVG - SVG internal links are fragile.
• Document Should Have Explicit Predecessors And Successors Defined - To improve overall document strucute.
• Document Content Should Never Contain Head Or Body Tag - Content represents the content of the body tag.
• Use Only Allowed Html Tags - Conventions on html tags in document content.
• Inline CSS And JavaScript Are Not Allowed - Content should be free of layout instructions.
• A Documentation Document Must Have Group And Classification Defined - This determines accessibility.
• Embedded SVG Image Must Have A Format Specified - Source format must be defined.
• Table Has Caption Defined After Tbody Tag - Normally it should be a the top.
• Documentation Document Is Classified Using Publication Section - For categorising documentation.
• Abbreviation Link Title Must Contain Abbreviated Text And Description Split By Semicolon - To create table of document abbreviations.
• Document Content Is Written In HTML5 - Documents are written in HTML5.
• Documentation Document Must Have Description Abstract - Explain WHAT document contains.

CrimeSearch

• Reference Should Never Use Arbitrary Numbers Or Abbreviations - Be concise.
• Never Modify 100 Objects In A Transaction - Use activities instead.
• Never Use GetPath To Retrieve A Url In ERP5 - Absolute and physical path may differ.
• Never Allow Relation String Fields To Set Relations To Categories - Categories are too complex to relate.
• Never Use aq_parent To Get Document Parent In Python - Use getParentValue()
• Never Hide Exceptions - It may lead to system corruption.
• Never Use Or Overload Reserved CSS Ids - To ensure the UI stays consistent.
• Never Override Python Builtin Names - Debugging will be much harder.
• Never Never Use Reindex In ERP5 - Reindexing is for debugging only.
• Document Content Does Not Contain $Macros - Macros introduce dependencies and reduce portability of a document.
• SVG images must not have duplicate PNG image - Set correct references.
• Cookies Are Not Allowed - Cookies have limitations and should not be used in ERP5.
• FailUnless Should Not Be Used In Python Unit Tests To Test Identity - Use assertEqual.
• Never Commit Debugger Code - No pdb-related code (import, call to set_trace, ...).
• Never Forget Edit Workflow On Documents - Needed to track creation and modification history.
• Never Use Zodb Path In Url - Use front-end friendly url.
• Images Inside SVG Must Be Embedded Using Reference Not With The Actual Image - Set correct references.
• Never Log Level Info Or More In Execution Path - Avoid trivial logs.
• Never Store Calculation Result In Python Property - Only store original content.
• Never Set Search Row And Select Column On Listbox Inside Document View - It is not allowed in view mode.
• Never Translate Glossary Without Looking At Application - Ambiguity and context matter.
• Never Forget The Original Translation Can Be Bad - Always verify translations.
• Never Hardcode Interactions - Use interaction workflows instead.
• Never Print Directly - Always go through a dialog.
• Never Render Reports Directly - Always go through dialog.
• Never Show Or Make User Work With Document Id - Expose title and reference only.
• Never Use Relative Url As Embedded Reference Inside SVG - SVG internal links are fragile.
• Never Name A Base Category The Same As A Property In ERP5 - They form a global vocabulary.
• Never Access State_change Object In ERP5 Workflow Scripts - Use state_change["attribute_name"].
• Never Hardcode Category In Scripts Or Classes - Reduces code flexibility and portability.
• Never Use DoActionFor In ERP5 - Use transition methods to manually trigger workflow transitions.
• Document Content Should Never Contain Head Or Body Tag - Content represents the content of the body tag.
• Never Use ContentValues or ObjectValues On More Than 50 Documents In ZODB - Folders may contain million of documents.
• Never Use Multiple Modules For Person Or Organisation - Use roles for classification.
• Never Write To ZODB If Not Required - ZODB is an incremental storage and every write creates more data.
• Never Create Interdependent Test Methods - It makes finding broken tests much harder.
• Never Translate Without Tools Or Advice - Verify translations.
• Never Translate PO File Without Looking At The Application - Ambiguity and context matter.
• Never Use Python If Obj if Obj Is Not A Simple Type - Truth testing in Zope/ERP5 can be surprising.
• Never Use ZODB Temp Folder Across Multiple Requests - Incompatible with ZEO and clustering.

CssSearch

• Use Recommended Layout CSS Classes - To ensure consistent layouts.
• Never Use Or Overload Reserved CSS Ids - To ensure the UI stays consistent.
• Reserved CSS Classes Should Not Be Used Or Overloaded - To ensure the UI stays consistent.

DebugSearch

• Create Resonable Log Messages - The code will be read in many contexts.
• Logs Must Contain Their Cause - Test report must contain info on the cause of a log
• Log Clear Enough To Disable Easily - It should be easy to track logs in the code.
• Never Never Use Reindex In ERP5 - Reindexing is for debugging only.
• Never Commit Debugger Code - No pdb-related code (import, call to set_trace, ...).
• Never Log Level Info Or More In Execution Path - Avoid trivial logs.
• Use Log Levels - Log levels help understand the importance of a log.

DescriptionSearch

• Documentation Document Must Have Description Abstract - Explain WHAT document contains.

DialogSearch

• Dialog Form Name Is Postfixed With Dialog - For consistent naming.
• Form Report Dialog Is Postfixed With Report - For consistent naming

DocumentSearch

• Never Allow Relation String Fields To Set Relations To Categories - Categories are too complex to relate.
• Set Form Action To Base_edit - For form consistency.
• Set Listbox Action To List Action On Document Form Listboxes - To allow clicking on listbox title.
• Use getTranslatedId To Display Document Ids In Listbox Or Form - Special Ids need meaningful translation.
• Do Not Mix Description And Comment - They have different meanings.
• Set Post Method And Utf-8 Encoding On Document Forms - For form consistency.
• Set List Method To contentValues On Document Form Listbox - Subobjects should be displayed.
• Set Listbox Selection Name To form_name_selection_name - Names must be unique.
• A Document Form Uses The form_view Page Template - For consistency across all forms.
• Set Form Encytype to multipart/form-data When Using File Upload - For form consistency.
• Set Document Form Ids To PortalType_view - This is the naming convention.
• Set Document Form Titles To What Is Displayed - Usually this is the portal type title.

Document NameSearch

• Document Name Must Use Anchor, Reference, Name, Version, Language And File Type - Main rule for document names.
• Publication Section In Document Name Is Separated By Hypen And Lowercase - When used in document name
• Version Number Is Ascending And Use Three Digits - Versioning in document name.
• Business Reference Is An Uppercase Id And Number Sequence Separated By Hyphen - Used as document name anchor.
• Document Name Is Camel Case And Dot Separated - Name in document name
• Reference Anchor Uses Uppercase Group, Project, Publication Section Or Business - Document name reference options.
• Language Is Abbreviated As Two Lowercase Characters - Language in document name.

Document Portal TypeSearch

• Use Localizer For Module Title Translation - Module titles are part of user interface.

DocumentationSearch

• Document Title Uses Capitalized Keywords Prefixed By Publication Section - Convention for Documentation title.
• Documentation Document Anchor Uses Software And Publication Section Split By Hyphen - Documentation reference convention.
• Documentation Document Should Have License Specified - Determining how this document may be used.
• Document Should Have Explicit Predecessors And Successors Defined - To improve overall document strucute.

ExceptionSearch

• Never Hide Exceptions - It may lead to system corruption.

ExportSearch

• Web Section And Exportable Document Should Have Short Title Specified - Used in exports.

Fast InputSearch

• Set Content Permission To Fast Input - Fast Inputs usually create sub documents or modify content.
• Define Declare Fast Input As Hidden Content Type - Use of fast input depends on use case.
• A Fast Input Must Use object_fast_input Action - Never configure as object_exchange action.

Field LibrarySearch

• Semantic Field Is Named Using My Prefix, Technical Context And Semantic Name - Differentiate between semantic and technical template fields.
• Technical Template Fields Are Defined In Base_viewFieldLibrary - Non semantic fields should not be duplicated.
• Field Library Fields Should Be Semantically Unified - Use consistent naming patterns.
• Semantic Field Should Be Used In Favor Of Technical Field - Semantic fields are more specific and descriptive.
• Only Use Proxy Fields In Non Field Library Forms - To prevent excessive customisation.
• Proxy Fields Should Share Semantics - To keep consistency across fields.
• Use Base_view Prefix Followed By Business Filed and FieldLibrary For Field Library Title - For naming consistency.
• A Form Field Proxies From A Buiness Template Field - Differentiate Core, Business and Custom Fields.
• Use My Prefix and Class Name For Template Field Name - To prevent creating multiple technical template fields.
• A Business Template Has Only One Field Library - Field libraries share semantic configuration.
• A Proxy Field Never Links To An External Field Library - Business templates must work standalone.
• Business Library Fields Proxy From Core Fields - Use three levels: core, business, custom
• Use Glossary Defined Prefix For Specific Semantics - Field libraries should be consistent within.

Field TitleSearch

• Field Title Must Be Singular, Capitalized And Uses Space Separator - Visible in user interface.

Follow UpSearch

• Document Should Have Follow-Up Defined - Follow-Up handles theming and relation to other objects

FormSearch

• Set Form Id To ModulePortalType_viewPortalTypeList - For form consistency.
• Use form_list Page Template On Forms - To name and declare forms consistently.
• Use Proxy Fields Of Proxy Fields In Form - To improve consistency and maintainability.
• Add Column Portal Type If Listbox Contains Multiple Types - The listbox title will not display all types.
• Field Title Must Be Singular, Capitalized And Uses Space Separator - Visible in user interface.
• Never Allow Relation String Fields To Set Relations To Categories - Categories are too complex to relate.
• Use Method Post And UTF-8 Encoding On Forms - To name and declare forms consistently.
• Listbox Selection Name Must Follow module_name_selection Pattern - It is used to find parameters in listbox.
• The Listbox Method Should Be Defined As SearchFolder To View Modules - To use portal catalog to display module content.
• Set Form Action To Base_edit - For form consistency.
• Listbox Must Only Be Put In Form Bottom Group - This is the default view of a module.
• Use Correct Names For Simulation And Validation Titles - For consistent titles across ERP5.
• Place Simulation And Validation Fields At Bottom Of Right Group - Form consistency.
• Set Listbox Title To Plural Of Portal Type Title If Applicable - Listbox title should reflect portal types displayed.
• Document Content Is Written In British English - General principle in ERP5 regarding language.
• Split Large Forms On Multiple Tabs - Multiple views preserver clarity.
• Define Count Method As countFolder On Module Listbox - To use portal catalog.
• Use Translated Portal Type To Display Portal Type - To enable automatic translation.
• Form Name Uses Lowercase View After Portal Type - For consistent naming.
• Set Listbox Action To List Action On Document Form Listboxes - To allow clicking on listbox title.
• ListField Or MultListField For Categories Must Use Item List Method - Preserve consistency in pop-up field rendering.
• Add Viewable Listbox Fields To More Columns - To allow user to view and toggle.
• Forms Must Use Left, Right, Center, Bottom And Hidden Groups - To allow consistent form rendering.
• Use getTranslatedId To Display Document Ids In Listbox Or Form - Special Ids need meaningful translation.
• Dialog Form Name Is Postfixed With Dialog - For consistent naming.
• Never Set Search Row And Select Column On Listbox Inside Document View - It is not allowed in view mode.
• Add Date In Listbox As Editable Date-Time Field - To allow to automatically adjust date format based on user preference.
• Set Description On Form Fields - Used to generate tool tips.
• Do Not Test Required In Field View Form - This should be done in constraints.
• Form Report Dialog Is Postfixed With Report - For consistent naming
• Do Not Mix Description And Comment - They have different meanings.
• Report Name Uses Portal Type Followed By View Report Name And Report - For consistent naming.
• Never Show Or Make User Work With Document Id - Expose title and reference only.
• Listbox Only Tabs Should Have A Read Only Title In Center Group - To display info on what is being shown.
• Set Post Method And Utf-8 Encoding On Document Forms - For form consistency.
• Set List Method To contentValues On Document Form Listbox - Subobjects should be displayed.
• Set Listbox Selection Name To form_name_selection_name - Names must be unique.
• A Document Form Uses The form_view Page Template - For consistency across all forms.
• Set Form Encytype to multipart/form-data When Using File Upload - For form consistency.
• Set Document Form Ids To PortalType_view - This is the naming convention.
• Set Form Title To What Is Displayed - For form consistency.
• Set Form Action Base_doSelect On Forms - To name and declare forms consistently.
• Set Document Form Titles To What Is Displayed - Usually this is the portal type title.
• Hide Listbox Editable Fields On The Form - To ensure they are not rendered.

FormatSearch

• Beware of Editor Autoformat - Patterns to avoid when creating document content.

GroupSearch

• Group Reference Is Uppercase And Uses Category Value - Group determines viewing permission.

HeadlineSearch

• Headers Start At Level 1 And Are Not Numbered - Numbers and downgrades are made automatically.

HostingSearch

• Content Should Be Served Using Asset And Blob Subdomains - Convention for working with urls.

HtmlSearch

• Use Only Allowed Html Tags - Conventions on html tags in document content.

HtmlSearch

• Use Of JavaScript Id Attribute Is Not Allowed - Duplicate ids will beak a page.
• JavaScript Class Name And Id Attribute Are Lowercase With Underscore Separator - General coding convention.

I18NSearch

• Document Content Is Written In British English - General principle in ERP5 regarding language.
• Never Translate Glossary Without Looking At Application - Ambiguity and context matter.
• Never Forget The Original Translation Can Be Bad - Always verify translations.
• Use Localizer For Module Title Translation - Module titles are part of user interface.
• Never Translate Without Tools Or Advice - Verify translations.
• Never Translate PO File Without Looking At The Application - Ambiguity and context matter.
• Translation - Conventions on how to make quality translations.

ImageSearch

• Image Must Have Alt Attribute - Required for certain templates. Add manually or dynamically.
• Png Is Saved In Image And Svg In Web Page Module - SVGs are written in xml.
• A Screeshot Displays Full Screen Without Bars - Patterns for working with screenshots.
• Image Format Must Be SVG Or PNG - No other formats are allowed (jpg/gif)
• SVG images must not have duplicate PNG image - Set correct references.
• Images Inside SVG Must Be Embedded Using Reference Not With The Actual Image - Set correct references.
• Image Must Have Format And Display Parameter In Url - To not render images in original format and size.
• Image Uses Publication Section As Anchor Reference - Patterns for working with images.
• Image Should Not Be Wrapped By Hand For Fullsize Viewing - It will be done automatic.
• Image Should Have Publication Section Defined - To make images more easy to discover.
• Never Use Relative Url As Embedded Reference Inside SVG - SVG internal links are fragile.
• Embedded SVG Image Must Have A Format Specified - Source format must be defined.

Inline CodeSearch

• Inline CSS And JavaScript Are Not Allowed - Content should be free of layout instructions.

InterfaceSearch

• Interface Name Uses Camelcase - To ensure consistent naming patterns.

JavascriptSearch

• A Non Anonymous JavaScript Method Must Be Declared Before Use - Jslint will throw on this, too.
• Abbreviations Are Not Allowed - Context is lost quickly.
• JavaScript Closing Bracket Is At Indent Of Function Call - Consistent coding patterns.
• JavaScript Opening Brace Is On Line Of Current Statement - Consistent coding patterns.
• JavaScript Constructor Starts With Captial Letter - Consistent Javascript patterns.
• Code Must Be Validated With JsLint - To ensure consistent syntax and quality.
• Use Of JavaScript Globals Is Discouraged - Better never declare any globals anyway.
• Use Of JavaScript Id Attribute Is Not Allowed - Duplicate ids will beak a page.
• JavaScript Class Name And Id Attribute Are Lowercase With Underscore Separator - General coding convention.

KeySearch

• SQL Column Id Use Singular For Related Key - To ensure consistent SQL naming.

KeywordSearch

• Document Keywords Are Lowercase Singular And Line Separated - Keywords are used.

LanguageSearch

• Language Is Abbreviated As Two Lowercase Characters - Language in document name.

LinkSearch

• Link Text On Applicable And Referenced Documents Is AD/RD - Counters are added automatically.
• Content Should Be Served By Cdn If Anonymous< - Hosting guideline.
• External Link Should Have Target Attribtue Specified - To make sure user stays on the current page.
• Use Path Links For Linking To Images Or Assets - Convention for working with inks in document content
• A Link Between Internal Documents Uses A Relative Url - General link pattern convention.
• Link Title Should Be Defined On Documentation Document Links - Required for certain templates.
• Use Path Links For Links To Large Files - Security and portability matter.

ListboxSearch

• Set Form Id To ModulePortalType_viewPortalTypeList - For form consistency.
• Use form_list Page Template On Forms - To name and declare forms consistently.
• Add Column Portal Type If Listbox Contains Multiple Types - The listbox title will not display all types.
• Use Method Post And UTF-8 Encoding On Forms - To name and declare forms consistently.
• Listbox Selection Name Must Follow module_name_selection Pattern - It is used to find parameters in listbox.
• The Listbox Method Should Be Defined As SearchFolder To View Modules - To use portal catalog to display module content.
• Listbox Must Only Be Put In Form Bottom Group - This is the default view of a module.
• Set Listbox Title To Plural Of Portal Type Title If Applicable - Listbox title should reflect portal types displayed.
• Define Count Method As countFolder On Module Listbox - To use portal catalog.
• Add Viewable Listbox Fields To More Columns - To allow user to view and toggle.
• Listbox Method Is Named Using Module Type And Portal Type List - For consistent naming in forms.
• Listbox Selection Uses Name Selection Postfix - For consistent naming.
• Never Set Search Row And Select Column On Listbox Inside Document View - It is not allowed in view mode.
• Add Date In Listbox As Editable Date-Time Field - To allow to automatically adjust date format based on user preference.
• Method In Listbox Is Prefixed With Listbox Section - To provide understandable context.
• Set Form Title To What Is Displayed - For form consistency.
• Set Form Action Base_doSelect On Forms - To name and declare forms consistently.
• Hide Listbox Editable Fields On The Form - To ensure they are not rendered.
• Listbox Uses List, Stat Or Count Method - For consistent naming.

LogSearch

• Create Resonable Log Messages - The code will be read in many contexts.
• Logs Must Contain Their Cause - Test report must contain info on the cause of a log
• Log Clear Enough To Disable Easily - It should be easy to track logs in the code.
• Never Log Level Info Or More In Execution Path - Avoid trivial logs.
• Use Log Levels - Log levels help understand the importance of a log.

MacroSearch

• Page Template Macro Variables Must Be Defined In Header - To not prevent standalone rendering.
• Document Content Does Not Contain $Macros - Macros introduce dependencies and reduce portability of a document.
• Page Template Macro Id Is Lowercase - Follow convention for variable names.
• Page Template Containing Multiple Macros Is Postfixed With Renderer - File acts as macro repository.

MessageSearch

• Do Not Add Any New Messages To User Interface - Message catalog is sufficient.

MethodSearch

• Python Script Method Name Be Prefixed With Portal Type - The context should always be visible.
• Method Name Is Prefixed With Portal Or Meta Type, Class Or Interface - Context must be clear.
• Language Priority - 
• Only Site Wide Script Uses ERP5Site Prefix - This should be an exception.
• Method Name Uses Mixed Case And Begins With Verb - To ensure consistent naming patterns.
• Listbox Method Is Named Using Module Type And Portal Type List - For consistent naming in forms.
• Report Method Name Uses ReportSectionList Postfix - for consistent naming.

ModuleSearch

• Set Form Id To ModulePortalType_viewPortalTypeList - For form consistency.
• Use form_list Page Template On Forms - To name and declare forms consistently.
• Use Proxy Fields Of Proxy Fields In Form - To improve consistency and maintainability.
• Add Column Portal Type If Listbox Contains Multiple Types - The listbox title will not display all types.
• Set Content Permission To Fast Input - Fast Inputs usually create sub documents or modify content.
• Never Allow Relation String Fields To Set Relations To Categories - Categories are too complex to relate.
• Use Method Post And UTF-8 Encoding On Forms - To name and declare forms consistently.
• Listbox Selection Name Must Follow module_name_selection Pattern - It is used to find parameters in listbox.
• The Listbox Method Should Be Defined As SearchFolder To View Modules - To use portal catalog to display module content.
• Set Form Action To Base_edit - For form consistency.
• Define Document Actions As Global Actions - Global actions will automatically be present.
• Listbox Must Only Be Put In Form Bottom Group - This is the default view of a module.
• Unset Acquire Local Roles On Document Portal Type Configuration If Applicable - sub and parent document security may differ.
• Use Correct Names For Simulation And Validation Titles - For consistent titles across ERP5.
• Place Simulation And Validation Fields At Bottom Of Right Group - Form consistency.
• Set Listbox Title To Plural Of Portal Type Title If Applicable - Listbox title should reflect portal types displayed.
• Define Declare Fast Input As Hidden Content Type - Use of fast input depends on use case.
• Set Priorities On Important Activities - To allow these activities to be executed faster.
• Define Transition Title From A Business Point Of View - User must understand easily.
• Define The Roles Allowed To Excecute A Transition - Follow ERP5 5A security model.
• Define Action Name Explicitly For Users - They are visible on the user interface.
• Include Module Base Categories In Business Template - They will not be created automatically.
• Split Large Forms On Multiple Tabs - Multiple views preserver clarity.
• Define Count Method As countFolder On Module Listbox - To use portal catalog.
• Use Translated Portal Type To Display Portal Type - To enable automatic translation.
• Set Listbox Action To List Action On Document Form Listboxes - To allow clicking on listbox title.
• Configuration And Project Business Templates Must Include Roles For Group, Site And Function - Extend generic security permissions.
• Include Module Local Roles In Business Template - They will not be created automatically.
• ListField Or MultListField For Categories Must Use Item List Method - Preserve consistency in pop-up field rendering.
• Add Viewable Listbox Fields To More Columns - To allow user to view and toggle.
• A Fast Input Must Use object_fast_input Action - Never configure as object_exchange action.
• Define Module Default Actions On Portal Action Tool - And not as portal type actions.
• Forms Must Use Left, Right, Center, Bottom And Hidden Groups - To allow consistent form rendering.
• Define Module Author And Auditor In Roles Tab Based On Use Cases - Follow ERP 5A Security model.
• Use getTranslatedId To Display Document Ids In Listbox Or Form - Special Ids need meaningful translation.
• Never Set Search Row And Select Column On Listbox Inside Document View - It is not allowed in view mode.
• Favor simulation_state Or validation_state For Workflow State - Stored in portal_catalog.
• Add Date In Listbox As Editable Date-Time Field - To allow to automatically adjust date format based on user preference.
• Set Description On Form Fields - Used to generate tool tips.
• Use Activities For Heavy Computations - To maintain responsive system.
• Do Not Test Required In Field View Form - This should be done in constraints.
• Do Not Mix Description And Comment - They have different meanings.
• Generic Business Templates Must Have Security Roles Set On States And Transitions - Must always be present.
• Workflow Validation Scripts Must Be Well Defined - To ensure data consistency.
• Never Show Or Make User Work With Document Id - Expose title and reference only.
• Listbox Only Tabs Should Have A Read Only Title In Center Group - To display info on what is being shown.
• Set At Least View Action On Module Action Tab - Only actions required should be set by default.
• Define And Translate Workflow Titles - For a meaningful workflow history.
• Workflow Validation Scripts Must Return Translated Messages - They are visible in user interface and workflow history.
• Define Workflow Permission To Allow Redefinition On Workflow States - This allows redefiniton on each document.
• The Default Dialog Should Be Used For All Transitions - Base_viewWorkflowActionDialog should always be enough.
• Define Report Actions As object_report Linked With View Permission - To enable fast report button.
• Set Post Method And Utf-8 Encoding On Document Forms - For form consistency.
• Set List Method To contentValues On Document Form Listbox - Subobjects should be displayed.
• A Validation Workflow Must Have A Delete State And Action - Deleting a document is part of the document life cycle.
• Set Listbox Selection Name To form_name_selection_name - Names must be unique.
• First Level Portal Types Should Have A Validation Workflow - Documents follow a lifecycle.
• Define Workflow Titles From A Business Point Of View - User must understand easily
• A Document Form Uses The form_view Page Template - For consistency across all forms.
• Set Form Encytype to multipart/form-data When Using File Upload - For form consistency.
• Never Use Multiple Modules For Person Or Organisation - Use roles for classification.
• Set Document Form Ids To PortalType_view - This is the naming convention.
• Set Form Title To What Is Displayed - For form consistency.
• Workflows Should Define Worklists - So user knows what he has to do in My Favorites.
• Set Form Action Base_doSelect On Forms - To name and declare forms consistently.
• Inside The Roles Tab, Assignor, Assignee, Associate And Auditor Must Be Defined - Follow 5A security model.
• Set Document Form Titles To What Is Displayed - Usually this is the portal type title.
• Hide Listbox Editable Fields On The Form - To ensure they are not rendered.
• Always Provide Portal Type Description - Modules can be complex, short description is helpful

Module Portal TypeSearch

• Use Localizer For Module Title Translation - Module titles are part of user interface.

NameSearch

• Semantic Field Is Named Using My Prefix, Technical Context And Semantic Name - Differentiate between semantic and technical template fields.
• Document Name Is Camel Case And Dot Separated - Name in document name
• Use My Prefix and Class Name For Template Field Name - To prevent creating multiple technical template fields.

Naming ConventionSearch

• Reference Should Never Use Arbitrary Numbers Or Abbreviations - Be concise.
• In Document Name Publication Section Is Written In Camelcase - Publication Section convention.
• Document Name Must Use Anchor, Reference, Name, Version, Language And File Type - Main rule for document names.
• Publication Section In Document Name Is Separated By Hypen And Lowercase - When used in document name
• Version Number Is Ascending And Use Three Digits - Versioning in document name.
• Business Reference Is An Uppercase Id And Number Sequence Separated By Hyphen - Used as document name anchor.
• Document Name Is Camel Case And Dot Separated - Name in document name
• Image Uses Publication Section As Anchor Reference - Patterns for working with images.
• Group Reference Is Uppercase And Uses Category Value - Group determines viewing permission.
• Reference Anchor Uses Uppercase Group, Project, Publication Section Or Business - Document name reference options.
• Project Reference Uses A Suffix And Character Sequence Separated By Hyphen - Document name project reference rules.
• Language Is Abbreviated As Two Lowercase Characters - Language in document name.

OverrideSearch

• Call Parent Method For Zope Hook Method Override In Python - Needs an explanation.

Page TemplateSearch

• Page Template Macro Variables Must Be Defined In Header - To not prevent standalone rendering.
• Page Template Macro Id Is Lowercase - Follow convention for variable names.
• Page Template Containing Multiple Macros Is Postfixed With Renderer - File acts as macro repository.
• Page Template Uses Method Naming Conventions - As page templates are used like scripts.

PluralSearch

• Plural Is Not Allowed - They can be amiguous.
• Plural In ERP5 Is Written Using List And Count - Plural is forbidden in ERP5.

Portal CatalogSearch

• SQL Column Id Use Singular For Related Key - To ensure consistent SQL naming.
• SQL Column Id Is Lowercase - To ensure consistency in SQL tables.
• ZSQL Method Is Lowercase And Uses Z Prefix And Underscore Separator - For consistent naming.

Portal SkinSearch

• ZSQL Method Is Prefixed With Z In Portal Skin - For consistent naming.

Portal TypeSearch

• Set Content Permission To Fast Input - Fast Inputs usually create sub documents or modify content.
• Define Document Actions As Global Actions - Global actions will automatically be present.
• Define Declare Fast Input As Hidden Content Type - Use of fast input depends on use case.
• Define Action Name Explicitly For Users - They are visible on the user interface.
• A Fast Input Must Use object_fast_input Action - Never configure as object_exchange action.
• Define Module Default Actions On Portal Action Tool - And not as portal type actions.
• Tool Title Is Plural - For consistent naming patterns.
• Define Report Actions As object_report Linked With View Permission - To enable fast report button.
• Module Title Is Plural, Capitalized And Space Separated - For consistent naming patterns.

PrintSearch

• Never Print Directly - Always go through a dialog.

ProductSearch

• A Python Class Is Defined Inside ERP5 Product Only - For consistent patterns across ERP5.

ProgramSearch

• User Interface Must Use Uppercase Abbreviations - For consistent naming patterns.
• Field Title Must Be Singular, Capitalized And Uses Space Separator - Visible in user interface.
• Python Script Method Name Be Prefixed With Portal Type - The context should always be visible.
• Validator Method Is Prefixed With Validator - To provide context.
• Method Name Is Prefixed With Portal Or Meta Type, Class Or Interface - Context must be clear.
• Use Recommended Layout CSS Classes - To ensure consistent layouts.
• Language Priority - 
• Workflow State Is Single Adjective Or Verb - To ensure consistent layouts.
• Page Template Macro Variables Must Be Defined In Header - To not prevent standalone rendering.
• Never Use Or Overload Reserved CSS Ids - To ensure the UI stays consistent.
• User Interface Module Title Is Singular, Separated By Space And Capitalized - Visible to the user.
• SQL Column Id Use Singular For Related Key - To ensure consistent SQL naming.
• Form Name Uses Lowercase View After Portal Type - For consistent naming.
• Knowing Python And Zope Is Required For Developing ERP5 - The basics a deveoper needs.
• Never Forget Edit Workflow On Documents - Needed to track creation and modification history.
• Sentence Starts With Capital Letter And Finishes With Semi-Colon Or Full-Stop - Make text consistent.
• Only Site Wide Script Uses ERP5Site Prefix - This should be an exception.
• Method Name Uses Mixed Case And Begins With Verb - To ensure consistent naming patterns.
• Page Template Macro Id Is Lowercase - Follow convention for variable names.
• Pseudo Constant Uses Uppercase In ERP5 - Consistent naming patterns.
• Listbox Method Is Named Using Module Type And Portal Type List - For consistent naming in forms.
• Dialog Form Name Is Postfixed With Dialog - For consistent naming.
• Rule Uses Optional Root And Mandatory Simulation Rule Postfix - For naming consistency.
• Listbox Selection Uses Name Selection Postfix - For consistent naming.
• Tool Title Is Plural - For consistent naming patterns.
• Form Report Dialog Is Postfixed With Report - For consistent naming
• SQL Column Id Is Lowercase - To ensure consistency in SQL tables.
• Never Print Directly - Always go through a dialog.
• Interface Name Uses Camelcase - To ensure consistent naming patterns.
• ZSQL Method Is Prefixed With Z In Portal Skin - For consistent naming.
• Report Name Uses Portal Type Followed By View Report Name And Report - For consistent naming.
• Never Render Reports Directly - Always go through dialog.
• Page Template Containing Multiple Macros Is Postfixed With Renderer - File acts as macro repository.
• Abbreviations Are Not Allowed In ERP5 Code - Code must be understandable.
• Reserved CSS Classes Should Not Be Used Or Overloaded - To ensure the UI stays consistent.
• Report Method Name Uses ReportSectionList Postfix - for consistent naming.
• Do Not Add Any New Messages To User Interface - Message catalog is sufficient.
• Document Has Mandatory View And Optional Detais And History Tab - For consistent appearance.
• Variable Name Is Lowercase Separated By Underscore - Independent of language used.
• A Python Class Is Defined Inside ERP5 Product Only - For consistent patterns across ERP5.
• Method In Listbox Is Prefixed With Listbox Section - To provide understandable context.
• ZSQL Method Is Lowercase And Uses Z Prefix And Underscore Separator - For consistent naming.
• PDF Style Sheet Should Also Follow Form And Method Conventions - To ensure consistent naming patterns.
• Attribute Must Be Assigned Only To Object Or Class - For consistent patterns across ERP5.
• Metadata Is Last Tab For Managers - For consistent appearance.
• Module Title Is Plural, Capitalized And Space Separated - For consistent naming patterns.
• Page Template Uses Method Naming Conventions - As page templates are used like scripts.
• Tab Title Is Singular Capitalized And Space Separated - For consistent naming patterns.
• Listbox Uses List, Stat Or Count Method - For consistent naming.
• Assign Properties To Zope Objects Only - For consistent patterns across ERP5.
• Plural In ERP5 Is Written Using List And Count - Plural is forbidden in ERP5.

ProgrammingSearch

• Never Hardcode Category In Scripts Or Classes - Reduces code flexibility and portability.

ProjectSearch

• Project Reference Uses A Suffix And Character Sequence Separated By Hyphen - Document name project reference rules.

PropertySearch

• Use Methods To Access Properties In ERP5 - ERP5 is method based.
• Never Store Calculation Result In Python Property - Only store original content.
• Never Name A Base Category The Same As A Property In ERP5 - They form a global vocabulary.
• Assign Properties To Zope Objects Only - For consistent patterns across ERP5.

ProxySearch

• Technical Template Fields Are Defined In Base_viewFieldLibrary - Non semantic fields should not be duplicated.
• Field Library Fields Should Be Semantically Unified - Use consistent naming patterns.
• Semantic Field Should Be Used In Favor Of Technical Field - Semantic fields are more specific and descriptive.
• Only Use Proxy Fields In Non Field Library Forms - To prevent excessive customisation.
• Proxy Fields Should Share Semantics - To keep consistency across fields.
• A Form Field Proxies From A Buiness Template Field - Differentiate Core, Business and Custom Fields.
• A Proxy Field Never Links To An External Field Library - Business templates must work standalone.
• Business Library Fields Proxy From Core Fields - Use three levels: core, business, custom
• Use Glossary Defined Prefix For Specific Semantics - Field libraries should be consistent within.

Proxy FieldSearch

• Use Proxy Fields Of Proxy Fields In Form - To improve consistency and maintainability.

Publication SectionSearch

• Publication Section In Document Name Is Separated By Hypen And Lowercase - When used in document name

PythonSearch

• Use Methods To Access Properties In ERP5 - ERP5 is method based.
• Never Use aq_parent To Get Document Parent In Python - Use getParentValue()
• Never Override Python Builtin Names - Debugging will be much harder.
• Python Class Method Should Have Security Declaration - Don't forget security declaration on class methods.
• Knowing Python And Zope Is Required For Developing ERP5 - The basics a deveoper needs.
• FailUnless Should Not Be Used In Python Unit Tests To Test Identity - Use assertEqual.
• Never Store Calculation Result In Python Property - Only store original content.
• Never Use Python If Obj if Obj Is Not A Simple Type - Truth testing in Zope/ERP5 can be surprising.
• Call Parent Method For Zope Hook Method Override In Python - Needs an explanation.

RecommendationSearch

• The Listbox Method Should Be Defined As SearchFolder To View Modules - To use portal catalog to display module content.
• Content Should Be Served By Cdn If Anonymous< - Hosting guideline.
• Unset Acquire Local Roles On Document Portal Type Configuration If Applicable - sub and parent document security may differ.
• Use Recommended Layout CSS Classes - To ensure consistent layouts.
• Web Section And Exportable Document Should Have Short Title Specified - Used in exports.
• Create Resonable Log Messages - The code will be read in many contexts.
• External Link Should Have Target Attribtue Specified - To make sure user stays on the current page.
• Document Should Have Follow-Up Defined - Follow-Up handles theming and relation to other objects
• Documentation Document Should Have License Specified - Determining how this document may be used.
• Python Class Method Should Have Security Declaration - Don't forget security declaration on class methods.
• Beware of Editor Autoformat - Patterns to avoid when creating document content.
• Read Patch Before Commit - Read your patch before committing.
• Knowing Python And Zope Is Required For Developing ERP5 - The basics a deveoper needs.
• Prevent Acquisition From Acquiring Restricted Properties In Python - To prevent acquisition errors.
• Field Library Fields Should Be Semantically Unified - Use consistent naming patterns.
• Semantic Field Should Be Used In Favor Of Technical Field - Semantic fields are more specific and descriptive.
• Proxy Fields Should Share Semantics - To keep consistency across fields.
• Content Should Be Served Using Asset And Blob Subdomains - Convention for working with urls.
• Link Title Should Be Defined On Documentation Document Links - Required for certain templates.
• Favor simulation_state Or validation_state For Workflow State - Stored in portal_catalog.
• Use Activities For Heavy Computations - To maintain responsive system.
• Do Not Mix Description And Comment - They have different meanings.
• Use Of JavaScript Globals Is Discouraged - Better never declare any globals anyway.
• Image Should Have Publication Section Defined - To make images more easy to discover.
• Comments Should Be Used Wisely - Don't make unnecessary comments.
• Listbox Only Tabs Should Have A Read Only Title In Center Group - To display info on what is being shown.
• Reserved CSS Classes Should Not Be Used Or Overloaded - To ensure the UI stays consistent.
• The Default Dialog Should Be Used For All Transitions - Base_viewWorkflowActionDialog should always be enough.
• Document Should Have Explicit Predecessors And Successors Defined - To improve overall document strucute.
• First Level Portal Types Should Have A Validation Workflow - Documents follow a lifecycle.
• PDF Style Sheet Should Also Follow Form And Method Conventions - To ensure consistent naming patterns.
• Add Complete Description To Glossary Terms - To provide context which is often needed.
• Code Should Work If All Else Fails - Always assume a part your code is depending on may not work.
• Workflows Should Define Worklists - So user knows what he has to do in My Favorites.
• Call Parent Method For Zope Hook Method Override In Python - Needs an explanation.

ReferenceSearch

• Document Name Must Use Anchor, Reference, Name, Version, Language And File Type - Main rule for document names.
• Documentation Document Anchor Uses Software And Publication Section Split By Hyphen - Documentation reference convention.
• Reference Anchor Uses Uppercase Group, Project, Publication Section Or Business - Document name reference options.

ReindexSearch

• Never Never Use Reindex In ERP5 - Reindexing is for debugging only.

ReportSearch

• Language Priority - 
• Form Report Dialog Is Postfixed With Report - For consistent naming
• Report Name Uses Portal Type Followed By View Report Name And Report - For consistent naming.
• Never Render Reports Directly - Always go through dialog.
• Report Method Name Uses ReportSectionList Postfix - for consistent naming.
• Define Report Actions As object_report Linked With View Permission - To enable fast report button.

ResiliencySearch

• Code Should Work If All Else Fails - Always assume a part your code is depending on may not work.

RoleSearch

• Never Use Multiple Modules For Person Or Organisation - Use roles for classification.

RuleSearch

• A Non Anonymous JavaScript Method Must Be Declared Before Use - Jslint will throw on this, too.
• Set Form Id To ModulePortalType_viewPortalTypeList - For form consistency.
• Use form_list Page Template On Forms - To name and declare forms consistently.
• Use Proxy Fields Of Proxy Fields In Form - To improve consistency and maintainability.
• Semantic Field Is Named Using My Prefix, Technical Context And Semantic Name - Differentiate between semantic and technical template fields.
• Add Column Portal Type If Listbox Contains Multiple Types - The listbox title will not display all types.
• In Document Name Publication Section Is Written In Camelcase - Publication Section convention.
• Technical Template Fields Are Defined In Base_viewFieldLibrary - Non semantic fields should not be duplicated.
• Set Content Permission To Fast Input - Fast Inputs usually create sub documents or modify content.
• Link Text On Applicable And Referenced Documents Is AD/RD - Counters are added automatically.
• User Interface Must Use Uppercase Abbreviations - For consistent naming patterns.
• Field Title Must Be Singular, Capitalized And Uses Space Separator - Visible in user interface.
• Sessions Are Not Allowed - Sessions are incompatible with clustering.
• Document Name Must Use Anchor, Reference, Name, Version, Language And File Type - Main rule for document names.
• Use gender neutral writing in documentation - Make text consistent.
• Use Methods To Access Properties In ERP5 - ERP5 is method based.
• Image Must Have Alt Attribute - Required for certain templates. Add manually or dynamically.
• Use Method Post And UTF-8 Encoding On Forms - To name and declare forms consistently.
• Listbox Selection Name Must Follow module_name_selection Pattern - It is used to find parameters in listbox.
• Set Form Action To Base_edit - For form consistency.
• Python Script Method Name Be Prefixed With Portal Type - The context should always be visible.
• Define Document Actions As Global Actions - Global actions will automatically be present.
• Document Title Uses Capitalized Keywords Prefixed By Publication Section - Convention for Documentation title.
• Link To Applicable Or Referenced Document Uses Title And Is Wrapped In Square Brackets - To flag links for auto tables.
• Image Must Have Alt Attribute For Automatic Captioning - Always add manually or dynamically.
• Listbox Must Only Be Put In Form Bottom Group - This is the default view of a module.
• Link Explaining Abbreviation Is Wrapped in Square Bracket And Uses Abbreviation As Link Text - For automatic link formatting.
• Use Correct Names For Simulation And Validation Titles - For consistent titles across ERP5.
• Validator Method Is Prefixed With Validator - To provide context.
• Place Simulation And Validation Fields At Bottom Of Right Group - Form consistency.
• Set Listbox Title To Plural Of Portal Type Title If Applicable - Listbox title should reflect portal types displayed.
• Method Name Is Prefixed With Portal Or Meta Type, Class Or Interface - Context must be clear.
• Documentation Document Anchor Uses Software And Publication Section Split By Hyphen - Documentation reference convention.
• Define Declare Fast Input As Hidden Content Type - Use of fast input depends on use case.
• Set Priorities On Important Activities - To allow these activities to be executed faster.
• Language Priority - 
• Document Theme Is Set Using Follow Up Software Product - For predicate and themeing.
• Logs Must Contain Their Cause - Test report must contain info on the cause of a log
• Define Transition Title From A Business Point Of View - User must understand easily.
• Workflow State Is Single Adjective Or Verb - To ensure consistent layouts.
• Define The Roles Allowed To Excecute A Transition - Follow ERP5 5A security model.
• Abbreviations Are Not Allowed - Context is lost quickly.
• Page Template Macro Variables Must Be Defined In Header - To not prevent standalone rendering.
• Png Is Saved In Image And Svg In Web Page Module - SVGs are written in xml.
• SVG Image Must Have Format Specified In Url - Format should always be defined.
• JavaScript Closing Bracket Is At Indent Of Function Call - Consistent coding patterns.
• Log Clear Enough To Disable Easily - It should be easy to track logs in the code.
• Live Tests Should Not Be Run On Production - Create and remove data is dangerous in production.
• Define Action Name Explicitly For Users - They are visible on the user interface.
• Use Path Links For Linking To Images Or Assets - Convention for working with inks in document content
• User Interface Module Title Is Singular, Separated By Space And Capitalized - Visible to the user.
• SQL Column Id Use Singular For Related Key - To ensure consistent SQL naming.
• JavaScript Opening Brace Is On Line Of Current Statement - Consistent coding patterns.
• Include Module Base Categories In Business Template - They will not be created automatically.
• Documentation Document Must Have Introduction Paragraph - Explain WHY document was written.
• Document Content Is Written In British English - General principle in ERP5 regarding language.
• Split Large Forms On Multiple Tabs - Multiple views preserver clarity.
• A Screeshot Displays Full Screen Without Bars - Patterns for working with screenshots.
• Image Format Must Be SVG Or PNG - No other formats are allowed (jpg/gif)
• Define Count Method As countFolder On Module Listbox - To use portal catalog.
• Publication Section In Document Name Is Separated By Hypen And Lowercase - When used in document name
• Use Translated Portal Type To Display Portal Type - To enable automatic translation.
• Table Uses Thead Tbody And Caption Tags - For consistent appearance.
• Form Name Uses Lowercase View After Portal Type - For consistent naming.
• JavaScript Constructor Starts With Captial Letter - Consistent Javascript patterns.
• A Link Between Internal Documents Uses A Relative Url - General link pattern convention.
• Only Use Proxy Fields In Non Field Library Forms - To prevent excessive customisation.
• Headers Start At Level 1 And Are Not Numbered - Numbers and downgrades are made automatically.
• Set Listbox Action To List Action On Document Form Listboxes - To allow clicking on listbox title.
• Configuration And Project Business Templates Must Include Roles For Group, Site And Function - Extend generic security permissions.
• Version Number Is Ascending And Use Three Digits - Versioning in document name.
• Include Module Local Roles In Business Template - They will not be created automatically.
• Sentence Starts With Capital Letter And Finishes With Semi-Colon Or Full-Stop - Make text consistent.
• Method Name Is Camelcase Starting With Lowercase Letter - Consistency across languages
• ListField Or MultListField For Categories Must Use Item List Method - Preserve consistency in pop-up field rendering.
• Only Site Wide Script Uses ERP5Site Prefix - This should be an exception.
• Add Viewable Listbox Fields To More Columns - To allow user to view and toggle.
• A Fast Input Must Use object_fast_input Action - Never configure as object_exchange action.
• Define Module Default Actions On Portal Action Tool - And not as portal type actions.
• Fix Whitespace In A Separate Commit - It is a motivation to fix unneeded whitespace.
• Forms Must Use Left, Right, Center, Bottom And Hidden Groups - To allow consistent form rendering.
• Method Name Uses Mixed Case And Begins With Verb - To ensure consistent naming patterns.
• Commits Are Atomic - Changes from a motivation must be committed together.
• Page Template Macro Id Is Lowercase - Follow convention for variable names.
• Define Module Author And Auditor In Roles Tab Based On Use Cases - Follow ERP 5A Security model.
• Use Log Levels - Log levels help understand the importance of a log.
• Business Reference Is An Uppercase Id And Number Sequence Separated By Hyphen - Used as document name anchor.
• Pseudo Constant Uses Uppercase In ERP5 - Consistent naming patterns.
• Listbox Method Is Named Using Module Type And Portal Type List - For consistent naming in forms.
• Use getTranslatedId To Display Document Ids In Listbox Or Form - Special Ids need meaningful translation.
• Image Must Have Format And Display Parameter In Url - To not render images in original format and size.
• Use Base_view Prefix Followed By Business Filed and FieldLibrary For Field Library Title - For naming consistency.
• Dialog Form Name Is Postfixed With Dialog - For consistent naming.
• Private Method Starts With Underscore - Consistent patterns.
• Rule Uses Optional Root And Mandatory Simulation Rule Postfix - For naming consistency.
• Commits Are Purpose Based - A change in code must have a motivation (like fixing a bug).
• Text From The User Interface Is Written In Italic - To highlight text to interact with.
• Document Name Is Camel Case And Dot Separated - Name in document name
• Listbox Selection Uses Name Selection Postfix - For consistent naming.
• A Form Field Proxies From A Buiness Template Field - Differentiate Core, Business and Custom Fields.
• Tool Title Is Plural - For consistent naming patterns.
• Image Uses Publication Section As Anchor Reference - Patterns for working with images.
• Add Date In Listbox As Editable Date-Time Field - To allow to automatically adjust date format based on user preference.
• Image Should Not Be Wrapped By Hand For Fullsize Viewing - It will be done automatic.
• Set Description On Form Fields - Used to generate tool tips.
• Code Snippet Uses Code Tag Wrapped In Pre Tag - Code section convention.
• Code Must Be Validated With JsLint - To ensure consistent syntax and quality.
• Use Path Links For Links To Large Files - Security and portability matter.
• Use Two Space Indentation - Consistent code indentation across languages.
• Do Not Test Required In Field View Form - This should be done in constraints.
• Form Report Dialog Is Postfixed With Report - For consistent naming
• SQL Column Id Is Lowercase - To ensure consistency in SQL tables.
• Interface Name Uses Camelcase - To ensure consistent naming patterns.
• Short Title On Documentation Documents Uses Title Without Publication Section - Short title convention.
• ZSQL Method Is Prefixed With Z In Portal Skin - For consistent naming.
• Report Name Uses Portal Type Followed By View Report Name And Report - For consistent naming.
• Generic Business Templates Must Have Security Roles Set On States And Transitions - Must always be present.
• Workflow Validation Scripts Must Be Well Defined - To ensure data consistency.
• End A File With Empty Line - Some tools cannot handle, display file as truncated.
• Never Hardcode If Not Necessary - Hard code is hard to maintain.
• Page Template Containing Multiple Macros Is Postfixed With Renderer - File acts as macro repository.
• Document Keywords Are Lowercase Singular And Line Separated - Keywords are used.
• Use My Prefix and Class Name For Template Field Name - To prevent creating multiple technical template fields.
• Set At Least View Action On Module Action Tab - Only actions required should be set by default.
• Define And Translate Workflow Titles - For a meaningful workflow history.
• Workflow Validation Scripts Must Return Translated Messages - They are visible in user interface and workflow history.
• Define Workflow Permission To Allow Redefinition On Workflow States - This allows redefiniton on each document.
• Abbreviations Are Not Allowed In ERP5 Code - Code must be understandable.
• Use Of JavaScript Id Attribute Is Not Allowed - Duplicate ids will beak a page.
• Report Method Name Uses ReportSectionList Postfix - for consistent naming.
• Test Changes Before Committing - Verify that system is usable after your change.
• Write Testable Code And Test Smart - To create quality code and tests.
• Use Localizer For Module Title Translation - Module titles are part of user interface.
• Group Reference Is Uppercase And Uses Category Value - Group determines viewing permission.
• Plural Is Not Allowed - They can be amiguous.
• Reference Anchor Uses Uppercase Group, Project, Publication Section Or Business - Document name reference options.
• Do Not Add Any New Messages To User Interface - Message catalog is sufficient.
• Document Has Mandatory View And Optional Detais And History Tab - For consistent appearance.
• Define Report Actions As object_report Linked With View Permission - To enable fast report button.
• Variable Name Is Lowercase Separated By Underscore - Independent of language used.
• A Python Class Is Defined Inside ERP5 Product Only - For consistent patterns across ERP5.
• Set Post Method And Utf-8 Encoding On Document Forms - For form consistency.
• Set List Method To contentValues On Document Form Listbox - Subobjects should be displayed.
• Method In Listbox Is Prefixed With Listbox Section - To provide understandable context.
• A Validation Workflow Must Have A Delete State And Action - Deleting a document is part of the document life cycle.
• Set Listbox Selection Name To form_name_selection_name - Names must be unique.
• Define Workflow Titles From A Business Point Of View - User must understand easily
• ZSQL Method Is Lowercase And Uses Z Prefix And Underscore Separator - For consistent naming.
• Use Only Allowed Html Tags - Conventions on html tags in document content.
• Inline CSS And JavaScript Are Not Allowed - Content should be free of layout instructions.
• A Business Template Has Only One Field Library - Field libraries share semantic configuration.
• Attribute Must Be Assigned Only To Object Or Class - For consistent patterns across ERP5.
• A Proxy Field Never Links To An External Field Library - Business templates must work standalone.
• Modify Correct Changelog On Business Template Commits - Differentiate major changes and purpose changelog.
• A Document Form Uses The form_view Page Template - For consistency across all forms.
• Set Form Encytype to multipart/form-data When Using File Upload - For form consistency.
• Project Reference Uses A Suffix And Character Sequence Separated By Hyphen - Document name project reference rules.
• JavaScript Class Name And Id Attribute Are Lowercase With Underscore Separator - General coding convention.
• A Documentation Document Must Have Group And Classification Defined - This determines accessibility.
• Set Document Form Ids To PortalType_view - This is the naming convention.
• Business Library Fields Proxy From Core Fields - Use three levels: core, business, custom
• Embedded SVG Image Must Have A Format Specified - Source format must be defined.
• Set Form Title To What Is Displayed - For form consistency.
• Metadata Is Last Tab For Managers - For consistent appearance.
• Module Title Is Plural, Capitalized And Space Separated - For consistent naming patterns.
• Page Template Uses Method Naming Conventions - As page templates are used like scripts.
• Table Has Caption Defined After Tbody Tag - Normally it should be a the top.
• Set Form Action Base_doSelect On Forms - To name and declare forms consistently.
• Inside The Roles Tab, Assignor, Assignee, Associate And Auditor Must Be Defined - Follow 5A security model.
• Set Document Form Titles To What Is Displayed - Usually this is the portal type title.
• Language Is Abbreviated As Two Lowercase Characters - Language in document name.
• Documentation Document Is Classified Using Publication Section - For categorising documentation.
• Abbreviation Link Title Must Contain Abbreviated Text And Description Split By Semicolon - To create table of document abbreviations.
• Tab Title Is Singular Capitalized And Space Separated - For consistent naming patterns.
• Hide Listbox Editable Fields On The Form - To ensure they are not rendered.
• Document Content Is Written In HTML5 - Documents are written in HTML5.
• Listbox Uses List, Stat Or Count Method - For consistent naming.
• Assign Properties To Zope Objects Only - For consistent patterns across ERP5.
• Plural In ERP5 Is Written Using List And Count - Plural is forbidden in ERP5.
• Documentation Document Must Have Description Abstract - Explain WHAT document contains.
• Use Glossary Defined Prefix For Specific Semantics - Field libraries should be consistent within.
• Always Provide Portal Type Description - Modules can be complex, short description is helpful

ScaleSearch

• Sessions Are Not Allowed - Sessions are incompatible with clustering.
• Cookies Are Not Allowed - Cookies have limitations and should not be used in ERP5.
• Never Use ZODB Temp Folder Across Multiple Requests - Incompatible with ZEO and clustering.

ScreenshotSearch

• A Screeshot Displays Full Screen Without Bars - Patterns for working with screenshots.

ScriptSearch

• Python Script Method Name Be Prefixed With Portal Type - The context should always be visible.
• Validator Method Is Prefixed With Validator - To provide context.
• Method Name Is Prefixed With Portal Or Meta Type, Class Or Interface - Context must be clear.
• Only Site Wide Script Uses ERP5Site Prefix - This should be an exception.
• Method In Listbox Is Prefixed With Listbox Section - To provide understandable context.

SecuritySearch

• Unset Acquire Local Roles On Document Portal Type Configuration If Applicable - sub and parent document security may differ.
• Define The Roles Allowed To Excecute A Transition - Follow ERP5 5A security model.
• Include Module Base Categories In Business Template - They will not be created automatically.
• Python Class Method Should Have Security Declaration - Don't forget security declaration on class methods.
• Configuration And Project Business Templates Must Include Roles For Group, Site And Function - Extend generic security permissions.
• Include Module Local Roles In Business Template - They will not be created automatically.
• Define Module Author And Auditor In Roles Tab Based On Use Cases - Follow ERP 5A Security model.
• Generic Business Templates Must Have Security Roles Set On States And Transitions - Must always be present.
• Inside The Roles Tab, Assignor, Assignee, Associate And Auditor Must Be Defined - Follow 5A security model.

SelectionSearch

• Listbox Selection Uses Name Selection Postfix - For consistent naming.

SimulationSearch

• Use Correct Names For Simulation And Validation Titles - For consistent titles across ERP5.
• Place Simulation And Validation Fields At Bottom Of Right Group - Form consistency.
• Rule Uses Optional Root And Mandatory Simulation Rule Postfix - For naming consistency.

SpecificitySearch

• Semantic Field Should Be Used In Favor Of Technical Field - Semantic fields are more specific and descriptive.
• Business Library Fields Proxy From Core Fields - Use three levels: core, business, custom

SqlSearch

• SQL Column Id Use Singular For Related Key - To ensure consistent SQL naming.
• SQL Column Id Is Lowercase - To ensure consistency in SQL tables.
• ZSQL Method Is Prefixed With Z In Portal Skin - For consistent naming.
• ZSQL Method Is Lowercase And Uses Z Prefix And Underscore Separator - For consistent naming.

StateSearch

• Workflow State Is Single Adjective Or Verb - To ensure consistent layouts.

Style SheetSearch

• PDF Style Sheet Should Also Follow Form And Method Conventions - To ensure consistent naming patterns.

TabSearch

• Split Large Forms On Multiple Tabs - Multiple views preserver clarity.
• Listbox Only Tabs Should Have A Read Only Title In Center Group - To display info on what is being shown.
• Document Has Mandatory View And Optional Detais And History Tab - For consistent appearance.
• Metadata Is Last Tab For Managers - For consistent appearance.
• Tab Title Is Singular Capitalized And Space Separated - For consistent naming patterns.

TableSearch

• Table Uses Thead Tbody And Caption Tags - For consistent appearance.
• Table Has Caption Defined After Tbody Tag - Normally it should be a the top.

TestSearch

• Logs Must Contain Their Cause - Test report must contain info on the cause of a log
• Live Tests Should Not Be Run On Production - Create and remove data is dangerous in production.
• FailUnless Should Not Be Used In Python Unit Tests To Test Identity - Use assertEqual.
• Never Log Level Info Or More In Execution Path - Avoid trivial logs.
• Use Log Levels - Log levels help understand the importance of a log.
• Test Changes Before Committing - Verify that system is usable after your change.
• Write Testable Code And Test Smart - To create quality code and tests.
• Never Create Interdependent Test Methods - It makes finding broken tests much harder.
• Never Use Python If Obj if Obj Is Not A Simple Type - Truth testing in Zope/ERP5 can be surprising.

TextSearch

• Use gender neutral writing in documentation - Make text consistent.
• Documentation Document Must Have Introduction Paragraph - Explain WHY document was written.
• Sentence Starts With Capital Letter And Finishes With Semi-Colon Or Full-Stop - Make text consistent.
• Text From The User Interface Is Written In Italic - To highlight text to interact with.

ThemeSearch

• Document Theme Is Set Using Follow Up Software Product - For predicate and themeing.

TicketSearch

• Project Reference Uses A Suffix And Character Sequence Separated By Hyphen - Document name project reference rules.

TitleSearch

• Document Title Uses Capitalized Keywords Prefixed By Publication Section - Convention for Documentation title.
• User Interface Module Title Is Singular, Separated By Space And Capitalized - Visible to the user.
• Short Title On Documentation Documents Uses Title Without Publication Section - Short title convention.
• Tab Title Is Singular Capitalized And Space Separated - For consistent naming patterns.

TransactionSearch

• Never Modify 100 Objects In A Transaction - Use activities instead.

TransitionSearch

• Never Use DoActionFor In ERP5 - Use transition methods to manually trigger workflow transitions.

TranslationSearch

• Document Content Is Written In British English - General principle in ERP5 regarding language.
• Never Translate Glossary Without Looking At Application - Ambiguity and context matter.
• Never Forget The Original Translation Can Be Bad - Always verify translations.
• Use Localizer For Module Title Translation - Module titles are part of user interface.
• Add Complete Description To Glossary Terms - To provide context which is often needed.
• Never Translate Without Tools Or Advice - Verify translations.
• Never Translate PO File Without Looking At The Application - Ambiguity and context matter.

UrlSearch

• Never Use GetPath To Retrieve A Url In ERP5 - Absolute and physical path may differ.
• Never Use Zodb Path In Url - Use front-end friendly url.

User InterfaceSearch

• User Interface Must Use Uppercase Abbreviations - For consistent naming patterns.
• Field Title Must Be Singular, Capitalized And Uses Space Separator - Visible in user interface.
• User Interface Module Title Is Singular, Separated By Space And Capitalized - Visible to the user.
• Text From The User Interface Is Written In Italic - To highlight text to interact with.
• Tool Title Is Plural - For consistent naming patterns.
• Do Not Add Any New Messages To User Interface - Message catalog is sufficient.
• Document Has Mandatory View And Optional Detais And History Tab - For consistent appearance.
• Metadata Is Last Tab For Managers - For consistent appearance.
• Module Title Is Plural, Capitalized And Space Separated - For consistent naming patterns.
• Tab Title Is Singular Capitalized And Space Separated - For consistent naming patterns.

ValidationSearch

• Use Correct Names For Simulation And Validation Titles - For consistent titles across ERP5.
• Validator Method Is Prefixed With Validator - To provide context.
• Place Simulation And Validation Fields At Bottom Of Right Group - Form consistency.
• Do Not Test Required In Field View Form - This should be done in constraints.

VariableSearch

• Variable Name Is Lowercase Separated By Underscore - Independent of language used.

VersionSearch

• Version Number Is Ascending And Use Three Digits - Versioning in document name.

Web ApplicationSearch

• Use Of JavaScript Id Attribute Is Not Allowed - Duplicate ids will beak a page.
• JavaScript Class Name And Id Attribute Are Lowercase With Underscore Separator - General coding convention.

WorkflowSearch

• Define Transition Title From A Business Point Of View - User must understand easily.
• Workflow State Is Single Adjective Or Verb - To ensure consistent layouts.
• Define The Roles Allowed To Excecute A Transition - Follow ERP5 5A security model.
• Configuration And Project Business Templates Must Include Roles For Group, Site And Function - Extend generic security permissions.
• Never Forget Edit Workflow On Documents - Needed to track creation and modification history.
• Favor simulation_state Or validation_state For Workflow State - Stored in portal_catalog.
• Never Hardcode Interactions - Use interaction workflows instead.
• Generic Business Templates Must Have Security Roles Set On States And Transitions - Must always be present.
• Workflow Validation Scripts Must Be Well Defined - To ensure data consistency.
• Define And Translate Workflow Titles - For a meaningful workflow history.
• Workflow Validation Scripts Must Return Translated Messages - They are visible in user interface and workflow history.
• Define Workflow Permission To Allow Redefinition On Workflow States - This allows redefiniton on each document.
• The Default Dialog Should Be Used For All Transitions - Base_viewWorkflowActionDialog should always be enough.
• Never Access State_change Object In ERP5 Workflow Scripts - Use state_change["attribute_name"].
• Never Use DoActionFor In ERP5 - Use transition methods to manually trigger workflow transitions.
• A Validation Workflow Must Have A Delete State And Action - Deleting a document is part of the document life cycle.
• First Level Portal Types Should Have A Validation Workflow - Documents follow a lifecycle.
• Define Workflow Titles From A Business Point Of View - User must understand easily
• Workflows Should Define Worklists - So user knows what he has to do in My Favorites.

WorklistSearch

• Workflows Should Define Worklists - So user knows what he has to do in My Favorites.

ZodbSearch

• Never Use ContentValues or ObjectValues On More Than 50 Documents In ZODB - Folders may contain million of documents.

ZodbSearch

• Never Write To ZODB If Not Required - ZODB is an incremental storage and every write creates more data.
• Never Use ZODB Temp Folder Across Multiple Requests - Incompatible with ZEO and clustering.

ZopeSearch

• Knowing Python And Zope Is Required For Developing ERP5 - The basics a deveoper needs.