├── .gitignore ├── LICENSE ├── README.md ├── content ├── common │ ├── apiMarked.js │ └── templates │ │ ├── layout │ │ └── base.jade │ │ └── mixins │ │ └── breadcrumbs.jade ├── en │ ├── pages │ │ ├── 404.jade │ │ ├── docs │ │ │ ├── api.jade │ │ │ ├── api │ │ │ │ ├── 0.2.x │ │ │ │ │ ├── class.jade │ │ │ │ │ └── markdown │ │ │ │ │ │ └── class │ │ │ │ │ │ ├── Classes │ │ │ │ │ │ ├── Content.md │ │ │ │ │ │ ├── ContentPage.md │ │ │ │ │ │ ├── ContentType.md │ │ │ │ │ │ ├── Email.md │ │ │ │ │ │ ├── Field.md │ │ │ │ │ │ ├── FieldTypes.md │ │ │ │ │ │ ├── Keystone.md │ │ │ │ │ │ ├── List.md │ │ │ │ │ │ └── View.md │ │ │ │ │ │ ├── Content │ │ │ │ │ │ ├── editable.md │ │ │ │ │ │ ├── fetch.md │ │ │ │ │ │ ├── initModel.md │ │ │ │ │ │ ├── page.md │ │ │ │ │ │ └── store.md │ │ │ │ │ │ ├── ContentPage │ │ │ │ │ │ ├── add.md │ │ │ │ │ │ ├── clean.md │ │ │ │ │ │ ├── get.md │ │ │ │ │ │ ├── name.md │ │ │ │ │ │ ├── populate.md │ │ │ │ │ │ ├── register.md │ │ │ │ │ │ ├── set.md │ │ │ │ │ │ └── validate.md │ │ │ │ │ │ ├── Email │ │ │ │ │ │ ├── buildOptions.md │ │ │ │ │ │ ├── compileTemplate.md │ │ │ │ │ │ ├── defaults.md │ │ │ │ │ │ ├── getEmailsPath.md │ │ │ │ │ │ ├── loadTemplate.md │ │ │ │ │ │ ├── prepare.md │ │ │ │ │ │ ├── render.md │ │ │ │ │ │ ├── renderMandrill.md │ │ │ │ │ │ ├── send.md │ │ │ │ │ │ ├── templateCSSMethods.md │ │ │ │ │ │ └── templateCache.md │ │ │ │ │ │ ├── Field │ │ │ │ │ │ ├── addToSchema.md │ │ │ │ │ │ ├── bindUnderscoreMethods.md │ │ │ │ │ │ ├── col.md │ │ │ │ │ │ ├── collapse.md │ │ │ │ │ │ ├── dependsOn.md │ │ │ │ │ │ ├── format.md │ │ │ │ │ │ ├── getData.md │ │ │ │ │ │ ├── getDefaultValue.md │ │ │ │ │ │ ├── getOptions.md │ │ │ │ │ │ ├── getPreSaveWatcher.md │ │ │ │ │ │ ├── getSize.md │ │ │ │ │ │ ├── getValueFromData.md │ │ │ │ │ │ ├── hidden.md │ │ │ │ │ │ ├── initial.md │ │ │ │ │ │ ├── isModified.md │ │ │ │ │ │ ├── nocol.md │ │ │ │ │ │ ├── noedit.md │ │ │ │ │ │ ├── nofilter.md │ │ │ │ │ │ ├── nosort.md │ │ │ │ │ │ ├── note.md │ │ │ │ │ │ ├── required.md │ │ │ │ │ │ ├── size.md │ │ │ │ │ │ ├── underscoreMethod.md │ │ │ │ │ │ ├── updateItem.md │ │ │ │ │ │ └── validateInput.md │ │ │ │ │ │ ├── FieldTypes │ │ │ │ │ │ ├── AzureFile.md │ │ │ │ │ │ ├── Boolean.md │ │ │ │ │ │ ├── CloudinaryImage.md │ │ │ │ │ │ ├── CloudinaryImages.md │ │ │ │ │ │ ├── Code.md │ │ │ │ │ │ ├── Color.md │ │ │ │ │ │ ├── Date.md │ │ │ │ │ │ ├── DateArray.md │ │ │ │ │ │ ├── Datetime.md │ │ │ │ │ │ ├── Email.md │ │ │ │ │ │ ├── Embedly.md │ │ │ │ │ │ ├── GeoPoint.md │ │ │ │ │ │ ├── Html.md │ │ │ │ │ │ ├── Key.md │ │ │ │ │ │ ├── LocalFile.md │ │ │ │ │ │ ├── LocalFiles.md │ │ │ │ │ │ ├── Location.md │ │ │ │ │ │ ├── Markdown.md │ │ │ │ │ │ ├── Money.md │ │ │ │ │ │ ├── Name.md │ │ │ │ │ │ ├── Number.md │ │ │ │ │ │ ├── NumberArray.md │ │ │ │ │ │ ├── Password.md │ │ │ │ │ │ ├── Relationship.md │ │ │ │ │ │ ├── S3File.md │ │ │ │ │ │ ├── Select.md │ │ │ │ │ │ ├── Text.md │ │ │ │ │ │ ├── TextArray.md │ │ │ │ │ │ ├── Textarea.md │ │ │ │ │ │ └── Url.md │ │ │ │ │ │ ├── Helpers │ │ │ │ │ │ ├── Middleware.md │ │ │ │ │ │ ├── Security.md │ │ │ │ │ │ └── Session.md │ │ │ │ │ │ ├── List │ │ │ │ │ │ ├── add.md │ │ │ │ │ │ ├── addPattern.md │ │ │ │ │ │ ├── automap.md │ │ │ │ │ │ ├── expandColumns.md │ │ │ │ │ │ ├── expandSort.md │ │ │ │ │ │ ├── field.md │ │ │ │ │ │ ├── getDocumentName.md │ │ │ │ │ │ ├── getPages.md │ │ │ │ │ │ ├── getSearchFilters.md │ │ │ │ │ │ ├── getUniqueValue.md │ │ │ │ │ │ ├── map.md │ │ │ │ │ │ ├── paginate.md │ │ │ │ │ │ ├── processFilters.md │ │ │ │ │ │ ├── register.md │ │ │ │ │ │ ├── relationship.md │ │ │ │ │ │ ├── schema │ │ │ │ │ │ │ ├── autokey.md │ │ │ │ │ │ │ ├── getRelated.md │ │ │ │ │ │ │ ├── populateRelated.md │ │ │ │ │ │ │ ├── sortable.md │ │ │ │ │ │ │ └── track.md │ │ │ │ │ │ ├── selectColumns.md │ │ │ │ │ │ ├── set.md │ │ │ │ │ │ ├── underscoreMethod.md │ │ │ │ │ │ └── updateAll.md │ │ │ │ │ │ ├── Security │ │ │ │ │ │ ├── createSecret.md │ │ │ │ │ │ ├── getSecret.md │ │ │ │ │ │ ├── getToken.md │ │ │ │ │ │ ├── middleware.md │ │ │ │ │ │ ├── requestToken.md │ │ │ │ │ │ ├── tokenize.md │ │ │ │ │ │ └── validate.md │ │ │ │ │ │ ├── Session │ │ │ │ │ │ ├── keystoneAuth.md │ │ │ │ │ │ ├── persist.md │ │ │ │ │ │ ├── signin.md │ │ │ │ │ │ ├── signinWithUser.md │ │ │ │ │ │ └── signout.md │ │ │ │ │ │ ├── View │ │ │ │ │ │ ├── on.md │ │ │ │ │ │ ├── query.md │ │ │ │ │ │ └── render.md │ │ │ │ │ │ ├── bindEmailTestRoutes.md │ │ │ │ │ │ ├── connect.md │ │ │ │ │ │ ├── cors.md │ │ │ │ │ │ ├── createItems.md │ │ │ │ │ │ ├── expandPath.md │ │ │ │ │ │ ├── get.md │ │ │ │ │ │ ├── getOrphanedLists.md │ │ │ │ │ │ ├── getPath.md │ │ │ │ │ │ ├── importer.md │ │ │ │ │ │ ├── init.md │ │ │ │ │ │ ├── initAPI.md │ │ │ │ │ │ ├── initNav.md │ │ │ │ │ │ ├── list.md │ │ │ │ │ │ ├── mount.md │ │ │ │ │ │ ├── options.md │ │ │ │ │ │ ├── populateRelated.md │ │ │ │ │ │ ├── pre.md │ │ │ │ │ │ ├── prefixModel.md │ │ │ │ │ │ ├── redirect.md │ │ │ │ │ │ ├── render.md │ │ │ │ │ │ ├── routes.md │ │ │ │ │ │ ├── set.md │ │ │ │ │ │ ├── start.md │ │ │ │ │ │ ├── static.md │ │ │ │ │ │ ├── static │ │ │ │ │ │ ├── Email.md │ │ │ │ │ │ ├── List.md │ │ │ │ │ │ └── View.md │ │ │ │ │ │ ├── utils.md │ │ │ │ │ │ ├── version.md │ │ │ │ │ │ └── wrapHTMLError.md │ │ │ │ ├── 0.3.x │ │ │ │ │ ├── class.jade │ │ │ │ │ └── markdown │ │ │ │ │ │ └── class │ │ │ │ │ │ ├── Classes │ │ │ │ │ │ ├── Content.md │ │ │ │ │ │ ├── ContentPage.md │ │ │ │ │ │ ├── ContentType.md │ │ │ │ │ │ ├── Email.md │ │ │ │ │ │ ├── Field.md │ │ │ │ │ │ ├── FieldTypes.md │ │ │ │ │ │ ├── Keystone.md │ │ │ │ │ │ ├── List.md │ │ │ │ │ │ └── View.md │ │ │ │ │ │ ├── Content │ │ │ │ │ │ ├── editable.md │ │ │ │ │ │ ├── fetch.md │ │ │ │ │ │ ├── initModel.md │ │ │ │ │ │ ├── page.md │ │ │ │ │ │ └── store.md │ │ │ │ │ │ ├── ContentPage │ │ │ │ │ │ ├── add.md │ │ │ │ │ │ ├── clean.md │ │ │ │ │ │ ├── get.md │ │ │ │ │ │ ├── name.md │ │ │ │ │ │ ├── populate.md │ │ │ │ │ │ ├── register.md │ │ │ │ │ │ ├── set.md │ │ │ │ │ │ └── validate.md │ │ │ │ │ │ ├── Email │ │ │ │ │ │ ├── buildOptions.md │ │ │ │ │ │ ├── compileTemplate.md │ │ │ │ │ │ ├── defaults.md │ │ │ │ │ │ ├── getEmailsPath.md │ │ │ │ │ │ ├── loadTemplate.md │ │ │ │ │ │ ├── prepare.md │ │ │ │ │ │ ├── render.md │ │ │ │ │ │ ├── renderMandrill.md │ │ │ │ │ │ ├── send.md │ │ │ │ │ │ ├── templateCSSMethods.md │ │ │ │ │ │ └── templateCache.md │ │ │ │ │ │ ├── Field │ │ │ │ │ │ ├── addToSchema.md │ │ │ │ │ │ ├── bindUnderscoreMethods.md │ │ │ │ │ │ ├── col.md │ │ │ │ │ │ ├── collapse.md │ │ │ │ │ │ ├── dependsOn.md │ │ │ │ │ │ ├── format.md │ │ │ │ │ │ ├── getData.md │ │ │ │ │ │ ├── getDefaultValue.md │ │ │ │ │ │ ├── getOptions.md │ │ │ │ │ │ ├── getPreSaveWatcher.md │ │ │ │ │ │ ├── getSize.md │ │ │ │ │ │ ├── getValueFromData.md │ │ │ │ │ │ ├── hidden.md │ │ │ │ │ │ ├── initial.md │ │ │ │ │ │ ├── isModified.md │ │ │ │ │ │ ├── nocol.md │ │ │ │ │ │ ├── noedit.md │ │ │ │ │ │ ├── nofilter.md │ │ │ │ │ │ ├── nosort.md │ │ │ │ │ │ ├── note.md │ │ │ │ │ │ ├── required.md │ │ │ │ │ │ ├── size.md │ │ │ │ │ │ ├── underscoreMethod.md │ │ │ │ │ │ ├── updateItem.md │ │ │ │ │ │ └── validateInput.md │ │ │ │ │ │ ├── FieldTypes │ │ │ │ │ │ ├── AzureFile.md │ │ │ │ │ │ ├── Boolean.md │ │ │ │ │ │ ├── CloudinaryImage.md │ │ │ │ │ │ ├── CloudinaryImages.md │ │ │ │ │ │ ├── Code.md │ │ │ │ │ │ ├── Color.md │ │ │ │ │ │ ├── Date.md │ │ │ │ │ │ ├── DateArray.md │ │ │ │ │ │ ├── Datetime.md │ │ │ │ │ │ ├── Email.md │ │ │ │ │ │ ├── Embedly.md │ │ │ │ │ │ ├── GeoPoint.md │ │ │ │ │ │ ├── Html.md │ │ │ │ │ │ ├── Key.md │ │ │ │ │ │ ├── LocalFile.md │ │ │ │ │ │ ├── LocalFiles.md │ │ │ │ │ │ ├── Location.md │ │ │ │ │ │ ├── Markdown.md │ │ │ │ │ │ ├── Money.md │ │ │ │ │ │ ├── Name.md │ │ │ │ │ │ ├── Number.md │ │ │ │ │ │ ├── NumberArray.md │ │ │ │ │ │ ├── Password.md │ │ │ │ │ │ ├── Relationship.md │ │ │ │ │ │ ├── S3File.md │ │ │ │ │ │ ├── Select.md │ │ │ │ │ │ ├── Text.md │ │ │ │ │ │ ├── TextArray.md │ │ │ │ │ │ ├── Textarea.md │ │ │ │ │ │ └── Url.md │ │ │ │ │ │ ├── Helpers │ │ │ │ │ │ ├── Middleware.md │ │ │ │ │ │ ├── Security.md │ │ │ │ │ │ └── Session.md │ │ │ │ │ │ ├── List │ │ │ │ │ │ ├── add.md │ │ │ │ │ │ ├── addFiltersToQuery.md │ │ │ │ │ │ ├── addSearchToQuery.md │ │ │ │ │ │ ├── automap.md │ │ │ │ │ │ ├── expandColumns.md │ │ │ │ │ │ ├── expandPaths.md │ │ │ │ │ │ ├── expandSort.md │ │ │ │ │ │ ├── field.md │ │ │ │ │ │ ├── getAdminURL.md │ │ │ │ │ │ ├── getCSV.md │ │ │ │ │ │ ├── getData.md │ │ │ │ │ │ ├── getDocumentName.md │ │ │ │ │ │ ├── getOptions.md │ │ │ │ │ │ ├── getPages.md │ │ │ │ │ │ ├── getSearchFilters.md │ │ │ │ │ │ ├── getUniqueValue.md │ │ │ │ │ │ ├── isReserved.md │ │ │ │ │ │ ├── map.md │ │ │ │ │ │ ├── paginate.md │ │ │ │ │ │ ├── processFilters.md │ │ │ │ │ │ ├── register.md │ │ │ │ │ │ ├── relationship.md │ │ │ │ │ │ ├── schema │ │ │ │ │ │ │ ├── autokey.md │ │ │ │ │ │ │ ├── history.md │ │ │ │ │ │ │ ├── sortable.md │ │ │ │ │ │ │ └── track.md │ │ │ │ │ │ ├── selectColumns.md │ │ │ │ │ │ ├── set.md │ │ │ │ │ │ ├── underscoreMethod.md │ │ │ │ │ │ └── updateAll.md │ │ │ │ │ │ ├── Middleware │ │ │ │ │ │ ├── api.md │ │ │ │ │ │ └── cors.md │ │ │ │ │ │ ├── Security │ │ │ │ │ │ ├── createSecret.md │ │ │ │ │ │ ├── getSecret.md │ │ │ │ │ │ ├── getToken.md │ │ │ │ │ │ ├── middleware.md │ │ │ │ │ │ ├── requestToken.md │ │ │ │ │ │ ├── tokenize.md │ │ │ │ │ │ └── validate.md │ │ │ │ │ │ ├── Session │ │ │ │ │ │ ├── keystoneAuth.md │ │ │ │ │ │ ├── persist.md │ │ │ │ │ │ ├── signin.md │ │ │ │ │ │ ├── signinWithUser.md │ │ │ │ │ │ └── signout.md │ │ │ │ │ │ ├── View │ │ │ │ │ │ ├── on.md │ │ │ │ │ │ ├── query.md │ │ │ │ │ │ └── render.md │ │ │ │ │ │ ├── adminApp.md │ │ │ │ │ │ ├── applyUpdates.md │ │ │ │ │ │ ├── bindEmailTestRoutes.md │ │ │ │ │ │ ├── connect.md │ │ │ │ │ │ ├── createItems.md │ │ │ │ │ │ ├── expandPath.md │ │ │ │ │ │ ├── get.md │ │ │ │ │ │ ├── getOrphanedLists.md │ │ │ │ │ │ ├── getPath.md │ │ │ │ │ │ ├── import.md │ │ │ │ │ │ ├── importer.md │ │ │ │ │ │ ├── init.md │ │ │ │ │ │ ├── initNav.md │ │ │ │ │ │ ├── list.md │ │ │ │ │ │ ├── mount.md │ │ │ │ │ │ ├── options.md │ │ │ │ │ │ ├── populateRelated.md │ │ │ │ │ │ ├── prefixModel.md │ │ │ │ │ │ ├── redirect.md │ │ │ │ │ │ ├── render.md │ │ │ │ │ │ ├── routes.md │ │ │ │ │ │ ├── set.md │ │ │ │ │ │ ├── start.md │ │ │ │ │ │ ├── static │ │ │ │ │ │ └── 0.2.x-to-0.3.x-Changes.md │ │ │ │ │ │ ├── utils.md │ │ │ │ │ │ ├── version.md │ │ │ │ │ │ └── wrapHTMLError.md │ │ │ │ └── 0.4.x │ │ │ │ │ ├── class.jade │ │ │ │ │ ├── endpoint.jade │ │ │ │ │ └── markdown │ │ │ │ │ └── class │ │ │ │ │ ├── Classes │ │ │ │ │ ├── Content.md │ │ │ │ │ ├── ContentPage.md │ │ │ │ │ ├── ContentType.md │ │ │ │ │ ├── Email.md │ │ │ │ │ ├── Field.md │ │ │ │ │ ├── FieldTypes.md │ │ │ │ │ ├── Keystone.md │ │ │ │ │ ├── List.md │ │ │ │ │ └── View.md │ │ │ │ │ ├── Content │ │ │ │ │ ├── editable.md │ │ │ │ │ ├── fetch.md │ │ │ │ │ ├── initModel.md │ │ │ │ │ ├── page.md │ │ │ │ │ └── store.md │ │ │ │ │ ├── ContentPage │ │ │ │ │ ├── add.md │ │ │ │ │ ├── clean.md │ │ │ │ │ ├── get.md │ │ │ │ │ ├── name.md │ │ │ │ │ ├── populate.md │ │ │ │ │ ├── register.md │ │ │ │ │ ├── set.md │ │ │ │ │ └── validate.md │ │ │ │ │ ├── Email │ │ │ │ │ ├── buildOptions.md │ │ │ │ │ ├── compileTemplate.md │ │ │ │ │ ├── defaults.md │ │ │ │ │ ├── getEmailsPath.md │ │ │ │ │ ├── loadTemplate.md │ │ │ │ │ ├── prepare.md │ │ │ │ │ ├── render.md │ │ │ │ │ ├── renderMandrill.md │ │ │ │ │ ├── send.md │ │ │ │ │ ├── templateCSSMethods.md │ │ │ │ │ └── templateCache.md │ │ │ │ │ ├── Field │ │ │ │ │ ├── addToSchema.md │ │ │ │ │ ├── bindUnderscoreMethods.md │ │ │ │ │ ├── col.md │ │ │ │ │ ├── collapse.md │ │ │ │ │ ├── dependsOn.md │ │ │ │ │ ├── format.md │ │ │ │ │ ├── getData.md │ │ │ │ │ ├── getDefaultValue.md │ │ │ │ │ ├── getOptions.md │ │ │ │ │ ├── getPreSaveWatcher.md │ │ │ │ │ ├── getSize.md │ │ │ │ │ ├── getValueFromData.md │ │ │ │ │ ├── hidden.md │ │ │ │ │ ├── initial.md │ │ │ │ │ ├── isModified.md │ │ │ │ │ ├── nocol.md │ │ │ │ │ ├── noedit.md │ │ │ │ │ ├── nofilter.md │ │ │ │ │ ├── nosort.md │ │ │ │ │ ├── note.md │ │ │ │ │ ├── required.md │ │ │ │ │ ├── size.md │ │ │ │ │ ├── underscoreMethod.md │ │ │ │ │ ├── updateItem.md │ │ │ │ │ └── validateInput.md │ │ │ │ │ ├── FieldTypes │ │ │ │ │ ├── AzureFile.md │ │ │ │ │ ├── Boolean.md │ │ │ │ │ ├── CloudinaryImage.md │ │ │ │ │ ├── CloudinaryImages.md │ │ │ │ │ ├── Code.md │ │ │ │ │ ├── Color.md │ │ │ │ │ ├── Date.md │ │ │ │ │ ├── DateArray.md │ │ │ │ │ ├── Datetime.md │ │ │ │ │ ├── Email.md │ │ │ │ │ ├── Embedly.md │ │ │ │ │ ├── GeoPoint.md │ │ │ │ │ ├── Html.md │ │ │ │ │ ├── Key.md │ │ │ │ │ ├── LocalFile.md │ │ │ │ │ ├── LocalFiles.md │ │ │ │ │ ├── Location.md │ │ │ │ │ ├── Markdown.md │ │ │ │ │ ├── Money.md │ │ │ │ │ ├── Name.md │ │ │ │ │ ├── Number.md │ │ │ │ │ ├── NumberArray.md │ │ │ │ │ ├── Password.md │ │ │ │ │ ├── Relationship.md │ │ │ │ │ ├── S3File.md │ │ │ │ │ ├── Select.md │ │ │ │ │ ├── Text.md │ │ │ │ │ ├── TextArray.md │ │ │ │ │ ├── Textarea.md │ │ │ │ │ └── Url.md │ │ │ │ │ ├── Helpers │ │ │ │ │ ├── Middleware.md │ │ │ │ │ ├── Security.md │ │ │ │ │ └── Session.md │ │ │ │ │ ├── List │ │ │ │ │ ├── add.md │ │ │ │ │ ├── addFiltersToQuery.md │ │ │ │ │ ├── addSearchToQuery.md │ │ │ │ │ ├── automap.md │ │ │ │ │ ├── expandColumns.md │ │ │ │ │ ├── expandPaths.md │ │ │ │ │ ├── expandSort.md │ │ │ │ │ ├── field.md │ │ │ │ │ ├── getAdminURL.md │ │ │ │ │ ├── getCSV.md │ │ │ │ │ ├── getData.md │ │ │ │ │ ├── getDocumentName.md │ │ │ │ │ ├── getOptions.md │ │ │ │ │ ├── getPages.md │ │ │ │ │ ├── getUniqueValue.md │ │ │ │ │ ├── isReserved.md │ │ │ │ │ ├── map.md │ │ │ │ │ ├── paginate.md │ │ │ │ │ ├── register.md │ │ │ │ │ ├── relationship.md │ │ │ │ │ ├── schema │ │ │ │ │ │ ├── autokey.md │ │ │ │ │ │ ├── history.md │ │ │ │ │ │ ├── sortable.md │ │ │ │ │ │ └── track.md │ │ │ │ │ ├── selectColumns.md │ │ │ │ │ ├── set.md │ │ │ │ │ ├── underscoreMethod.md │ │ │ │ │ └── updateAll.md │ │ │ │ │ ├── Middleware │ │ │ │ │ ├── api.md │ │ │ │ │ └── cors.md │ │ │ │ │ ├── Security │ │ │ │ │ ├── createSecret.md │ │ │ │ │ ├── getSecret.md │ │ │ │ │ ├── getToken.md │ │ │ │ │ ├── middleware.md │ │ │ │ │ ├── requestToken.md │ │ │ │ │ ├── tokenize.md │ │ │ │ │ └── validate.md │ │ │ │ │ ├── Session │ │ │ │ │ ├── keystoneAuth.md │ │ │ │ │ ├── persist.md │ │ │ │ │ ├── signin.md │ │ │ │ │ ├── signinWithUser.md │ │ │ │ │ └── signout.md │ │ │ │ │ ├── View │ │ │ │ │ ├── on.md │ │ │ │ │ ├── query.md │ │ │ │ │ └── render.md │ │ │ │ │ ├── adminApp.md │ │ │ │ │ ├── createItems.md │ │ │ │ │ ├── expandPath.md │ │ │ │ │ ├── get.md │ │ │ │ │ ├── getOrphanedLists.md │ │ │ │ │ ├── getPath.md │ │ │ │ │ ├── importer.md │ │ │ │ │ ├── init.md │ │ │ │ │ ├── initDatabase.md │ │ │ │ │ ├── initExpressApp.md │ │ │ │ │ ├── initExpressSession.md │ │ │ │ │ ├── initNav.md │ │ │ │ │ ├── list.md │ │ │ │ │ ├── mount.md │ │ │ │ │ ├── openDatabaseConnection.md │ │ │ │ │ ├── options.md │ │ │ │ │ ├── populateRelated.md │ │ │ │ │ ├── prefixModel.md │ │ │ │ │ ├── redirect.md │ │ │ │ │ ├── render.md │ │ │ │ │ ├── routes.md │ │ │ │ │ ├── set.md │ │ │ │ │ ├── start.md │ │ │ │ │ ├── static.md │ │ │ │ │ ├── static │ │ │ │ │ └── 0.3.x-to-0.4.x-Changes.md │ │ │ │ │ ├── utils.md │ │ │ │ │ ├── version.md │ │ │ │ │ └── wrapHTMLError.md │ │ │ ├── configuration.jade │ │ │ ├── database.jade │ │ │ ├── faqs.jade │ │ │ ├── getting-started.jade │ │ │ ├── index.jade │ │ │ └── views.jade │ │ ├── examples.jade │ │ ├── home.jade │ │ └── starting.jade │ └── templates │ │ └── mixins │ │ ├── docsapinav.jade │ │ └── docsnav.jade ├── index.js └── zh │ ├── pages │ ├── 404.jade │ ├── docs │ │ ├── configuration.jade │ │ ├── database.jade │ │ ├── getting-started.jade │ │ ├── index.jade │ │ └── views.jade │ ├── examples.jade │ ├── home.jade │ └── starting.jade │ └── templates │ └── mixins │ └── docsnav.jade ├── gulpfile.js ├── index.js ├── package.json └── public ├── favicon.ico ├── fonts ├── entypo-social.eot ├── entypo-social.svg ├── entypo-social.ttf ├── entypo-social.woff ├── entypo.eot ├── entypo.svg ├── entypo.ttf └── entypo.woff ├── images ├── admin-interface.jpg ├── brand-continental.png ├── brand-event_cinemas.png ├── brand-macmillan.png ├── brand-sony.png ├── brand-vodafone.png ├── brand-westpac.png ├── getting-started │ ├── commands-safari.png │ ├── commands-terminal.png │ ├── commands.jpg │ ├── finished.jpg │ ├── mongodb-logo.png │ └── nodejs-logo.png ├── home │ ├── admin-interface.png │ ├── inline-item-creation.png │ ├── responsive-design.png │ ├── sophisticated-fields.png │ └── sophisticated-filtering.png ├── intro-bg-inverse.png ├── intro-bg.png ├── logo-128.png ├── logo-16.png ├── logo-32.png ├── logo-64.png ├── logo-inverted.svg ├── logo.png ├── logo.svg └── tools-bg.png ├── js ├── anchor-links.js ├── api-code.js └── lib │ ├── bootstrap │ ├── affix.js │ ├── alert.js │ ├── button.js │ ├── carousel.js │ ├── collapse.js │ ├── dropdown.js │ ├── modal.js │ ├── popover.js │ ├── scrollspy.js │ ├── tab.js │ ├── tooltip.js │ └── transition.js │ ├── jquery │ ├── jquery-1.10.2.js │ ├── jquery-1.10.2.min.js │ └── jquery-1.10.2.min.map │ └── prism │ └── prism.min.js └── styles ├── bootstrap ├── alerts.less ├── badges.less ├── bootstrap.less ├── breadcrumbs.less ├── button-groups.less ├── buttons.less ├── carousel.less ├── close.less ├── code.less ├── component-animations.less ├── dropdowns.less ├── forms.less ├── glyphicons.less ├── grid.less ├── input-groups.less ├── jumbotron.less ├── labels.less ├── list-group.less ├── media.less ├── mixins.less ├── modals.less ├── navbar.less ├── navs.less ├── normalize.less ├── pager.less ├── pagination.less ├── panels.less ├── popovers.less ├── print.less ├── progress-bars.less ├── responsive-utilities.less ├── scaffolding.less ├── tables.less ├── theme.less ├── thumbnails.less ├── tooltip.less ├── type.less ├── utilities.less ├── variables.less └── wells.less ├── entypo.less ├── prism.css ├── site.less ├── site.min.css ├── site ├── docs.less ├── flex.less ├── getting-started.less ├── intro.less ├── layout.less └── utils.less └── variables.less /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Dependency directory 11 | node_modules 12 | 13 | # Build folder 14 | build 15 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 |

