Enum tpnote_lib::config::LocalLinkKind

pub enum LocalLinkKind {
    Off,
    Short,
    Long,
}

Defines the way the HTML exporter rewrites local links.

The enum LocalLinkKind allows you to fine tune how local links are written out. Valid variants are: off, short and long. In order to achieve this, the user must respect the following convention concerning absolute paths in local links in Tp-Note documents: When a document contains a local link with an absolute path, the base of this path is considered to be the the directory where the marker file .tpnoteroot resides (or / in non exists). The option --export-link- rewriting decides how local links in the Tp-Note document are converted when the HTML is generated. If its value is short, then local links with relative paths are converted to absolute paths. The base of the resulting path is where the .tpnoteroot file resides (or / if none exists). Consider the following example LocalLinkKind::Short:

• The Tp-Note file /my/docs/car/bill.md contains
• a local link with an absolute path: /car/scan.jpg,
• and another link with a relative path: ./photo.jpg.
• The document root marker is: /my/docs/.tpnoteroot.

The images in the resulting HTML will appear as

• /car/scan.jpg.
• /car/photo.jpg.

For LocalLinkKind::Long, in addition to the above, all absolute paths in local links are rebased to /’. Consider the following example:

• The Tp-Note file /my/docs/car/bill.md contains
• a link with an absolute path: /car/scan.jpg,
• and another link with a relative path: ./photo.jpg.
• The document root marker is: /my/docs/.tpnoteroot.

The images in the resulting HTML will appear as

• /my/docs/car/scan.jpg.
• /my/docs/car/photo.jpg.

Variants

Off

Do not rewrite links.

Short

Rewrite relative local links. Base: “.tpnoteroot”

Long

Rewrite all local links. Base: “/”

Trait Implementations

impl Clone for LocalLinkKind

fn clone(&self) -> LocalLinkKind

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LocalLinkKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LocalLinkKind

fn default() -> LocalLinkKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalLinkKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for LocalLinkKind

type Err = LibCfgError

The associated error which can be returned from parsing.

fn from_str(level: &str) -> Result<LocalLinkKind, Self::Err>

Parses a string s to return a value of this type.

impl Hash for LocalLinkKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LocalLinkKind

fn eq(&self, other: &LocalLinkKind) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LocalLinkKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for LocalLinkKind

impl Eq for LocalLinkKind

impl StructuralEq for LocalLinkKind

impl StructuralPartialEq for LocalLinkKind