User Tools

Site Tools


lostplot:manual:writer_formatting

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
lostplot:manual:writer_formatting [2021/11/16 10:52]
admin
lostplot:manual:writer_formatting [2021/11/16 12:40]
admin
Line 34: Line 34:
 ==== Emphasis and Reference Tags ==== ==== Emphasis and Reference Tags ====
  
-{{ :​lostplot:​manual:​toolbar_0022.jpg?​200|}} ​The [Emphasis] toolbar icon in the [Format] toolbar tab is used to wrap selected text with tags which in the case of Emphasis modifies the way that the text is styled in the final __Document__,​ and in the case or Reference tags makes no change to styling but provides internal linkage to alternate text and background information.+ The [Emphasis] toolbar icon in the [Format] toolbar tab is used to wrap selected text with tags which in the case of Emphasis modifies the way that the text is styled in the final __Document__,​ and in the case or Reference tags makes no change to styling but provides internal linkage to alternate text and background information.
  
 Note that all Emphasis characters in **//​LostPlot//​** utilises the customised **//​LostPlot//​** tags and //not// the standard/​extended MarkDown set. This has been done to standardise the form and nature of the tags, as well as removing duplication. If you wish to use the code MarkDown emphasis tags, change the project configuration. Note that all Emphasis characters in **//​LostPlot//​** utilises the customised **//​LostPlot//​** tags and //not// the standard/​extended MarkDown set. This has been done to standardise the form and nature of the tags, as well as removing duplication. If you wish to use the code MarkDown emphasis tags, change the project configuration.
Line 115: Line 115:
   * **Description** - This component, while a requirement of the MarkDown tag, is not currently utilised by the **//​LostPlot//​** MarkDown formatter. While it can be used by authors to give a description of the image, it will not translate into any visual component within the __Document__ pane.   * **Description** - This component, while a requirement of the MarkDown tag, is not currently utilised by the **//​LostPlot//​** MarkDown formatter. While it can be used by authors to give a description of the image, it will not translate into any visual component within the __Document__ pane.
  
-  * **Image_path** - This is the path to the image file which should be placed into the document. It can be a fully qualified URL (web address), or a relative address to an image stored within **//​LostPlot//​**. In the latter case, use the syntax ''​images:''​ followed by the image name, such as ''​images:​johns_passport.png''​. It is usual practice to avoid using spaces in file names, but where unavoidable replace spaces in the tag with a '​+'​ symbol (the conventional web syntax for a space, preventing interpretation as a real syntax-relevant space). This will maintain the tag syntax, but still allow the display of images with spaces embedded in their file name.+  * **Image_path** - This is the path to the image file which should be placed into the document. It can be a fully qualified URL (web address), or a relative address to an image stored within **//​LostPlot//​**. In the latter case, use the syntax ''​images:''​ followed by the image name, such as ''​images:​johns_passport.png''​. It is usual practice to avoid using spaces in file names, but where unavoidable replace spaces in the //tag// (i.e. not the actual file) with a '​+'​ symbol (the conventional web syntax for a space, preventing interpretation as a real syntax-relevant space). This will maintain the tag syntax, but still allow the display of images with spaces embedded in their file name.
  
   * **Alt Text** - This component is a requirement of the web standards to provide a caption for the image where the image file can not be displayed (such as a missing file, but more importantly for text-readers). Not that the caption //must// be enclosed in double quotes and be separated from the image path by a single space. A prefix can be added to the Alt Text field however, which describes how the image is displayed in the __Document__ pane (see below).   * **Alt Text** - This component is a requirement of the web standards to provide a caption for the image where the image file can not be displayed (such as a missing file, but more importantly for text-readers). Not that the caption //must// be enclosed in double quotes and be separated from the image path by a single space. A prefix can be added to the Alt Text field however, which describes how the image is displayed in the __Document__ pane (see below).
lostplot/manual/writer_formatting.txt ยท Last modified: 2021/11/16 12:40 by admin