⚠️ Archived

3 |

This repository is archived and is no longer maintained.

4 |

For the latest Keystone release please visit the Keystone website.

5 |
6 |
7 |
8 | 9 | ## NOTE: The Keystone Website has been merged in to the main keystone repo [here](https://github.com/keystonejs/keystone/tree/master/docs) 10 | 11 | If you are looking to contribute to the keystone documentation, or other parts of the website, please make your requests there. This code base is no longer the source of the keystone website. 12 | 13 | 14 | # keystonejs-site 15 | 16 | [keystonejs.com](http://keystonejs.com) site and docs. 17 | 18 | ## Running locally 19 | 20 | % npm install 21 | % npm start 22 | -------------------------------------------------------------------------------- /content/common/templates/mixins/breadcrumbs.jade: -------------------------------------------------------------------------------- 1 | mixin breadcrumbs(docssection, docssubsection) 2 | .page-header.page-breadcrumbs 3 | .container 4 | h1 5 | a(href=docssection.path).page-breadcrumbs__section= docssection.label 6 | span.page-breadcrumbs__subsection= docssubsection.label 7 | -------------------------------------------------------------------------------- /content/en/pages/docs/api.jade: -------------------------------------------------------------------------------- 1 | extends ../../../common/templates/layout/base 2 | 3 | include ../../templates/mixins/docsnav 4 | 5 | block intro 6 | .page-header 7 | .container 8 | h1 Keystone Api 9 | p.lead Class and Endpoint Api 10 | 11 | block content 12 | .container: .row 13 | 14 | .col-sm-3 15 | +docsnav(docssection) 16 | 17 | .col-sm-9: .docs-content 18 | 19 | h2 20 | a(href='/docs/api/current/class') Class Api 21 | 22 | 23 | -------------------------------------------------------------------------------- /content/en/pages/docs/api/0.2.x/markdown/class/Classes/Content.md: -------------------------------------------------------------------------------- 1 | #### Keystone.content( ) 2 | > _@api_ **public** 3 | 4 |
code
 
5 | 
6 | 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Classes/ContentPage.md:
--------------------------------------------------------------------------------
1 | #### Keystone.content.Page( key, options )
2 | > _@param_ **key**  {String}  
3 | > _@param_ **options**  {Options}   
4 | > _@api_ **public**    
5 | 
6 | 
  code
 
7 | 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Classes/ContentType.md:
--------------------------------------------------------------------------------
 1 | #### Keystone.content.Type( path, options )
 2 | > _@param_ **path**  {String}  
 3 | > _@param_ **options**  {Options}   
 4 | > _@api_ **public**      
 5 | 
 6 | 
TODO

 7 | 
 8 | 
  code
 
 9 | 
10 | 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Classes/Field.md:
--------------------------------------------------------------------------------
 1 | #### Keystone.Field( list, path, options )
 2 | > *@param* **list** _{Object}_  - valid Keystone list   
 3 | > *@param* **path** _{String}_  - path   
 4 | > *@param* **options** _{Object}_  - options   
 5 | > *@api* **private**  
 6 | 
 7 | 
 Extended by `Field.Types` Classes, methods should not be used directly. 

 8 | 
 9 | 
10 |  
11 | 
12 | 
  code
 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Classes/FieldTypes.md:
--------------------------------------------------------------------------------
 1 | #### .Field.Types 
 2 |   
 3 | Returns an object of Keystone Field Types to work with.  
 4 | Each Field Type inherits all the `Field` methods above.  
 5 | 
Any new or override methods for each Type are  styled like so . 
 6 | 

 7 | 
 8 | 
  
 
 9 | 
10 | 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Classes/View.md:
--------------------------------------------------------------------------------
 1 | #### new Keystone.View( req, res )
 2 | > *@param* **req** _{Object}_  - valid Express req object  
 3 | > *@param* **res** _{Object}_  - valid Express res object   
 4 | > _@return_ **Instance**   
 5 | 
 6 | Helper to simplify view logic in a Keystone application  
 7 | 
 8 | ```javascript
 9 | 	var view = new keystone.View(req, res);
10 |     
11 | 	view.render('index');
12 | ```  
13 | 
14 | 
 code
 
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Content/editable.md:
--------------------------------------------------------------------------------
 1 | #### .content.editable( user, options )  
 2 | > *@param* **user** _{Object}_  - user object  
 3 | > *@param* **options** _{Object}_   
 4 | > *@api* **private**  
 5 | 
 6 | Outputs client-side editable data for content management.  
 7 | 
 8 | Called automatically when pages are added.  
 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Content/fetch.md:
--------------------------------------------------------------------------------
1 | #### .content.fetch( page, callback )  
2 | > *@param* **page** _{String}_   
3 | > *@param* **callback** _{Function}_    
4 | > *@api* **public**     
5 | 
6 | 
 
Loads page content by page key (optional).
If page key is not provided, returns a hash of all page contents in the database.
keystone.content.fetch('home', function(err, content) { ... });
 
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Content/initModel.md:
--------------------------------------------------------------------------------
1 | #### .content.initModel( )   
2 | > *@api* **private**      
3 | 
4 | Ensures the Mongoose model for storing content is initialised.  
5 | 
6 | Called automatically when pages are added.  
7 |  
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Content/page.md:
--------------------------------------------------------------------------------
1 | #### .content.page( key, page )  
2 | > *@param* **key** _{String}_  
3 | > *@param* **page** _{Object}_  
4 | > *@api* **private**     
5 | 
6 | Registers a page. Should not be called directly, use `.content.Page.register()` instead.
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Content/store.md:
--------------------------------------------------------------------------------
 1 | #### .content.store( page, content, callback )  
 2 | > *@param* **page** _{String}_  
 3 | > *@param* **content** _{Object}_  
 4 | > *@param* **callback** _{Function}_    
 5 | > *@api* **public**     
 6 | 
 7 | 
 
Sets page content by page key.
Merges content with existing content.
keystone.content.store('home', { title: 'Welcome' }, function(err) { ... });
 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/ContentPage/add.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.add( fields )  
2 | > *@param* **fields** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/ContentPage/clean.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.clean( data )  
2 | > *@param* **data** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | Cleans a data structure so only the defined fields are present.
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/ContentPage/get.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.get( key )  
2 | > *@param* **key** _{String}_   
3 | > *@api* **public**   
4 |  
5 | 
 
Gets page options
 page.get('test') // returns the 'test' value
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/ContentPage/name.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.name  
2 | > *@api* **public**     
3 | 
4 | 
 
Getter
return this.get('name') || this.set('name', utils.keyToLabel(this.key));

5 |  
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/ContentPage/populate.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.populate( data )  
2 | > *@param* **data** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | Populates a data structure based on defined fields
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/ContentPage/register.md:
--------------------------------------------------------------------------------
 1 | #### .content.Page.register(  )  
 2 | > *@api* **public**     
 3 | 
 4 | 
 
Registers the page with Keystone.
var homePage = new keystone.content.Page('home');
 5 | // ...
 6 | homePage.register();
 7 | 
 8 | 	// later...
 9 | 	var homePage = keystone.content.page('home');
10 | 
11 | 

12 | 
13 | 
14 | 
  
 
15 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/ContentPage/set.md:
--------------------------------------------------------------------------------
 1 | #### .content.Page.set( key, value )   
 2 | > *@param* **key** _{String}_  
 3 | > *@param* **value** _{Array|Function|Object|String}_  
 4 | > *@api* **public**     
 5 | 
 6 | 
 
Sets page options.
page.set('test', value) // sets the 'test' option to `value`

 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/ContentPage/validate.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.validate( data )  
2 | > *@param* **data** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | Validates a data structure based on defined fields.
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/buildOptions.md:
--------------------------------------------------------------------------------
 1 | #### Email.buildOptions( err, options [, _callback_] ) 
 2 | > *@param* **err** _{Object}_  - Error  
 3 | > *@param* **options** _{Object}_  - Input options  
 4 | > *@param* **callback** _{Object}_  - callback(err, message)   
 5 | > *@api* **private**  
 6 | 
 7 | Build an options object.
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/compileTemplate.md:
--------------------------------------------------------------------------------
1 | #### Email.compileTemplate(  _callback_  ) 
2 | > *@param* **callback** _{Object}_  - callback(err, email)  
3 | > *@api* **private**  
4 | 
5 | Ensures the template for the email has been compiled
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/defaults.md:
--------------------------------------------------------------------------------
 1 | #### Email.defaults    
 2 | > *@api* **public**  
 3 | 
 4 | 
 
Email.defaults 
{
 5 | 	templateExt: 'jade',
 6 | 	templateEngine: require('jade'),
 7 | 	templateBasePath: path.normalize(path.join(__dirname, '..', 'templates', 'helpers', 'emails')),
 8 | 	mandrill: {
 9 | 		track_opens: true,
10 | 		track_clicks: true,
11 | 		preserve_recipients: false,
12 | 		inline_css: true
13 | 	},
14 | 	// Mandrill template
15 | 	templateMandrillName: null,
16 | 	templateForceHtml: false // Force html render
17 | }
18 | 
 
