Differences

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

--- lostplot:manual:writer_formatting [2021/11/14 11:48]
admin
+++ lostplot:manual:writer_formatting [2021/11/16 12:40] (current)
admin
@@ Line 35: / Line 35: @@
 {{ :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.
+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.
 === Emphasis ===
-To emphasise text, select the text with the mouse or keyboard then click the required emphasis in the drop-down menu. Five typical emphasis types are currently supported by **//LostPlot//**:
+To emphasise text, select the text with the mouse or keyboard then click the required emphasis in the drop-down menu. Seven typical emphasis types are currently supported by **//LostPlot//**:
-  * **Bold** - text is wrapped in double-asterisk characters [ * * ]
+  * **Bold** - text is wrapped in double asterisk characters [ * * ]
-  * __Underline__ - text is wrapped in double-underscore characters [ _ _ ]
+  * __Underline__ - text is wrapped in double underscore characters [ _ _ ]
-  * //Italic// - text is wrapped in double-tilde characters [ ~ ~ ]
+  * //Italic// - text is wrapped in double forward-slash characters [ / / ]
-  * <del>Strikethrough</del> - text is wrapped in double-hyphen characters [ - - ]
+  * <del>Strikethrough</del> - text is wrapped in double-hyphen characters [ ~ ~ ]
-  * ''Monospaced Text'' - (also known as 'code') text is wrapped in reverse-ticks (gravs) [``]
+  * ''Monospaced Text'' - (also known as 'code') text is wrapped in double reverse-ticks (gravs) [``]
+  * Superscript - text is wrapped in double-plus characters [ + + ]
+  * Subscript - text is wrapped in double-minus characters [ - - ]
 //Note: To show characters in this document, spaces are often added to prevent the MarkDown interpreter of the Wiki from processing them. In the case of using these tags manually in **//LostPlot//**, do not include any spaces within the tags.//
@@ Line 59: / Line 63: @@
   * Resource Tags
-__Placeholders__
+**__Placeholders__**
 Placeholders wrap selected text in double-curled braces in the form { {name} } and represent direct replacements for text that has been defined within the project configuration. Adding the placeholder { {author} } into the __Content__ of an __Index Card__ for example, will result in the actual author's name being embedded into the final styled document in the __Document__ pane.
@@ Line 66: / Line 70: @@
-__Resources__
+**__Resources__**
 In nearly all respects, Resource tags act and produce final __Document__ pane text in exactly the same manner as conventional Placeholder tags. Their main benefit comes from internal use within **//LostPlot//** in regards to referencing and giving access to background information and research.
@@ Line 72: / Line 76: @@
 Resource tags wrap selected text in a curled-brace and vertical-bar combination in the form { |name| }.
-For the majority of resource tags, simply place the name of the resource within the tags as normal and enter the final text in the resource record (see Managing Resources). For projects with non-overlapping resources (e.g. only one character called 'John'), the use of the tag is conventional. There are however, also suffix forms that allow more control over what is replaced when the __Document__ pane is styled:
+For the majority of resource tags, simply place the name of the resource within the tags as normal and enter the final text in the resource record (see Managing Resources). For projects with non-overlapping resources (e.g. only one character called 'John'), the use of the tag is conventional. There are two forms in which the resource tag can be used which allows more control over what is replaced when the __Document__ pane is styled:
   * **{ |name| }** - the conventional use. The text { |john| } is replaced with the normal title of the 'john' resource (e.g. 'John').
-  * **{ |name:version| }** - used when there are multiple resources with the same name (e.g. { |john:1| } and { |john:2| }). In practice, this will probably be rare in conventional storytelling (and should probably be avoided).
+  * **{ |name:keyword| }** - used when an alternate text should be used in the __Document__ styling other than the normal title of the resource. Within the resource manager, alternates are created in a keyword=text manner. Usually this is done as a result of a one-off requirement based upon the circumstances of the text being written (e.g. { |john:first| } may replace the text with 'Maj. Johnathon Rice' rather than the normal 'John'.
-  * **{ |name=keyword| }** - used when an alternate text should be used in the __Document__ styling other than the normal title of the resource. Within the resource manager, alternates are created in a keyword=text manner. Usually this is done as a result of a one-off requirement based upon the circumstances of the text being written (e.g. { |john=first| } may replace the text with 'Maj. Johnathon Rice' rather than the normal 'John'. Note that you can use the tag { |name:version=keyword| }.
+//Note: If you have multiple characters with the same name that you want to use as a resource placeholders simply add a short suffix to make them unique. For example, { |JohnP| } and { |JohnR| } could therefore both simply have 'John' as their replacement text (if not exactly advisable from a storytelling perspective...)//
-//Note: While the name=keyword usage of the tag could be a one-off necessity, the name:version usage can be greatly simplified by using unique tag names but then using the same title: { |JohnP| } and { |JohnR| } could therefore both simply have 'John' as their replacement text (if not exactly advisable from a storytelling perspective...)//
 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 ====
+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 ===
+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:
+> ''[Text to appear in the document](hyperlink to the document)''
+  * The text within the **square-braces** (which must always comes first) is displayed within the document in the style usually connected with a hyperlink. This may vary according to the web browser in use, but is usually blue and underlined.
+  * The text within the **normal braces** (which must always come last) is hidden from the reader, and represents the link to the destination web resource.
+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)''
+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 ===
+The image MarkDown tag is at present the most complex MarkDown tag supported directly by the **//LostPlot//** menu. This takes the form of:
+> ''![description](image_path "Alt Text")''
+  * **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// (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).
+There are four options for prefixing format information within the Alt Caption component of the image tag, controlling where the image is displayed in the text:
+  * No Prefix - Entering just the caption, with no special prefix results in the image being included in-line using normal web--display rules and with no special considerations.
+  * **<<** - Entering double left-arrows (e.g. ''"<<caption"'') results in the image being embedded in the text on the left hand side of the paragraph, with the following text wrapping around the image.
+  * **>>** - Entering double right-arrows (e.g. ''">>caption"'') results in the image being embedded in the text on the right hand side of the paragraph, with the following text wrapping around the image.
+  * **><** - Entering a right then left arrow (e.g. ''"><caption"'') results in the image being placed on its own line, centred in the page width. This is the most common and advised method of entering images as 'illustrations' in the document.
+----
+==== Strip Emphasis ====
+The [Strip Emphasis] menu option is used to remove all emphasis tags from selected text. This option is useful to reset a section of text to a known base level before reapplying emphasis a second time.
 ----

Pergamon Wiki

User Tools

Site Tools

Differences

Page Tools