plugin:caption
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:caption [2015-09-12 20:03] – Aleksandr | plugin:caption [2024-02-24 17:06] (current) – tbiskup | ||
---|---|---|---|
Line 4: | Line 4: | ||
description: | description: | ||
author | author | ||
- | email : till@till-biskup.de | + | email : till [at] till [minus] |
type : syntax | type : syntax | ||
- | lastupdate : 2015-08-04 | + | lastupdate : 2024-02-24 |
- | compatible : Weatherwax+,Adora Belle,Angua,Rincewind | + | compatible : Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum |
depends | depends | ||
- | conflicts | + | conflicts |
similar | similar | ||
tags : caption, figure, tables | tags : caption, figure, tables | ||
Line 20: | Line 20: | ||
---- | ---- | ||
- | Please refer to the [[http:// | + | Please refer to the [[https://www.till-biskup.de/ |
+ | |||
+ | ===== Syntax ===== | ||
+ | |||
+ | The plugin basically provides two different syntax elements, similar to the [[plugin: | ||
+ | |||
+ | < | ||
+ | ... | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | Besides ''< | ||
+ | |||
+ | ''< | ||
+ | |||
+ | **Note:** Illustrations always have their captions set below the actual illustration, | ||
+ | |||
+ | Within the syntax elements, almost every other DokuWiki markup is allowed. | ||
+ | |||
+ | The caption environment provides for automatic numbering and the output of the string " | ||
+ | |||
+ | Whether the abbreviated or spelled notation is to be used can be set via the configuration interface of the plugin. The respective strings are localized, localizations for German, English, Korean and Portuguese-Brazil are currently available, others can be easily installed if necessary((According to the guidelines and structures of DokuWiki for multilingualism.)). | ||
+ | |||
+ | **Note:** In DokuWiki almost everything is allowed within a ''< | ||
+ | |||
+ | ==== Labels and references ==== | ||
+ | |||
+ | Since the figures and tables are automatically numbered by the plugin, there is a need to be able to refer to these figures / tables automatically in the text without having to change all references by hand each time when regrouping the figures / tables. | ||
+ | |||
+ | The original restriction by the parser that only references to already defined figures / tables were resolved has been fixed((The " | ||
+ | |||
+ | The syntax looks like this: | ||
+ | |||
+ | <figure label> | ||
+ | ... | ||
+ | </ | ||
+ | |||
+ | ... | ||
+ | |||
+ | {{ref> | ||
+ | |||
+ | The same applies to the tables. This means that the (optional) label is defined in the opening tag of an image / table ((Pay attention to short, concise but meaningful labels. Since the same labels are also used in the case of LaTeX export in LaTeX, all limitations of LaTeX labels apply: no special characters such as umlauts, no spaces)) and via the structure | ||
+ | |||
+ | {{ref> | ||
+ | |||
+ | referred to. The reference does not differentiate between figures and tables; without exception (like the corresponding LaTeX command '' | ||
+ | |||
+ | **Note:** If a label / table has a label defined, this will be displayed as a " | ||
+ | |||
+ | ==== Changing numbering ==== | ||
+ | |||
+ | Sometimes you would like to control the numbering of your figures/ | ||
+ | |||
+ | {{setcounter figure=5}} | ||
+ | |||
+ | Note: You can only set the four defined types ('' | ||
+ | |||
+ | ==== Example ==== | ||
+ | |||
+ | And that's how the DokuWiki markup could look like: | ||
+ | <code xml> | ||
+ | < | ||
+ | {{: | ||
+ | < | ||
+ | Create a caption, which also contains some // formatting //. | ||
+ | Basically, everything is allowed ((footnotes actually? | ||
+ | </ | ||
+ | </ | ||
+ | And the result: | ||
+ | |||
+ | {{ https:// | ||
+ | |||
+ | or analogously for a table: | ||
+ | <code bash> | ||
+ | < | ||
+ | < | ||
+ | |||
+ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
+ | | Some text | some more text | some less text | | ||
+ | | no idea what to write in here ||| | ||
+ | | | But still some idea for here || | ||
+ | |||
+ | </ | ||
+ | </ | ||
+ | |||
+ | {{https:// | ||
+ | |||
+ | ==== Styles ==== | ||
+ | |||
+ | The individual elements are as far as possible separately addressable and adaptable via changes to the CSS file of the plugin. | ||
+ | |||
+ | The following is an example of the XHTML code generated by the plugin, specifying the appropriate classes. | ||
+ | |||
+ | <code xml> | ||
+ | <figure class=" | ||
+ | < | ||
+ | <span class=" | ||
+ | <span class=" | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | Basically, it is important to format the image subheadings and table headings so that they are as clear as possible from the surrounding body text (especially if they span multiple paragraphs, which may be less common, but may well occur). | ||
+ | |||
+ | ==== Configuration ==== | ||
+ | |||
+ | The DokuWiki configuration interface can be used to set whether the over / signatures begin with abbreviated or advertised " | ||
+ | |||
+ | The " | ||
===== Installation ===== | ===== Installation ===== | ||
- | The plugin | + | Search and install the plugin |
+ | |||
+ | ===== Development ===== | ||
+ | |||
+ | Development takes place via git and GitHub. | ||
+ | |||
+ | Feel free to fork the repository, change it and submit pull requests. | ||
+ | |||
+ | === Change Log === | ||
+ | |||
+ | {{rss> | ||
+ | |||
+ | === Known Bugs and Issues === | ||
+ | |||
+ | Please report bugs or feature requests |
plugin/caption.1442081021.txt.gz · Last modified: 2015-09-12 20:03 by Aleksandr