19 | 
20 | 
  
 
21 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/getEmailsPath.md:
--------------------------------------------------------------------------------
1 | #### Email.getEmailsPath(  )    
2 | > *@api* **public**  
3 | 
4 | Return the value of ` keystone.get('emails'); `.
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/loadTemplate.md:
--------------------------------------------------------------------------------
1 | #### Email.loadTemplate(  _callback_  ) 
2 | > *@param* **callback** _{Object}_  - callback(err, email)  
3 | > *@api* **private**  
4 | 
5 | Loads the template. Looks for `templateName.templateExt`, followed by `templateName/email.templateExt`
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/prepare.md:
--------------------------------------------------------------------------------
1 | #### Email.prepare( options [, _callback_ ] ) 
2 | > *@param* **options** _{Object}_  - locals  
3 | > *@param* **callback** _{Object}_  - callback(err, message)    
4 | > *@api* **private**  
5 | 
6 | Ensures the template for the email has been compiled
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/render.md:
--------------------------------------------------------------------------------
 1 | #### Email.render( locals [, _callback_ ] )   
 2 | > *@param* **locals** _{Object}_  - object of local variables provided to the template   
 3 | > *@param* **callback** _{Object}_  - callback(err, email)  
 4 | 
 5 | Renders the email and passes it to the callback. Used by `Email.send()` but can also be called directly to generate a preview.
 6 | 
 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/renderMandrill.md:
--------------------------------------------------------------------------------
1 | #### Email.renderMandrill( [_locals_ ,] options [, _callback_ ] ) 
2 | > *@param* **locals** _{Object}_  - backwards compatibility    
3 | > *@param* **options** _{Object}_  - locals options object   
4 | > *@param* **callback** _{Object}_  - callback(err, info)      
5 | 
6 | Renders a Mandrill template
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/templateCSSMethods.md:
--------------------------------------------------------------------------------
1 | #### Email.templateCSSMethods.shadeColor( color, percent )
2 | > *@param* **color** {String}  
3 | > *@param* **percent** {Number}     
4 | > *@api* **public**  
5 | 
6 | return a shaded color.
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Email/templateCache.md:
--------------------------------------------------------------------------------
1 | #### Email.templateCache   
2 | > *@api* **public**  
3 | 
4 | A cache of compiled templates organi(sz)ed by name.
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/addToSchema.md:
--------------------------------------------------------------------------------
1 | #### Field.addToSchema(  )   
2 | > *@api* **private**  
3 | 
4 | Default method to register the field on the List's Mongoose Schema.  
5 | 
Overridden by some fieldType Classes.

6 | 
7 | 
  
 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/bindUnderscoreMethods.md:
--------------------------------------------------------------------------------
 1 | #### Field.bindUnderscoreMethods( methods )  
 2 | > *@param* **methods** {Array}    
 3 | > *@api* **private**  
 4 | 
 5 | Automatically bind underscore methods specified by the _underscoreMethods property.
 6 | 
Will always include the 'update' method

 7 | 
 8 | 
  
 
 9 | 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/col.md:
--------------------------------------------------------------------------------
1 | #### Field.col(  )
2 | > *@api* **private**  
3 | 
4 | 
 
Getter
return this.options.col
5 | 

6 | 
7 | 
  
 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/collapse.md:
--------------------------------------------------------------------------------
 1 | #### Field.collapse(  )
 2 | > *@api* **private**   
 3 | 
 4 | 
 5 | 
 
Getter
return this.options.collapse
 6 | 

 7 | 
 8 | 
  
 
 9 | 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/dependsOn.md:
--------------------------------------------------------------------------------
1 | #### Field.dependsOn(  )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.dependsOn
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/format.md:
--------------------------------------------------------------------------------
 1 | #### Field.format( item )   
 2 | > *@param* **item** {Object} - valid item object   
 3 | > *@api* **private**  
 4 | 
 5 | Default method to format the field value for display.  
 6 | 
Overridden by some fieldType Classes.

 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/getData.md:
--------------------------------------------------------------------------------
 1 | #### Field.getData( data )   
 2 | > *@param* **data** {Object} - valid data object   
 3 | > *@api* **private**  
 4 | 
 5 | Gets the field's data from an Item, as used by the React components
 6 | 
 7 | 
 
Return
return item.get(this.path);
 8 | 

 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/getDefaultValue.md:
--------------------------------------------------------------------------------
 1 | #### Field.getDefaultValue(  )   
 2 | > *@api* **private**  
 3 | 
 4 | Gets default value for the field, based on the option or default for the type
 5 | 
 6 | 
 
Return
return this.options.default
 7 | 

 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/getOptions.md:
--------------------------------------------------------------------------------
1 | #### Field.getOptions(  )   
2 | > *@api* **private**  
3 | 
4 | Gets the options for the Field, as used by the React components.
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/getPreSaveWatcher.md:
--------------------------------------------------------------------------------
1 | #### Field.getPreSaveWatcher(  )    
2 | > *@api* **private**   
3 | 
4 | Field watching implementation
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/getSize.md:
--------------------------------------------------------------------------------
 1 | #### Field.getSize( )   
 2 | > *@api* **private**  
 3 | 
 4 | Validates and returns the size of the field.  
 5 | Defaults to deprecated 'width' option.
 6 | 
 7 | 
 
Return
return this.__size
 8 | 

 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/getValueFromData.md:
--------------------------------------------------------------------------------
1 | #### Field.getValueFromData(  )   
2 | > *@api* **private**    
3 | 
4 | Retrieves the value from an object, whether the path is nested or flattened.  
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/hidden.md:
--------------------------------------------------------------------------------
1 | #### Field.hidden(  )
2 | > *@api* **private**   
3 | 
4 | 
 
Getter
return this.options.hidden
5 | 

6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/initial.md:
--------------------------------------------------------------------------------
1 | #### Field.initial(  )    
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.initial
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/isModified.md:
--------------------------------------------------------------------------------
 1 | #### Field.isModified( item )   
 2 | > *@param* **item** {Object} - valid item object  
 3 | > *@api* **private**  
 4 | 
 5 | Default method to detect whether the field has been modified in an item.  
 6 | 
Overridden by some fieldType Classes.

 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/nocol.md:
--------------------------------------------------------------------------------
1 | #### Field.nocol(  )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.nocol
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/noedit.md:
--------------------------------------------------------------------------------
1 | #### Field.noedit(   )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.noedit
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/nofilter.md:
--------------------------------------------------------------------------------
1 | #### Field.nofilter(  )
2 | > *@api* **private**   
3 | 
4 | 
 
Getter
return this.options.nofilter
5 | 

6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/nosort.md:
--------------------------------------------------------------------------------
1 | #### Field.nosort(  )
2 | > *@api* **private**   
3 | 
4 | 
 
Getter
return this.options.nosort
5 | 

6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/note.md:
--------------------------------------------------------------------------------
1 | #### Field.note(  )
2 | > *@api* **private**  
3 | 
4 | 
 
Getter

5 | return this.options.note
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/required.md:
--------------------------------------------------------------------------------
1 | #### Field.required(  ) 
2 | > *@api* **private**  
3 | 
4 | 
5 | 
 
Getter
return this.options.required
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/size.md:
--------------------------------------------------------------------------------
1 | #### Field.size(  )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.getSize()
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/underscoreMethod.md:
--------------------------------------------------------------------------------
1 | #### Field.underscoreMethod( path, fn )   
2 | > *@param* **path** {String} 
3 | > *@param* **item** {Function} 
4 | > *@api* **private**   
5 | 
6 | Adds a method to the underscoreMethods collection on the field's list, with a path prefix to match this field's path and bound to the document.  
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/updateItem.md:
--------------------------------------------------------------------------------
 1 | #### Field.updateItem( item, data )
 2 | > *@param* **item** {Object} - valid item object   
 3 | > *@param* **data** {Object}    
 4 | > *@api* **private**  
 5 | 
 6 | Updates the value for this field in the item from a data object
 7 | 
Overridden by some fieldType Classes.

 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Field/validateInput.md:
--------------------------------------------------------------------------------
 1 | #### Field.validateInput( data [, required, item ] )   
 2 | > *@param* **data** {Object} - valid data object  
 3 | > *@param* **required** {Boolean} - true if this is a required field  
 4 | > *@param* **item** {Object} - valid item object  
 5 | > *@api* **private**  
 6 | 
 7 | Validates that a value for this field has been provided in a data object
 8 | 
Overridden by some fieldType Classes.

 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/FieldTypes/Color.md:
--------------------------------------------------------------------------------
 1 | #### .Field.Types.Color( list, path, options )  
 2 | > *@param* **list** _{Object}_  - valid Keystone list   
 3 | > *@param* **path** _{String}_  - path   
 4 | > *@param* **options** _{Object}_  - options   
 5 | > *@api* **public**  
 6 | 
 7 | 
 
defaults
this._nativeType = String;
 8 | this._underscoreMethods = [];
 9 | this._fixedSize = 'small';

10 | 
11 | 
  code
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Helpers/Middleware.md:
--------------------------------------------------------------------------------
1 | #### Keystone.middleware 
2 | 
3 | Middleware helpers for cors and api
4 |  
5 | 
6 | 
  code
 
7 | 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Helpers/Session.md:
--------------------------------------------------------------------------------
1 | #### Keystone.session
2 | 
3 | Helper to uilize sessions  
4 |  
5 | 
6 | 
  code
 
7 | 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/addPattern.md:
--------------------------------------------------------------------------------
1 | #### List.addPattern( pattern )  
2 | > *@param* **pattern** _{String}_  - Search string   
3 | > _@return_ **this**   
4 | 
5 |  Adds preset patterns of fields and behaviours to the Schema
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/automap.md:
--------------------------------------------------------------------------------
1 | #### List.automap ( field )
2 | > *@param* **field** _{Object}_  - valid field object  
3 | > _@api_ **private**   
4 | 
5 | Checks to see if a field path matches a currently unmapped path, and
6 | if so, adds a mapping for it.
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/expandSort.md:
--------------------------------------------------------------------------------
1 | #### List.expandSort( input )
2 | > *@param* **paths** _{String}_    
3 | > _@return_ **Object**   
4 | > _@api_ **private**  
5 | 
6 | 
 code
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/field.md:
--------------------------------------------------------------------------------
 1 | #### List.field( path, options )
 2 | > *@param* **path** _{String}_ - new field path  
 3 | > *@param* **options** _{Object}_  - field options   
 4 | > _@return_ **Object**   
 5 | > _@api_ **private**    
 6 | 
 7 | Creates a new field at the specified path, with the provided options.  
 8 | If no options are provides, returns the field at the specified path.  
 9 | 
10 | 
11 | 
 code
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/getDocumentName.md:
--------------------------------------------------------------------------------
 1 | #### List.getDocumentName( doc, escape )
 2 | > *@param* **doc** _{Object}_ - mongoose document   
 3 | > *@param* **escape** _{Boolean}_     
 4 | > _@return_ **String**    
 5 | 
 6 | Gets the name of the provided document from the correct path  
 7 | 
 8 | ```javascript
 9 | var name = list.getDocumentName(item)
10 | ```
11 | 
12 | 
   
  
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/getPages.md:
--------------------------------------------------------------------------------
1 | #### List.getPages( options, maxPages )   
2 | > _@param_ **options** {Object} - page options  
3 | > _@param_ **maxPages** {Number} - the maximum number pages to display in the pagination  
4 | > _@return_ **Object**  - options  
5 | 
6 | Generate page array for pagination  
7 | 
8 | 
   
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/getSearchFilters.md:
--------------------------------------------------------------------------------
 1 | #### List.getSearchFilters( search, add )    
 2 | > _@param_ **search** {String} - query
 3 | > _@param_ **add** {Object} - additional filters     
 4 | > _@return_ **Object**
 5 | 
 6 | Gets filters for a Mongoose query that will search for the provided string, based on the searchFields List option.  
 7 | 
 8 | Also accepts a filters object from `processFilters()`, any of which may override the search string.  
 9 | 
10 | ```javascript  
11 | list.getSearchFilters('jed') // returns { name: /jed/i }
12 | ```
13 | 
14 |  
15 | 
   
 
16 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/map.md:
--------------------------------------------------------------------------------
 1 | #### List.map( field, path )  
 2 | > _@param_ **field** {String} - map to  
 3 | > _@param_ **path** {String} - map this  
 4 | > _@return_ **Object**  
 5 | > _@api_ **private**  
 6 | 
 7 | Maps a built-in field (e.g. name) to a specific path or returns field mapping  
 8 |  
 9 | 
 code
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/paginate.md:
--------------------------------------------------------------------------------
 1 | #### List.paginate( options  [, _callback_ ] )  
 2 | > _@param_ **options** {Object} - options  
 3 | > _@param_ **callback** {Function} - callback   
 4 | > _@return_ **chain** - exec
 5 | 
 6 | Gets a special Query object that will paginate documents in the list.  
 7 | 
 8 | ```javascript
 9 | list.paginate({
10 | 	page: 1,
11 | 	perPage: 100,
12 | 	maxPages: 10
13 | }).exec(function(err, results) {
14 | 	// do something
15 | });
16 |  
17 | ```
18 | 
 code
 
19 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/processFilters.md:
--------------------------------------------------------------------------------
1 | #### List.processFilters( q )  
2 | > _@param_ **q** {String} - filters   
3 | > _@return_ **Object** - filters  
4 | 
5 | Processes a filter string into a filters object
6 | 
7 | 
8 | 
 
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/register.md:
--------------------------------------------------------------------------------
1 | #### List.register(  )  
2 | > _@return_ **this**    
3 | 
4 | Registers the Schema with Mongoose, and the List with Keystone.  
5 | 
6 | Also adds default fields and virtuals to the schema for the list.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/relationship.md:
--------------------------------------------------------------------------------
1 | #### List.relationship( ...def )  
2 | > _@param_ **def** {...String|Option} - relationship (multiple arguments allowed)  
3 | > _@return_ **this**     
4 | > _@api_ **private**  
5 | 
6 | Registers relationships to this list defined on others  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/schema/getRelated.md:
--------------------------------------------------------------------------------
1 | #### List _schemaPlugins_.getRelated (  )  
2 | > _@api_ **private**   
3 | 
4 | 
5 | 
 code
 
6 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/schema/populateRelated.md:
--------------------------------------------------------------------------------
1 | #### List _schemaPlugins_.populateRelated (  )  
2 | > _@api_ **private**   
3 | 
4 | 
5 | 
 code
 
6 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/schema/sortable.md:
--------------------------------------------------------------------------------
 1 | #### List _schemaPlugins_.sortable (  )  
 2 | > _@api_ **private**   
 3 | 
 4 | 
 
 5 | #### Drag and Drop Sorting in AdminUI
 6 | Adds a hidden field `sortOrder` to the schema.  
 7 | 
    sortable: true 

 8 | 
 9 | Uses  list.schema.pre('save'...) to alter documents.
10 | 
11 | 
 code
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/schema/track.md:
--------------------------------------------------------------------------------
 1 | #### List _schemaPlugins_.track (  )  
 2 | > _@api_ **private**   
 3 | 
 4 | 
Adds tracking fields to a collection
 track: true 
  
 5 | 
 6 | 
 
Added fields
    { 
 7 | 		createdAt: false, 
 8 | 		createdBy: false,
 9 | 		updatedAt: false,
10 | 		updatedBy: false
11 | 	};
12 | 
 
13 | 
14 | Uses  list.schema.pre('save'...)  to alter documents.
15 | 
16 | 
 code
 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/selectColumns.md:
--------------------------------------------------------------------------------
1 | #### List.selectColumns( q, cols )  
2 | > _@param_ **q** {Query} - query    
3 | > _@param_ **cols** {Array} - columns    
4 | > _@return_ **Query** - q   
5 | 
6 | Specified select and populate options for a query based the provided columns.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/set.md:
--------------------------------------------------------------------------------
 1 | #### List.set( key, value )
 2 | > _@param_ **key** {String} - key name  
 3 | > _@param_ **value** {...String|Object|Array|Function} - value  
 4 | > _@return_ **value** - value  
 5 | 
 6 | Gets and Sets list options. Aliased as `.get()`.  
 7 | 
 8 | ```javascript
 9 | list.set('test') // returns the 'test' value
10 | list.set('test', value) // sets the 'test' option to `value`
11 | ```
12 | 
13 | 
 code
 
14 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/underscoreMethod.md:
--------------------------------------------------------------------------------
1 | #### List.underscoreMethod( path, fn )
2 | > _@param_ **path** {String} - path  
3 | > _@param_ **fn** {Function} - underscore method  
4 | > _@return_ **this**  
5 | 
6 | Adds a method to the underscoreMethods collection on the list, which is then added to the schema before the list is registered with mongoose.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/List/updateAll.md:
--------------------------------------------------------------------------------
1 | #### List.updateAll( data [, _callback_ ] )
2 | > _@param_ **data** {Object} - path  
3 | > _@param_ **callback** {Function} - callback  
4 | > _@return_ **this**  
5 | 
6 | Updates every document in a List, setting the provided data on each.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Security/createSecret.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.createSecret(  )    
2 | > *@api* **public**  
3 | 
4 | 
  
 
5 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Security/getSecret.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.getSecret( req )   
2 | > *@param* **req** _{Object}_  - express request object    
3 | > *@api* **public**  
4 | 
5 | 
  
 
6 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Security/getToken.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.getToken( req, res )    
2 | > *@param* **req** _{Object}_  - express request object    
3 | > *@param* **res** _{Object}_  - express response object   
4 | > *@api* **public**  
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Security/middleware.md:
--------------------------------------------------------------------------------
 1 | #### .security.csrf.middleware.init( req, res, next )  
 2 | > *@param* **req** _{Object}_  - express request object  
 3 | > *@param* **res** _{Object}_  - express response object  
 4 | > *@param* **next** _{Object}_  - callback   
 5 | > *@api* **public**  
 6 | 
 7 | 
  
 
 8 | 
 9 | 
10 | #### .security.csrf.middleware.validate( req, res, next )  
11 | > *@param* **req** _{Object}_  - express request object  
12 | > *@param* **res** _{Object}_  - express response object  
13 | > *@param* **next** _{Object}_  - callback   
14 | > *@api* **public**
15 | 
16 | 
  
 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Security/requestToken.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.requestToken( req )   
2 | > *@param* **req** _{Object}_  - express request object    
3 | > *@api* **public**  
4 | 
5 | 
  
 
6 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Security/tokenize.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.tokenize( salt, secret )   
2 | > *@param* **salt** _{String}_    
3 | > *@param* **secret** _{String}_     
4 | > *@api* **public**  
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Security/validate.md:
--------------------------------------------------------------------------------
1 | #### .session.keystoneAuth( req, token )  
2 | > *@param* **req** _{Object}_  - express request object  
3 | > *@param* **token** _{String}_  - token  
4 | > *@api* **public**    
5 | 
6 | 
  
  
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/Session/persist.md:
--------------------------------------------------------------------------------
 1 | #### .session.persist( req, res, next )  
 2 | > *@param* **req** _{Object}_  - express request object  
 3 | > *@param* **res** _{Object}_  - express response object  
 4 | > *@param* **next** _{Object}_  - callback  
 5 | 
 6 | Middleware to ensure session persistence across server restarts.  
 7 | 
 8 | Looks for a userId cookie, and if present, and there is no user signed in, automatically signs the user in.
 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/View/render.md:
