Skip to content

Commit 6eb9522

Browse files
authored
Update function documentation in templates.html
1 parent 750daff commit 6eb9522

1 file changed

Lines changed: 14 additions & 12 deletions

File tree

templates.html

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -400,23 +400,25 @@ <h5>For all types of Article [Article, Page, Analysis (and custom types)]</h5>
400400
</ul>
401401
<h4>Functions</h4>
402402
<ul>
403-
<li>r(refId: string, args: object): string [inserts a reference and returns a string with an HTML element with an anchor link] </li>
404-
<li>note(noteText: string, args: object): string [inserts a note and returns a string with an HTML element with an anchor link] </li>
405-
<li>img(imgId: string, args: object, options: object): string [returns a string with an IMG element. The possible attributes of <i>options</i> are: width (number), height (number), version (string), title (string/boolean), caption (string/boolean), alt (string/boolean) and style (string)] </li>
406-
<li>media_url(mediaId: string, media: object): string [returns the URL corresponding to the media ID] </li>
407-
<li>photo_version(photo: object, version: string): string [returns the URL of the requested image version. If it does not exist, it returns the smallest version that is larger than the one requested] </li>
408-
<li>reference(articleUri: string, pos: number): string [returns the reference ID related to a given reference position]</li>
409-
<li>references_length(articleUri: string): number [returns the number of references in an article]</li>
403+
<li>declare(key: string, value: string, args: object): void [this function allows user-edited pages to pass information to templates]</li>
404+
<li>escape_latex(text: string): string [escapes LaTeX special characters]</li>
405+
<li>format_date(dateStr: string, options: object): string [formats dates in a human-readable format]</li>
410406
<li>get_authors(ref: object): array[string] [returns the authors in a reference object]</li>
411-
<li>get_urls(ref: object): array[string] [returns the URLs (UR) in a reference object]</li>
407+
<li>get_latex(markdown: string, footnotes: array[array[string]], options: object): string [converts Markdown to LaTeX]</li>
412408
<li>get_py(ref: object): string [returns the publication year in a reference object]</li>
409+
<li>get_tags(ref: object, tags: array): array[array] [it receives an array with the desired tags (note: this array may contain arrays with tags that function as synonyms. For example: [["VL", "VO", "T3"], "IS", "SP"]. If "VL" is found, the function will not search for the other tags within the internal array. The function returns an array with an array for each tag found. In this array, there are three elements (the tag itself, a label for the tag and the value found)]</li>
413410
<li>get_title(ref: object): string [returns the title in a reference object]</li>
414411
<li>get_type(ref: object): string [returns the type of a reference object. For example: "Journal Article"]</li>
415-
<li>get_tags(ref: object, tags: array): array[array] [it receives an array with the desired tags (note: this array may contain arrays with tags that function as synonyms. For example: [["VL", "VO", "T3"], "IS", "SP"]. If "VL" is found, the function will not search for the other tags within the internal array. The function returns an array with an array for each tag found. In this array, there are three elements (the tag itself, a label for the tag and the value found)]</li>
416-
<li>reference_loc(articleUri: string, pos: number): string [returns "Ibid." if the previous reference is equal to the given reference, "Loc. cit." if there is another reference equal to the given reference but not immediately preceding it, and "" for the other cases]</li>
417-
<li>declare(key: string, value: string, args: object): void [this function allows user-edited pages to pass information to templates]</li>
418-
<li>format_date(dateStr: string, options: object): string [formats dates in a human-readable format]</li>
412+
<li>get_urls(ref: object): array[string] [returns the URLs (UR) in a reference object]</li>
413+
<li>img(imgId: string, args: object, options: object): string [returns a string with an IMG element. The possible attributes of <i>options</i> are: width (number), height (number), version (string), title (string/boolean), caption (string/boolean), alt (string/boolean) and style (string)] </li>
419414
<li>iso_datetime(dateStr: string): string [formats dates according to the ISO 8601 standard]</li>
415+
<li>media_url(mediaId: string, media: object): string [returns the URL corresponding to the media ID] </li>
416+
<li>note(noteText: string, args: object): string [inserts a note and returns a string with an HTML element with an anchor link] </li>
417+
<li>photo_version(photo: object, version: string): string [returns the URL of the requested image version. If it does not exist, it returns the smallest version that is larger than the one requested] </li>
418+
<li>r(refId: string, args: object): string [inserts a reference and returns a string with an HTML element with an anchor link] </li>
419+
<li>reference(articleUri: string, pos: number): string [returns the reference ID related to a given reference position]</li>
420+
<li>reference_loc(articleUri: string, pos: number): string [returns "Ibid." if the previous reference is equal to the given reference, "Loc. cit." if there is another reference equal to the given reference but not immediately preceding it, and "" for the other cases]</li>
421+
<li>references_length(articleUri: string): number [returns the number of references in an article]</li>
420422
<li>rfc822_datetime(dateStr: string, timezone: string): string [formats dates according to the RFC 822 standard]</li>
421423
</ul>
422424
</code>

0 commit comments

Comments
 (0)