lostplot:manual:writer_formatting
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
lostplot:manual:writer_formatting [2021/11/16 10:46] admin |
lostplot:manual:writer_formatting [2021/11/16 12:40] (current) admin |
||
|---|---|---|---|
| Line 86: | Line 86: | ||
| It should also be noted that LostPlot is **//not//** advising that authors should utilise the Resource tagging system for //every// occasion that a resource (character, event, place etc.) is used in the text. The most conventional method of using the Resource tag system is to place the //1st occurrence// of a resource in an __Index Card__ into a tagged reference so that the author can bring up the details of the resource for reference when required. | It should also be noted that LostPlot is **//not//** advising that authors should utilise the Resource tagging system for //every// occasion that a resource (character, event, place etc.) is used in the text. The most conventional method of using the Resource tag system is to place the //1st occurrence// of a resource in an __Index Card__ into a tagged reference so that the author can bring up the details of the resource for reference when required. | ||
| - | === Links and Images === | + | ==== Links and Images ==== |
| The most complex MarkDown tags that **//LostPlot//** supports from the menu are the hyperlinks and images. These two tags involve two, or possibly even three set of tags embedded within each other but luckily are not used very commonly within the body text of a document. Usually when used, they have a special purpose in certain situations only. | The most complex MarkDown tags that **//LostPlot//** supports from the menu are the hyperlinks and images. These two tags involve two, or possibly even three set of tags embedded within each other but luckily are not used very commonly within the body text of a document. Usually when used, they have a special purpose in certain situations only. | ||
| - | **__Hyperlinks__** | + | === Hyperlinks === |
| - | The most common use use of Hyperlinks is in the linking of references to sources on the internet - not just within the final document such as in a reference or appendix, but also within the summary for author reference during development. | + | The most common use of Hyperlinks is in the linking of references to sources on the internet - not just within the final document such as in a reference or appendix, but also within the summary for author reference during development. |
| Hyperlinks are embedded in the text in two parts separated by square and conventional braces: | Hyperlinks are embedded in the text in two parts separated by square and conventional braces: | ||
| Line 103: | Line 103: | ||
| The following example therefore, would result in a clickable link to the Esferico ltd. website (ignore spaces - these have been added to prevent automatic formatting by the wiki): | The following example therefore, would result in a clickable link to the Esferico ltd. website (ignore spaces - these have been added to prevent automatic formatting by the wiki): | ||
| - | [Esferico Website](https : / / www. esferico. net) | + | > ''[Esferico Website](https : / / www. esferico. net)'' |
| Note that if the [Hyperlink] menu option is selected, currently selected text is placed into the **plain-text** portion of the link. You are required to enter the hyperlink portion manually. | Note that if the [Hyperlink] menu option is selected, currently selected text is placed into the **plain-text** portion of the link. You are required to enter the hyperlink portion manually. | ||
| - | __Images__ | + | === Images === |
| The image MarkDown tag is at present the most complex MarkDown tag supported directly by the **//LostPlot//** menu. This takes the form of: | The image MarkDown tag is at present the most complex MarkDown tag supported directly by the **//LostPlot//** menu. This takes the form of: | ||
| 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''. | + | * **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.1637059566.txt.gz ยท Last modified: 2021/11/16 10:46 by admin
Page Tools