--------------------------------------------------------------------------------
 1 | #### View.render( renderFn, locals, callback )
 2 | > *@param* **renderFn** _{Function|String}_  - Render function  
 3 | > *@param* **locals** _{Object}_  - Locals  
 4 | > *@param* **callback** _{Function}_  - Render callback  
 5 | 
 6 | Executes the current queue of init and action methods in series, and then executes the render function.  
 7 | If renderFn is a string, it is provided to `res.render`.  
 8 | It is expected that *most* init stacks require processing in series, but it is safe to execute actions in parallel.  
 9 | If there are several `init` methods that should be run in parallel, queue them as an array, e.g. `view.on('init', [first, second])`.  
10 | 
11 | 
 
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/bindEmailTestRoutes.md:
--------------------------------------------------------------------------------
1 | #### .bindEmailTestRoutes( app, emails )
2 | > *@param* **app** _{Object}_   Express app
3 | > *@param* **emails** _{Object}_   
4 | > _@api_ **public** 
5 | 
6 | 
7 | 
8 | 
   code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/cors.md:
--------------------------------------------------------------------------------
1 | #### .cors
2 | > *@api* **public**     
3 | 
4 | 
 
Adds CORS headers to the response.
 app.all('/api*', keystone.middleware.cors);
5 | 

6 | 
7 | 
  code
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/expandPath.md:
--------------------------------------------------------------------------------
 1 | #### .expandPath( path )
 2 | > *@param* **key** _{String}_  - path  
 3 | > _@return_ **expandedPath** 
 4 | 
 5 | Expands a path to include moduleRoot if it is relative
 6 | 
 7 | ```javascript
 8 | var path = keystone.expandPath(keystone.get('views'));
 9 | ```
10 | 
   
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/get.md:
--------------------------------------------------------------------------------
 1 | #### .get( key )
 2 | > *@param* **key** _{String}_  - Key of the option you want to retrieve  
 3 | > _@return_ **value** 
 4 | 
 5 | Get a Keystone option/value pair.
 6 | 
 7 | ```javascript
 8 | var brand = keystone.get('brand');
 9 | // >> KeystoneJS
10 | ```
11 | 
12 | 
  
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/getOrphanedLists.md:
--------------------------------------------------------------------------------
 1 | #### .getOrphanedLists( )
 2 | > _@return_ **nav** 
 3 | 
 4 | Retrieves orphaned lists (those not in a nav section)
 5 | 
 6 | ```javascript
 7 | var orphanLists = keystone.getOrphanedLists();
 8 | ```
 9 | 
  code 
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/getPath.md:
--------------------------------------------------------------------------------
 1 | #### .getPath( key, defaultValue )
 2 | > *@param* **key** _{String}_  - Key of the option you want to retrieve  
 3 | > *@param* **defaultValue** _{String}_  - Default value if `key` is not a valid option   
 4 | > _@return_ **path** 
 5 | 
 6 | Gets an expanded path option, expanded to include moduleRoot if it is relative.  
 7 | 
 8 | ```javascript
 9 | var path = keystone.getPath('views', 'templates/views');
10 | ```
11 | 
   
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/importer.md:
--------------------------------------------------------------------------------
 1 | #### .importer( rel__dirname )
 2 | > *@param* **rel__dirname** _{String}_  - path  
 3 | > _@return_ **imported** 
 4 | 
 5 | Import all .js Modules in given path
 6 | 
 7 | ```javascript
 8 | var importRoutes = keystone.importer(__dirname);
 9 |  
10 | var routes = {
11 |     site: importRoutes('./site'),
12 |     api: importRoutes('./api')
13 | };
14 | ```
15 | 
 code 
 
16 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/initNav.md:
--------------------------------------------------------------------------------
1 | #### .initNav( nav )
2 | > *@param* **nav** _{Object}_   
3 | > _@api_ **private**   
4 | 
5 | Initialises Keystone's internal nav config.
6 | 
7 | 
  code
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/list.md:
--------------------------------------------------------------------------------
 1 | #### .list( arg )
 2 | > *@param* **arg** _{...String|Function}_  - current list key or new constructed List  
 3 | > _@return_ **list** 
 4 | 
 5 | Registers or retrieves a list.  Used by `List.register()` to register a newly constructed List with Keystone.   
 6 | 
 7 | ```javascript
 8 | var User = keystone.list('User');
 9 | 
10 | User.model.find().exec(function(docs,err) {
11 | 
12 | });
13 | ```  
14 | 
To retrieve a list that may return `undefined` you should use `keystone.lists[key]`.  Using `.list()` will throw a `ReferenceError` if the arg is not a valid `List` or the `key` for a valid `List` 
 `  
15 | 
16 | 
17 | 
  code 
 
18 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/options.md:
--------------------------------------------------------------------------------
 1 | #### .options( options )
 2 | > *@param* **options** _{Object}_  - An **Object** of key/value pairs to add to options.  
 3 | > _@return_ **keystone._options** 
 4 | 
 5 | Set multiple Keystone option/value pair.
 6 | 
 7 | ```javascript
 8 | keystone.options({test: value});
 9 | ```
10 | 
 
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/pre.md:
--------------------------------------------------------------------------------
 1 | #### .pre( event, fn )
 2 | > _@param_ **event**  {String}  
 3 | > _@param_ **fn**  {Function}  - function to call  
 4 | > _@api_ **public**  
 5 | 
 6 | Registers a pre-event handler.  
 7 | Valid events include:  
 8 | - `routes` - calls the function before any routes are matched, after all other middleware 
 9 | 
10 | 
   
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/prefixModel.md:
--------------------------------------------------------------------------------
1 | #### .prefixModel( key ) 
2 | > *@param* **key** _{String}_  - collection name  
3 | > _@return_ **this** 
4 | 
5 | Create proper model collection name with or without prefix. 
6 | 
7 | 
8 | 
     
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/redirect.md:
--------------------------------------------------------------------------------
 1 | #### .redirect( ...params )
 2 | > *@param* **params** _{...String|Object}_  - String or Object of redirects   
 3 | > _@return_ **callback events** 
 4 | 
 5 | Adds one or more redirections (urls that are redirected when no matching routes are found, before treating the request as a 404)
 6 | 
 7 | ```javascript
 8 | keystone.redirect('/old-route', 'new-route');
 9 | 
10 | keystone.redirect({
11 |     'old-route': 'new-route'
12 | });
13 | ```
14 | 
  code 
 
15 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/render.md:
--------------------------------------------------------------------------------
 1 | #### .render( req, res, view, ext )  
 2 | > *@param* **req** _{Object}_  -  Express req object  
 3 | > *@param* **res** _{Object}_  -  Express res object  
 4 | > *@param* **view** _{String}_  -  View to render  
 5 | > *@param* **ext** _{Object}_  -  extend the locals object     
 6 | > _@api_ **private**   
 7 | 
 8 | Internal method to render a view
 9 | 
10 | 
  code 
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/routes.md:
--------------------------------------------------------------------------------
 1 | #### .routes( app )
 2 | > *@param* **app** _{Express()}_  - Express app instance  
 3 | > _@return_ **this** 
 4 | 
 5 | Adds bindings for the keystone routes
 6 | 
 7 | ```javascript
 8 | var app = express();
 9 | app.use(...); // middlewareroutes, routes, etc. should come before keystone is mounted / started
10 | keystone.routes(app);
11 | ```
12 | 
  code 
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/set.md:
--------------------------------------------------------------------------------
 1 | #### .set( key, value )
 2 | > *@param* **key** _{String}_  - Key of the option you want to set  
 3 | > *@param* **value** _{...String|Object|Function|Array}_  - Can be any valid **Object** value   
 4 | > _@return_ **this** 
 5 | 
 6 | Set a Keystone option/value pair.
 7 | 
 8 | ```javascript
 9 | keystone.set('mongo','mongodb://localhost/keystone');
10 | 
11 | keystone.set('custom key',{key1:'key1'});
12 | ```
13 | 
  
 
14 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/start.md:
--------------------------------------------------------------------------------
 1 | #### .start( [_events_] )
 2 | > *@param* **events** _{...Function|Object}_  - Function or Object of events  
 3 | > _@return_ **callback events** 
 4 | 
 5 | Start the Keystone server.  You can work with the events in the example.
 6 | 
 7 | ```javascript
 8 | keystone.start({
 9 |     onMount: function() {
10 | 
11 |     },
12 |     onStart: function() {
13 |     
14 |     },
15 |     onHttpServerCreated: function() {
16 | 
17 |     },
18 |     onHttpsServerCreated: function() {
19 | 
20 |     },
21 |     onSocketServerCreated: function() {
22 | 
23 |     },
24 | });
25 | ```
26 | 
  code 
 
27 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/static.md:
--------------------------------------------------------------------------------
 1 | #### .static( app )
 2 | > *@param* **app** _{Express()}_  - Express App  
 3 | > _@return_ **this** 
 4 | 
 5 | Adds bindings for keystone static resources.  
 6 | Can be included before other middleware (e.g. session management, logging, etc) for reduced overhead.
 7 | 
 8 | ```javascript
 9 | var app = express();
10 | keystone.static(app);
11 | ```
12 | 
  code 
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/static/View.md:
--------------------------------------------------------------------------------
 1 | #### new Keystone.View( req, res )
 2 | > *@param* **req** _{Object}_  - valid Express req object  
 3 | > *@param* **res** _{Object}_  - valid Express res object   
 4 | > _@return_ **Instance**   
 5 | 
 6 | Helper to simplify view logic in a Keystone application  
 7 | 
 8 | ```javascript
 9 | 	var view = new keystone.View(req, res);
10 |     
11 | 	view.render('index');
12 | ```  
13 | 
14 | 
 relevant code
 
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/utils.md:
--------------------------------------------------------------------------------
1 | #### .utils
2 | > _@api_ **public** 
3 | 
4 | 
 
Expose `keystone-utils`
Keystone.utils = require('keystone-utils');

5 | 
6 | 
   
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/version.md:
--------------------------------------------------------------------------------
1 | #### .version 
2 | > _@api_ **public** {Number} 
3 | 
4 | Current version
5 | 
6 | 
    
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.2.x/markdown/class/wrapHTMLError.md:
--------------------------------------------------------------------------------
 1 | #### .wrapHTMLError( title, [_err_] )
 2 | > *@param* **title** _{String}_  - Error title  
 3 | > *@param* **err** _{String}_  - _Optional_ Error message  
 4 | > _@return_ **html** 
 5 | 
 6 | Wraps an error in simple HTML to be sent as a response to the browser
 7 | 
 8 | ```javascript
 9 | var html = keystone.wrapHTMLError('Credential Error','Please login to view this page');
10 | ```
11 | 
  code 
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Classes/Content.md:
--------------------------------------------------------------------------------
1 | #### Keystone.content(  )
2 | > _@api_ **public**    
3 | 
4 | 
  code
 
5 | 
6 | 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Classes/ContentPage.md:
--------------------------------------------------------------------------------
1 | #### Keystone.content.Page( key, options )
2 | > _@param_ **key**  {String}  
3 | > _@param_ **options**  {Options}   
4 | > _@api_ **public**    
5 | 
6 | 
  code
 
7 | 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Classes/ContentType.md:
--------------------------------------------------------------------------------
 1 | #### Keystone.content.Type( path, options )
 2 | > _@param_ **path**  {String}  
 3 | > _@param_ **options**  {Options}   
 4 | > _@api_ **public**     
 5 | 
 6 | 
TODO

 7 | 
 8 | 
  code
 
 9 | 
10 | 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Classes/FieldTypes.md:
--------------------------------------------------------------------------------
 1 | #### .Field.Types 
 2 |   
 3 | Returns an object of Keystone Field Types to work with.  
 4 | Each Field Type inherits all the `Field` methods above.  
 5 | 
Any new or override methods for each Type are  styled like so . 
 6 | 

 7 | Field Type Classes are located at:  
 8 | **/fields/types/fieldtype/FieldtypeType.js**  
 9 | 
10 |   
11 | Each Field Type has React class constructors on top of their unique methods.
12 |   
13 | ##### Field HTML  
14 | **/fields/types/fieldtype/FieldtypeField.js**  
15 | 
16 |  
17 | 
  code
 
18 | 
19 | 
20 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Classes/View.md:
--------------------------------------------------------------------------------
 1 | #### new Keystone.View( req, res )
 2 | > *@param* **req** _{Object}_  - valid Express req object  
 3 | > *@param* **res** _{Object}_  - valid Express res object   
 4 | > _@return_ **Instance**   
 5 | 
 6 | Helper to simplify view logic in a Keystone application  
 7 | 
 8 | ```javascript
 9 | 	var view = new keystone.View(req, res);
