Public Member Functions
	__init__ (self, str fname)
	raw_content (self)
	content (self)
	title (self)
str	html (self)
dict[str, str]	get_ctx (self)
	__repr__ (self)

Public Attributes
str	fname = fname
	content

Detailed Description

A page of the :py:obj:`online documentation <InfoPageSet>`.

Definition at line 54 of file __init__.py.

Constructor & Destructor Documentation

◆ init()

searx.infopage.InfoPage.__init__	(		self,
		str	fname )

Definition at line 57 of file __init__.py.

    def __init__(self, fname: str):
        self.fname: str = fname
 

Member Function Documentation

◆ repr()

searx.infopage.InfoPage.__repr__ ( self )

Definition at line 113 of file __init__.py.

    def __repr__(self):
        return f'<{self.__class__.__name__} fname={self.fname!r}>'

◆ content()

searx.infopage.InfoPage.content ( self )

Content of the page (rendered in a Jinja context)

Definition at line 67 of file __init__.py.

    def content(self):
        """Content of the page (rendered in a Jinja context)"""
        ctx = self.get_ctx()
        template = jinja2.Environment().from_string(self.raw_content)
        return template.render(**ctx)
 

References get_ctx(), and raw_content().

Here is the call graph for this function:

◆ get_ctx()

dict[str, str] searx.infopage.InfoPage.get_ctx ( self )

Jinja context to render :py:obj:`InfoPage.content`

Definition at line 94 of file __init__.py.

    def get_ctx(self) -> dict[str, str]:
        """Jinja context to render :py:obj:`InfoPage.content`"""
 
        def _md_link(name: str, url: str):
            url = url_for(url, _external=True)
            return "[%s](%s)" % (name, url)
 
        def _md_search(query: str):
            url = '%s?q=%s' % (url_for('search', _external=True), urllib.parse.quote(query))
            return '[%s](%s)' % (query, url)
 
        ctx: dict[str, t.Any] = {}
        ctx['GIT_URL'] = GIT_URL
        ctx['get_setting'] = get_setting
        ctx['link'] = _md_link
        ctx['search'] = _md_search
 
        return ctx
 

Referenced by content().

Here is the caller graph for this function:

◆ html()

str searx.infopage.InfoPage.html ( self )

Render Markdown (CommonMark_) to HTML by using markdown-it-py_.

.. _CommonMark: https://commonmark.org/
.. _markdown-it-py: https://github.com/executablebooks/markdown-it-py

Definition at line 83 of file __init__.py.

    def html(self) -> str:
        """Render Markdown (CommonMark_) to HTML by using markdown-it-py_.
 
        .. _CommonMark: https://commonmark.org/
        .. _markdown-it-py: https://github.com/executablebooks/markdown-it-py
 
        """
        return (
            MarkdownIt("commonmark", {"typographer": True}).enable(["replacements", "smartquotes"]).render(self.content)
        )
 

◆ raw_content()

searx.infopage.InfoPage.raw_content ( self )

Raw content of the page (without any jinja rendering)

Definition at line 61 of file __init__.py.

    def raw_content(self):
        """Raw content of the page (without any jinja rendering)"""
        with open(self.fname, 'r', encoding='utf-8') as f:
            return f.read()
 

References fname.

Referenced by content(), and title().

Here is the caller graph for this function:

◆ title()

searx.infopage.InfoPage.title ( self )

Title of the content (without any markup)

Definition at line 74 of file __init__.py.

    def title(self):
        """Title of the content (without any markup)"""
        _t = ""
        for l in self.raw_content.split('\n'):
            if l.startswith('# '):
                _t = l.strip('# ')
        return _t
 

References raw_content().

Here is the call graph for this function:

Member Data Documentation

◆ content

searx.infopage.InfoPage.content

Definition at line 91 of file __init__.py.

◆ fname

searx.infopage.InfoPage.fname = fname

Definition at line 58 of file __init__.py.

Referenced by raw_content().

The documentation for this class was generated from the following file:

/home/andrew/Documents/code/public/searxng/searx/infopage/__init__.py

Public Member Functions

Public Attributes