References
Class Summary
| Static Public Class Summary | ||
| public |
Dumb component for rendering a iso690fr block citation |
|
| public |
Virtual component class for rendering generic block citations |
|
| public |
Dumb component for rendering a iso690fr inline citation |
|
| public |
Virtual component class for rendering generic inline citations |
|
| public |
dumb component for back cover page of a static publication of document |
|
| public |
dumb component for rendering the structured representation of a static document |
|
| public |
dumb component for rendering the structured representation of a static section |
|
| public |
dumb component for rendering the structured representation of a static section |
|
| public |
dumb component and placeholder for rendering the structured representation of an entity long citation (in a glossary for example) |
|
| public |
dumb component and placeholder for rendering the structured representation of an entity citation |
|
| public |
dumb component for containing either a static or dynamic note, acting whether as a pointer or as a container |
|
| public |
dumb component for cover page of a static publication of document |
|
| public |
dumb component for rendering a static table of contents |
|
| public |
dumb component for displaying a simple structured image figure |
|
| public |
dumb static-oriented component for displaying an image gallery |
|
| public |
dumb component for rendering the structured representation of a static note |
|
| public |
dumb component for rendering the structured representation of a static note pointer |
|
| public |
dumb component for rendering a static table of figures |
|
| public |
dumb component for rendering the structured representation of a static section |
|
| public |
dumb static-oriented component for displaying a table |
|
| public |
dumb component for rendering a static table of contents |
|
| public |
dumb component for rendering a static table of figures |
|
| public |
dumb component for rendering the structured representation of a cited element in the format of openUrl/Context Object in Span |
|
| public |
dumb component for rendering the structured representation of a cite element |
|
| public |
dumb component for rendering the structured representation of a date |
|
| public | ||
| public |
dumb component for rendering the structured representation of a section |
|
| public |
dumb component for rendering the structured representation of parent journal information |
|
| public |
dumb component for rendering the structured representation of a person |
|
| public |
dumb component for rendering the structured representation of publisher information |
|
| public |
dumb generic component for rendering the structured representation of a property |
|
| public |
dumb static-oriented component for displaying a webpage poster image |
|
Function Summary
| Static Public Function Summary | ||
| public |
renderContents(contents: Object): ReactElement | string Consumes a peritext content's pseudo-dom nodes list to produce react markup |
|
| public |
resolveDataDependencies(inputSections: array, assetsController: Object, assetsParams: Object, resolveData: boolean, callback: function(err: error, finalSections: array)) Resolves interpolations ni metadata, resources, and contextualizations, and possibly fetches stores necessary data for rendering |
|
Variable Summary
| Static Public Variable Summary | ||
| public |
Exposes assets communication methods |
|
| public |
bibToSchema(bib: string): string: * Translates a peritext bibType to a schema.org Type |
|
| public |
citation: * Citation contextualizer that resolve sections data according to contextualization+settings params |
|
| public |
cleanNaiveTree(params: Object, models: Object, callback: function(error: error, results: {errors: array, validTree: Object})): * Resolves resource and metadata statements from a naive representation of a section |
|
| public |
composeRenderedSections(sections: array, settings: Object, inputStyle: string, messages: array): Object: * Resolves a sections' list against rendering settings by modifying contents, adding output-related pseudo-sections, and updating css styles |
|
| public |
computeReferences(sections: array, settings: Object): array: * Filter and order a list of resources against bibliography settings |
|
| public |
concatTree(tree: Object, params: Object, callback: function(error: error, newTree: object)): * Turns a fsTree into a dumTree, that is to say a tree which presents .bib resources and .md files contents concatenated by folder (according to inner 'include' statements and then automatically) |
|
| public |
Exposes contents communication methods |
|
| public |
contextualizeBlockDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for dynamic outputs |
|
| public |
contextualizeBlockDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for dynamic outputs |
|
| public |
contextualizeBlockDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for dynamic outputs |
|
| public |
contextualizeBlockDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an block contextualization for dynamic outputs |
|
| public |
contextualizeBlockDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for dynamic outputs |
|
| public |
contextualizeBlockDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for dynamic outputs |
|
| public |
contextualizeBlockStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for static outputs |
|
| public |
contextualizeBlockStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for static outputs |
|
| public |
contextualizeBlockStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for static outputs |
|
| public |
contextualizeBlockStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for static outputs |
|
| public |
contextualizeBlockStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for static outputs |
|
| public |
contextualizeBlockStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle a block contextualization for static outputs |
|
| public |
contextualizeInlineDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for dynamic outputs |
|
| public |
contextualizeInlineDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for dynamic outputs |
|
| public |
contextualizeInlineDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for dynamic outputs |
|
| public |
contextualizeInlineDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for dynamic outputs |
|
| public |
contextualizeInlineDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for dynamic outputs |
|
| public |
contextualizeInlineDynamic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for dynamic outputs |
|
| public |
contextualizeInlineStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for static outputs |
|
| public |
contextualizeInlineStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for static outputs |
|
| public |
contextualizeInlineStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for static outputs |
|
| public |
contextualizeInlineStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for static outputs |
|
| public |
contextualizeInlineStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for static outputs |
|
| public |
contextualizeInlineStatic(inputSection: Object, inputContextualization: Object, settings: Object): Object: * Handle an inline contextualization for static outputs |
|
| public |
models of peritext contextualizers |
|
| public |
createFromPath(requestParams: Object, callback: function(error: error, returnedPath: string)): * Creates a file from a certain path and possibly some contents (Crud) |
|
| public |
Exposes peritext default models for metadata, resources, contextualizers, and rendering settings |
|
| public |
Exposes default language parameters for includes and templates |
|
| public |
deleteFromPath(requestParams: Object, callback: function(error: error)): * Deletes a file from a certain path and possibly some contents (cruD) |
|
| public |
deleteMeta(metaList: array, domain: string, key: string): array: * Delete a specific metadata prop |
|
| public |
exportSectionToPdf(params: Object, assetsParams: Object, callback: function(err: error)): * Exports a section representation to a pdf file |
|
| public |
filterResources(resourcesList: array, key: string, value: string): array: * Filter resources that have a specific value |
|
| public |
findByMetadata(sections: array, domain: string, key: string): Object: * Finds a specific section in a sections list through one of its metadata |
|
| public |
generateOpenUrl(resource: Object): string: * Generates an openUrl URI describing the resource, and aimed at being used in a ContextObjectInSpan (COinS) |
|
| public |
getAssetUri(requestParams: Object, callback: function(error: error, finalPath: string)): * Gets the absolute uri of an asset |
|
| public |
getAssetUri(path: array | string, params: Object): function(connectorError: error, uri: string): * Provides the URI of a specific assets file from connector |
|
| public |
getContextualizerModel(bibType: string, contextualizerModels: Object): Object: * Build a model object from a specific bibType, composing it according to its inheritance dependencies, from more general models to the specific bibType |
|
| public |
getMetaValue(metaList: array, domain: string, key: string): string: * Gets a value in metadata props array by its domain and key |
|
| public |
Returns an appropriate connector function for directly reading a file from assets source |
|
| public |
getResourceModel(bibType: string, resourceModels: Object): Object: * Builds a model object from a specific bibType, composing it according to its inheritance dependencies, from more general models to the specific bibType |
|
| public |
glossary: * Glossary contextualizer that resolve sections data according to contextualization+settings params |
|
| public |
Checks if the value has a metadata property |
|
| public |
hasResource(resourcesList: array, resource: Object): boolean: * Checks if a resource list contains a resource, by citeKey |
|
| public |
imagegallery: * Image gallery contextualizer that resolve sections data according to contextualization+settings params |
|
| public |
iso690fr: * ISO 690 style citation - formatted in french language |
|
| public |
jsToComponent(node: Object, index: number): ReactElement: * Consumes a peritext content's pseudo-dom node (described as a js object) and returns a react component |
|
| public |
markdownToJsAbstraction(section: Object, parameters: Object, callback: function(error: error, results: {errors: array, section: Object})): * Parses markdown contents in order to update section data with new contents (as a pseudo-DOM nested javascript object representation), notes, contextualizers and contextualizations |
|
| public |
metaStringToCouple(str: string): Object: * Converts a bibtex metadata expression (e.g. |
|
| public |
models of peritext sections metadata |
|
| public |
numbersToLetters(num: number): string: * Transforms 1, 2, 3 ordinally used number into a, b, c ordinally used letters |
|
| public |
organizeTree(params: Object, callback: function(error: error, results: {errors: array, sections: array})): * Organizes relations betwwen sections |
|
| public |
parseBibAuthors(str: string): array: * Parses a list of authors as they are formatted in bbiTeX statements |
|
| public |
parseBibContextualization(inputStr: string): Object: * Parses a bibTeX-like contextualization statement given as string and returns an object |
|
| public |
parseBibNestedValues(bibObject: Object): Object: * Parses bibTeX nested values inside a bibObject |
|
| public |
parseBibTexStr(str: string): function(error: error, result: Object): * Parses a bibTeX string and returns an object |
|
| public |
parseMarkdown(str: string, expressions: Object, -: function(error: error, results: {extracted: array, cleanStr: string})): * Parses markdown string for markdown files includes statements and inline resources descriptions |
|
| public |
parseSection(params: Object, callback: function(error: error, sections: array)): * Parses an fsTree representation and renders a list of sections to be used with peritext exporters or as is |
|
| public |
parseTreeResources(dumbTree: Object, callback: function(error: error, dumbTree: Object)): * Converts dumbTree resources representations (as string) to js objects - recursively do the same for tree's children |
|
| public |
propagateData(params: Object, callback: function(error: error, result: {errors: array, sections: array})): * Populate the metadatas of a list of sections, by applying propagation from parents or inbetween metadata values (e.g. |
|
| public |
readFromPath(requestParams: Object, callback: function(error: error)): * Reads a file from a certain path (cRud) |
|
| public |
renderSection(params: Object, assetsParams: Object, rendererCallback: function(err: error, result: string)): * Renders a section representation as a string representation of an html page |
|
| public |
resolveBindings(contextualizer: object, section: object, models: object, callback: function(err: error, results: {errors: array, newSection: Object})): * Resolves contextualizations' contextualizer and resource, verifying that contextualization will be possible |
|
| public |
resolveContextualizationsImplementation(section: object, renderingMode: string, settings: object): Object: * Resolves all the contextualizations of a section by updating its contents pseudo-DOM representation |
|
| public |
resolveContextualizationsRelations(sections: array, settings: object): array: * Resolves relations of recurrence, order, and similarity between contextualizations in a section |
|
| public |
resolvePropAgainstType(prop: Object, valueType: string, model: Object): string | array | number | Object: * Transforms a string value to a complex and type-compliant value, thanks to its model's type |
|
| public |
resolveSectionAgainstModels(section: Object, models: Object, callback: function(err: error, result: {errors: array, section: Object})): * Consumes and normalize the metadata of a section |
|
| public |
resolveSettings(settings: Object, bibType: string, settingsModel: Object): Object: * Populate rendering settings according to default bibtype-related settings |
|
| public |
models of peritext resources |
|
| public |
sameMetaScope(meta1: Object, meta1: Object): boolean: * Checks if two metadata props have the same scope (domain and key) |
|
| public |
models of possible peritext sections bibType and their inheritance rules |
|
| public |
serializeBibTexObject(bibObject: object): function(error: error, bibStr: string): * Serializes a javascript object representing a resource or a contextualizer, to a bibTeX-formatted string |
|
| public |
serializeHtmlMeta(metadata: Object, template: string): string: * Consumes a metadata object against an html metadata node template |
|
| public |
serializePropAgainstType(prop: Object, valueType: string, model: Object): string: * Transforms a (possibly not primitive : array, object, bibAuthor) value to a string-friendly value, thanks to its model's type |
|
| public |
serializeSectionList(param: Object, callback: function(error: error, fsTree: Object)): * Converts a sections' list to a fsTree representation of the resulting sourcedata |
|
| public |
setMetaValue(metaList: array, domain: string, key: string, newValue: string): array: * Sets a value in metadata props array after localized it by its domain and key |
|
| public |
models of peritext (possible, and default) rendering settings |
|
| public |
table: * Table contextualizer that resolve sections data according to contextualization+settings params |
|
| public |
timeline: * Timeline contextualizer that resolve sections data according to contextualization+settings params |
|
| public |
updateFromPath(requestParams: Object, callback: function(error: error)): * Updates a file from a certain path and possibly some contents (crUd) |
|
| public |
updateFromSource(params: Object, models: Object, parametesr: Object, callback: function(parsingErrors: error, results: Object)): * |
|
| public |
updateToSource(params: Object, sections: array, models: Object, oldFsTree: Object, callback: function(serializingErrors: error, sections: array)): * Serializes the representation of a series of peritext sections to an fsTree representation by "diffing" new fsTree with previous fsTree then makes a diff list with deep-diff then monitor source tree updating (with C.U.D. |
|
| public |
validateResources(section: Object, models: Object, callback: function(err: null, output: Object)): * Validates the resources of a section against resources models |
|
| public |
webpage: * Webpage contextualizer that resolve sections data according to contextualization+settings params |
|