10 |     
11 | 	view.render('index');
12 | ```  
13 | 
14 | 
  code
 
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Content/editable.md:
--------------------------------------------------------------------------------
 1 | #### .content.editable( user, options )  
 2 | > *@param* **user** _{Object}_  - user object  
 3 | > *@param* **options** _{Object}_   
 4 | > *@api* **private**  
 5 | 
 6 | Outputs client-side editable data for content management.  
 7 | 
 8 | Called automatically when pages are added.  
 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Content/fetch.md:
--------------------------------------------------------------------------------
1 | #### .content.fetch( page, callback )  
2 | > *@param* **page** _{String}_   
3 | > *@param* **callback** _{Function}_    
4 | > *@api* **public**     
5 | 
6 | 
 
Loads page content by page key (optional).
If page key is not provided, returns a hash of all page contents in the database.
keystone.content.fetch('home', function(err, content) { ... });
 
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Content/initModel.md:
--------------------------------------------------------------------------------
1 | #### .content.initModel( )   
2 | > *@api* **private**      
3 | 
4 | Ensures the Mongoose model for storing content is initialised.  
5 | 
6 | Called automatically when pages are added.  
7 |  
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Content/page.md:
--------------------------------------------------------------------------------
1 | #### .content.page( key, page )  
2 | > *@param* **key** _{String}_  
3 | > *@param* **page** _{Object}_  
4 | > *@api* **private**     
5 | 
6 | Registers a page. Should not be called directly, use `.content.Page.register()` instead.
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Content/store.md:
--------------------------------------------------------------------------------
 1 | #### .content.store( page, content, callback )  
 2 | > *@param* **page** _{String}_  
 3 | > *@param* **content** _{Object}_  
 4 | > *@param* **callback** _{Function}_    
 5 | > *@api* **public**     
 6 | 
 7 | 
 
Sets page content by page key.
Merges content with existing content.
keystone.content.store('home', { title: 'Welcome' }, function(err) { ... });
 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/ContentPage/add.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.add( fields )  
2 | > *@param* **fields** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/ContentPage/clean.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.clean( data )  
2 | > *@param* **data** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | Cleans a data structure so only the defined fields are present.
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/ContentPage/get.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.get( key )  
2 | > *@param* **key** _{String}_   
3 | > *@api* **public**   
4 |  
5 | 
 
Gets page options
 page.get('test') // returns the 'test' value
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/ContentPage/name.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.name  
2 | > *@api* **public**     
3 | 
4 | 
 
Getter
return this.get('name') || this.set('name', utils.keyToLabel(this.key));

5 |  
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/ContentPage/populate.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.populate( data )  
2 | > *@param* **data** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | Populates a data structure based on defined fields
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/ContentPage/register.md:
--------------------------------------------------------------------------------
 1 | #### .content.Page.register(  )  
 2 | > *@api* **public**     
 3 | 
 4 | 
 
Registers the page with Keystone.
var homePage = new keystone.content.Page('home');
 5 | // ...
 6 | homePage.register();
 7 | 
 8 | 	// later...
 9 | 	var homePage = keystone.content.page('home');
10 | 
11 | 

12 | 
13 | 
14 | 
  
 
15 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/ContentPage/set.md:
--------------------------------------------------------------------------------
 1 | #### .content.Page.set( key, value )   
 2 | > *@param* **key** _{String}_  
 3 | > *@param* **value** _{Array|Function|Object|String}_  
 4 | > *@api* **public**     
 5 | 
 6 | 
 
Sets page options.
page.set('test', value) // sets the 'test' option to `value`

 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/ContentPage/validate.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.validate( data )  
2 | > *@param* **data** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | Validates a data structure based on defined fields.
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/buildOptions.md:
--------------------------------------------------------------------------------
 1 | #### Email.buildOptions( err, options [, _callback_] ) 
 2 | > *@param* **err** _{Object}_  - Error  
 3 | > *@param* **options** _{Object}_  - Input options  
 4 | > *@param* **callback** _{Object}_  - callback(err, message)   
 5 | > *@api* **private**  
 6 | 
 7 | Build an options object.
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/compileTemplate.md:
--------------------------------------------------------------------------------
1 | #### Email.compileTemplate(  _callback_  ) 
2 | > *@param* **callback** _{Object}_  - callback(err, email)  
3 | > *@api* **private**  
4 | 
5 | Ensures the template for the email has been compiled
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/defaults.md:
--------------------------------------------------------------------------------
 1 | #### Email.defaults    
 2 | > *@api* **public**  
 3 | 
 4 | 
 
Email.defaults 
{
 5 | 	templateExt: 'jade',
 6 | 	templateEngine: require('jade'),
 7 | 	templateBasePath: path.normalize(path.join(__dirname, '..', 'templates', 'helpers', 'emails')),
 8 | 	mandrill: {
 9 | 		track_opens: true,
10 | 		track_clicks: true,
11 | 		preserve_recipients: false,
12 | 		inline_css: true
13 | 	},
14 | 	// Mandrill template
15 | 	templateMandrillName: null,
16 | 	templateForceHtml: false // Force html render
17 | }
18 | 
 
19 | 
20 | 
  
 
21 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/getEmailsPath.md:
--------------------------------------------------------------------------------
1 | #### Email.getEmailsPath(  )    
2 | > *@api* **public**  
3 | 
4 | Return the value of ` keystone.get('emails'); `.
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/loadTemplate.md:
--------------------------------------------------------------------------------
1 | #### Email.loadTemplate(  _callback_  ) 
2 | > *@param* **callback** _{Object}_  - callback(err, email)  
3 | > *@api* **private**  
4 | 
5 | Loads the template. Looks for `templateName.templateExt`, followed by `templateName/email.templateExt`
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/prepare.md:
--------------------------------------------------------------------------------
1 | #### Email.prepare( options [, _callback_ ] ) 
2 | > *@param* **options** _{Object}_  - locals  
3 | > *@param* **callback** _{Object}_  - callback(err, message)    
4 | > *@api* **private**  
5 | 
6 | Ensures the template for the email has been compiled
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/render.md:
--------------------------------------------------------------------------------
 1 | #### Email.render( locals [, _callback_ ] )   
 2 | > *@param* **locals** _{Object}_  - object of local variables provided to the template   
 3 | > *@param* **callback** _{Object}_  - callback(err, email)  
 4 | 
 5 | Renders the email and passes it to the callback. Used by `Email.send()` but can also be called directly to generate a preview.
 6 | 
 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/renderMandrill.md:
--------------------------------------------------------------------------------
1 | #### Email.renderMandrill( [_locals_ ,] options [, _callback_ ] ) 
2 | > *@param* **locals** _{Object}_  - backwards compatibility    
3 | > *@param* **options** _{Object}_  - locals options object   
4 | > *@param* **callback** _{Object}_  - callback(err, info)      
5 | 
6 | Renders a Mandrill template
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/templateCSSMethods.md:
--------------------------------------------------------------------------------
1 | #### Email.templateCSSMethods.shadeColor( color, percent )
2 | > *@param* **color** {String}  
3 | > *@param* **percent** {Number}     
4 | > *@api* **public**  
5 | 
6 | return a shaded color.
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Email/templateCache.md:
--------------------------------------------------------------------------------
1 | #### Email.templateCache   
2 | > *@api* **public**  
3 | 
4 | A cache of compiled templates organi(sz)ed by name.
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/addToSchema.md:
--------------------------------------------------------------------------------
1 | #### Field.addToSchema(  )   
2 | > *@api* **private**  
3 | 
4 | Default method to register the field on the List's Mongoose Schema.  
5 | 
Overridden by some fieldType Classes.

6 | 
7 | 
  
 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/bindUnderscoreMethods.md:
--------------------------------------------------------------------------------
 1 | #### Field.bindUnderscoreMethods( methods )  
 2 | > *@param* **methods** {Array}    
 3 | > *@api* **private**  
 4 | 
 5 | Automatically bind underscore methods specified by the _underscoreMethods property.
 6 | 
Will always include the 'update' method

 7 | 
 8 | 
  
 
 9 | 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/col.md:
--------------------------------------------------------------------------------
1 | #### Field.col(  )
2 | > *@api* **private**  
3 | 
4 | 
 
Getter
return this.options.col
5 | 

6 | 
7 | 
  
 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/collapse.md:
--------------------------------------------------------------------------------
 1 | #### Field.collapse(  )
 2 | > *@api* **private**   
 3 | 
 4 | 
 5 | 
 
Getter
return this.options.collapse
 6 | 

 7 | 
 8 | 
  
 
 9 | 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/dependsOn.md:
--------------------------------------------------------------------------------
1 | #### Field.dependsOn(  )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.dependsOn
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/format.md:
--------------------------------------------------------------------------------
 1 | #### Field.format( item )   
 2 | > *@param* **item** {Object} - valid item object   
 3 | > *@api* **private**  
 4 | 
 5 | Default method to format the field value for display.  
 6 | 
Overridden by some fieldType Classes.

 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/getData.md:
--------------------------------------------------------------------------------
 1 | #### Field.getData( data )   
 2 | > *@param* **data** {Object} - valid data object   
 3 | > *@api* **private**  
 4 | 
 5 | Gets the field's data from an Item, as used by the React components
 6 | 
 7 | 
 
Return
return item.get(this.path);
 8 | 

 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/getDefaultValue.md:
--------------------------------------------------------------------------------
 1 | #### Field.getDefaultValue(  )   
 2 | > *@api* **private**  
 3 | 
 4 | Gets default value for the field, based on the option or default for the type
 5 | 
 6 | 
 
Return
return this.options.default
 7 | 

 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/getOptions.md:
--------------------------------------------------------------------------------
1 | #### Field.getOptions(  )   
2 | > *@api* **private**  
3 | 
4 | Gets the options for the Field, as used by the React components.
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/getPreSaveWatcher.md:
--------------------------------------------------------------------------------
1 | #### Field.getPreSaveWatcher(  )    
2 | > *@api* **private**   
3 | 
4 | Field watching implementation
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/getSize.md:
--------------------------------------------------------------------------------
 1 | #### Field.getSize( )   
 2 | > *@api* **private**  
 3 | 
 4 | Validates and returns the size of the field.  
 5 | Defaults to deprecated 'width' option.
 6 | 
 7 | 
 
Return
return this.__size
 8 | 

 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/getValueFromData.md:
--------------------------------------------------------------------------------
1 | #### Field.getValueFromData(  )   
2 | > *@api* **private**    
3 | 
4 | Retrieves the value from an object, whether the path is nested or flattened.  
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/hidden.md:
--------------------------------------------------------------------------------
1 | #### Field.hidden(  )
2 | > *@api* **private**   
3 | 
4 | 
 
Getter
return this.options.hidden
5 | 

6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/initial.md:
--------------------------------------------------------------------------------
1 | #### Field.initial(  )    
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.initial
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/isModified.md:
--------------------------------------------------------------------------------
 1 | #### Field.isModified( item )   
 2 | > *@param* **item** {Object} - valid item object  
 3 | > *@api* **private**  
 4 | 
 5 | Default method to detect whether the field has been modified in an item.  
 6 | 
Overridden by some fieldType Classes.

 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/nocol.md:
--------------------------------------------------------------------------------
1 | #### Field.nocol(  )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.nocol
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/noedit.md:
--------------------------------------------------------------------------------
1 | #### Field.noedit(   )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.noedit
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/nofilter.md:
--------------------------------------------------------------------------------
1 | #### Field.nofilter(  )
2 | > *@api* **private**   
3 | 
4 | 
 
Getter
return this.options.nofilter
5 | 

6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/nosort.md:
--------------------------------------------------------------------------------
1 | #### Field.nosort(  )
2 | > *@api* **private**   
3 | 
4 | 
 
Getter
return this.options.nosort
5 | 

6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/note.md:
--------------------------------------------------------------------------------
1 | #### Field.note(  )
2 | > *@api* **private**  
3 | 
4 | 
 
Getter

5 | return this.options.note
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/required.md:
--------------------------------------------------------------------------------
1 | #### Field.required(  ) 
2 | > *@api* **private**  
3 | 
4 | 
5 | 
 
Getter
return this.options.required
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/size.md:
--------------------------------------------------------------------------------
1 | #### Field.size(  )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.getSize()
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/underscoreMethod.md:
--------------------------------------------------------------------------------
1 | #### Field.underscoreMethod( path, fn )   
2 | > *@param* **path** {String} 
3 | > *@param* **item** {Function} 
4 | > *@api* **private**   
5 | 
6 | Adds a method to the underscoreMethods collection on the field's list, with a path prefix to match this field's path and bound to the document.  
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/updateItem.md:
--------------------------------------------------------------------------------
 1 | #### Field.updateItem( item, data )
 2 | > *@param* **item** {Object} - valid item object   
 3 | > *@param* **data** {Object}    
 4 | > *@api* **private**  
 5 | 
 6 | Updates the value for this field in the item from a data object
 7 | 
Overridden by some fieldType Classes.

 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Field/validateInput.md:
--------------------------------------------------------------------------------
 1 | #### Field.validateInput( data [, required, item ] )   
 2 | > *@param* **data** {Object} - valid data object  
 3 | > *@param* **required** {Boolean} - true if this is a required field  
 4 | > *@param* **item** {Object} - valid item object  
 5 | > *@api* **private**  
 6 | 
 7 | Validates that a value for this field has been provided in a data object
 8 | 
Overridden by some fieldType Classes.

 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/FieldTypes/Color.md:
--------------------------------------------------------------------------------
 1 | #### .Field.Types.Color( list, path, options )  
 2 | > *@param* **list** _{Object}_  - valid Keystone list   
 3 | > *@param* **path** _{String}_  - path   
 4 | > *@param* **options** _{Object}_  - options   
 5 | > *@api* **public**  
 6 | 
 7 | 
 
defaults
this._nativeType = String;
 8 | this._underscoreMethods = [];
 9 | this._fixedSize = 'small';

10 | 
11 | 
  code
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Helpers/Middleware.md:
--------------------------------------------------------------------------------
1 | #### Keystone.middleware 
2 | 
3 | Middleware helpers for cors and api
4 |  
5 | 
6 | 
  code
 
7 | 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Helpers/Session.md:
--------------------------------------------------------------------------------
1 | #### Keystone.session
2 | 
3 | Helper to uilize sessions  
4 |  
5 | 
6 | 
  code
 
7 | 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/addFiltersToQuery.md:
--------------------------------------------------------------------------------
1 | #### List.addFiltersToQuery( filters, query )   
2 | > *@param* **filters** _{Array}_  - Filters to add to query   
3 | > *@param* **query** _{Object}_  - Query object   
4 | > _@api_ **private**   
5 | 
6 | Adds one or more filters to a list query in the AdminUI
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/addSearchToQuery.md:
--------------------------------------------------------------------------------
1 | #### List.addSearchToQuery( searchString, query )  
2 | > *@param* **searchString** _{String}_  - Search string   
3 | > *@param* **query** _{Object}_  - Query object    
4 | > _@api_ **private**  
5 | 
6 | Adds a search string to a list query in the AdminUI
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/automap.md:
--------------------------------------------------------------------------------
1 | #### List.automap ( field )
2 | > *@param* **field** _{Object}_  - valid field object  
3 | > _@api_ **private**   
4 | 
5 | Checks to see if a field path matches a currently unmapped path, and
6 | if so, adds a mapping for it.
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/expandPaths.md:
--------------------------------------------------------------------------------
1 | #### List.expandPaths( paths )
2 | > *@param* **paths** _{String}_  - field paths  
3 | > _@return_ **Object**   
4 | 
5 | Expand a String of field paths into objects
6 | 
7 | 
 code
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/expandSort.md:
--------------------------------------------------------------------------------
1 | #### List.expandSort( input )
2 | > *@param* **paths** _{String}_    
3 | > _@return_ **Object**   
4 | > _@api_ **private**  
5 | 
6 | 
 code
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/field.md:
--------------------------------------------------------------------------------
 1 | #### List.field( path, options )
 2 | > *@param* **path** _{String}_ - new field path  
 3 | > *@param* **options** _{Object}_  - field options   
 4 | > _@return_ **Object**   
 5 | > _@api_ **private**    
 6 | 
 7 | Creates a new field at the specified path, with the provided options.  
 8 | If no options are provides, returns the field at the specified path.  
 9 | 
10 | 
11 | 
 code
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/getAdminURL.md:
--------------------------------------------------------------------------------
 1 | #### List.getAdminURL( item )
 2 | > *@param* **item** _{String}_ - item  
 3 | > _@return_ **String**    
 4 | 
 5 | Gets the Admin URL to view the list (or an item if provided)  
 6 | 
 7 | ```javascript
 8 | 	var listURL = list.getAdminURL()
 9 | 	var itemURL = list.getAdminURL(item)  
10 | ```  
11 | 
12 | 
 code
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/getCSV.md:
--------------------------------------------------------------------------------
 1 | #### List.getCSV ( item, [fields, expandRelationshipFields] )
 2 | > *@param* **item** _{Object}_ - list item  
 3 | > *@param* **fields** _{Object}_   
 4 | > *@param* **expandRelationshipFields** _{Boolean}_   
 5 | > _@return_ **String**    
 6 | 
 7 | Gets the data from an Item ready to be serialised to CSV for download
 8 | 
 9 | 
10 | 
 code
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/getData.md:
--------------------------------------------------------------------------------
 1 | #### List.getData ( item, [fields, expandRelationshipFields] )
 2 | > *@param* **item** _{Object}_ - list item  
 3 | > *@param* **fields** _{Object}_   
 4 | > *@param* **expandRelationshipFields** _{Boolean}_   
 5 | > _@return_ **String**    
 6 | 
 7 | Gets the data from an Item ready to be serialised for client-side use, as used by the React components  
 8 | 
 9 | 
 code
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/getDocumentName.md:
--------------------------------------------------------------------------------
 1 | #### List.getDocumentName( doc [, _escape_ ] )
 2 | > *@param* **doc** _{Object}_ - mongoose document   
 3 | > *@param* **escape** _{Boolean}_    
 4 | > _@return_ **String**    
 5 | 
 6 | Gets the name of the provided document from the correct path  
 7 | 
 8 | ```javascript
 9 | var name = list.getDocumentName(item)
10 | ```
11 | 
12 | 
 code
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/getOptions.md:
--------------------------------------------------------------------------------
1 | #### List.getOptions( )   
2 | > _@return_ **Object**    
3 | 
4 | Gets the options for the List, as used by the React components
5 | 
6 | 
 code
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/getPages.md:
--------------------------------------------------------------------------------
1 | #### List.getPages( options [, _maxPages_ ] )   
2 | > _@param_ **options** {Object} - page options  
3 | > _@param_ **maxPages** {Number} - the maximum number pages to display in the pagination  
4 | > _@return_ **Object**  - options  
5 | 
6 | Generate page array for pagination  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/map.md:
--------------------------------------------------------------------------------
 1 | #### List.map( field, path )  
 2 | > _@param_ **field** {String} - map to  
 3 | > _@param_ **path** {String} - map this  
 4 | > _@return_ **Object**  
 5 | > _@api_ **private**  
 6 | 
 7 | Maps a built-in field (e.g. name) to a specific path or returns field mapping  
 8 |  
 9 | 
 code
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/paginate.md:
--------------------------------------------------------------------------------
 1 | #### List.paginate( options  [, _callback_ ] )  
 2 | > _@param_ **options** {Object} - options  
 3 | > _@param_ **callback** {Function} - callback   
 4 | > _@return_ **chain** - exec
 5 | 
 6 | Gets a special Query object that will paginate documents in the list.  
 7 | 
 8 | ```javascript
 9 | list.paginate({
10 | 	page: 1,
11 | 	perPage: 100,
12 | 	maxPages: 10
13 | }).exec(function(err, results) {
14 | 	// do something
15 | });
16 |  
17 | ```
18 | 
 code
 
19 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/processFilters.md:
--------------------------------------------------------------------------------
 1 | #### List.processFilters( q )  
 2 | > _@param_ **q** {String} - filters   
 3 | > _@return_ **Object** - filters  
 4 | 
 5 | Processes a filter string into a filters object
 6 | 
 7 | 
This function is deprecated in favor of .addFiltersToQuery and will be removed in a later version.

 8 | 
 9 | 
 code
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/register.md:
--------------------------------------------------------------------------------
1 | #### List.register(  )  
2 | > _@return_ **this**    
3 | 
4 | Registers the Schema with Mongoose, and the List with Keystone.  
5 | 
6 | Also adds default fields and virtuals to the schema for the list.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/relationship.md:
--------------------------------------------------------------------------------
1 | #### List.relationship( ...def )  
2 | > _@param_ **def** {...String|Option} - relationship (multiple arguments allowed)  
3 | > _@return_ **this**     
4 | > _@api_ **private**  
5 | 
6 | Registers relationships to this list defined on others  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/schema/history.md:
--------------------------------------------------------------------------------
 1 | #### List _schemaPlugins_.history (  )  
 2 | > _@api_ **private**   
 3 | 
 4 | 
 
 5 | #### When enabled, it tracks changes to each document on save or remove.  
 6 | Creates a new collection named `yourcollections_revisions` when **boolean** `true`.  
 7 | Revisions are noted on all `Save` and `Remove` operations.  
 8 | 
    history: true

 9 | 
10 | Uses  list.schema.pre('save'...)  and  list.schema.pre('remove'...) to alter documents.
11 | 
12 | 
code
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/schema/sortable.md:
--------------------------------------------------------------------------------
 1 | #### List _schemaPlugins_.sortable (  )  
 2 | > _@api_ **private**   
 3 | 
 4 | 
 
 5 | #### Drag and Drop Sorting in AdminUI
 6 | Adds a hidden field `sortOrder` to the schema.  
 7 | 
    sortable: true 

 8 | 
 9 | Uses  list.schema.pre('save'...) to alter documents.
10 | 
11 | 
code
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/schema/track.md:
--------------------------------------------------------------------------------
 1 | #### List _schemaPlugins_.track (  )  
 2 | > _@api_ **private**   
 3 | 
 4 | 
Adds tracking fields to a collection
 track: true 
  
 5 | 
 6 | 
 
Added fields
    { 
 7 | 		createdAt: false, 
 8 | 		createdBy: false,
 9 | 		updatedAt: false,
10 | 		updatedBy: false
11 | 	};
12 | 
 
13 | 
14 | Uses  list.schema.pre('save'...)  to alter documents.
15 | 
16 | 
 code
 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/selectColumns.md:
--------------------------------------------------------------------------------
1 | #### List.selectColumns( q, cols )  
2 | > _@param_ **q** {Query} - query    
3 | > _@param_ **cols** {Array} - columns    
4 | > _@return_ **Query** - q   
5 | 
6 | Specified select and populate options for a query based the provided columns.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/set.md:
--------------------------------------------------------------------------------
 1 | #### List.set( key, value )
 2 | > _@param_ **key** {String} - key name  
 3 | > _@param_ **value** {...String|Object|Array|Function} - value  
 4 | > _@return_ **value** - value  
 5 | 
 6 | Gets and Sets list options. Aliased as `.get()`.  
 7 | 
 8 | ```javascript
 9 | list.set('test') // returns the 'test' value
10 | list.set('test', value) // sets the 'test' option to `value`
11 | ```
12 | 
13 | 
 code
 
14 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/underscoreMethod.md:
--------------------------------------------------------------------------------
1 | #### List.underscoreMethod( path, fn )
2 | > _@param_ **path** {String} - path  
3 | > _@param_ **fn** {Function} - underscore method  
4 | > _@return_ **this**    
5 | 
6 | Adds a method to the underscoreMethods collection on the list, which is then added to the schema before the list is registered with mongoose.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/List/updateAll.md:
--------------------------------------------------------------------------------
1 | #### List.updateAll( data [, _callback_ ] )
2 | > _@param_ **data** {Object} - path  
3 | > _@param_ **callback** {Function} - callback  
4 | > _@return_ **this**  
5 | 
6 | Updates every document in a List, setting the provided data on each.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Middleware/cors.md:
--------------------------------------------------------------------------------
1 | #### .middleware.cors
2 | > *@api* **public**     
3 | 
4 | 
 
Adds CORS headers to the response.
 app.all('/api*', keystone.middleware.cors);
5 | 

6 | 
7 | 
  code
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Security/createSecret.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.createSecret(  )    
2 | > *@api* **public**  
3 | 
4 | 
  
 
5 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Security/getSecret.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.getSecret( req )   
2 | > *@param* **req** _{Object}_  - express request object    
3 | > *@api* **public**  
4 | 
5 | 
  
 
6 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Security/getToken.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.getToken( req, res )    
2 | > *@param* **req** _{Object}_  - express request object    
3 | > *@param* **res** _{Object}_  - express response object   
4 | > *@api* **public**  
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Security/middleware.md:
--------------------------------------------------------------------------------
 1 | #### .security.csrf.middleware.init( req, res, next )  
 2 | > *@param* **req** _{Object}_  - express request object  
 3 | > *@param* **res** _{Object}_  - express response object  
 4 | > *@param* **next** _{Object}_  - callback   
 5 | > *@api* **public**  
 6 | 
 7 | 
  
 
 8 | 
 9 | 
10 | #### .security.csrf.middleware.validate( req, res, next )  
11 | > *@param* **req** _{Object}_  - express request object  
12 | > *@param* **res** _{Object}_  - express response object  
13 | > *@param* **next** _{Object}_  - callback   
14 | > *@api* **public**
15 | 
16 | 
  
 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Security/requestToken.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.requestToken( req )   
2 | > *@param* **req** _{Object}_  - express request object    
3 | > *@api* **public**  
4 | 
5 | 
  
 
6 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Security/tokenize.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.tokenize( salt, secret )   
2 | > *@param* **salt** _{String}_    
3 | > *@param* **secret** _{String}_     
4 | > *@api* **public**  
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Security/validate.md:
--------------------------------------------------------------------------------
1 | #### .session.keystoneAuth( req, token )  
2 | > *@param* **req** _{Object}_  - express request object  
3 | > *@param* **token** _{String}_  - token  
4 | > *@api* **public**    
5 | 
6 | 
  
  
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/Session/persist.md:
--------------------------------------------------------------------------------
 1 | #### .session.persist( req, res, next )  
 2 | > *@param* **req** _{Object}_  - express request object  
 3 | > *@param* **res** _{Object}_  - express response object  
 4 | > *@param* **next** _{Object}_  - callback  
 5 | 
 6 | Middleware to ensure session persistence across server restarts.  
 7 | 
 8 | Looks for a userId cookie, and if present, and there is no user signed in, automatically signs the user in.
 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/View/render.md:
--------------------------------------------------------------------------------
 1 | #### View.render( renderFn, locals, callback )
 2 | > *@param* **renderFn** _{Function|String}_  - Render function  
 3 | > *@param* **locals** _{Object}_  - Locals  
 4 | > *@param* **callback** _{Function}_  - Render callback  
 5 | 
 6 | Executes the current queue of init and action methods in series, and then executes the render function.  
 7 | If **renderFn** is a String, it is provided to `res.render`.  
 8 | It is expected that *most* init stacks require processing in series, but it is safe to execute actions in parallel.  
 9 | If there are several `init` methods that should be run in parallel, queue them as an Array, e.g. `view.on('init', [first, second])`.  
10 | 
11 | 
 
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/adminApp.md:
--------------------------------------------------------------------------------
1 | #### .adminApp
2 | > _@api_ **public** 
3 | 
4 | Expose Admin UI App. 
5 | 
6 | 
   
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/applyUpdates.md:
--------------------------------------------------------------------------------
1 | #### .applyUpdates( callback )
2 | > *@param* **callback** _{Function}_  - callback function  
3 | 
4 | Applies Application updates
5 | 
6 | 
7 | 
  code 
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/bindEmailTestRoutes.md:
--------------------------------------------------------------------------------
1 | #### .bindEmailTestRoutes( app, emails )
2 | > *@param* **app** _{Object}_   
3 | > *@param* **emails** _{Object}_   
4 | > _@api_ **private** 
5 | 
6 | 
7 | 
8 | 
   code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/expandPath.md:
--------------------------------------------------------------------------------
 1 | #### .expandPath( path )
 2 | > *@param* **key** _{String}_  - path  
 3 | > _@return_ **expandedPath** 
 4 | 
 5 | Expands a path to include moduleRoot if it is relative
 6 | 
 7 | ```javascript
 8 | var path = keystone.expandPath(keystone.get('views'));
 9 | ```
10 | 
   
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/get.md:
--------------------------------------------------------------------------------
 1 | #### .get( key )
 2 | > *@param* **key** _{String}_  - Key of the option you want to retrieve  
 3 | > _@return_ **value** 
 4 | 
 5 | Get a Keystone option/value pair.
 6 | 
 7 | ```javascript
 8 | var brand = keystone.get('brand');
 9 | // >> KeystoneJS
10 | ```
11 | 
12 | 
  
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/getOrphanedLists.md:
--------------------------------------------------------------------------------
 1 | #### .getOrphanedLists( )
 2 | > _@return_ **nav** 
 3 | 
 4 | Retrieves orphaned lists (those not in a nav section)
 5 | 
 6 | ```javascript
 7 | var orphanLists = keystone.getOrphanedLists();
 8 | ```
 9 | 
  code 
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/getPath.md:
--------------------------------------------------------------------------------
 1 | #### .getPath( key, defaultValue )
 2 | > *@param* **key** _{String}_  - Key of the option you want to retrieve  
 3 | > *@param* **defaultValue** _{String}_  - Default value if `key` is not a valid option   
 4 | > _@return_ **path** 
 5 | 
 6 | Gets an expanded path option, expanded to include moduleRoot if it is relative.  
 7 | 
 8 | ```javascript
 9 | var path = keystone.getPath('views', 'templates/views');
10 | ```
11 | 
   
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/import.md:
--------------------------------------------------------------------------------
 1 | #### .import( dirname )
 2 | > *@param* **dirname** _{String}_  - path  
 3 | > _@return_ **imported** 
 4 | 
 5 | returns all .js modules (recursively) in the path specified, relative to the module root (where the keystone project is being consumed from).
 6 | 
 7 | ```javascript
 8 | var models = keystone.import('models');
 9 | ```
10 | 
  code 
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/importer.md:
--------------------------------------------------------------------------------
 1 | #### .importer( rel__dirname )
 2 | > *@param* **rel__dirname** _{String}_  - path  
 3 | > _@return_ **imported** 
 4 | 
 5 | Import all .js Modules in given path
 6 | 
 7 | ```javascript
 8 | var importRoutes = keystone.importer(__dirname);
 9 |  
10 | var routes = {
11 |     site: importRoutes('./site'),
12 |     api: importRoutes('./api')
13 | };
14 | ```
15 | 
 code 
 
16 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/initNav.md:
--------------------------------------------------------------------------------
1 | #### .initNav( nav )
2 | > *@param* **nav** _{Object}_   
3 | > _@api_ **private**   
4 | 
5 | Initialises Keystone's internal nav config.
6 | 
7 | 
  code
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/list.md:
--------------------------------------------------------------------------------
 1 | #### .list( arg )
 2 | > *@param* **arg** _{...String|Function}_  - current list key or new constructed List  
 3 | > _@return_ **list** 
 4 | 
 5 | Registers or retrieves a list.  Used by `List.register()` to register a newly constructed List with Keystone.   
 6 | 
 7 | ```javascript
 8 | var User = keystone.list('User');
 9 | 
10 | User.model.find().exec(function(docs,err) {
11 | 
12 | });
13 | ```  
14 | 
To retrieve a list that may return `undefined` you should use `keystone.lists[key]`.  Using `.list()` will throw a `ReferenceError` if the arg is not a valid `List` or the `key` for a valid `List` 
 `  
15 | 
16 | 
17 | 
  code 
 
18 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/options.md:
--------------------------------------------------------------------------------
 1 | #### .options( options )
 2 | > *@param* **options** _{Object}_  - An **Object** of key/value pairs to add to options.  
 3 | > _@return_ **keystone._options** 
 4 | 
 5 | Set multiple Keystone option/value pair.
 6 | 
 7 | ```javascript
 8 | keystone.options({test: value});
 9 | ```
10 | 
 
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/prefixModel.md:
--------------------------------------------------------------------------------
1 | #### .prefixModel( key ) 
2 | > *@param* **key** _{String}_  - collection name  
3 | > _@return_ **this** 
4 | 
5 | Create proper model collection name with or without prefix. 
6 | 
7 | 
8 | 
     
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/redirect.md:
--------------------------------------------------------------------------------
 1 | #### .redirect( ...params )
 2 | > *@param* **params** _{...String|Object}_  - String or Object of redirects   
 3 | > _@return_ **callback events** 
 4 | 
 5 | Adds one or more redirections (urls that are redirected when no matching routes are found, before treating the request as a 404)
 6 | 
 7 | ```javascript
 8 | keystone.redirect('/old-route', 'new-route');
 9 | 
10 | keystone.redirect({
11 |     'old-route': 'new-route'
12 | });
13 | ```
14 | 
  code 
 
15 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/render.md:
--------------------------------------------------------------------------------
 1 | #### .render( req, res, view, ext )  
 2 | > *@param* **req** _{Object}_  -  Express req object  
 3 | > *@param* **res** _{Object}_  -  Express res object  
 4 | > *@param* **view** _{String}_  -  View to render  
 5 | > *@param* **ext** _{Object}_  -  extend the locals object     
 6 | > _@api_ **private**   
 7 | 
 8 | Internal method to render a view
 9 | 
10 | 
  code 
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/routes.md:
--------------------------------------------------------------------------------
 1 | #### .routes( app )
 2 | > *@param* **app** _{Express()}_  - Express app instance  
 3 | > _@return_ **this** 
 4 | 
 5 | Adds bindings for the keystone routes
 6 | 
 7 | ```javascript
 8 | var app = express();
 9 | app.use(...); // middlewareroutes, routes, etc. should come before keystone is mounted / started
10 | keystone.routes(app);
11 | ```
12 | 
  code 
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/set.md:
--------------------------------------------------------------------------------
 1 | #### .set( key, value )
 2 | > *@param* **key** _{String}_  - Key of the option you want to set  
 3 | > *@param* **value** _{...String|Object|Function|Array}_  - Can be any valid **Object** value   
 4 | > _@return_ **this** 
 5 | 
 6 | Set a Keystone option/value pair.
 7 | 
 8 | ```javascript
 9 | keystone.set('mongo','mongodb://localhost/keystone');
10 | 
11 | keystone.set('custom key',{key1:'key1'});
12 | ```
13 | 
  
 
14 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/start.md:
--------------------------------------------------------------------------------
 1 | #### .start( [_events_] )
 2 | > *@param* **events** _{...Function|Object}_  - Function or Object of events  
 3 | > _@return_ **callback events** 
 4 | 
 5 | Start the Keystone server.  You can work with the events in the example.
 6 | 
 7 | ```javascript
 8 | keystone.start({
 9 |     onMount: function() {
10 | 
11 |     },
12 |     onStart: function() {
13 |     
14 |     },
15 |     onHttpServerCreated: function() {
16 | 
17 |     },
18 |     onHttpsServerCreated: function() {
19 | 
20 |     },
21 |     onSocketServerCreated: function() {
22 | 
23 |     },
24 | });
25 | ```
26 | 
  code 
 
27 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/utils.md:
--------------------------------------------------------------------------------
1 | #### .utils
2 | > _@api_ **public** 
3 | 
4 | 
 
Expose `keystone-utils`
Keystone.utils = require('keystone-utils');

5 | 
6 | 
   
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/version.md:
--------------------------------------------------------------------------------
1 | #### .version 
2 | > _@api_ **public** {Number} 
3 | 
4 | Current version
5 | 
6 | 
    
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.3.x/markdown/class/wrapHTMLError.md:
--------------------------------------------------------------------------------
 1 | #### .wrapHTMLError( title, [_err_] )
 2 | > *@param* **title** _{String}_  - Error title  
 3 | > *@param* **err** _{String}_  - _Optional_ Error message  
 4 | > _@return_ **html** 
 5 | 
 6 | Wraps an error in simple HTML to be sent as a response to the browser
 7 | 
 8 | ```javascript
 9 | var html = keystone.wrapHTMLError('Credential Error','Please login to view this page');
10 | ```
11 | 
  code 
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/endpoint.jade:
--------------------------------------------------------------------------------
 1 | extends ../../../../../common/templates/layout/base
 2 | 
 3 | include ../../../../templates/mixins/docsapinav
 4 | 
 5 | block intro
 6 | 	.page-header
 7 | 		.container
 8 | 			h1 Endpoint Api
 9 | 			p.lead incoming (version 0.4.x)
10 | 	
11 | block content
12 | 	.container: .row
13 | 		
14 | 		.col-sm-3
15 | 			+docsnav(docssection)
16 | 		
17 | 		.col-sm-9: .docs-content
18 | 			
19 | 			h2
20 | 				a(name='methods')
21 | 				| in development
22 | 			
23 | 			
24 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Classes/Content.md:
--------------------------------------------------------------------------------
1 | #### Keystone.content(  )
2 | > _@api_ **public**    
3 | 
4 | 
  code
 
5 | 
6 | 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Classes/ContentPage.md:
--------------------------------------------------------------------------------
1 | #### Keystone.content.Page( key, options )
2 | > _@param_ **key**  {String}  
3 | > _@param_ **options**  {Options}   
4 | > _@api_ **public**    
5 | 
6 | 
  code
 
7 | 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Classes/ContentType.md:
--------------------------------------------------------------------------------
 1 | #### Keystone.content.Type( path, options )
 2 | > _@param_ **path**  {String}  
 3 | > _@param_ **options**  {Options}   
 4 | > _@api_ **public**    
 5 | 
 6 | 
TODO

 7 | 
 8 | 
  code
 
 9 | 
10 | 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Classes/View.md:
--------------------------------------------------------------------------------
 1 | #### new Keystone.View( req, res )
 2 | > *@param* **req** _{Object}_  - valid Express req object  
 3 | > *@param* **res** _{Object}_  - valid Express res object   
 4 | > _@return_ **Instance**   
 5 | 
 6 | Helper to simplify view logic in a Keystone application  
 7 | 
 8 | ```javascript
 9 | 	var view = new keystone.View(req, res);
10 |     
11 | 	view.render('index');
12 | ```  
13 | 
14 | 
  code
 
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Content/editable.md:
--------------------------------------------------------------------------------
 1 | #### .content.editable( user, options )  
 2 | > *@param* **user** _{Object}_  - user object  
 3 | > *@param* **options** _{Object}_   
 4 | > *@api* **private**  
 5 | 
 6 | Outputs client-side editable data for content management.  
 7 | 
 8 | Called automatically when pages are added.  
 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Content/fetch.md:
--------------------------------------------------------------------------------
1 | #### .content.fetch( page, callback )  
2 | > *@param* **page** _{String}_   
3 | > *@param* **callback** _{Function}_    
4 | > *@api* **public**     
5 | 
6 | 
 
Loads page content by page key (optional).
If page key is not provided, returns a hash of all page contents in the database.
keystone.content.fetch('home', function(err, content) { ... });
 
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Content/initModel.md:
--------------------------------------------------------------------------------
1 | #### .content.initModel( )   
2 | > *@api* **private**      
3 | 
4 | Ensures the Mongoose model for storing content is initialised.  
5 | 
6 | Called automatically when pages are added.  
7 |  
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Content/page.md:
--------------------------------------------------------------------------------
1 | #### .content.page( key, page )  
2 | > *@param* **key** _{String}_  
3 | > *@param* **page** _{Object}_  
4 | > *@api* **private**     
5 | 
6 | Registers a page. Should not be called directly, use `.content.Page.register()` instead.
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Content/store.md:
--------------------------------------------------------------------------------
 1 | #### .content.store( page, content, callback )  
 2 | > *@param* **page** _{String}_  
 3 | > *@param* **content** _{Object}_  
 4 | > *@param* **callback** _{Function}_    
 5 | > *@api* **public**     
 6 | 
 7 | 
 
Sets page content by page key.
Merges content with existing content.
keystone.content.store('home', { title: 'Welcome' }, function(err) { ... });
 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/ContentPage/add.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.add( fields )  
2 | > *@param* **fields** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/ContentPage/clean.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.clean( data )  
2 | > *@param* **data** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | Cleans a data structure so only the defined fields are present.
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/ContentPage/get.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.get( key )  
2 | > *@param* **key** _{String}_   
3 | > *@api* **public**   
4 |  
5 | 
 
Gets page options
 page.get('test') // returns the 'test' value
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/ContentPage/name.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.name  
2 | > *@api* **public**     
3 | 
4 | 
 
Getter
return this.get('name') || this.set('name', utils.keyToLabel(this.key));

5 |  
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/ContentPage/populate.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.populate( data )  
2 | > *@param* **data** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | Populates a data structure based on defined fields
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/ContentPage/register.md:
--------------------------------------------------------------------------------
 1 | #### .content.Page.register(  )  
 2 | > *@api* **public**     
 3 | 
 4 | 
 
Registers the page with Keystone.
var homePage = new keystone.content.Page('home');
 5 | // ...
 6 | homePage.register();
 7 | 
 8 | 	// later...
 9 | 	var homePage = keystone.content.page('home');
10 | 
11 | 

12 | 
13 | 
14 | 
  
 
15 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/ContentPage/set.md:
--------------------------------------------------------------------------------
 1 | #### .content.Page.set( key, value )   
 2 | > *@param* **key** _{String}_  
 3 | > *@param* **value** _{Array|Function|Object|String}_  
 4 | > *@api* **public**     
 5 | 
 6 | 
 
Sets page options.
page.set('test', value) // sets the 'test' option to `value`

 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/ContentPage/validate.md:
--------------------------------------------------------------------------------
1 | #### .content.Page.validate( data )  
2 | > *@param* **data** _{Object}_  
3 | > *@api* **public**     
4 | 
5 | Validates a data structure based on defined fields.
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/buildOptions.md:
--------------------------------------------------------------------------------
 1 | #### Email.buildOptions( err, options [, _callback_] ) 
 2 | > *@param* **err** _{Object}_  - Error  
 3 | > *@param* **options** _{Object}_  - Input options  
 4 | > *@param* **callback** _{Object}_  - callback(err, message)   
 5 | > *@api* **private**  
 6 | 
 7 | Build an options object.
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/compileTemplate.md:
--------------------------------------------------------------------------------
1 | #### Email.compileTemplate(  _callback_  ) 
2 | > *@param* **callback** _{Object}_  - callback(err, email)  
3 | > *@api* **private**  
4 | 
5 | Ensures the template for the email has been compiled
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/defaults.md:
--------------------------------------------------------------------------------
 1 | #### Email.defaults    
 2 | > *@api* **public**  
 3 | 
 4 | 
 
Email.defaults 
{
 5 | 	templateExt: 'jade',
 6 | 	templateEngine: require('jade'),
 7 | 	templateBasePath: path.normalize(path.join(__dirname, '..', 'templates', 'helpers', 'emails')),
 8 | 	mandrill: {
 9 | 		track_opens: true,
10 | 		track_clicks: true,
11 | 		preserve_recipients: false,
12 | 		inline_css: true
13 | 	},
14 | 	// Mandrill template
15 | 	templateMandrillName: null,
16 | 	templateForceHtml: false // Force html render
17 | }
18 | 
 
19 | 
20 | 
  
 
21 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/getEmailsPath.md:
--------------------------------------------------------------------------------
1 | #### Email.getEmailsPath(  )    
2 | > *@api* **public**  
3 | 
4 | Return the value of ` keystone.get('emails'); `.
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/loadTemplate.md:
--------------------------------------------------------------------------------
1 | #### Email.loadTemplate(  _callback_  ) 
2 | > *@param* **callback** _{Object}_  - callback(err, email)  
3 | > *@api* **private**  
4 | 
5 | Loads the template. Looks for `templateName.templateExt`, followed by `templateName/email.templateExt`
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/prepare.md:
--------------------------------------------------------------------------------
1 | #### Email.prepare( options [, _callback_ ] ) 
2 | > *@param* **options** _{Object}_  - locals  
3 | > *@param* **callback** _{Object}_  - callback(err, message)    
4 | > *@api* **private**  
5 | 
6 | Ensures the template for the email has been compiled
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/render.md:
--------------------------------------------------------------------------------
 1 | #### Email.render( locals [, _callback_ ] )   
 2 | > *@param* **locals** _{Object}_  - object of local variables provided to the template   
 3 | > *@param* **callback** _{Object}_  - callback(err, email)  
 4 | 
 5 | Renders the email and passes it to the callback. Used by `Email.send()` but can also be called directly to generate a preview.
 6 | 
 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/renderMandrill.md:
--------------------------------------------------------------------------------
1 | #### Email.renderMandrill( [_locals_ ,] options [, _callback_ ] ) 
2 | > *@param* **locals** _{Object}_  - backwards compatibility    
3 | > *@param* **options** _{Object}_  - locals options object   
4 | > *@param* **callback** _{Object}_  - callback(err, info)      
5 | 
6 | Renders a Mandrill template
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/templateCSSMethods.md:
--------------------------------------------------------------------------------
1 | #### Email.templateCSSMethods.shadeColor( color, percent )
2 | > *@param* **color** {String}  
3 | > *@param* **percent** {Number}     
4 | > *@api* **public**  
5 | 
6 | return a shaded color.
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Email/templateCache.md:
--------------------------------------------------------------------------------
1 | #### Email.templateCache   
2 | > *@api* **public**  
3 | 
4 | A cache of compiled templates organi(sz)ed by name.
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/addToSchema.md:
--------------------------------------------------------------------------------
1 | #### Field.addToSchema(  )   
2 | > *@api* **private**  
3 | 
4 | Default method to register the field on the List's Mongoose Schema.  
5 | 
Overridden by some fieldType Classes.

6 | 
7 | 
  
 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/bindUnderscoreMethods.md:
--------------------------------------------------------------------------------
 1 | #### Field.bindUnderscoreMethods( methods )  
 2 | > *@param* **methods** {Array}    
 3 | > *@api* **private**  
 4 | 
 5 | Automatically bind underscore methods specified by the _underscoreMethods property.
 6 | 
Will always include the 'update' method

 7 | 
 8 | 
  
 
 9 | 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/col.md:
--------------------------------------------------------------------------------
1 | #### Field.col(  )
2 | > *@api* **private**  
3 | 
4 | 
 
Getter
return this.options.col
5 | 

6 | 
7 | 
  
 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/collapse.md:
--------------------------------------------------------------------------------
 1 | #### Field.collapse(  )
 2 | > *@api* **private**   
 3 | 
 4 | 
 5 | 
 
Getter
return this.options.collapse
 6 | 

 7 | 
 8 | 
  
 
 9 | 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/dependsOn.md:
--------------------------------------------------------------------------------
1 | #### Field.dependsOn(  )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.dependsOn
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/format.md:
--------------------------------------------------------------------------------
 1 | #### Field.format( item )   
 2 | > *@param* **item** {Object} - valid item object   
 3 | > *@api* **private**  
 4 | 
 5 | Default method to format the field value for display.  
 6 | 
Overridden by some fieldType Classes.

 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/getData.md:
--------------------------------------------------------------------------------
 1 | #### Field.getData( data )   
 2 | > *@param* **data** {Object} - valid data object   
 3 | > *@api* **private**  
 4 | 
 5 | Gets the field's data from an Item, as used by the React components
 6 | 
 7 | 
 
Return
return item.get(this.path);
 8 | 

 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/getDefaultValue.md:
--------------------------------------------------------------------------------
 1 | #### Field.getDefaultValue(  )   
 2 | > *@api* **private**  
 3 | 
 4 | Gets default value for the field, based on the option or default for the type
 5 | 
 6 | 
 
Return
return this.options.default
 7 | 

 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/getOptions.md:
--------------------------------------------------------------------------------
1 | #### Field.getOptions(  )   
2 | > *@api* **private**  
3 | 
4 | Gets the options for the Field, as used by the React components.
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/getPreSaveWatcher.md:
--------------------------------------------------------------------------------
1 | #### Field.getPreSaveWatcher(  )    
2 | > *@api* **private**   
3 | 
4 | Field watching implementation
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/getSize.md:
--------------------------------------------------------------------------------
 1 | #### Field.getSize( )   
 2 | > *@api* **private**  
 3 | 
 4 | Validates and returns the size of the field.  
 5 | Defaults to deprecated 'width' option.
 6 | 
 7 | 
 
Return
return this.__size
 8 | 

 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/getValueFromData.md:
--------------------------------------------------------------------------------
1 | #### Field.getValueFromData( data ) 
2 | > *@param* **data** {Object} - valid data object     
3 | > *@api* **private**    
4 | 
5 | Retrieves the value from an object, whether the path is nested or flattened.  
6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/hidden.md:
--------------------------------------------------------------------------------
1 | #### Field.hidden(  )
2 | > *@api* **private**   
3 | 
4 | 
 
Getter
return this.options.hidden
5 | 

6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/initial.md:
--------------------------------------------------------------------------------
1 | #### Field.initial(  )    
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.initial
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/isModified.md:
--------------------------------------------------------------------------------
 1 | #### Field.isModified( item )   
 2 | > *@param* **item** {Object} - valid item object  
 3 | > *@api* **private**  
 4 | 
 5 | Default method to detect whether the field has been modified in an item.  
 6 | 
Overridden by some fieldType Classes.

 7 | 
 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/nocol.md:
--------------------------------------------------------------------------------
1 | #### Field.nocol(  )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.nocol
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/noedit.md:
--------------------------------------------------------------------------------
1 | #### Field.noedit(   )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.options.noedit
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/nofilter.md:
--------------------------------------------------------------------------------
1 | #### Field.nofilter(  )
2 | > *@api* **private**   
3 | 
4 | 
 
Getter
return this.options.nofilter
5 | 

6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/nosort.md:
--------------------------------------------------------------------------------
1 | #### Field.nosort(  )
2 | > *@api* **private**   
3 | 
4 | 
 
Getter
return this.options.nosort
5 | 

6 | 
7 | 
  
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/note.md:
--------------------------------------------------------------------------------
1 | #### Field.note(  )
2 | > *@api* **private**  
3 | 
4 | 
 
Getter

5 | return this.options.note
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/required.md:
--------------------------------------------------------------------------------
1 | #### Field.required(  ) 
2 | > *@api* **private**  
3 | 
4 | 
5 | 
 
Getter
return this.options.required
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/size.md:
--------------------------------------------------------------------------------
1 | #### Field.size(  )
2 | > *@api* **private**   
3 | 
4 | 
5 | 
 
Getter
return this.getSize()
6 | 

7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/underscoreMethod.md:
--------------------------------------------------------------------------------
1 | #### Field.underscoreMethod( path, fn )   
2 | > *@param* **path** {String} 
3 | > *@param* **item** {Function} 
4 | > *@api* **private**   
5 | 
6 | Adds a method to the underscoreMethods collection on the field's list, with a path prefix to match this field's path and bound to the document.  
7 | 
8 | 
  
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/updateItem.md:
--------------------------------------------------------------------------------
 1 | #### Field.updateItem( item, data )
 2 | > *@param* **item** {Object} - valid item object   
 3 | > *@param* **data** {Object}    
 4 | > *@api* **private**  
 5 | 
 6 | Updates the value for this field in the item from a data object
 7 | 
Overridden by some fieldType Classes.

 8 | 
 9 | 
  
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Field/validateInput.md:
--------------------------------------------------------------------------------
 1 | #### Field.validateInput( data [, required, item ] )   
 2 | > *@param* **data** {Object} - valid data object  
 3 | > *@param* **required** {Boolean} - true if this is a required field  
 4 | > *@param* **item** {Object} - valid item object  
 5 | > *@api* **private**  
 6 | 
 7 | Validates that a value for this field has been provided in a data object
 8 | 
Overridden by some fieldType Classes.

 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/FieldTypes/Color.md:
--------------------------------------------------------------------------------
 1 | #### .Field.Types.Color( list, path, options )  
 2 | > *@param* **list** _{Object}_  - valid Keystone list   
 3 | > *@param* **path** _{String}_  - path   
 4 | > *@param* **options** _{Object}_  - options   
 5 | > *@api* **public**  
 6 | 
 7 | 
 
defaults
this._nativeType = String;
 8 | this._underscoreMethods = [];
 9 | this._fixedSize = 'small';

10 | 
11 | 
  code
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Helpers/Middleware.md:
--------------------------------------------------------------------------------
1 | #### Keystone.middleware 
2 | 
3 | Middleware helpers for sucurity and api functions
4 |  
5 | 
6 | 
  code
 
7 | 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Helpers/Session.md:
--------------------------------------------------------------------------------
1 | #### Keystone.session
2 | 
3 | Helper to uilize sessions  
4 |  
5 | 
6 | 
  code
 
7 | 
8 | 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/addFiltersToQuery.md:
--------------------------------------------------------------------------------
1 | #### List.addFiltersToQuery( filters, query )   
2 | > *@param* **filters** _{Array}_  - Filters to add to query   
3 | > *@param* **query** _{Object}_  - Query object   
4 | > _@return_ **this** 
5 | 
6 | Adds one or more filters to a list query in the AdminUI
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/addSearchToQuery.md:
--------------------------------------------------------------------------------
1 | #### List.addSearchToQuery( searchString, query )  
2 | > *@param* **searchString** _{String}_  - Search string   
3 | > *@param* **query** _{Object}_  - Query object    
4 | > _@return_ **this**   
5 | 
6 | Adds a search string to a list query in the AdminUI
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/automap.md:
--------------------------------------------------------------------------------
1 | #### List.automap ( field )
2 | > *@param* **field** _{Object}_  - valid field object  
3 | > _@return_ **this**   
4 | 
5 | Checks to see if a field path matches a currently unmapped path, and
6 | if so, adds a mapping for it.
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/expandPaths.md:
--------------------------------------------------------------------------------
1 | #### List.expandPaths( paths )
2 | > *@param* **paths** _{String}_  - field paths  
3 | > _@return_ **Object**   
4 | 
5 | Expand a String of field paths into objects
6 | 
7 | 
code
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/expandSort.md:
--------------------------------------------------------------------------------
1 | #### List.expandSort( input )
2 | > *@param* **paths** _{String}_    
3 | > _@return_ **Object**   
4 | 
5 | 
6 | 
 code
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/field.md:
--------------------------------------------------------------------------------
 1 | #### List.field( path, options )
 2 | > *@param* **path** _{String}_ - new field path  
 3 | > *@param* **options** _{Object}_  - field options   
 4 | > _@return_ **Object**    
 5 | 
 6 | Creates a new field at the specified path, with the provided options.  
 7 | If no options are provides, returns the field at the specified path.  
 8 | 
 9 | 
10 | 
 code
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/getAdminURL.md:
--------------------------------------------------------------------------------
 1 | #### List.getAdminURL( item )
 2 | > *@param* **item** _{String}_ - item  
 3 | > _@return_ **String**    
 4 | 
 5 | Gets the Admin URL to view the list (or an item if provided)  
 6 | 
 7 | ```javascript
 8 | 	var listURL = list.getAdminURL()
 9 | 	var itemURL = list.getAdminURL(item)  
10 | ```  
11 | 
12 | 
code
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/getCSV.md:
--------------------------------------------------------------------------------
 1 | #### List.getCSV ( item, [fields, expandRelationshipFields] )
 2 | > *@param* **item** _{Object}_ - list item  
 3 | > *@param* **fields** _{Object}_   
 4 | > *@param* **expandRelationshipFields** _{Boolean}_   
 5 | > _@return_ **String**    
 6 | 
 7 | Gets the data from an Item ready to be serialised to CSV for download
 8 | 
 9 | 
10 | 
code
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/getData.md:
--------------------------------------------------------------------------------
 1 | #### List.getData ( item, [fields, expandRelationshipFields] )
 2 | > *@param* **item** _{Object}_ - list item  
 3 | > *@param* **fields** _{Object}_   
 4 | > *@param* **expandRelationshipFields** _{Boolean}_   
 5 | > _@return_ **String**    
 6 | 
 7 | Gets the data from an Item ready to be serialised for client-side use, as used by the React components  
 8 | 
 9 | 
code
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/getDocumentName.md:
--------------------------------------------------------------------------------
 1 | #### .getDocumentName( doc, escape )
 2 | > *@param* **doc** _{Object}_ - mongoose document  
 3 | > *@param* **escape** _{Boolean}_    
 4 | > _@return_ **String**    
 5 | 
 6 | Gets the name of the provided document from the correct path  
 7 | 
 8 | ```javascript
 9 | var name = list.getDocumentName(item)
10 | ```
11 | 
12 | 
 code
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/getOptions.md:
--------------------------------------------------------------------------------
1 | #### List.getOptions( )   
2 | > _@return_ **Object**    
3 | 
4 | Gets the options for the List, as used by the React components
5 | 
6 | 
code
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/getPages.md:
--------------------------------------------------------------------------------
1 | #### .getPages( options, maxPages )   
2 | > @param **options** {Object} - page options  
3 | > @param **maxPages** {Number} - the maximum number pages to display in the pagination       
4 | > _@return_ **Object**  - options  
5 | 
6 | Generate page array for pagination  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/map.md:
--------------------------------------------------------------------------------
1 | #### List.map( field, path )  
2 | > _@param_ **field** {String} - map to  
3 | > _@param_ **path** {String} - map this  
4 | > _@return_ **Object**  
5 | 
6 | Maps a built-in field (e.g. name) to a specific path or returns field mapping  
7 |  
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/paginate.md:
--------------------------------------------------------------------------------
 1 | #### List.paginate( options  [, _callback_ ] )  
 2 | > _@param_ **options** {Object} - options  
 3 | > _@param_ **callback** {Function} - callback   
 4 | > _@return_ **chain** - exec
 5 | 
 6 | Gets a special Query object that will paginate documents in the list.  
 7 | 
 8 | ```javascript
 9 | list.paginate({
10 | 	page: 1,
11 | 	perPage: 100,
12 | 	maxPages: 10
13 | }).exec(function(err, results) {
14 | 	// do something
15 | });
16 |  
17 | ```
18 | 
 code
 
19 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/register.md:
--------------------------------------------------------------------------------
1 | #### List.register(  )  
2 | > _@return_ **this**    
3 | 
4 | Registers the Schema with Mongoose, and the List with Keystone.  
5 | 
6 | Also adds default fields and virtuals to the schema for the list.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/relationship.md:
--------------------------------------------------------------------------------
1 | #### List.relationship( ...def )  
2 | > _@param_ **def** {...String|Option} - relationship (multiple arguments allowed)  
3 | > _@return_ **this**     
4 | 
5 | Registers relationships to this list defined on others  
6 | 
7 | 
 code
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/schema/history.md:
--------------------------------------------------------------------------------
 1 | #### List _schemaPlugins_.history (  )  
 2 | > _@api_ **private**   
 3 | 
 4 | 
 
 5 | #### When enabled, it tracks changes to each document on save or remove.  
 6 | Creates a new collection named `yourcollections_revisions` when **boolean** `true`.  
 7 | Revisions are noted on all `Save` and `Remove` operations.  
 8 | 
    history: true

 9 | 
10 | Uses  list.schema.pre('save'...)  and  list.schema.pre('remove'...) to alter documents.
11 | 
12 | 
code
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/schema/sortable.md:
--------------------------------------------------------------------------------
 1 | #### List _schemaPlugins_.sortable (  )  
 2 | > _@api_ **private**   
 3 | 
 4 | 
 
 5 | #### Drag and Drop Sorting in AdminUI
 6 | Adds a hidden field `sortOrder` to the schema.  
 7 | 
    sortable: true 

 8 | 
 9 | Uses  list.schema.pre('save'...) to alter documents.
10 | 
11 | 
code
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/schema/track.md:
--------------------------------------------------------------------------------
 1 | #### List _schemaPlugins_.track (  )  
 2 | > _@api_ **private**   
 3 | 
 4 | 
Adds tracking fields to a collection
 track: true 
  
 5 | 
 6 | 
 
Added fields
    { 
 7 | 		createdAt: false, 
 8 | 		createdBy: false,
 9 | 		updatedAt: false,
10 | 		updatedBy: false
11 | 	};
12 | 
 
13 | 
14 | Uses  list.schema.pre('save'...)  to alter documents.
15 | 
16 | 
 code
 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/selectColumns.md:
--------------------------------------------------------------------------------
1 | #### List.selectColumns( q, cols )  
2 | > _@param_ **q** {Query} - query    
3 | > _@param_ **cols** {Array} - columns    
4 | > _@return_ **Query** - q   
5 | 
6 | Specified select and populate options for a query based the provided columns.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/set.md:
--------------------------------------------------------------------------------
 1 | #### List.set( key, value )
 2 | > _@param_ **key** {String} - key name  
 3 | > _@param_ **value** {...String|Object|Array|Function} - value  
 4 | > _@return_ **value** - value  
 5 | 
 6 | Gets and Sets list options. Aliased as `.get()`.  
 7 | 
 8 | ```javascript
 9 | list.set('test') // returns the 'test' value
10 | list.set('test', value) // sets the 'test' option to `value`
11 | ```
12 | 
13 | 
 code
 
14 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/underscoreMethod.md:
--------------------------------------------------------------------------------
1 | #### List.underscoreMethod( path, fn )
2 | > _@param_ **path** {String} - path  
3 | > _@param_ **fn** {Function} - underscore method  
4 | > _@return_ **this**  
5 | 
6 | Adds a method to the underscoreMethods collection on the list, which is then added to the schema before the list is registered with mongoose.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/List/updateAll.md:
--------------------------------------------------------------------------------
1 | #### List.updateAll( data [, _callback_ ] )
2 | > _@param_ **data** {Object} - path  
3 | > _@param_ **callback** {Function} - callback  
4 | > _@return_ **this**  
5 | 
6 | Updates every document in a List, setting the provided data on each.  
7 | 
8 | 
 code
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Middleware/cors.md:
--------------------------------------------------------------------------------
1 | #### .middleware.cors
2 | > *@api* **public**     
3 | 
4 | 
 
Adds CORS headers to the response.
 app.all('/api*', keystone.middleware.cors);
5 | 

6 | 
7 | 
  code
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Security/createSecret.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.createSecret(  )    
2 | > *@api* **public**  
3 | 
4 | 
  
 
5 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Security/getSecret.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.getSecret( req )   
2 | > *@param* **req** _{Object}_  - express request object    
3 | > *@api* **public**  
4 | 
5 | 
  
 
6 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Security/getToken.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.getToken( req, res )    
2 | > *@param* **req** _{Object}_  - express request object    
3 | > *@param* **res** _{Object}_  - express response object   
4 | > *@api* **public**  
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Security/middleware.md:
--------------------------------------------------------------------------------
 1 | #### .security.csrf.middleware.init( req, res, next )  
 2 | > *@param* **req** _{Object}_  - express request object  
 3 | > *@param* **res** _{Object}_  - express response object  
 4 | > *@param* **next** _{Object}_  - callback   
 5 | > *@api* **public**  
 6 | 
 7 | 
  
 
 8 | 
 9 | 
10 | #### .security.csrf.middleware.validate( req, res, next )  
11 | > *@param* **req** _{Object}_  - express request object  
12 | > *@param* **res** _{Object}_  - express response object  
13 | > *@param* **next** _{Object}_  - callback   
14 | > *@api* **public**
15 | 
16 | 
  
 
17 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Security/requestToken.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.requestToken( req )   
2 | > *@param* **req** _{Object}_  - express request object    
3 | > *@api* **public**  
4 | 
5 | 
  
 
6 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Security/tokenize.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.tokenize( salt, secret )   
2 | > *@param* **salt** _{String}_    
3 | > *@param* **secret** _{String}_     
4 | > *@api* **public**  
5 | 
6 | 
  
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Security/validate.md:
--------------------------------------------------------------------------------
1 | #### .security.csrf.validate( req, token )  
2 | > *@param* **req** _{Object}_  - express request object  
3 | > *@param* **token** _{String}_  - token  
4 | > *@api* **public**    
5 | 
6 | 
  
  
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/Session/persist.md:
--------------------------------------------------------------------------------
 1 | #### .session.persist( req, res, next )  
 2 | > *@param* **req** _{Object}_  - express request object  
 3 | > *@param* **res** _{Object}_  - express response object  
 4 | > *@param* **next** _{Object}_  - callback  
 5 | 
 6 | Middleware to ensure session persistence across server restarts.  
 7 | 
 8 | Looks for a userId cookie, and if present, and there is no user signed in, automatically signs the user in.
 9 | 
10 | 
  
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/View/render.md:
--------------------------------------------------------------------------------
 1 | #### View.render( renderFn, locals, callback )
 2 | > *@param* **renderFn** _{Function|String}_  - Render function  
 3 | > *@param* **locals** _{Object}_  - Locals  
 4 | > *@param* **callback** _{Function}_  - Render callback  
 5 | 
 6 | Executes the current queue of init and action methods in series, and then executes the render function.  
 7 | If renderFn is a string, it is provided to `res.render`.  
 8 | It is expected that *most* init stacks require processing in series, but it is safe to execute actions in parallel.  
 9 | If there are several `init` methods that should be run in parallel, queue them as an array, e.g. `view.on('init', [first, second])`.  
10 | 
11 | 
 
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/adminApp.md:
--------------------------------------------------------------------------------
1 | #### .adminApp
2 | > _@api_ **public** 
3 | 
4 | Expose Admin UI App. 
5 | 
6 | 
   
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/expandPath.md:
--------------------------------------------------------------------------------
 1 | #### .expandPath( path )
 2 | > *@param* **key** _{String}_  - path  
 3 | > _@return_ **expandedPath** 
 4 | 
 5 | Expands a path to include moduleRoot if it is relative
 6 | 
 7 | ```javascript
 8 | var path = keystone.expandPath(keystone.get('views'));
 9 | ```
10 | 
   
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/get.md:
--------------------------------------------------------------------------------
 1 | #### .get( key )
 2 | > *@param* **key** _{String}_  - Key of the option you want to retrieve  
 3 | > _@return_ **value** 
 4 | 
 5 | Get a Keystone option/value pair.
 6 | 
 7 | ```javascript
 8 | var brand = keystone.get('brand');
 9 | // >> KeystoneJS
10 | ```
11 | 
12 | 
  
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/getOrphanedLists.md:
--------------------------------------------------------------------------------
 1 | #### .getOrphanedLists( )
 2 | > _@return_ **nav** 
 3 | 
 4 | Retrieves orphaned lists (those not in a nav section)
 5 | 
 6 | ```javascript
 7 | var orphanLists = keystone.getOrphanedLists();
 8 | ```
 9 | 
  code 
 
10 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/getPath.md:
--------------------------------------------------------------------------------
 1 | #### .getPath( key, defaultValue )
 2 | > *@param* **key** _{String}_  - Key of the option you want to retrieve  
 3 | > *@param* **defaultValue** _{String}_  - Default value if `key` is not a valid option   
 4 | > _@return_ **path** 
 5 | 
 6 | Gets an expanded path option, expanded to include moduleRoot if it is relative.  
 7 | 
 8 | ```javascript
 9 | var path = keystone.getPath('views', 'templates/views');
10 | ```
11 | 
   
 
12 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/importer.md:
--------------------------------------------------------------------------------
 1 | #### .importer( rel__dirname )
 2 | > *@param* **rel__dirname** _{String}_  - path  
 3 | > _@return_ **imported** 
 4 | 
 5 | Import all .js Modules in given path
 6 | 
 7 | ```javascript
 8 | var importRoutes = keystone.importer(__dirname);
 9 |  
10 | var routes = {
11 |     site: importRoutes('./site'),
12 |     api: importRoutes('./api')
13 | };
14 | ```
15 | 
 code 
 
16 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/initDatabase.md:
--------------------------------------------------------------------------------
1 | #### .initDatabase( )
2 | 
3 | > _@return_ **this** 
4 | 
5 | Establish databse connection options if not available. 
6 | 
7 | 
 code 
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/initExpressApp.md:
--------------------------------------------------------------------------------
1 | #### .initExpressApp( )
2 | 
3 | > _@return_ **this** 
4 | 
5 | Creates initial  express app.  Runs `initDatabase` and `initExpressSession`.  
6 | 
7 | 
 code 
 
8 |  
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/initExpressSession.md:
--------------------------------------------------------------------------------
 1 | #### .initExpressSession( )
 2 | 
 3 | > _@return_ **this** 
 4 | 
 5 | Creates express session object. 
 6 | 
 7 | 
 
Expose initialised session and options
 
 8 | 	keystone.set('session options', sessionOptions);
 9 | 	keystone.expressSession = session(sessionOptions);
10 | 	keystone.sessionStorePromise = sessionStorePromise;
11 | 
  
12 | 
13 | 
 code 
 
14 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/initNav.md:
--------------------------------------------------------------------------------
1 | #### .initNav( nav )
2 | > *@param* **nav** _{Object}_   
3 | > _@api_ **private**   
4 | 
5 | Initialises Keystone's internal nav config.
6 | 
7 | 
  code
 
8 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/list.md:
--------------------------------------------------------------------------------
 1 | #### .list( arg )
 2 | > *@param* **arg** _{...String|Function}_  - current list key or new constructed List  
 3 | > _@return_ **list** 
 4 | 
 5 | Registers or retrieves a list.  Used by `List.register()` to register a newly constructed List with Keystone.   
 6 | 
 7 | ```javascript
 8 | var User = keystone.list('User');
 9 | 
10 | User.model.find().exec(function(docs,err) {
11 | 
12 | });
13 | ```  
14 | 
To retrieve a list that may return `undefined` you should use `keystone.lists[key]`.  Using `.list()` will throw a `ReferenceError` if the arg is not a valid `List` or the `key` for a valid `List` 
 `  
15 | 
16 | 
17 | 
  code 
 
18 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/openDatabaseConnection.md:
--------------------------------------------------------------------------------
1 | #### .openDatabaseConnection( callback )
2 | 
3 | > *@param* **callback** _{Function}_     
4 | > _@return_ **this** 
5 | 
6 | Create connection to database
7 | 
8 | 
 code 
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/options.md:
--------------------------------------------------------------------------------
 1 | #### .options( options )
 2 | > *@param* **options** _{Object}_  - An **Object** of key/value pairs to add to options.  
 3 | > _@return_ **keystone._options** 
 4 | 
 5 | Set multiple Keystone option/value pair.
 6 | 
 7 | ```javascript
 8 | keystone.options({test: value});
 9 | ```
10 | 
 
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/prefixModel.md:
--------------------------------------------------------------------------------
1 | #### .prefixModel( key ) 
2 | > *@param* **key** _{String}_  - collection name  
3 | > _@return_ **this** 
4 | 
5 | Create proper model collection name with or without prefix. 
6 | 
7 | 
8 | 
     
 
9 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/redirect.md:
--------------------------------------------------------------------------------
 1 | #### .redirect( ...params )
 2 | > *@param* **params** _{...String|Object}_  - String or Object of redirects   
 3 | > _@return_ **callback events** 
 4 | 
 5 | Adds one or more redirections (urls that are redirected when no matching routes are found, before treating the request as a 404)
 6 | 
 7 | ```javascript
 8 | keystone.redirect('/old-route', 'new-route');
 9 | 
10 | keystone.redirect({
11 |     'old-route': 'new-route'
12 | });
13 | ```
14 | 
  code 
 
15 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/render.md:
--------------------------------------------------------------------------------
 1 | #### .render( req, res, view, ext )  
 2 | > *@param* **req** _{Object}_  -  Express req object  
 3 | > *@param* **res** _{Object}_  -  Express res object  
 4 | > *@param* **view** _{String}_  -  View to render  
 5 | > *@param* **ext** _{Object}_  -  extend the locals object     
 6 | > _@api_ **private**   
 7 | 
 8 | Internal method to render a view
 9 | 
10 | 
  code 
 
11 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/routes.md:
--------------------------------------------------------------------------------
 1 | #### .routes( app )
 2 | > *@param* **app** _{Express()}_  - Express app instance  
 3 | > _@return_ **this** 
 4 | 
 5 | Adds bindings for the keystone routes
 6 | 
 7 | ```javascript
 8 | var app = express();
 9 | app.use(...); // middlewareroutes, routes, etc. should come before keystone is mounted / started
10 | keystone.routes(app);
11 | ```
12 | 
  code 
 
13 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/set.md:
--------------------------------------------------------------------------------
 1 | #### .set( key, value )
 2 | > *@param* **key** _{String}_  - Key of the option you want to set  
 3 | > *@param* **value** _{...String|Object|Function|Array}_  - Can be any valid **Object** value   
 4 | > _@return_ **this** 
 5 | 
 6 | Set a Keystone option/value pair.
 7 | 
 8 | ```javascript
 9 | keystone.set('mongo','mongodb://localhost/keystone');
10 | 
11 | keystone.set('custom key',{key1:'key1'});
12 | ```
13 | 
  
 
14 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/start.md:
--------------------------------------------------------------------------------
 1 | #### .start( [_events_] )
 2 | > *@param* **events** _{...Function|Object}_  - Function or Object of events  
 3 | > _@return_ **callback events** 
 4 | 
 5 | Start the Keystone server.  You can work with the events in the example.
 6 | 
 7 | ```javascript
 8 | keystone.start({
 9 |     onMount: function() {
10 | 
11 |     },
12 |     onStart: function() {
13 |     
14 |     },
15 |     onHttpServerCreated: function() {
16 | 
17 |     },
18 |     onHttpsServerCreated: function() {
19 | 
20 |     },
21 |     onSocketServerCreated: function() {
22 | 
23 |     },
24 | });
25 | ```
26 | 
  code 
 
27 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/static.md:
--------------------------------------------------------------------------------
1 | #### .static ( app )
2 | > _@param_ **app** {Object} - Express app
3 | 
4 | Legacy Attach Mechanisms 
5 | 
6 | 
 
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/static/0.3.x-to-0.4.x-Changes.md:
--------------------------------------------------------------------------------
 1 | 
 2 | #### Core 
 3 | * Removal of `keystone.connect`.  Express and  Mongoose instances are now set during `keystone.init` where you can pass custom Express/Mongoose instances.  
 4 | 
 5 | #### List Class
 6 | * Removal of `List.processFilters`.
 7 | * Removal of `List.getSearchFilters`.
 8 | 
 9 | #### React Admin UI
10 | 
11 | #### Fields
12 | 
13 | 
14 | #### Code
15 | 
16 | 
17 | #### Endpoint Api
18 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/utils.md:
--------------------------------------------------------------------------------
1 | #### .utils
2 | > _@api_ **public** 
3 | 
4 | 
 
Expose `keystone-utils`
Keystone.utils = require('keystone-utils');

5 | 
6 | 
   
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/version.md:
--------------------------------------------------------------------------------
1 | #### .version 
2 | > _@api_ **public** {Number} 
3 | 
4 | Current version
5 | 
6 | 
    
 
7 | 


--------------------------------------------------------------------------------
/content/en/pages/docs/api/0.4.x/markdown/class/wrapHTMLError.md:
--------------------------------------------------------------------------------
 1 | #### .wrapHTMLError( title, [_err_] )
 2 | > *@param* **title** _{String}_  - Error title  
 3 | > *@param* **err** _{String}_  - _Optional_ Error message  
 4 | > _@return_ **html** 
 5 | 
 6 | Wraps an error in simple HTML to be sent as a response to the browser
 7 | 
 8 | ```javascript
 9 | var html = keystone.wrapHTMLError('Credential Error','Please login to view this page');
10 | ```
11 | 
  code 
 
12 | 


--------------------------------------------------------------------------------
/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/favicon.ico


--------------------------------------------------------------------------------
/public/fonts/entypo-social.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/fonts/entypo-social.eot


--------------------------------------------------------------------------------
/public/fonts/entypo-social.svg:
--------------------------------------------------------------------------------
 1 |   
 2 | 
 3 | 
10 | 
11 | 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/public/fonts/entypo-social.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/fonts/entypo-social.ttf


--------------------------------------------------------------------------------
/public/fonts/entypo-social.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/fonts/entypo-social.woff


--------------------------------------------------------------------------------
/public/fonts/entypo.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/fonts/entypo.eot


--------------------------------------------------------------------------------
/public/fonts/entypo.svg:
--------------------------------------------------------------------------------
 1 |   
 2 | 
 3 | 
10 | 
11 | 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/public/fonts/entypo.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/fonts/entypo.ttf


--------------------------------------------------------------------------------
/public/fonts/entypo.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/fonts/entypo.woff


--------------------------------------------------------------------------------
/public/images/admin-interface.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/admin-interface.jpg


--------------------------------------------------------------------------------
/public/images/brand-continental.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/brand-continental.png


--------------------------------------------------------------------------------
/public/images/brand-event_cinemas.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/brand-event_cinemas.png


--------------------------------------------------------------------------------
/public/images/brand-macmillan.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/brand-macmillan.png


--------------------------------------------------------------------------------
/public/images/brand-sony.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/brand-sony.png


--------------------------------------------------------------------------------
/public/images/brand-vodafone.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/brand-vodafone.png


--------------------------------------------------------------------------------
/public/images/brand-westpac.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/brand-westpac.png


--------------------------------------------------------------------------------
/public/images/getting-started/commands-safari.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/getting-started/commands-safari.png


--------------------------------------------------------------------------------
/public/images/getting-started/commands-terminal.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/getting-started/commands-terminal.png


--------------------------------------------------------------------------------
/public/images/getting-started/commands.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/getting-started/commands.jpg


--------------------------------------------------------------------------------
/public/images/getting-started/finished.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/getting-started/finished.jpg


--------------------------------------------------------------------------------
/public/images/getting-started/mongodb-logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/getting-started/mongodb-logo.png


--------------------------------------------------------------------------------
/public/images/getting-started/nodejs-logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/getting-started/nodejs-logo.png


--------------------------------------------------------------------------------
/public/images/home/admin-interface.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/home/admin-interface.png


--------------------------------------------------------------------------------
/public/images/home/inline-item-creation.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/home/inline-item-creation.png


--------------------------------------------------------------------------------
/public/images/home/responsive-design.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/home/responsive-design.png


--------------------------------------------------------------------------------
/public/images/home/sophisticated-fields.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/home/sophisticated-fields.png


--------------------------------------------------------------------------------
/public/images/home/sophisticated-filtering.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/home/sophisticated-filtering.png


--------------------------------------------------------------------------------
/public/images/intro-bg-inverse.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/intro-bg-inverse.png


--------------------------------------------------------------------------------
/public/images/intro-bg.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/intro-bg.png


--------------------------------------------------------------------------------
/public/images/logo-128.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/logo-128.png


--------------------------------------------------------------------------------
/public/images/logo-16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/logo-16.png


--------------------------------------------------------------------------------
/public/images/logo-32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/logo-32.png


--------------------------------------------------------------------------------
/public/images/logo-64.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/logo-64.png


--------------------------------------------------------------------------------
/public/images/logo-inverted.svg:
--------------------------------------------------------------------------------
 1 | 
 2 | 
 3 | 
 4 | 
 6 | 
 7 | 	
 8 | 		
10 | 	
11 | 
12 | 
13 | 
14 | 
15 | 
16 | 
17 | 
18 | 
19 | 
20 | 
21 | 
22 | 
23 | 
24 | 
25 | 


--------------------------------------------------------------------------------
/public/images/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/logo.png


--------------------------------------------------------------------------------
/public/images/tools-bg.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/keystonejs/keystonejs-site/0788f5e4389cbb3d95b548c9a3197e93bdbe35ee/public/images/tools-bg.png


--------------------------------------------------------------------------------
/public/styles/bootstrap/breadcrumbs.less:
--------------------------------------------------------------------------------
 1 | //
 2 | // Breadcrumbs
 3 | // --------------------------------------------------
 4 | 
 5 | 
 6 | .breadcrumb {
 7 |   padding: @breadcrumb-padding-vertical @breadcrumb-padding-horizontal;
 8 |   margin-bottom: @line-height-computed;
 9 |   list-style: none;
10 |   background-color: @breadcrumb-bg;
11 |   border-radius: @border-radius-base;
12 | 
13 |   > li {
14 |     display: inline-block;
15 | 
16 |     + li:before {
17 |       content: "@{breadcrumb-separator}\00a0"; // Unicode space added since inline-block means non-collapsing white-space
18 |       padding: 0 5px;
19 |       color: @breadcrumb-color;
20 |     }
21 |   }
22 | 
23 |   > .active {
24 |     color: @breadcrumb-active-color;
25 |   }
26 | }
27 | 


--------------------------------------------------------------------------------
/public/styles/bootstrap/close.less:
--------------------------------------------------------------------------------
 1 | //
 2 | // Close icons
 3 | // --------------------------------------------------
 4 | 
 5 | 
 6 | .close {
 7 |   float: right;
 8 |   font-size: (@font-size-base * 1.5);
 9 |   font-weight: @close-font-weight;
10 |   line-height: 1;
11 |   color: @close-color;
12 |   text-shadow: @close-text-shadow;
13 |   .opacity(.2);
14 | 
15 |   &:hover,
16 |   &:focus {
17 |     color: @close-color;
18 |     text-decoration: none;
19 |     cursor: pointer;
20 |     .opacity(.5);
21 |   }
22 | 
23 |   // Additional properties for button version
24 |   // iOS requires the button element instead of an anchor tag.
25 |   // If you want the anchor version, it requires `href="#"`.
26 |   button& {
27 |     padding: 0;
28 |     cursor: pointer;
29 |     background: transparent;
30 |     border: 0;
31 |     -webkit-appearance: none;
32 |   }
33 | }
34 | 


--------------------------------------------------------------------------------
/public/styles/bootstrap/component-animations.less:
--------------------------------------------------------------------------------
 1 | //
 2 | // Component animations
 3 | // --------------------------------------------------
 4 | 
 5 | // Heads up!
 6 | //
 7 | // We don't use the `.opacity()` mixin here since it causes a bug with text
 8 | // fields in IE7-8. Source: https://github.com/twitter/bootstrap/pull/3552.
 9 | 
10 | .fade {
11 |   opacity: 0;
12 |   .transition(opacity .15s linear);
13 |   &.in {
14 |     opacity: 1;
15 |   }
16 | }
17 | 
18 | .collapse {
19 |   display: none;
20 |   &.in {
21 |     display: block;
22 |   }
23 | }
24 | .collapsing {
25 |   position: relative;
26 |   height: 0;
27 |   overflow: hidden;
28 |   .transition(height .35s ease);
29 | }
30 | 


--------------------------------------------------------------------------------
/public/styles/bootstrap/wells.less:
--------------------------------------------------------------------------------
 1 | //
 2 | // Wells
 3 | // --------------------------------------------------
 4 | 
 5 | 
 6 | // Base class
 7 | .well {
 8 |   min-height: 20px;
 9 |   padding: 19px;
10 |   margin-bottom: 20px;
11 |   background-color: @well-bg;
12 |   border: 1px solid @well-border;
13 |   border-radius: @border-radius-base;
14 |   .box-shadow(inset 0 1px 1px rgba(0,0,0,.05));
15 |   blockquote {
16 |     border-color: #ddd;
17 |     border-color: rgba(0,0,0,.15);
18 |   }
19 | }
20 | 
21 | // Sizes
22 | .well-lg {
23 |   padding: 24px;
24 |   border-radius: @border-radius-large;
25 | }
26 | .well-sm {
27 |   padding: 9px;
28 |   border-radius: @border-radius-small;
29 | }
30 | 


--------------------------------------------------------------------------------
/public/styles/site.less:
--------------------------------------------------------------------------------
 1 | // bootstrap
 2 | @import "bootstrap/bootstrap.less";
 3 | 
 4 | // keystone
 5 | @import "variables.less";
 6 | @import "entypo.less";
 7 | @import "site/layout.less";
 8 | @import "site/flex.less";
 9 | @import "site/docs.less";
10 | @import "site/utils.less";
11 | 
12 | @import "site/intro.less";
13 | @import "site/getting-started.less";
14 | 
15 | 


--------------------------------------------------------------------------------