 | Sony: No PlayStation Vita ShortagesSony has increased production of the Vita to make
2 | sure that there are plenty of systems to go around. |
Test 1
Test 2
--------------------------------------------------------------------------------
/tests/fixtures/dynamic_attributes_test.plim:
--------------------------------------------------------------------------------
1 | a**attrs|Test
2 |
3 | a **attrs,Test2
4 |
5 | a(
6 | **attrs(
7 | data=**{'a':'b'}
8 | )
9 | ) Test3
10 |
11 | a(**attrs**attrs2 disabled) Test4
--------------------------------------------------------------------------------
/tests/fixtures/try_test.plim:
--------------------------------------------------------------------------------
1 | -try
2 | div Test
3 | - except IOError
4 | div IOError
5 | -except KeyError as e
6 | div = e
7 | - else
8 | div All was well
9 | -finally
10 | div Finally
11 |
--------------------------------------------------------------------------------
/tests/fixtures/multiline_variable_result.mako:
--------------------------------------------------------------------------------
1 | ${form(fieldset('',field('text',title=_('Tab name'),name='name',size=30,maxlength=16,tip=_('Enter a tab name (up to 16 characters).'),required="required")),render_buttons=False)+ "Test"}
--------------------------------------------------------------------------------
/tests/fixtures/stylus_result.mako:
--------------------------------------------------------------------------------
1 |
9 |
--------------------------------------------------------------------------------
/tests/fixtures/handlebars_result.mako:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/tests/fixtures/scss_test.plim:
--------------------------------------------------------------------------------
1 | -scss
2 | @option style: expanded;
3 | .selector {
4 | a {
5 | display: block;
6 | }
7 | strong {
8 | color: blue;
9 | }
10 | }
--------------------------------------------------------------------------------
/tests/fixtures/try_result.mako:
--------------------------------------------------------------------------------
1 | %try:
2 | Test
3 | %except IOError:
4 | IOError
5 | %except KeyError as e:
6 | ${e}
7 | %else:
8 | All was well
9 | %finally:
10 | Finally
11 | %endtry
--------------------------------------------------------------------------------
/tests/fixtures/explicit_space_result.mako:
--------------------------------------------------------------------------------
1 | ${ungettext('The link remains valid for {num} day.','The link remains valid for {num} days.',3).format(num=3)} ${_('Upon the expiration of this period, all non-activated accounts ''will be removed from the site.')}
-------------------------------------------------------------------------------- /tests/fixtures/style_script_result.mako: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/fixtures/call_test.plim: -------------------------------------------------------------------------------- 1 | -call expression="${4==4}" self:conditional 2 | |i'm the result 3 | 4 | - call expression=${4==4} self:conditional 5 | | i'm the result 6 | 7 | - call self:conditional 8 | | i'm the result 9 | 10 | - call self:conditional 11 | 12 | -------------------------------------------------------------------------------- /tests/fixtures/style_script_test.plim: -------------------------------------------------------------------------------- 1 | style type="text/css" 2 | h1 {color:red;} 3 | p {color:blue;} 4 | 5 | 6 | script type="text/javascript" 7 | document.write("Hello World!"); 8 | // test that `embedded markup` is not parsed 9 | document.write("`hello world`"); 10 | -------------------------------------------------------------------------------- /tests/fixtures/stylus_test.plim: -------------------------------------------------------------------------------- 1 | -stylus 2 | body 3 | background: linear-gradient(top, white, black) 4 | 5 | border-radius() 6 | -webkit-border-radius arguments 7 | -moz-border-radius arguments 8 | border-radius arguments 9 | 10 | a.button 11 | border-radius 5px 12 | -------------------------------------------------------------------------------- /docs/license.rst: -------------------------------------------------------------------------------- 1 | License 2 | ========= 3 | 4 | Plim source code is licensed under the `MIT license${i}
3 | %endwhile
4 | 2 Test
------------------------------------
5 |
6 |
7 | %while i in var:
8 | ${i}
9 | %if i:
10 | 4 Test
11 | %endif
12 | 5 Test
13 | %while i:
14 | ${i}
15 | %if i:
16 | 4 Test
17 | %endif
18 | 5 Test
19 | %endwhile
20 |
21 | %endwhile
22 |
23 | %while i in []:
24 |
25 | %endwhile
26 | %while i in [1,2,3,4,5]:
27 |
28 | %endwhile
--------------------------------------------------------------------------------
/tests/fixtures/for_result.mako:
--------------------------------------------------------------------------------
1 | %for i in [1,2,3,4,5]:
2 | ${i}
3 | %endfor
4 | 2 Test
------------------------------------
5 |
6 | %for i in var:
7 | ${i}
8 | %if i:
9 | 4 Test
10 | %endif
11 | 5 Test
12 | %for i in var:
13 | ${i}
14 | %if i:
15 | 4 Test
16 | %endif
17 | 5 Test
18 | %endfor
19 |
20 | %endfor
21 |
22 | %for i in []:
23 |
24 | %endfor
25 |
26 | %for i in [1,2,3,4,5]:
27 | ${i}
28 | %endfor
--------------------------------------------------------------------------------
/plim/unportable.py:
--------------------------------------------------------------------------------
1 | import re
2 |
3 |
4 |
5 | PARSE_IMPLICIT_LITERAL_RE = re.compile(
6 | # Order matters
7 | u'(?P12 | %if is_editor: 13 | Edit 14 | %elif (is_admin): 15 | Delete 16 | %elif is_guest: 17 | No Caption 18 | %else: 19 | Caption 20 | %endif 21 |
22 | %if idea: 23 | Idea 24 | %elif is_day: 25 | Think about it 26 | %else: 27 | Sleep 28 | %endif 29 |
Cool! 30 | -------------------------------------------------------------------------------- /plim/util.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from typing import Sequence, Iterable 3 | 4 | PY3K = sys.version_info >= (3, 0) 5 | 6 | from io import StringIO 7 | 8 | 9 | def joined(buf: Iterable[str], sep: str = '') -> str: 10 | """ note: `buf` iterable will be fully consumed, so if you are passing a stream make sure you tee it 11 | if you need to use the `buf` again later 12 | """ 13 | return sep.join(buf) 14 | 15 | 16 | def space_separated(buf: Sequence[str]) -> str: 17 | return joined(buf, ' ') 18 | 19 | 20 | u = str 21 | MAXSIZE = sys.maxsize 22 | -------------------------------------------------------------------------------- /tests/fixtures/for_result.dtl: -------------------------------------------------------------------------------- 1 | {% for i in [1,2,3,4,5] %} 2 |{{i}}
3 | {% endfor %}
4 | 2 Test
------------------------------------
5 |
6 | {% for i in var %}
7 | {{i}}
8 | {% if i %}
9 | 4 Test
10 | {% endif %}
11 | 5 Test
12 | {% for i in var %}
13 | {{i}}
14 | {% if i %}
15 | 4 Test
16 | {% endif %}
17 | 5 Test
18 | {% endfor %}
19 |
20 | {% endfor %}
21 |
22 | {% for i in [] %}
23 |
24 | {% endfor %}
25 |
26 | {% for i in [1,2,3,4,5] %}
27 | {{i}}
28 | {% endfor %}
--------------------------------------------------------------------------------
/tests/fixtures/pipe_test.plim:
--------------------------------------------------------------------------------
1 | | # We are inside indented block
2 |
3 | Test
4 | Test # 6
5 | Test # 4
6 | Test # 3
7 | Test # 2
8 | Test # 1
9 |
10 | |---------------------
11 |
12 | | Test
13 | | Test
14 |
15 | | Test
16 | Test1
17 | Test2
18 | Test4
19 |
20 | |
21 | Test
22 | # we are inside toplevel literal
23 | | Test
24 |
25 | |---------------------
26 | ,# Pipe with explicit space
27 | Test
--------------------------------------------------------------------------------
/tests/fixtures/inline_loop_test.plim:
--------------------------------------------------------------------------------
1 | -for item in ['a','b','c',':'][::][1:]: li: strong = Case1
2 |
3 | -for item in ['a','b','c',':'][::][1:]: li
4 | strong = Case2
5 |
6 | -for item in ['a','b','c',':'][::][1:]: li: -for item2 in ['a','b','c',':'][::][1:]
7 | strong = Case3
8 |
9 |
10 | ul: -for item in {1, 2, 3}: li.link:a(href=route_to(item))=item
11 |
12 | ul: -for link in [
13 | 'About',
14 | 'Blog',
15 | 'Sitemap'
16 | ]: li: a href=route_to(link) = link
17 |
18 | table: -for item in items: tr
19 | td = item.name
20 | td = item.price
21 |
--------------------------------------------------------------------------------
/tests/fixtures/embedded_result.mako:
--------------------------------------------------------------------------------
1 | Embedded string everywhere
2 | ---
3 | Embedded strings everywhere
4 | ---
5 | This is a link embedded into a literal block. 6 | --- 7 | another very funny recursive test 8 | --- 9 | Embed everything
statements
10 | %for word in ['like', 'this']:
11 | ${word}
12 | %endfor
13 |
.
14 | ---
15 | Try using multi-line embedded markup Like this test
16 |
--------------------------------------------------------------------------------
/tests/fixtures/one_liners_result.mako:
--------------------------------------------------------------------------------
1 | <%inherit file="base.html"/><%inherit file="base.html"/><%inherit/><%inherit file="/ideas/base.html"/><%page args="x, y, z='default'"/><%page/><%include file="header.html"/>Content<%include file="footer.html"/><%namespace name="dyn" file="${context['namespace_name']}"/><%namespace file="${context['namespace_name']}" name="dyn"/><%namespace file="${context['namespace_name']}" name="dyn"/><%namespace file="${context['namespace_name']}" name="dyn"/><%namespace file="${context['namespace_name']} " name="dyn"/><%namespace file="${context['namespace_name']} " name="dyn"/>
--------------------------------------------------------------------------------
/tests/fixtures/one_liners_test.plim:
--------------------------------------------------------------------------------
1 | -inherit base.html
2 | - inherit file="base.html"
3 | -inherit
4 | -inherit /ideas/base.html
5 |
6 | -page args="x, y, z='default'"
7 | - page
8 |
9 | -include file="header.html"
10 | | Content
11 | - include footer.html
12 |
13 | -namespace name="dyn" file="${context['namespace_name']}"
14 | - namespace name="dyn" = context['namespace_name']
15 | -namespace name="dyn" ${context['namespace_name']}
16 | -namespace name="dyn" | ${context['namespace_name']}
17 | -namespace name="dyn" , ${context['namespace_name']}
18 | -namespace name="dyn" =, context['namespace_name']
--------------------------------------------------------------------------------
/tests/django_test/fixtures/if_test.plim:
--------------------------------------------------------------------------------
1 |
2 |
3 | - if True
4 | div 1 Test
5 | div 2 Test
6 |
7 | |------------------------------------
8 |
9 | -if False
10 | div 3 False Test
11 | - if True
12 | div 4 Test
13 | div 5 Test
14 | -elif True
15 | div 6 True Test
16 | - elif 1 == 1
17 | div 7 Test
18 | -else
19 | div 8 Else Test
20 |
21 | -if False
22 | -elif True
23 | -else
24 |
25 | /--------------------------------
26 | - if (
27 | a == b
28 | ) or (
29 | c == d)
30 | |Test
31 | -elif (
32 | e == f
33 | )
34 | |Test2
--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [mypy]
2 | warn_unused_ignores = true
3 | follow_imports = normal
4 | show_error_context = true
5 | warn_incomplete_stub = true
6 | ignore_missing_imports = true
7 | check_untyped_defs = true
8 | cache_dir = ./.local/mypy-cache
9 | warn_redundant_casts = true
10 | warn_unused_configs = true
11 | strict_optional = true
12 | strict_equality = true
13 |
14 | [coverage:report]
15 | # Regexes for lines to exclude from consideration
16 | exclude_lines =
17 | # Have to re-enable the standard pragma
18 | pragma: no cover
19 |
20 | ignore_errors = True
21 |
22 | [coverage:run]
23 | source =
24 | plim
25 |
--------------------------------------------------------------------------------
/docs/related.rst:
--------------------------------------------------------------------------------
1 | Related projects
2 | ================
3 |
4 | There is a number of similar projects that you might be interested in.
5 |
6 | - `slimish-jinja2 1 Test
3 | %endif
4 | 2 Test
------------------------------------
5 |
6 | %if False:
7 | 3 False Test
8 | %if True:
9 | 4 Test
10 | %endif
11 | 5 Test
12 | %elif True:
13 | 6 True Test
14 | %elif 1 == 1:
15 | 7 Test
16 | %else:
17 | 8 Else Test
18 | %endif
19 |
20 | %if False:
21 |
22 | %elif True:
23 |
24 | %else:
25 |
26 | %endif
27 | %if (a == b) or (c == d):
28 | Test
29 | %elif (e == f):
30 | Test2
31 | %endif
32 | %if "permission:admin" in effective_principals(request):
33 | Allow
34 | %endif -------------------------------------------------------------------------------- /tests/fixtures/embedded_test.plim: -------------------------------------------------------------------------------- 1 | a href="#" Embedded `strong string` everywhere 2 | 3 | a href="#" Embedded `strong string`_`i s` everywhere 4 | 5 | This is a `a href="#" link` embedded `br` into a literal block. 6 | 7 | | another `a href="#" very ``strong funny ````i recursive``````` test 8 | 9 | Embed everything `#even statements``-for word in ['like', 'this']:= word```. 10 | 11 | Try using multi-line embedded markup `a( 12 | href="#" 13 | ): Like this ``strong( 14 | data-something="true" 15 | ) test``` 16 | -------------------------------------------------------------------------------- /tests/fixtures/plim_multiline_tag_result.mako: -------------------------------------------------------------------------------- 1 |Test
2 | ${Test()}
3 | ${title}
4 |
5 | ${_(u'Editing "{title}" information').format(title=c.title)}
6 |${url('product',tagname=tagname)}
7 | 
${Test}
8 | ${Test}
9 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | # EditorConfig is awesome: https://EditorConfig.org
2 |
3 | # top-most EditorConfig file
4 | root = true
5 |
6 | # Unix-style newlines with a newline ending every file
7 | [*]
8 | end_of_line = lf
9 | insert_final_newline = true
10 |
11 | # Matches multiple files with brace expansion notation
12 | # Set default charset
13 | [*.{js,py}]
14 | charset = utf-8
15 |
16 | # 4 space indentation
17 | [*.py]
18 | indent_style = space
19 | indent_size = 4
20 |
21 | [*.sh]
22 | indent_style = space
23 | indent_size = 4
24 |
25 | # Tab indentation (no size specified)
26 | [Makefile]
27 | indent_style = tab
28 |
29 | [*.nix]
30 | indent_style = space
31 | indent_size = 4
32 |
--------------------------------------------------------------------------------
/tests/fixtures/if_test.plim:
--------------------------------------------------------------------------------
1 |
2 |
3 | - if True
4 | div 1 Test
5 | div 2 Test
6 |
7 | |------------------------------------
8 |
9 | -if False
10 | div 3 False Test
11 | - if True
12 | div 4 Test
13 | div 5 Test
14 | -elif True
15 | div 6 True Test
16 | - elif 1 == 1
17 | div 7 Test
18 | -else
19 | div 8 Else Test
20 |
21 | -if False
22 | -elif True
23 | -else
24 |
25 | /--------------------------------
26 | - if (
27 | a == b
28 | ) or (
29 | c == d)
30 | |Test
31 | -elif (
32 | e == f
33 | )
34 | |Test2
35 |
36 | -if "permission:admin" in effective_principals(request)
37 | p Allow
38 |
--------------------------------------------------------------------------------
/tests/fixtures/dynamic_attributes_result.mako:
--------------------------------------------------------------------------------
1 | TestTest2 Test3Test4
22 |
--------------------------------------------------------------------------------
/tests/fixtures/if_result.dtl:
--------------------------------------------------------------------------------
1 | {% if True %}
2 | 1 Test
3 | {% endif %}
4 | 2 Test
------------------------------------
5 |
6 | {% if False %}
7 | 3 False Test
8 | {% if True %}
9 | 4 Test
10 | {% endif %}
11 | 5 Test
12 | {% elif True %}
13 | 6 True Test
14 | {% elif 1 == 1 %}
15 | 7 Test
16 | {% else %}
17 | 8 Else Test
18 | {% endif %}
19 |
20 | {% if False %}
21 |
22 | {% elif True %}
23 |
24 | {% else %}
25 |
26 | {% endif %}
27 | {% if (a == b) or (c == d) %}
28 | Test
29 | {% elif (e == f) %}
30 | Test2
31 | {% endif %}
32 | {% if "permission:admin" in effective_principals(request) %}
33 | Allow
34 | {% endif %} -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Mako>=0.9.0 2 | pyrsistent>=0.18.1 3 | babel>=1.3 4 | # We use reStructuredText (docutils component) for both supporting 5 | # the "-rest" extension and project documenting. So, ensure that the docutils 6 | # get installed or upgraded on the target machine 7 | docutils>=0.3 8 | # We use Markdown for the "-markdown" extension 9 | markdown2>=1.4.2 10 | # Explicitly list PyExecJs as a dependency for the CoffeeScript and Stylus extensions 11 | PyExecJS>=1.0.4 12 | # We use CoffeeScript for "-coffee" extension 13 | CoffeeScript 14 | # We use SCSS for "-scss/sass" extension 15 | pyScss>=1.2.0.post3 16 | # We use the stylus package for "-stylus" extension 17 | # https://github.com/bkad/python-stylus 18 | stylus>=0.1.1 19 | -------------------------------------------------------------------------------- /docs/locale/zh_CN/LC_MESSAGES/cli.po: -------------------------------------------------------------------------------- 1 | # 2 | msgid "" 3 | msgstr "" 4 | "Project-Id-Version: Plim 0.9\n" 5 | "Report-Msgid-Bugs-To: \n" 6 | "POT-Creation-Date: 2015-06-12 16:42+0800\n" 7 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" 8 | "Last-Translator: FULL NAME-
17 | %for item in {1, 2, 3}:
18 |
- ${item} 19 | %endfor 20 |
-
21 | %for link in ['About','Blog','Sitemap']:
22 |
- ${link} 23 | %endfor 24 |
| ${item.name} | ${item.price} |
5 | %for row in accountdata: 6 | Value: ${row}
7 | %endfor 8 | 9 | <%def name="account(accountname, type=u'中文')"> 10 | account name: ${accountname}, type: ${type} 11 | <%def name="mydef()"> 12 | <%def name="subdef()"> 13 | a sub def 14 | i'm the def, and the subcomponent is ${subdef()} 15 | <%block> 16 | this is a block. 17 | <%block filter="h"> 18 | this is some escaped html. 19 | <%block name="post_prose" args="post"> 20 | ${post.content} 21 | <%block name="post_prose"> 22 | ${pageargs['post'].content} 23 | <%block name="post_prose"> 24 | ${pageargs['post'].content} -------------------------------------------------------------------------------- /tests/fixtures/def_block_test.plim: -------------------------------------------------------------------------------- 1 | - def hello() 2 | | hello world 3 | 4 | 5 | - def account() 6 | | Account for ${username}:
7 | 8 | - for row in accountdata 9 | | Value: ${row}
10 | 11 | 12 | -def account(accountname, type=u'中文') 13 | | account name: ${accountname}, type: ${type} 14 | 15 | 16 | -def mydef() 17 | -def subdef() 18 | | a sub def 19 | 20 | | i'm the def, and the subcomponent is ${subdef()} 21 | 22 | 23 | html:body 24 | -block 25 | | this is a block. 26 | 27 | 28 | - block filter="h" 29 | html this is some escaped html. 30 | 31 | 32 | span.post_prose 33 | -block args="post" post_prose 34 | = post.content 35 | 36 | -block name="post_prose" 37 | =pageargs['post'].content 38 | 39 | -block post_prose 40 | = pageargs['post'].content 41 | -------------------------------------------------------------------------------- /docs/locale/cli.pot: -------------------------------------------------------------------------------- 1 | # SOME DESCRIPTIVE TITLE. 2 | # Copyright (C) 2014, Maxim Avanov 3 | # This file is distributed under the same license as the Plim package. 4 | # FIRST AUTHOR
Test1
Test2
Test3
Test4
Test5
${Test|n}
<%
40 | count = 10
41 | for i in range(count):
42 | print i
43 | %>
44 |
<%
45 | count = 0
46 | count += 1
47 | %>
48 |
<%
49 | under_the_line = True
50 | %>
51 |
<%
52 | count = 1
53 | for i in range(count):
54 | print i
55 | %>
56 | <%
57 | # Inline feature is primarily for placing comments as here
58 | var = 1
59 | %>
60 | <%!
61 | from datetime import datetime
62 | %>
63 | <%!
64 | from json import dumps
65 | %>
66 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # https://www.gnu.org/software/make/manual/html_node/Special-Variables.html
2 | # https://ftp.gnu.org/old-gnu/Manuals/make-3.80/html_node/make_17.html
3 | PROJECT_MKFILE_PATH := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
4 | PROJECT_MKFILE_DIR := $(shell cd $(shell dirname $(PROJECT_MKFILE_PATH)); pwd)
5 |
6 | PROJECT_NAME := plim
7 | PROJECT_ROOT := $(PROJECT_MKFILE_DIR)
8 |
9 | BUILD_DIR := $(PROJECT_ROOT)/build
10 | DIST_DIR := $(PROJECT_ROOT)/dist
11 |
12 | PROJECT=plim
13 |
14 | .PHONY: test
15 | test:
16 | pytest -s --cov=plim --cov-report xml $(PROJECT_ROOT)/tests
17 |
18 | .PHONY: typecheck
19 | typecheck:
20 | mypy --config-file setup.cfg --strict --package $(PROJECT_NAME)
21 |
22 | .PHONY: prepare-dist
23 | prepare-dist:
24 | rm -rf $(BUILD_DIR) $(DIST_DIR)
25 | python $(PROJECT_ROOT)/setup.py sdist bdist_wheel
26 |
27 | .PHONY: publish
28 | publish: | test publish
29 | twine upload $(DIST_DIR)/*
30 |
31 | .PHONY: shell
32 | shell:
33 | nix-shell $(PROJECT_ROOT)/shell.nix
34 |
--------------------------------------------------------------------------------
/tests/django_test/__init__.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | import os
3 |
4 | import plim
5 | from plim import lexer as l
6 | from plim import syntax
7 | from plim.errors import PlimSyntaxError, ParserNotFound
8 | from .. import TestCaseBase
9 |
10 |
11 | class TestDjangoSyntax(TestCaseBase):
12 |
13 | def setUp(self):
14 | super(TestDjangoSyntax, self).setUp()
15 | self.preprocessor = plim.preprocessor_factory(syntax='django')
16 |
17 | def test_conditionals(self):
18 | test_case = 'if'
19 | source = self.get_file_contents(test_case + '_test.plim')
20 | result = self.get_file_contents(test_case + '_result.dtl')
21 | data = self.preprocessor(source)
22 | self.check_relevant_chars(data.strip(), result.strip())
23 |
24 | def test_loops(self):
25 | test_case = 'for'
26 | source = self.get_file_contents(test_case + '_test.plim')
27 | result = self.get_file_contents(test_case + '_result.dtl')
28 | data = self.preprocessor(source)
29 | self.check_relevant_chars(data.strip(), result.strip())
--------------------------------------------------------------------------------
/docs/cli.rst:
--------------------------------------------------------------------------------
1 | Command-line Interface
2 | ======================
3 |
4 | .. versionadded:: 0.7.12
5 |
6 | The package provides the command-line tool ``plimc`` to compile plim
7 | source files into Mako templates.
8 |
9 | .. code-block:: shell
10 |
11 | $ plimc -h
12 | usage: plimc [-h] [-o OUTPUT] [-e ENCODING] [-p PREPROCESSOR] [-H] [-V] source
13 |
14 | Compile plim source files into mako files.
15 |
16 | positional arguments:
17 | source path to source plim template
18 |
19 | optional arguments:
20 | -h, --help show this help message and exit
21 | -o OUTPUT, --output OUTPUT
22 | write result to FILE.
23 | -e ENCODING, --encoding ENCODING
24 | content encoding
25 | -p PREPROCESSOR, --preprocessor PREPROCESSOR
26 | Preprocessor instance that will be used for parsing
27 | the template
28 | -H, --html Render HTML output instead of Mako template
29 | -V, --version show program's version number and exit
30 |
31 |
--------------------------------------------------------------------------------
/pytest.ini:
--------------------------------------------------------------------------------
1 | # Can also be defined in setup.cfg or tox.ini files, but
2 | # searching stops when the first [pytest] section is found in any of these files.
3 | # There is no merging of configuration values from multiple files.
4 | # Read more on https://pytest.org/latest/customize.html
5 | # -------------------------------------------------------------------------------
6 | [pytest]
7 | # This would tell py.test to not recurse into typical sphinx-build directories or
8 | # into any tmp prefixed directory.
9 | #https://docs.pytest.org/en/latest/reference.html#confval-norecursedirs
10 | norecursedirs = _build build dist tmp* *.egg* frontend* docs* deploy*
11 |
12 | # One or more Glob-style file patterns determining which python files are considered
13 | # as test modules.
14 | python_files = test_*.py *_test.py *_tests.py *_t.py
15 |
16 | # https://docs.pytest.org/en/latest/reference.html#confval-python_classes
17 | python_classes =
18 | Test*
19 | *Tests
20 |
21 | # https://docs.pytest.org/en/latest/reference.html#confval-testpaths
22 | testpaths =
23 | tests
24 |
25 | # use coverage plugin
26 | addopts = -s
27 |
--------------------------------------------------------------------------------
/docs/locale/zh_CN/LC_MESSAGES/license.po:
--------------------------------------------------------------------------------
1 | #
2 | msgid ""
3 | msgstr ""
4 | "Project-Id-Version: Plim 0.9\n"
5 | "Report-Msgid-Bugs-To: \n"
6 | "POT-Creation-Date: 2015-06-12 16:42+0800\n"
7 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
8 | "Last-Translator: FULL NAME
3 | %endif
4 | <%include file="content.html"/>
5 | %if not new_title:
6 |
7 | %endif
8 | <%inherit file="../../base.html"/>
9 | %if c.id:
10 |
11 | %else:
12 |
19 | ${link['text']}
20 |
21 | ${link['text']}
22 |
23 | ${link['text']}
24 |
25 | ${link['text']}
--------------------------------------------------------------------------------
/tests/fixtures/python_test.plim:
--------------------------------------------------------------------------------
1 | - python x = 1
2 | y = x + 1
3 | if True:
4 | y += 1
5 | else:
6 | y -= 1
7 | - py
8 | z = y + 1
9 |
10 |
11 | -py
12 | a = z + y + x
13 | -py! from abcde import fghi
14 | from module import func
15 |
16 | -py
17 | a = u'Привет Мир!'
18 |
19 | -py
20 | for i in i_list:
21 | for j in j_list:
22 | print i, j
23 | if i == j:
24 | print "Equal"
25 | if True:
26 | print "True"
27 |
28 | -py
29 | # Test that `embedded markup` is not parsed
30 | a = "`test test`"
31 |
32 | -----------------------------------------------
33 | text = 'new-style python blocks'
34 | -----------------------------------------------
35 | div
36 | --- count = 10
37 | for i in range(count):
38 | print i
39 |
40 | div: --- count = 0
41 | count += 1
42 |
43 | div: ---
44 | under_the_line = True
45 |
46 | --------count = 1--------
47 | for i in range(count):
48 | print i
49 |
50 | -------- # Inline feature is primarily for placing comments as here ------------------
51 | var = 1
52 |
53 | ---! from datetime import datetime
54 | -------! from json import dumps
55 |
56 | / Emtpy python blocks are not rendered
57 | --------------------------------------------------------------------------------------
58 | -------------------------- ---------------------------
59 | ---
60 |
--------------------------------------------------------------------------------
/docs/locale/authors.pot:
--------------------------------------------------------------------------------
1 | # SOME DESCRIPTIVE TITLE.
2 | # Copyright (C) 2014, Maxim Avanov
3 | # This file is distributed under the same license as the Plim package.
4 | # FIRST AUTHOR , YEAR.
5 | #
6 | #, fuzzy
7 | msgid ""
8 | msgstr ""
9 | "Project-Id-Version: Plim 0.9\n"
10 | "Report-Msgid-Bugs-To: \n"
11 | "POT-Creation-Date: 2015-06-22 20:43+0800\n"
12 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 | "Last-Translator: FULL NAME \n"
14 | "Language-Team: LANGUAGE \n"
15 | "MIME-Version: 1.0\n"
16 | "Content-Type: text/plain; charset=UTF-8\n"
17 | "Content-Transfer-Encoding: 8bit\n"
18 |
19 | #: ../authors.rst:2
20 | # 52c1f7c01fa742ab9fa4a5e1daf1c8ec
21 | msgid "Authors"
22 | msgstr ""
23 |
24 | #: ../../AUTHORS:1
25 | # 9982f035b7ae4f3e87975ca0b835230e
26 | msgid "Plim was created by `Maxim Avanov `_."
52 | msgstr ""
53 |
54 |
--------------------------------------------------------------------------------
/docs/locale/zh_CN/LC_MESSAGES/related.po:
--------------------------------------------------------------------------------
1 | #
2 | msgid ""
3 | msgstr ""
4 | "Project-Id-Version: Plim 0.9\n"
5 | "Report-Msgid-Bugs-To: \n"
6 | "POT-Creation-Date: 2015-06-12 16:42+0800\n"
7 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
8 | "Last-Translator: FULL NAME \n"
9 | "Language-Team: LANGUAGE \n"
10 | "MIME-Version: 1.0\n"
11 | "Content-Type: text/plain; charset=UTF-8\n"
12 | "Content-Transfer-Encoding: 8bit\n"
13 |
14 | #: ../related.rst:4
15 | msgid "There is a number of similar projects that you might be interested in."
16 | msgstr "这里列举了一系列与 Plim 相似的项目，你可能会感兴趣："
17 |
18 | #: ../related.rst:6
19 | msgid "`slimish-jinja2 `_"
20 | msgstr ""
21 |
22 | #: ../related.rst:7
23 | msgid "`PyJade `_"
24 | msgstr ""
25 |
26 | #: ../related.rst:8
27 | msgid "`mint `_"
28 | msgstr ""
29 |
30 | #: ../related.rst:9
31 | msgid "`SHPAML `_"
36 | msgstr ""
37 |
38 | #: ../related.rst:11
39 | msgid "`PyHAML `_"
40 | msgstr ""
41 |
42 | #: ../related.rst:12
43 | msgid "`HamlPy `_"
44 | msgstr ""
45 |
46 | #: ../related.rst:14
47 | msgid ""
48 | "See also `a list of Slim related projects `_."
50 | msgstr ""
51 | "这里还有 `一系列与 Slim 相似的项目 `_ 。"
53 |
54 | #: ../related.rst:2
55 | msgid "Related projects"
56 | msgstr "相关项目"
57 |
58 |
--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | name: "CI"
2 | on:
3 | push:
4 | branches: [ master, develop ]
5 | pull_request:
6 | branches: [ master, develop ]
7 |
8 | jobs:
9 | tests:
10 | strategy:
11 | matrix:
12 | python-version: [ 39, 310 ]
13 | runs-on: ubuntu-latest
14 | steps:
15 | - uses: actions/checkout@v2.3.4
16 | with:
17 | submodules: recursive
18 | - uses: cachix/install-nix-action@v12
19 | with:
20 | install_url: https://releases.nixos.org/nix/nix-2.11.1/install
21 | extra_nix_config: "system-features = benchmark kvm"
22 | - name: Run tests on Python${{ matrix.python-version }}
23 | run: |
24 | nix-shell --argstr pyVersion ${{ matrix.python-version }} --run \
25 | "pip install -e . && pip install -r requirements.txt && pip install -r requirements-test.txt && make test"
26 |
27 | - name: Coveralls
28 | env:
29 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
30 | run: |
31 | nix-shell --argstr pyVersion ${{ matrix.python-version }} --run "coveralls --service=github"
32 |
33 | coveralls:
34 | name: Coveralls [finalize]
35 | needs: tests
36 | runs-on: ubuntu-latest
37 | steps:
38 | - uses: actions/checkout@v2.3.4
39 | with:
40 | submodules: recursive
41 | - uses: cachix/install-nix-action@v12
42 | with:
43 | install_url: https://releases.nixos.org/nix/nix-2.11.1/install
44 | extra_nix_config: "system-features = benchmark kvm"
45 | - name: Coveralls [finalize]
46 | env:
47 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48 | run: |
49 | nix-shell --run "coveralls --service=github --finish"
50 |
--------------------------------------------------------------------------------
/tests/test_cli.py:
--------------------------------------------------------------------------------
1 | import os
2 | import subprocess
3 | import sys
4 | import codecs
5 | import tempfile
6 | import shutil
7 |
8 | from plim import syntax
9 | from plim.console import plimc
10 | from plim.util import PY3K
11 | from . import TestCaseBase
12 |
13 |
14 | class TestCLI(TestCaseBase):
15 |
16 | def setUp(self):
17 | super(TestCLI, self).setUp()
18 | self.mako_syntax = syntax.Mako()
19 | from io import BytesIO
20 | self.stdout = BytesIO()
21 |
22 | def test_cli_mako_output(self):
23 | plimc(['tests/fixtures/unicode_attributes_test.plim'], stdout=self.stdout)
24 |
25 | def test_cli_html_output(self):
26 | plimc(['--html', 'tests/fixtures/unicode_attributes_test.plim'], stdout=self.stdout)
27 |
28 | def test_custom_preprocessor(self):
29 | initial_cwd = os.getcwd()
30 | tmp_dir = tempfile.mkdtemp()
31 | os.chdir(tmp_dir)
32 |
33 | # copy test module into the temporary dir
34 | test_items = (
35 | ('custom_parser_module.py', 'a.py'),
36 | ('custom_parser_template.plim', 'a.plim')
37 | )
38 | for item_src, item_dest in test_items:
39 | item_src = os.path.join(initial_cwd, 'tests', 'cli_fixtures', item_src)
40 | item_dest = os.path.join(tmp_dir, item_dest)
41 | shutil.copy(item_src, item_dest)
42 |
43 | # Make tests
44 | data = subprocess.Popen(
45 | ['plimc', '-p', 'a:custom_preprocessor', 'a.plim'],
46 | stdin=subprocess.PIPE,
47 | stdout=subprocess.PIPE
48 | ).communicate()[0]
49 | data = codecs.decode(data, 'utf-8')
50 |
51 | self.assertNotEqual(initial_cwd, os.getcwd())
52 | self.assertIn('', sys.path)
53 | self.assertEqual(data, '')
54 |
55 | # Cleanup
56 | os.chdir(initial_cwd)
57 | shutil.rmtree(tmp_dir)
58 |
--------------------------------------------------------------------------------
/tests/fixtures/literal_one_liners_test.plim:
--------------------------------------------------------------------------------
1 | -if not new_title
2 |
13 | %endif
14 | <%include file="profile.html"/>
15 |
16 | ${test.variable}(${test.variable}){${test.variable}}[${test.variable}] ——01.2.2.13 -4)AbcdeабвгдÖ汉语/漢語This is a test
17 | of implicit literal.You must capitalize the first letter
18 | and then indent each following line to make it working.если строки вашего текста начинается с символа, не входящегов состав ASCII-символов в диапазоне от 33 до 126,то вы можете смело оставлять их "как есть".
3 |
4 | -include content.html
5 |
6 | -if not new_title
7 |
8 | /------------------------------------
9 | -inherit ../../base.html
10 | -if c.id
11 |
12 | -else
13 |
51 | a#${link.get('id', 'sidenav-{}'.format(i))} href=link['url'] = link['text']
52 |
53 |
54 |
55 | a#${link.get('id', 'sidenav-{}'.format(i))} href=link['url'] = link['text']
56 |
57 |
58 |
59 | a#${
60 | link.get('id', 'sidenav-{}'.format(i))
61 | }.${asl_class} href=link['url'] \
62 | data-cache=cache \
63 | data-frame=frame = link['text']
64 |
65 |
66 | a#${test+
67 | link.get('id', 'sidenav-{}'.format(i))
68 | +test}.${test+
69 | asl_class
70 | } href=link['url'] \
71 | data-cache=cache \
72 | data-frame=frame = link['text']
73 |
--------------------------------------------------------------------------------
/default.nix:
--------------------------------------------------------------------------------
1 | # https://nixos.wiki/wiki/Development_environment_with_nix-shell
2 | { pkgs ? (import ./nixpkgs).pkgs
3 | , pyVersion ? "310"
4 | }:
5 |
6 | let
7 |
8 | python = pkgs."python${pyVersion}Full";
9 | pythonPkgs = pkgs."python${pyVersion}Packages";
10 |
11 | devEnv = pkgs.mkShellNoCC {
12 | name = "plim-devenv";
13 |
14 | # The packages in the `buildInputs` list will be added to the PATH in our shell
15 | # Python-specific guide:
16 | # https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/python.section.md
17 | nativeBuildInputs = with pkgs; [
18 | # see https://nixos.org/nixos/packages.html
19 | # Python distribution
20 | python
21 | pythonPkgs.virtualenv
22 | pythonPkgs.wheel
23 | pythonPkgs.twine
24 | pythonPkgs.coveralls
25 |
26 | gnumake
27 | nodejs
28 | nodePackages.npm
29 | taglib
30 | ncurses
31 | libxml2
32 | libxslt
33 | libzip
34 | zlib
35 | # root CA certificates
36 | cacert
37 | which
38 | ];
39 | shellHook = ''
40 | # set SOURCE_DATE_EPOCH so that we can use python wheels
41 | export SOURCE_DATE_EPOCH=$(date +%s)
42 |
43 | VENV_DIR=$PWD/.venv
44 |
45 | export PATH=$VENV_DIR/bin:$PATH
46 | export PYTHONPATH=""
47 | export LANG=en_GB.UTF-8
48 |
49 | # https://python-poetry.org/docs/configuration/
50 | export PIP_CACHE_DIR="$PWD/.local/pip-cache${pyVersion}"
51 |
52 | # Setup virtualenv
53 | if [ ! -d $VENV_DIR ]; then
54 | virtualenv $PWD/.venv
55 | $VENV_DIR/bin/python -m pip install -e $PWD
56 | $VENV_DIR/bin/python -m pip install -r $PWD/requirements.txt
57 | fi
58 |
59 | if [ ! -d $PWD/node_modules ]; then
60 | npm install stylus
61 | fi
62 | '';
63 | };
64 |
65 | in
66 | {
67 | inherit devEnv;
68 | }
69 |
--------------------------------------------------------------------------------
/docs/locale/related.pot:
--------------------------------------------------------------------------------
1 | # SOME DESCRIPTIVE TITLE.
2 | # Copyright (C) 2014, Maxim Avanov
3 | # This file is distributed under the same license as the Plim package.
4 | # FIRST AUTHOR , YEAR.
5 | #
6 | #, fuzzy
7 | msgid ""
8 | msgstr ""
9 | "Project-Id-Version: Plim 0.9\n"
10 | "Report-Msgid-Bugs-To: \n"
11 | "POT-Creation-Date: 2015-06-22 20:43+0800\n"
12 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 | "Last-Translator: FULL NAME \n"
14 | "Language-Team: LANGUAGE \n"
15 | "MIME-Version: 1.0\n"
16 | "Content-Type: text/plain; charset=UTF-8\n"
17 | "Content-Transfer-Encoding: 8bit\n"
18 |
19 | #: ../related.rst:2
20 | # 7a14d207d98846a19842d032f2c9b0d8
21 | msgid "Related projects"
22 | msgstr ""
23 |
24 | #: ../related.rst:4
25 | # 60149bc6ea094872829fc6a6961e9917
26 | msgid "There is a number of similar projects that you might be interested in."
27 | msgstr ""
28 |
29 | #: ../related.rst:6
30 | # 4093e94ac0c74e7e8d3cb0c5bec43fa9
31 | msgid "`slimish-jinja2 `_"
32 | msgstr ""
33 |
34 | #: ../related.rst:7
35 | # 30bc1c4f11df4afaad7ca82be09a5750
36 | msgid "`PyJade `_"
37 | msgstr ""
38 |
39 | #: ../related.rst:8
40 | # ef35f525f8dd434a9e60865b34776dea
41 | msgid "`mint `_"
42 | msgstr ""
43 |
44 | #: ../related.rst:9
45 | # 49d1cb3f5d3b432dae4155d46a18207b
46 | msgid "`SHPAML `_"
52 | msgstr ""
53 |
54 | #: ../related.rst:11
55 | # 35e39aecb1ad47a8878c76840216c0a9
56 | msgid "`PyHAML `_"
57 | msgstr ""
58 |
59 | #: ../related.rst:12
60 | # f85fba0a1d124672a9353ba796d1a5dd
61 | msgid "`HamlPy `_"
62 | msgstr ""
63 |
64 | #: ../related.rst:14
65 | # 9af79d54bd124cf497c33fb1e0a4be74
66 | msgid "See also `a list of Slim related projects `_."
67 | msgstr ""
68 |
69 |
--------------------------------------------------------------------------------
/docs/frameworks.rst:
--------------------------------------------------------------------------------
1 | =======================
2 | Framework Integration
3 | =======================
4 |
5 |
6 | Pyramid
7 | =========
8 |
9 | Add ``plim.adapters.pyramid_renderer`` into the ``pyramid.includes`` list of your .ini configuration file
10 |
11 | .. code-block:: ini
12 |
13 | [app:main]
14 | pyramid.includes =
15 | # ... (other packages)
16 | plim.adapters.pyramid_renderer
17 |
18 | The adapter will add the ``.plim`` renderer for use in Pyramid. This can be overridden and more may be
19 | added via the ``config.add_plim_renderer()`` directive:
20 |
21 | .. code-block:: python
22 |
23 | config.add_plim_renderer('.plm', mako_settings_prefix='mako.')
24 |
25 | The renderer will load its configuration from a provided mako prefix in the Pyramid
26 | settings dictionary. The default prefix is 'mako.'.
27 |
28 | Flask
29 | ======
30 |
31 | First install the flask_mako package. The following code snippet would get Flask working with plim:
32 |
33 | .. code-block:: python
34 |
35 | from flask import Flask
36 | from flask_mako import MakoTemplates, render_template
37 | from plim import preprocessor
38 |
39 | app = Flask(__name__, template_folder='.')
40 | mako = MakoTemplates(app)
41 | app.config['MAKO_PREPROCESSOR'] = preprocessor
42 |
43 | @app.route('/')
44 | def hello():
45 | return render_template('hello.html', name='mako')
46 |
47 | if __name__ == "__main__":
48 | app.run(debug=True)
49 |
50 |
51 | With hello.html in templates dir:
52 |
53 | .. code-block:: html
54 |
55 | doctype html
56 | html
57 | head
58 | title hello ${name}
59 | body
60 | p hello ${name}
61 |
62 |
63 |
64 | Syntax Highlighters
65 | ======================
66 |
67 | At this moment, Plim doesn't have syntax highlighters.
68 |
69 | But, at a starting point you can use
70 | `Slim syntax highlighters `_,
71 | since most of Plim syntax is the same as of Slim.
72 |
73 | Editors support
74 | ----------------
75 |
76 |
77 | * `vim-plim `_ - a Plim port of `vim-slim `_ plugin.
78 |
79 |
80 |
--------------------------------------------------------------------------------
/docs/locale/zh_CN/LC_MESSAGES/index.po:
--------------------------------------------------------------------------------
1 | #
2 | msgid ""
3 | msgstr ""
4 | "Project-Id-Version: Plim 0.9\n"
5 | "Report-Msgid-Bugs-To: \n"
6 | "POT-Creation-Date: 2015-06-12 16:42+0800\n"
7 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
8 | "Last-Translator: FULL NAME \n"
9 | "Language-Team: LANGUAGE \n"
10 | "MIME-Version: 1.0\n"
11 | "Content-Type: text/plain; charset=UTF-8\n"
12 | "Content-Transfer-Encoding: 8bit\n"
13 |
14 | #: ../index.rst:8
15 | msgid "Plim Documentation"
16 | msgstr "Plim 中文文档"
17 |
18 | #: ../index.rst:23
19 | msgid ""
20 | "Plim is a Python port of `Ruby's Slim template language `_ to translate its syntax into a valid HTML/Mako markup."
25 | msgstr ""
26 | "Plim 是 `Ruby Slim 模版 `_ 将其语法转换为符合 HTML/Mako 标准的标签。"
30 |
31 | #: ../index.rst:30
32 | msgid "Installation"
33 | msgstr "安装指南"
34 |
35 | #: ../index.rst:38
36 | msgid "Tests"
37 | msgstr "运行测试"
38 |
39 | #: ../index.rst:40
40 | msgid ""
41 | "Plim provides an extensive test suite based on `nosetests "
42 | "`_."
52 | msgstr ""
53 | "你可以在 `这里 "
54 | "`_ 看到覆盖率统计。"
55 |
56 | #: ../index.rst:52
57 | msgid "Detailed example"
58 | msgstr "示例"
59 |
60 | #: ../index.rst:166
61 | msgid "Main Documentation"
62 | msgstr "主要文档"
63 |
64 | #: ../index.rst:183
65 | msgid "Indices and tables"
66 | msgstr ""
67 |
68 | #: ../index.rst:185
69 | msgid ":ref:`genindex`"
70 | msgstr ""
71 |
72 | #: ../index.rst:186
73 | msgid ":ref:`modindex`"
74 | msgstr ""
75 |
76 | #: ../index.rst:187
77 | msgid ":ref:`search`"
78 | msgstr ""
79 |
--------------------------------------------------------------------------------
/docs/locale/index.pot:
--------------------------------------------------------------------------------
1 | # SOME DESCRIPTIVE TITLE.
2 | # Copyright (C) 2014, Maxim Avanov
3 | # This file is distributed under the same license as the Plim package.
4 | # FIRST AUTHOR , YEAR.
5 | #
6 | #, fuzzy
7 | msgid ""
8 | msgstr ""
9 | "Project-Id-Version: Plim 0.9\n"
10 | "Report-Msgid-Bugs-To: \n"
11 | "POT-Creation-Date: 2015-06-22 20:43+0800\n"
12 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 | "Last-Translator: FULL NAME \n"
14 | "Language-Team: LANGUAGE \n"
15 | "MIME-Version: 1.0\n"
16 | "Content-Type: text/plain; charset=UTF-8\n"
17 | "Content-Transfer-Encoding: 8bit\n"
18 |
19 | #: ../index.rst:8
20 | # f6f4c1e6d7a04a0da2b2f13c1843cd56
21 | msgid "Plim Documentation"
22 | msgstr ""
23 |
24 | #: ../index.rst:23
25 | # 2eaa426688a24a7693aa151b8e525aa8
26 | msgid "Plim is a Python port of `Ruby's Slim template language `_ to translate its syntax into a valid HTML/Mako markup."
27 | msgstr ""
28 |
29 | #: ../index.rst:30
30 | # aeef021e407a41c4b53890e7126b63ae
31 | msgid "Installation"
32 | msgstr ""
33 |
34 | #: ../index.rst:38
35 | # ea6938fb83b3498a8d9d8ae3654acd20
36 | msgid "Tests"
37 | msgstr ""
38 |
39 | #: ../index.rst:40
40 | # 2075f9ace53449618d8eb6bf0edbfafa
41 | msgid "Plim provides an extensive test suite based on `nosetests `_."
47 | msgstr ""
48 |
49 | #: ../index.rst:52
50 | # 18b7199b5bc946e3a9694716490b086e
51 | msgid "Detailed example"
52 | msgstr ""
53 |
54 | #: ../index.rst:166
55 | # a3ee0818fde642c9b696899899169fe0
56 | msgid "Main Documentation"
57 | msgstr ""
58 |
59 | #: ../index.rst:183
60 | # 632a1c8d3c7349958ec3754e3c6f3423
61 | msgid "Indices and tables"
62 | msgstr ""
63 |
64 | #: ../index.rst:185
65 | # d90dfb1201c6481eb978fdd20044cc37
66 | msgid ":ref:`genindex`"
67 | msgstr ""
68 |
69 | #: ../index.rst:186
70 | # 5a554d3b01854993a51cf28ce31fd34b
71 | msgid ":ref:`modindex`"
72 | msgstr ""
73 |
74 | #: ../index.rst:187
75 | # e8f102f4d12047649caaf614f88e935f
76 | msgid ":ref:`search`"
77 | msgstr ""
78 |
79 |
--------------------------------------------------------------------------------
/plim/adapters/pyramid_renderer.py:
--------------------------------------------------------------------------------
1 | import copy
2 | try:
3 | from pyramid_mako import MakoRendererFactory
4 | from pyramid_mako import parse_options_from_settings
5 | from pyramid_mako import PkgResourceTemplateLookup
6 | except ImportError:
7 | raise NotImplementedError(
8 | "It seems that you are trying to integrate Plim with Pyramid. "
9 | "To do so, please install Pyramid>=1.5 and pyramid_mako>=0.3.1 template bindings."
10 | )
11 |
12 |
13 | def add_plim_renderer(config, extension, mako_settings_prefix='mako.', preprocessor='plim.preprocessor'):
14 | """
15 | Register a Plim renderer for a template extension.
16 |
17 | This function is available on the Pyramid configurator after
18 | including the package:
19 |
20 | .. code-block:: python
21 |
22 | config.add_plim_renderer('.plim', mako_settings_prefix='mako.')
23 |
24 | The renderer will load its configuration from a provided mako prefix in the Pyramid
25 | settings dictionary. The default prefix is 'mako.'.
26 |
27 | :param config: Pyramid Config instance
28 | :param extension: renderer file extension
29 | :type extension: str
30 | :param mako_settings_prefix: prefix of mako configuration options.
31 | :type mako_settings_prefix: str
32 | """
33 | renderer_factory = MakoRendererFactory()
34 | config.add_renderer(extension, renderer_factory)
35 |
36 | def register() -> None:
37 | settings = copy.copy(config.registry.settings)
38 | settings['{prefix}preprocessor'.format(prefix=mako_settings_prefix)] = preprocessor
39 |
40 | opts = parse_options_from_settings(settings, mako_settings_prefix, config.maybe_dotted)
41 | lookup = PkgResourceTemplateLookup(**opts)
42 |
43 | renderer_factory.lookup = lookup
44 |
45 | # read about config.action() at
46 | # http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/extconfig.html#using-config-action-in-a-directive
47 | config.action(('plim-renderer', extension), register)
48 |
49 |
50 | def includeme(config):
51 | """
52 | Set up standard configurator registrations. Use via:
53 |
54 | .. code-block:: python
55 |
56 | config = Configurator()
57 | config.include('pyramid_mako')
58 |
59 | Once this function has been invoked, the ``.plim`` renderer
60 | is available for use in Pyramid. This can be overridden and more may be
61 | added via the ``config.add_plim_renderer`` directive.
62 | """
63 | config.add_directive('add_plim_renderer', add_plim_renderer)
64 | config.add_plim_renderer('.plim')
65 |
--------------------------------------------------------------------------------
/docs/locale/zh_CN/LC_MESSAGES/frameworks.po:
--------------------------------------------------------------------------------
1 | #
2 | msgid ""
3 | msgstr ""
4 | "Project-Id-Version: Plim 0.9\n"
5 | "Report-Msgid-Bugs-To: \n"
6 | "POT-Creation-Date: 2015-06-12 16:42+0800\n"
7 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
8 | "Last-Translator: FULL NAME \n"
9 | "Language-Team: LANGUAGE \n"
10 | "MIME-Version: 1.0\n"
11 | "Content-Type: text/plain; charset=UTF-8\n"
12 | "Content-Transfer-Encoding: 8bit\n"
13 |
14 | #: ../frameworks.rst:3
15 | msgid "Framework Integration"
16 | msgstr "与 Web 框架集成"
17 |
18 | #: ../frameworks.rst:7
19 | msgid "Pyramid"
20 | msgstr ""
21 |
22 | #: ../frameworks.rst:9
23 | msgid ""
24 | "Add ``plim.adapters.pyramid_renderer`` into the ``pyramid.includes`` list of"
25 | " your .ini configuration file"
26 | msgstr ""
27 | "将 ``plim.adapters.pyramid_renderer`` 添加至项目 .ini 配置文件的 "
28 | "``pyram`id.includes`` 列表中："
29 |
30 | #: ../frameworks.rst:18
31 | msgid ""
32 | "The adapter will add the ``.plim`` renderer for use in Pyramid. This can be "
33 | "overridden and more may be added via the ``config.add_plim_renderer()`` "
34 | "directive:"
35 | msgstr ""
36 |
37 | #: ../frameworks.rst:25
38 | msgid ""
39 | "The renderer will load its configuration from a provided mako prefix in the "
40 | "Pyramid settings dictionary. The default prefix is 'mako.'."
41 | msgstr ""
42 |
43 | #: ../frameworks.rst:29
44 | msgid "Flask"
45 | msgstr ""
46 |
47 | #: ../frameworks.rst:31
48 | msgid "The following code snippet would get Flask working with plim:"
49 | msgstr "想要在 Flask 中使用 plim 只需要在项目中添加下面的代码："
50 |
51 | #: ../frameworks.rst:50
52 | msgid "With hello.html in templates dir:"
53 | msgstr "templates 目录中的 hello.html 需要写成这样："
54 |
55 | #: ../frameworks.rst:64
56 | msgid "Syntax Highlighters"
57 | msgstr "代码高亮"
58 |
59 | #: ../frameworks.rst:66
60 | msgid "At this moment, Plim doesn't have syntax highlighters."
61 | msgstr "现在还没有专门的 plim 语法高亮工具。"
62 |
63 | #: ../frameworks.rst:68
64 | msgid ""
65 | "But, at a starting point you can use `Slim syntax highlighters "
66 | "`_, since most of"
67 | " Plim syntax is the same as of Slim."
68 | msgstr ""
69 | "不过，由于 Plim 和 Slim 的语法很相似，你可以使用 "
70 | "`Slim 的语法高亮工具 `_ "
71 | "作为替代。"
72 |
73 | #: ../frameworks.rst:73
74 | msgid "Editors support"
75 | msgstr "编辑器支持"
76 |
77 | #: ../frameworks.rst:76
78 | msgid ""
79 | "`vim-plim `_ - a Plim port of `vim-"
80 | "slim `_ plugin."
81 | msgstr ""
82 | "`vim-plim `_ —— 一个 Plim 的 "
83 | "`vim-slim `_ 插件移植版本。"
84 |
--------------------------------------------------------------------------------
/docs/locale/frameworks.pot:
--------------------------------------------------------------------------------
1 | # SOME DESCRIPTIVE TITLE.
2 | # Copyright (C) 2014, Maxim Avanov
3 | # This file is distributed under the same license as the Plim package.
4 | # FIRST AUTHOR , YEAR.
5 | #
6 | #, fuzzy
7 | msgid ""
8 | msgstr ""
9 | "Project-Id-Version: Plim 0.9\n"
10 | "Report-Msgid-Bugs-To: \n"
11 | "POT-Creation-Date: 2015-06-22 20:43+0800\n"
12 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 | "Last-Translator: FULL NAME \n"
14 | "Language-Team: LANGUAGE \n"
15 | "MIME-Version: 1.0\n"
16 | "Content-Type: text/plain; charset=UTF-8\n"
17 | "Content-Transfer-Encoding: 8bit\n"
18 |
19 | #: ../frameworks.rst:3
20 | # 00313155ff97436badcd2acbba3a3229
21 | msgid "Framework Integration"
22 | msgstr ""
23 |
24 | #: ../frameworks.rst:7
25 | # e436b01dc25c4d3082e8bd47943fe185
26 | msgid "Pyramid"
27 | msgstr ""
28 |
29 | #: ../frameworks.rst:9
30 | # 9c718edf15a1413bae23f8719ce47ca4
31 | msgid "Add ``plim.adapters.pyramid_renderer`` into the ``pyramid.includes`` list of your .ini configuration file"
32 | msgstr ""
33 |
34 | #: ../frameworks.rst:18
35 | # 9910e3441c8a40dfbaa3934ab80e68e7
36 | msgid "The adapter will add the ``.plim`` renderer for use in Pyramid. This can be overridden and more may be added via the ``config.add_plim_renderer()`` directive:"
37 | msgstr ""
38 |
39 | #: ../frameworks.rst:25
40 | # 9b282d6b9545428eafb1f8e79ddcad0c
41 | msgid "The renderer will load its configuration from a provided mako prefix in the Pyramid settings dictionary. The default prefix is 'mako.'."
42 | msgstr ""
43 |
44 | #: ../frameworks.rst:29
45 | # 87678022521b47ccb3eecfa028d3579c
46 | msgid "Flask"
47 | msgstr ""
48 |
49 | #: ../frameworks.rst:31
50 | # 160957593df242d1ae5c3111ff97899a
51 | msgid "The following code snippet would get Flask working with plim:"
52 | msgstr ""
53 |
54 | #: ../frameworks.rst:50
55 | # 7d39b344fc1c4219b38debbf82035cf7
56 | msgid "With hello.html in templates dir:"
57 | msgstr ""
58 |
59 | #: ../frameworks.rst:64
60 | # ea1efa5e20144350b6e99a984d7c0d85
61 | msgid "Syntax Highlighters"
62 | msgstr ""
63 |
64 | #: ../frameworks.rst:66
65 | # 5387495ebd9146f28e1dd5320860ec25
66 | msgid "At this moment, Plim doesn't have syntax highlighters."
67 | msgstr ""
68 |
69 | #: ../frameworks.rst:68
70 | # 89436053f97943a2a13bf14ce51c5ca9
71 | msgid "But, at a starting point you can use `Slim syntax highlighters `_, since most of Plim syntax is the same as of Slim."
72 | msgstr ""
73 |
74 | #: ../frameworks.rst:73
75 | # 71ff4864470944f8875790447d3e5b07
76 | msgid "Editors support"
77 | msgstr ""
78 |
79 | #: ../frameworks.rst:76
80 | # a8e9f4ff68764694b4fc369c4a4e76bf
81 | msgid "`vim-plim `_ - a Plim port of `vim-slim `_ plugin."
82 | msgstr ""
83 |
84 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | import io
2 | import os
3 | import sys
4 |
5 | from setuptools import find_packages
6 | from setuptools import setup
7 |
8 |
9 | PY3K = sys.version_info >= (3, 0)
10 | here = lambda path: os.path.join(os.path.abspath(os.path.dirname(__file__)), path)
11 |
12 |
13 | def read(*filenames, **kwargs):
14 | encoding = kwargs.get('encoding', 'utf-8')
15 | sep = kwargs.get('sep', '\n')
16 | buf = []
17 | for filename in filenames:
18 | with io.open(filename, encoding=encoding) as f:
19 | buf.append(f.read())
20 | return sep.join(buf)
21 |
22 |
23 | requires = []
24 | with open(here('requirements.txt')) as f:
25 | rows = f.read().strip().split('\n')
26 | for row in rows:
27 | row = row.strip()
28 | if row and not (row.startswith('#') or row.startswith('http')):
29 | requires.append(row)
30 |
31 |
32 | long_description = read(
33 | os.path.join(os.path.dirname(__file__), 'README.rst'),
34 | os.path.join(os.path.dirname(__file__), 'CHANGES'),
35 | )
36 |
37 |
38 | setup(
39 | name='Plim',
40 | version='1.1.0',
41 | packages=find_packages(exclude=['tests', 'nixpkgs', 'node_modules']),
42 | install_requires=requires,
43 | setup_requires=[],
44 | tests_require=['pytest', 'coverage'],
45 | package_data={
46 | # If any package contains *.txt or *.rst files, include them
47 | '': ['*.txt', '*.rst']
48 | },
49 | include_package_data=True,
50 |
51 | entry_points={
52 | 'console_scripts': [
53 | 'plimc = plim.console:plimc',
54 | ]
55 | },
56 |
57 | # PyPI metadata
58 | # Read more at http://docs.python.org/distutils/setupscript.html#meta-data
59 | author="Maxim Avanov",
60 | author_email="maxim.avanov@gmail.com",
61 | maintainer="Maxim Avanov",
62 | maintainer_email="maxim.avanov@gmail.com",
63 | description="Plim is a Python port of Ruby's Slim template language built on top of Mako Templates",
64 | long_description=long_description,
65 | license="MIT",
66 | url="https://github.com/avanov/Plim",
67 | download_url="https://github.com/avanov/Plim",
68 | keywords="mako templates ruby slim jade pyjade pyramid flask haml pyhaml",
69 | classifiers=[
70 | 'Development Status :: 5 - Production/Stable',
71 | 'Environment :: Web Environment',
72 | 'Framework :: Pylons',
73 | 'Framework :: Pyramid',
74 | 'Framework :: TurboGears',
75 | 'Intended Audience :: Developers',
76 | 'License :: OSI Approved',
77 | 'License :: OSI Approved :: MIT License',
78 | 'Operating System :: MacOS',
79 | 'Operating System :: Microsoft',
80 | 'Operating System :: POSIX',
81 | 'Programming Language :: Python',
82 | 'Programming Language :: Python :: 3',
83 | 'Topic :: Internet :: WWW/HTTP',
84 | 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
85 | 'Topic :: Software Development :: Libraries :: Python Modules',
86 | 'Topic :: Software Development :: Pre-processors',
87 | 'Topic :: Text Processing :: Markup :: HTML',
88 | ]
89 | )
90 |
--------------------------------------------------------------------------------
/docs/differences.rst:
--------------------------------------------------------------------------------
1 | Syntactic Differences
2 | =====================
3 |
4 | Plim is *not the exact* port of Slim. Here is the full list of differences.
5 |
6 |
7 | #. Slim has the ( ``'`` ), ( ``='`` ), and ( ``=='`` ) `line indicators `_.
8 | In Plim, single quote has been replaced by the comma char ( ``,`` ):
9 |
10 | .. code-block:: slim
11 |
12 | , value
13 | =, value
14 | ==, value
15 |
16 |
17 | The change was made in order to get rid of the syntactic ambiguities like these:
18 |
19 | .. code-block:: plim
20 |
21 | / Is this an empty python string or a syntax error caused by the unclosed single quote?
22 | =''
23 |
24 | / Is this a python string 'u' ('u''' is the correct python syntax) or
25 | a syntax error caused by the unclosed unicode docstring?
26 | ='u'''
27 |
28 | Meanwhile, the comma char is not allowed at the beginning of python expression,
29 | therefore the following code samples are consistent:
30 |
31 | .. code-block:: plim
32 |
33 | / Syntax error at mako runtime caused by the unclosed single quote
34 | =,'
35 |
36 | / Correct and consistent. Produces an empty unicode string followed by an
37 | explicit trailing whitespace
38 | =,u''
39 |
40 |
41 | In addition, the comma syntax seems more natural, since in formal writing we also add a whitespace
42 | between a comma and the following word (in contrast to apostrophes, which may be written
43 | together with some parts of words - "I'm", "it's" etc).
44 |
45 |
46 |
47 | #. Unlike Slim, Plim does not support square or curly braces for wrapping tag attributes.
48 | You can use only parentheses ``()``:
49 |
50 | .. code-block:: slim
51 |
52 | / For attributes wrapping we can use only parentheses
53 | p(title="Link Title")
54 | h1 class=(item.id == 1 and 'one' or 'unknown') Title
55 |
56 | / Square and curly braces are allowed only in Python and Mako expressions
57 | a#idx-${item.id} href=item.get_link(
58 | **{'argument': 'value'}) = item.attrs['title']
59 |
60 |
61 | #. In Plim, all html tags **MUST** be written in lowercase.
62 |
63 | This restriction was introduced to support
64 | :ref:`Implicit Literal Blocks ` feature.
65 |
66 | .. code-block:: slim
67 |
68 | doctype 5
69 | html
70 | head
71 | title Page Title
72 | body
73 | p
74 | | Hello, Explicit Literal Block!
75 | p
76 | Hello, Implicit Literal Block!
77 |
78 |
79 | #. You do not have to use the ``|`` (pipe) indicator in ``style`` and ``script`` tags.
80 |
81 | #. Plim does not make distinctions between control structures and embedded filters.
82 |
83 | For example, in Slim you would write ``-if``, ``-for``, and ``coffee:`` (without
84 | preceding dash, but with the colon sign at the tail).
85 | But in Plim, you must write ``-if``, ``-for``, and ``-coffee``.
86 |
87 | #. In contrast to Slim, Plim does not support the ``/!`` line indicator
88 | `which is used as an HTML-comment `_. You can use
89 | raw HTML-comments instead.
90 |
--------------------------------------------------------------------------------
/plim/console.py:
--------------------------------------------------------------------------------
1 | """
2 | This module contains entry points for command-line utilities provided by Plim package.
3 | """
4 | import sys
5 | import os
6 | import argparse
7 | import codecs
8 | from pkg_resources import get_distribution
9 | from pkg_resources import EntryPoint
10 |
11 | from mako.template import Template
12 | from mako.lookup import TemplateLookup
13 |
14 |
15 | def plimc(args=None, stdout=None):
16 | """This is the `plimc` command line utility
17 |
18 | :param args: list of command-line arguments. If None, then ``sys.argv[1:]`` will be used.
19 | :type args: list or None
20 | :param stdout: file-like object representing stdout. If None, then ``sys.stdout`` will be used.
21 | Custom stdout is used for testing purposes.
22 | :type stdout: None or a file-like object
23 | """
24 | # Parse arguments
25 | # ------------------------------------
26 | cli_parser = argparse.ArgumentParser(description='Compile plim source files into mako files.')
27 | cli_parser.add_argument('source', help="path to source plim template")
28 | cli_parser.add_argument('-o', '--output', help="write result to FILE.")
29 | cli_parser.add_argument('-e', '--encoding', default='utf-8', help="content encoding")
30 | cli_parser.add_argument('-p', '--preprocessor', default='plim:preprocessor',
31 | help="Preprocessor instance that will be used for parsing the template")
32 | cli_parser.add_argument('-H', '--html', action='store_true', help="Render HTML output instead of Mako template")
33 | cli_parser.add_argument('-V', '--version', action='version',
34 | version='Plim {}'.format(get_distribution("Plim").version))
35 |
36 | if args is None:
37 | args = sys.argv[1:]
38 | args = cli_parser.parse_args(args)
39 |
40 | # Get custom preprocessor, if specified
41 | # -------------------------------------
42 | preprocessor_path = args.preprocessor
43 | # Add an empty string path, so modules located at the current working dir
44 | # are reachable and considered in the first place (see issue #32).
45 | sys.path.insert(0, '')
46 | preprocessor = EntryPoint.parse('x={}'.format(preprocessor_path)).resolve()
47 |
48 | # Render to html, if requested
49 | # ----------------------------
50 | if args.html:
51 | root_dir = os.path.dirname(os.path.abspath(args.source))
52 | template_file = os.path.basename(args.source)
53 | lookup = TemplateLookup(directories=[root_dir],
54 | input_encoding=args.encoding,
55 | output_encoding=args.encoding,
56 | preprocessor=preprocessor)
57 | content = lookup.get_template(template_file).render_unicode()
58 | else:
59 | with codecs.open(args.source, 'rb', args.encoding) as fd:
60 | content = preprocessor(fd.read())
61 |
62 | # Output
63 | # ------------------------------------
64 | if args.output is None:
65 | if stdout is None:
66 | stdout = sys.stdout.buffer
67 | fd = stdout
68 | content = codecs.encode(content, 'utf-8')
69 | else:
70 | fd = codecs.open(args.output, 'wb', args.encoding)
71 | try:
72 | fd.write(content)
73 | finally:
74 | fd.close()
75 |
--------------------------------------------------------------------------------
/tests/__init__.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | import os
3 | import codecs
4 | import unittest
5 | import plim
6 | from plim import syntax
7 |
8 |
9 |
10 | class TestCaseBase(unittest.TestCase):
11 | def setUp(self):
12 | here = os.path.abspath(os.path.dirname(__file__))
13 | self.templates_dir = os.path.join(here, 'fixtures')
14 | self.maxDiff = None
15 | self.syntax = plim.syntax.Mako()
16 |
17 | def tearDown(self):
18 | pass
19 |
20 | def get_file_contents(self, template_name):
21 | return codecs.open(os.path.join(self.templates_dir, template_name), 'r', 'utf-8').read()
22 |
23 | def check_relevant_chars(self, value1, value2):
24 | value1 = value1.strip().replace('\n\n\n\n', '\n\n').replace('\n\n\n', '\n\n').replace('\n\n', '\n')
25 | value2 = value2.strip().replace('\n\n\n\n', '\n\n').replace('\n\n\n', '\n\n').replace('\n\n', '\n')
26 | self.assertEqual(value1, value2)
27 |
28 |
29 | class TestPreprocessorSyntax(TestCaseBase):
30 |
31 | def test_plim(self):
32 | cases = [
33 | 'pipe',
34 | 'plim_line',
35 | 'if',
36 | 'unless',
37 | 'python',
38 | 'for',
39 | 'while',
40 | 'until',
41 | 'with',
42 | 'try',
43 | 'def_block',
44 | 'style_script',
45 | 'comment',
46 | 'one_liners',
47 | 'mako_text',
48 | 'early_return',
49 | 'call',
50 | 'multiline_variable',
51 | 'literal_one_liners',
52 | 'no_filtering',
53 | 'linebreak',
54 | 'explicit_space',
55 | 'unicode_attributes',
56 | 'inline_conditions',
57 | 'handlebars',
58 | ]
59 | for test_case in cases:
60 | source = self.get_file_contents(test_case + '_test.plim')
61 | result = self.get_file_contents(test_case + '_result.mako')
62 | data = plim.preprocessor(source)
63 | self.check_relevant_chars(data.strip(), result.strip())
64 |
65 |
66 | def test_dynamic_attributes(self):
67 | test_case = 'dynamic_attributes'
68 | source = self.get_file_contents(test_case + '_test.plim')
69 | result = self.get_file_contents(test_case + '_result.mako')
70 | data = plim.preprocessor(source)
71 | # normalize data
72 | data = data.replace(", YEAR.
5 | #
6 | #, fuzzy
7 | msgid ""
8 | msgstr ""
9 | "Project-Id-Version: Plim 0.9\n"
10 | "Report-Msgid-Bugs-To: \n"
11 | "POT-Creation-Date: 2015-06-22 20:43+0800\n"
12 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 | "Last-Translator: FULL NAME \n"
14 | "Language-Team: LANGUAGE \n"
15 | "MIME-Version: 1.0\n"
16 | "Content-Type: text/plain; charset=UTF-8\n"
17 | "Content-Transfer-Encoding: 8bit\n"
18 |
19 | #: ../differences.rst:2
20 | # fd63c5dd82d847c6b6217c990db2c401
21 | msgid "Syntactic Differences"
22 | msgstr ""
23 |
24 | #: ../differences.rst:4
25 | # 6543dce23d0a49dd84aa3e8392d3f573
26 | msgid "Plim is *not the exact* port of Slim. Here is the full list of differences."
27 | msgstr ""
28 |
29 | #: ../differences.rst:7
30 | # f3f2929b131f45ba84f8ce2e3cfcee08
31 | msgid "Slim has the ( ``'`` ), ( ``='`` ), and ( ``=='`` ) `line indicators `_. In Plim, single quote has been replaced by the comma char ( ``,`` ):"
32 | msgstr ""
33 |
34 | #: ../differences.rst:17
35 | # 7826b242449f48dca65f39d4ee1970f0
36 | msgid "The change was made in order to get rid of the syntactic ambiguities like these:"
37 | msgstr ""
38 |
39 | #: ../differences.rst:28
40 | # 1b608163774543c78d47de11dde0d784
41 | msgid "Meanwhile, the comma char is not allowed at the beginning of python expression, therefore the following code samples are consistent:"
42 | msgstr ""
43 |
44 | #: ../differences.rst:41
45 | # cdce2fe7525d46cd9f60329336fd2485
46 | msgid "In addition, the comma syntax seems more natural, since in formal writing we also add a whitespace between a comma and the following word (in contrast to apostrophes, which may be written together with some parts of words - \"I'm\", \"it's\" etc)."
47 | msgstr ""
48 |
49 | #: ../differences.rst:47
50 | # 47c4d22c877e40f9ae9cc32446a8d435
51 | msgid "Unlike Slim, Plim does not support square or curly braces for wrapping tag attributes. You can use only parentheses ``()``:"
52 | msgstr ""
53 |
54 | #: ../differences.rst:61
55 | # 29992bcf5c9e4a36a01da0e0225866ac
56 | msgid "In Plim, all html tags **MUST** be written in lowercase."
57 | msgstr ""
58 |
59 | #: ../differences.rst:63
60 | # 2a470b5d41b548dda64bed052f282a56
61 | msgid "This restriction was introduced to support :ref:`Implicit Literal Blocks ` feature."
62 | msgstr ""
63 |
64 | #: ../differences.rst:79
65 | # 8a859a687ea444b89adfacaf4fc8f338
66 | msgid "You do not have to use the ``|`` (pipe) indicator in ``style`` and ``script`` tags."
67 | msgstr ""
68 |
69 | #: ../differences.rst:81
70 | # 1637fde6f5aa4a9db414ba1d51fd88bb
71 | msgid "Plim does not make distinctions between control structures and embedded filters."
72 | msgstr ""
73 |
74 | #: ../differences.rst:83
75 | # a2f0ef6306e04b62aeddb1bcaebab475
76 | msgid "For example, in Slim you would write ``-if``, ``-for``, and ``coffee:`` (without preceding dash, but with the colon sign at the tail). But in Plim, you must write ``-if``, ``-for``, and ``-coffee``."
77 | msgstr ""
78 |
79 | #: ../differences.rst:87
80 | # c57b1618796c49fc88ea5d710a71fa80
81 | msgid "In contrast to Slim, Plim does not support the ``/!`` line indicator `which is used as an HTML-comment `_. You can use raw HTML-comments instead."
82 | msgstr ""
83 |
84 |
--------------------------------------------------------------------------------
/docs/locale/zh_CN/LC_MESSAGES/differences.po:
--------------------------------------------------------------------------------
1 | #
2 | msgid ""
3 | msgstr ""
4 | "Project-Id-Version: Plim 0.9\n"
5 | "Report-Msgid-Bugs-To: \n"
6 | "POT-Creation-Date: 2015-06-12 16:42+0800\n"
7 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
8 | "Last-Translator: FULL NAME \n"
9 | "Language-Team: LANGUAGE \n"
10 | "MIME-Version: 1.0\n"
11 | "Content-Type: text/plain; charset=UTF-8\n"
12 | "Content-Transfer-Encoding: 8bit\n"
13 |
14 | #: ../differences.rst:2
15 | msgid "Syntactic Differences"
16 | msgstr "语法区别"
17 |
18 | #: ../differences.rst:4
19 | msgid ""
20 | "Plim is *not the exact* port of Slim. Here is the full list of differences."
21 | msgstr "Plim *不是完整的* Slim 移植，两者区别在于："
22 |
23 | #: ../differences.rst:7
24 | msgid ""
25 | "Slim has the ( ``'`` ), ( ``='`` ), and ( ``=='`` ) `line indicators "
26 | "`_. In Plim, single "
27 | "quote has been replaced by the comma char ( ``,`` ):"
28 | msgstr ""
29 | "Slim 中有 ( ``'`` )、( ``='`` )、( ``=='`` ) ` 三种行内指示符（line indicators）"
30 | "`_ 。Plim 使用 ``,`` 代替 ``'``。"
31 |
32 | #: ../differences.rst:17
33 | msgid ""
34 | "The change was made in order to get rid of the syntactic ambiguities like "
35 | "these:"
36 | msgstr ""
37 | "之所以这样改动，是为了避免这种情况下的语法歧义："
38 |
39 | #: ../differences.rst:28
40 | msgid ""
41 | "Meanwhile, the comma char is not allowed at the beginning of python "
42 | "expression, therefore the following code samples are consistent:"
43 | msgstr ""
44 | "然而 Python 表达式不允许以逗号起始，因此下面的例子并不会产生歧义"
45 |
46 | #: ../differences.rst:41
47 | msgid ""
48 | "In addition, the comma syntax seems more natural, since in formal writing we"
49 | " also add a whitespace between a comma and the following word (in contrast "
50 | "to apostrophes, which may be written together with some parts of words - "
51 | "\"I'm\", \"it's\" etc)."
52 | msgstr ""
53 | "另外，使用逗号相比引号也更自然，因为我们在书写普通英文单词，如 “I'm”、“it's” 时也会使用单引号。"
54 |
55 | #: ../differences.rst:47
56 | msgid ""
57 | "Unlike Slim, Plim does not support square or curly braces for wrapping tag "
58 | "attributes. You can use only parentheses ``()``:"
59 | msgstr ""
60 | "和 Slim 不同的是，Plim 并不支持方括号或者花括号作为标签属性标记，只允许小括号 ``()`` ："
61 |
62 | #: ../differences.rst:61
63 | msgid "In Plim, all html tags **MUST** be written in lowercase."
64 | msgstr "Plim 中，所有 HTML 标签 **必须** 完全小写："
65 |
66 | #: ../differences.rst:63
67 | msgid ""
68 | "This restriction was introduced to support :ref:`Implicit Literal Blocks "
69 | "` feature."
70 | msgstr ""
71 | "该限制是为了提供 :ref:`隐式纯文本块（Implicit Literal Blocks） ` 功能。"
72 |
73 | #: ../differences.rst:79
74 | msgid ""
75 | "You do not have to use the ``|`` (pipe) indicator in ``style`` and "
76 | "``script`` tags."
77 | msgstr "不必在 ``style`` and ``script`` 标签中使用 ``|`` （管道符）。"
78 |
79 | #: ../differences.rst:81
80 | msgid ""
81 | "Plim does not make distinctions between control structures and embedded "
82 | "filters."
83 | msgstr "Plim 并不对结构控制和内嵌的过滤器之间加以区别。"
84 |
85 | #: ../differences.rst:83
86 | msgid ""
87 | "For example, in Slim you would write ``-if``, ``-for``, and ``coffee:`` "
88 | "(without preceding dash, but with the colon sign at the tail). But in Plim, "
89 | "you must write ``-if``, ``-for``, and ``-coffee``."
90 | msgstr ""
91 | "在 Slim 中你需要写 ``-if``、``-for`` 以及 ``coffee:`` ，"
92 | "但是在 Plim 中你不可以在结尾添加冒号： ``-if``、``-for``、``-coffee``。"
93 |
94 | #: ../differences.rst:87
95 | msgid ""
96 | "In contrast to Slim, Plim does not support the ``/!`` line indicator `which "
97 | "is used as an HTML-comment `_. You can "
98 | "use raw HTML-comments instead."
99 | msgstr ""
100 | "和 Slim 不同，Plim 并不支持 ``/!`` 这样的 `HTML 批量注释 `_ ，"
101 | "在 Plim 中你只能使用原生 HTML 注释符。"
102 |
103 |
--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
1 | .. Plim documentation master file, created by
2 | sphinx-quickstart on Sun Jun 10 21:08:09 2012.
3 | You can adapt this file completely to your liking, but it should at least
4 | contain the root `toctree` directive.
5 |
6 | =========================
7 | Plim Documentation
8 | =========================
9 |
10 | .. image:: https://pypip.in/v/Plim/badge.png
11 | :target: https://crate.io/packages/Plim
12 |
13 | .. image:: https://pypip.in/d/Plim/badge.png
14 | :target: https://crate.io/packages/Plim
15 |
16 | .. image:: https://api.travis-ci.org/avanov/Plim.png
17 | :target: https://travis-ci.org/avanov/Plim
18 |
19 | .. image:: https://coveralls.io/repos/avanov/Plim/badge.png?branch=develop
20 | :target: https://coveralls.io/r/avanov/Plim?branch=develop
21 |
22 |
23 | Plim is a Python port of `Ruby's Slim template language `_
26 | to translate its syntax into a valid HTML/Mako markup.
27 |
28 |
29 | Installation
30 | =============
31 |
32 | .. code-block:: bash
33 |
34 | pip install Plim
35 |
36 |
37 | Tests
38 | =======
39 |
40 | Plim provides an extensive test suite based on
41 | `pytest `_.
49 |
50 |
51 | Detailed example
52 | =================
53 |
54 | .. code-block:: plim
55 |
56 | / base.html
57 | --------------------------
58 | doctype html
59 | html = next.body()
60 |
61 |
62 | .. code-block:: plim
63 |
64 | / helpers.html
65 | --------------------------
66 | -def other_headers()
67 | meta charset="utf-8"
68 | link rel="stylesheet" href="/static/css/main.css"
69 |
70 |
71 | .. code-block:: plim
72 |
73 | / layout.html
74 | --------------------------
75 | -inherit base.html
76 | -namespace name="helper" helpers.html
77 |
78 | head
79 | title Plim Example
80 | meta name="keywords" content="template language"
81 | = helper.other_headers()
82 |
83 | script
84 | /* "script" and "style" blocks do not require explicit literal indicator "|" */
85 | $(content).do_something();
86 |
87 | style
88 | body {
89 | background:#FFF;
90 | }
91 |
92 | -scss
93 | /* SCSS/SASS extension */
94 | @option compress: no;
95 | .selector {
96 | a {
97 | display: block;
98 | }
99 | strong {
100 | color: blue;
101 | }
102 | }
103 |
104 | -coffee
105 | # CoffeeScript extension
106 | square = (x) -> x * x
107 |
108 | body
109 | h1 Markup examples
110 | #content.example1
111 | p Nest by indentation
112 | `_.
59 |
60 | - 0.9.1
61 |
62 | - New Syntax: `New-style Python Blocks `_.
63 | - New Syntax: `New-style Module-level Blocks `_.
64 |
65 |
66 | - 0.9.0
67 |
68 | - Change: Pyramid adapter now relies on Pyramid>=1.5a2 and pyramid_mako>=0.3.1.
69 | - Change: The package now depends on Mako>=0.9.0.
70 | - Change: Sass/Scss extension now requires PyScss>=1.2.0.post3.
71 | - Change: Pyramid adapter's ``plim.file_extension`` configuration option is deprecated.
72 | The ``config.add_plim_renderer()`` `directive is provided instead `_.
73 |
74 | Version 0.8
75 | ------------
76 |
77 | - 0.8.9
78 |
79 | - Bugfix: Use sys.maxsize instead of unavailable sys.maxint on Python 3.
80 |
81 | - 0.8.8
82 |
83 | - Hotfix: Make Plim working with a development version of pyScss for Python-3.x setups.
84 |
85 | - 0.8.7
86 |
87 | - Bugfix: Pyramid adapter is now compatible with the 1.5a2+ version of the framework.
88 | - Change: `default template file extension `_
89 | used in pyramid bindings is changed from ".plm" to ".plim".
90 |
91 | - 0.8.6
92 |
93 | - Hotfix: fixed assertion error in handlebars parser.
94 |
95 | - 0.8.5
96 |
97 | - Feature: added support for `Handlebars blocks `_.
98 |
99 | - 0.8.4
100 |
101 | - Hotfix: updated links to github.
102 |
103 | - 0.8.3
104 |
105 | - Hotfix: prevent lexer from parsing embedded markup inside ``style`` and ``script`` blocks.
106 |
107 | - 0.8.2
108 |
109 | - Feature: added support for `Embedded Markup `_.
110 | - Feature: plimc utility is now able to output plain HTML.
111 |
112 | - 0.8.1
113 |
114 | - Feature: added support for `Inline Statements `_.
115 |
116 | - 0.8.0
117 |
118 | - Feature: added support for dynamic attributes unpacker (an equivalent to Slim's splat attributes).
119 |
120 |
121 | Version 0.7
122 | ------------
123 |
124 | - 0.7.14
125 |
126 | - Hotfix: fixed bug with unicode handling.
127 |
128 | - 0.7.13
129 |
130 | - Hotfix: fixed bug with static unicode attributes.
131 |
132 | - 0.7.12
133 |
134 | - Unnecessary newline characters at the end of literal blocks have been removed.
135 | - Added the command-line tool ``plimc``.
136 |
137 | - 0.7.11
138 |
139 | - Fixed bug that had to do with incorrect parsing of multi-line dynamic class attributes.
140 | - Fixed bug that had to do with passing incorrect data to plim parser in babel adapter.
141 |
142 | - 0.7.10
143 | Fixed bug with unicode error in python block. Thanks to sqrabs@github!
144 |
145 | - 0.7.9
146 | Added babel message extraction plugin.
147 |
148 | - 0.7.8
149 | Expanded range of possible numeric values that don't require double-quoting.
150 |
151 | - 0.7.7
152 |
153 | - Fixed bug with linebreaks without trailing newline character.
154 | - Fixed bug with missing explicit whitespace after ``=,`` and ``==,`` line indicators.
155 |
156 | - 0.7.6
157 | Fixed bug with incorrect parsing of static boolean attributes.
158 |
159 | - 0.7.5
160 | Fixed bug with comment and content blocks separated by empty lines.
161 |
162 | - 0.7.4
163 | Added -stylus extension.
164 |
165 | - 0.7.3
166 | Fix bug with literal one-liners.
167 |
168 | - 0.7.1
169 | Fixed installation error caused by missing README.rst.
170 |
171 | - 0.7.0
172 | Initial public release.
--------------------------------------------------------------------------------
/plim/syntax.py:
--------------------------------------------------------------------------------
1 | import re
2 | from typing import Sequence, Any
3 |
4 | from pyrsistent import v, pvector
5 |
6 | from . import lexer as l
7 |
8 | PARSE_IMPLICIT_LITERAL_RE = re.compile(
9 | # Order matters
10 | '(?P(?:'
11 | '\$?\{|\(|\[|&.+;|[0-9]+|'
12 | '(?:'
13 | '[^\u0021-\u007E]' # not ASCII 33 - 126
14 | '|' # or
15 | '[A-Z]' # uppercase latin letters (ASCII 65 - 90)
16 | ')' # It is possible because TAG_RE can match only lowercase tag names
17 | ').*)\s*'
18 | )
19 |
20 |
21 | class BaseSyntax(object):
22 | VARIABLE_PLACEHOLDER_START_SEQUENCE = '${'
23 | VARIABLE_PLACEHOLDER_END_SEQUENCE = '}'
24 |
25 | STATEMENT_START_START_SEQUENCE = '%'
26 | STATEMENT_START_END_SEQUENCE = ':'
27 | STATEMENT_END_START_SEQUENCE = '%'
28 | STATEMENT_END_END_SEQUENCE = ''
29 |
30 | # Parsers
31 | # ----------------------------------
32 | PARSE_DOCTYPE_RE = re.compile('doctype\s+(?P[0-9a-z\.]+)', re.IGNORECASE)
33 | PARSE_STYLE_SCRIPT_RE = re.compile('(?:style|script).*', re.IGNORECASE)
34 | PARSE_HANDLEBARS_RE = re.compile('(?:handlebars).*')
35 | PARSE_TAG_TREE_RE = re.compile('(?:#|\.|{tag}).*'.format(tag=l.TAG_RULE))
36 | # This constant uses l.LITERAL_CONTENT_PREFIX and l.LITERAL_CONTENT_SPACE_PREFIX
37 | PARSE_EXPLICIT_LITERAL_RE = re.compile("(?:\||,).*", re.IGNORECASE)
38 | PARSE_IMPLICIT_LITERAL_RE = PARSE_IMPLICIT_LITERAL_RE
39 | PARSE_RAW_HTML_RE = re.compile('\<.*')
40 | PARSE_VARIABLE_RE = re.compile("=(?P=)?(?P,)?\s*(?P.*)", re.IGNORECASE)
41 | PARSE_COMMENT_RE = re.compile('/.*')
42 |
43 | PARSE_STATEMENTS_RE = re.compile('-\s*(?Pif|for|while|with|try)(?P.*)')
44 | PARSE_FOREIGN_STATEMENTS_RE = re.compile('-\s*(?Punless|until)(?P.*)')
45 | PARSE_PYTHON_NEW_RE = re.compile('---[-]*(?P\!)?\s*(?P[^-].*)?')
46 | PARSE_PYTHON_CLASSIC_RE = re.compile('-\s*(?Ppy(?:thon)?(?P\!?))(?P\s+.*)?')
47 | PARSE_DEF_BLOCK_RE = re.compile('-\s*(?P(?:def|block)(?:\s+.*)?)')
48 | PARSE_MAKO_ONE_LINERS_RE = re.compile('-\s*(?P(?:include|inherit|page|namespace)(?:\s+.*)?)')
49 | PARSE_MAKO_TEXT_RE = re.compile('-\s*(?Ptext(?:\s+.*)?)')
50 | PARSE_CALL_RE = re.compile('-\s*(?Pcall(?:\s+.*)?)')
51 | PARSE_EARLY_RETURN_RE = re.compile('-\s*(?Preturn|continue|break)\s*')
52 | PARSE_EXTENSION_LANGUAGES_RE = re.compile('-\s*(?Pmd|markdown|rst|rest|coffee|scss|sass|stylus)\s*')
53 |
54 | PARSE_ELIF_ELSE_RE = re.compile('-\s*(?Pelif|else)(?P.*)')
55 | PARSE_EXCEPT_ELSE_FINALLY_RE = re.compile('-\s*(?Pexcept|else|finally)(?P.*)')
56 |
57 | def __init__(self, custom_parsers: Sequence[Any] = v()):
58 | """
59 | :param custom_parsers: a list of 2-tuples of (parser_regex, parser_callable) or None
60 | :type custom_parsers: list or None
61 | """
62 | if not custom_parsers:
63 | custom_parsers = v()
64 | else:
65 | custom_parsers = pvector(custom_parsers)
66 |
67 | # We initialize standard parsers here rather than in a class' scope, because
68 | # we would like to be able to discard parsers in some syntax implementations by
69 | # replacing them with None (see Django syntax vs. Mako syntax definitions below).
70 | standard_parsers = ( # Order matters
71 | (self.PARSE_STYLE_SCRIPT_RE, l.parse_style_script),
72 | (self.PARSE_DOCTYPE_RE, l.parse_doctype),
73 | (self.PARSE_HANDLEBARS_RE, l.parse_handlebars),
74 | (self.PARSE_TAG_TREE_RE, l.parse_tag_tree),
75 | (self.PARSE_EXPLICIT_LITERAL_RE, l.parse_explicit_literal_with_embedded_markup),
76 | (self.PARSE_IMPLICIT_LITERAL_RE, l.parse_implicit_literal),
77 | (self.PARSE_RAW_HTML_RE, l.parse_raw_html),
78 | (self.PARSE_VARIABLE_RE, l.parse_variable),
79 | (self.PARSE_COMMENT_RE, l.parse_comment),
80 | (self.PARSE_STATEMENTS_RE, l.parse_statements),
81 | (self.PARSE_FOREIGN_STATEMENTS_RE, l.parse_foreign_statements),
82 | (self.PARSE_PYTHON_NEW_RE, l.parse_python_new_style),
83 | (self.PARSE_PYTHON_CLASSIC_RE, l.parse_python),
84 | (self.PARSE_DEF_BLOCK_RE, l.parse_def_block),
85 | (self.PARSE_MAKO_ONE_LINERS_RE, l.parse_mako_one_liners),
86 | (self.PARSE_MAKO_TEXT_RE, l.parse_mako_text),
87 | (self.PARSE_CALL_RE, l.parse_call),
88 | (self.PARSE_EARLY_RETURN_RE, l.parse_early_return),
89 | (self.PARSE_EXTENSION_LANGUAGES_RE, l.parse_markup_languages)
90 | )
91 | custom_parsers = custom_parsers.extend(standard_parsers)
92 | # discard parsers with None pattern
93 | self.parsers = tuple([p for p in custom_parsers if p[0]])
94 |
95 | def __str__(self) -> str:
96 | return 'Base Syntax'
97 |
98 |
99 | class Mako(BaseSyntax):
100 | def __str__(self) -> str:
101 | return 'Mako Syntax'
102 |
103 |
104 | class Django(BaseSyntax):
105 | VARIABLE_PLACEHOLDER_START_SEQUENCE = '{{'
106 | VARIABLE_PLACEHOLDER_END_SEQUENCE = '}}'
107 | STATEMENT_START_START_SEQUENCE = '{% '
108 | STATEMENT_START_END_SEQUENCE = ' %}'
109 | STATEMENT_END_START_SEQUENCE = STATEMENT_START_START_SEQUENCE
110 | STATEMENT_END_END_SEQUENCE = STATEMENT_START_END_SEQUENCE
111 |
112 | PARSE_MAKO_ONE_LINERS_RE = None # type: ignore
113 | PARSE_MAKO_TEXT_RE = None # type: ignore
114 |
115 | def __str__(self):
116 | return 'Django Syntax'
117 |
--------------------------------------------------------------------------------
/docs/make.bat:
--------------------------------------------------------------------------------
1 | @ECHO OFF
2 |
3 | REM Command file for Sphinx documentation
4 |
5 | if "%SPHINXBUILD%" == "" (
6 | set SPHINXBUILD=sphinx-build
7 | )
8 | set BUILDDIR=_build
9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10 | set I18NSPHINXOPTS=%SPHINXOPTS% .
11 | if NOT "%PAPER%" == "" (
12 | set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13 | set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14 | )
15 |
16 | if "%1" == "" goto help
17 |
18 | if "%1" == "help" (
19 | :help
20 | echo.Please use `make ^` where ^ is one of
21 | echo. html to make standalone HTML files
22 | echo. dirhtml to make HTML files named index.html in directories
23 | echo. singlehtml to make a single large HTML file
24 | echo. pickle to make pickle files
25 | echo. json to make JSON files
26 | echo. htmlhelp to make HTML files and a HTML help project
27 | echo. qthelp to make HTML files and a qthelp project
28 | echo. devhelp to make HTML files and a Devhelp project
29 | echo. epub to make an epub
30 | echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31 | echo. text to make text files
32 | echo. man to make manual pages
33 | echo. texinfo to make Texinfo files
34 | echo. gettext to make PO message catalogs
35 | echo. changes to make an overview over all changed/added/deprecated items
36 | echo. linkcheck to check all external links for integrity
37 | echo. doctest to run all doctests embedded in the documentation if enabled
38 | goto end
39 | )
40 |
41 | if "%1" == "clean" (
42 | for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
43 | del /q /s %BUILDDIR%\*
44 | goto end
45 | )
46 |
47 | if "%1" == "html" (
48 | %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
49 | if errorlevel 1 exit /b 1
50 | echo.
51 | echo.Build finished. The HTML pages are in %BUILDDIR%/html.
52 | goto end
53 | )
54 |
55 | if "%1" == "dirhtml" (
56 | %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
57 | if errorlevel 1 exit /b 1
58 | echo.
59 | echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
60 | goto end
61 | )
62 |
63 | if "%1" == "singlehtml" (
64 | %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
65 | if errorlevel 1 exit /b 1
66 | echo.
67 | echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
68 | goto end
69 | )
70 |
71 | if "%1" == "pickle" (
72 | %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
73 | if errorlevel 1 exit /b 1
74 | echo.
75 | echo.Build finished; now you can process the pickle files.
76 | goto end
77 | )
78 |
79 | if "%1" == "json" (
80 | %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
81 | if errorlevel 1 exit /b 1
82 | echo.
83 | echo.Build finished; now you can process the JSON files.
84 | goto end
85 | )
86 |
87 | if "%1" == "htmlhelp" (
88 | %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
89 | if errorlevel 1 exit /b 1
90 | echo.
91 | echo.Build finished; now you can run HTML Help Workshop with the ^
92 | .hhp project file in %BUILDDIR%/htmlhelp.
93 | goto end
94 | )
95 |
96 | if "%1" == "qthelp" (
97 | %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
98 | if errorlevel 1 exit /b 1
99 | echo.
100 | echo.Build finished; now you can run "qcollectiongenerator" with the ^
101 | .qhcp project file in %BUILDDIR%/qthelp, like this:
102 | echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Plim.qhcp
103 | echo.To view the help file:
104 | echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Plim.ghc
105 | goto end
106 | )
107 |
108 | if "%1" == "devhelp" (
109 | %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
110 | if errorlevel 1 exit /b 1
111 | echo.
112 | echo.Build finished.
113 | goto end
114 | )
115 |
116 | if "%1" == "epub" (
117 | %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
118 | if errorlevel 1 exit /b 1
119 | echo.
120 | echo.Build finished. The epub file is in %BUILDDIR%/epub.
121 | goto end
122 | )
123 |
124 | if "%1" == "latex" (
125 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
126 | if errorlevel 1 exit /b 1
127 | echo.
128 | echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
129 | goto end
130 | )
131 |
132 | if "%1" == "text" (
133 | %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
134 | if errorlevel 1 exit /b 1
135 | echo.
136 | echo.Build finished. The text files are in %BUILDDIR%/text.
137 | goto end
138 | )
139 |
140 | if "%1" == "man" (
141 | %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
142 | if errorlevel 1 exit /b 1
143 | echo.
144 | echo.Build finished. The manual pages are in %BUILDDIR%/man.
145 | goto end
146 | )
147 |
148 | if "%1" == "texinfo" (
149 | %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
150 | if errorlevel 1 exit /b 1
151 | echo.
152 | echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
153 | goto end
154 | )
155 |
156 | if "%1" == "gettext" (
157 | %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
158 | if errorlevel 1 exit /b 1
159 | echo.
160 | echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
161 | goto end
162 | )
163 |
164 | if "%1" == "changes" (
165 | %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
166 | if errorlevel 1 exit /b 1
167 | echo.
168 | echo.The overview file is in %BUILDDIR%/changes.
169 | goto end
170 | )
171 |
172 | if "%1" == "linkcheck" (
173 | %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
174 | if errorlevel 1 exit /b 1
175 | echo.
176 | echo.Link check complete; look for any errors in the above output ^
177 | or in %BUILDDIR%/linkcheck/output.txt.
178 | goto end
179 | )
180 |
181 | if "%1" == "doctest" (
182 | %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
183 | if errorlevel 1 exit /b 1
184 | echo.
185 | echo.Testing of doctests in the sources finished, look at the ^
186 | results in %BUILDDIR%/doctest/output.txt.
187 | goto end
188 | )
189 |
190 | :end
191 |
--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
1 | # Makefile for Sphinx documentation
2 | #
3 |
4 | # You can set these variables from the command line.
5 | SPHINXOPTS =
6 | SPHINXBUILD = sphinx-build
7 | PAPER =
8 | BUILDDIR = _build
9 |
10 | # Internal variables.
11 | PAPEROPT_a4 = -D latex_paper_size=a4
12 | PAPEROPT_letter = -D latex_paper_size=letter
13 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14 | # the i18n builder cannot share the environment and doctrees with the others
15 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16 |
17 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18 |
19 | help:
20 | @echo "Please use \`make ' where is one of"
21 | @echo " html to make standalone HTML files"
22 | @echo " dirhtml to make HTML files named index.html in directories"
23 | @echo " singlehtml to make a single large HTML file"
24 | @echo " pickle to make pickle files"
25 | @echo " json to make JSON files"
26 | @echo " htmlhelp to make HTML files and a HTML help project"
27 | @echo " qthelp to make HTML files and a qthelp project"
28 | @echo " devhelp to make HTML files and a Devhelp project"
29 | @echo " epub to make an epub"
30 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31 | @echo " latexpdf to make LaTeX files and run them through pdflatex"
32 | @echo " text to make text files"
33 | @echo " man to make manual pages"
34 | @echo " texinfo to make Texinfo files"
35 | @echo " info to make Texinfo files and run them through makeinfo"
36 | @echo " gettext to make PO message catalogs"
37 | @echo " changes to make an overview of all changed/added/deprecated items"
38 | @echo " linkcheck to check all external links for integrity"
39 | @echo " doctest to run all doctests embedded in the documentation (if enabled)"
40 | @echo " chs to make Chinese .mo translation based on the related po files"
41 |
42 | .PHONY: init-chs chs update
43 |
44 | init-chs: gettext update
45 |
46 | update:
47 | sphinx-intl update -p locale -l zh_CN
48 |
49 | chs:
50 | sphinx-intl build
51 | $(SPHINXBUILD) -b html -D language='zh_CN' $(ALLSPHINXOPTS) $(BUILDDIR)/html
52 | @echo "Build finished. The HTML pages are in $(BUILDDIR)."
53 |
54 | clean:
55 | -rm -rf $(BUILDDIR)/*
56 |
57 | html:
58 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
59 | @echo
60 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
61 |
62 | dirhtml:
63 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64 | @echo
65 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
66 |
67 | singlehtml:
68 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
69 | @echo
70 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
71 |
72 | pickle:
73 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
74 | @echo
75 | @echo "Build finished; now you can process the pickle files."
76 |
77 | json:
78 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
79 | @echo
80 | @echo "Build finished; now you can process the JSON files."
81 |
82 | htmlhelp:
83 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
84 | @echo
85 | @echo "Build finished; now you can run HTML Help Workshop with the" \
86 | ".hhp project file in $(BUILDDIR)/htmlhelp."
87 |
88 | qthelp:
89 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
90 | @echo
91 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \
92 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
93 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Plim.qhcp"
94 | @echo "To view the help file:"
95 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Plim.qhc"
96 |
97 | devhelp:
98 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
99 | @echo
100 | @echo "Build finished."
101 | @echo "To view the help file:"
102 | @echo "# mkdir -p $$HOME/.local/share/devhelp/Plim"
103 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Plim"
104 | @echo "# devhelp"
105 |
106 | epub:
107 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
108 | @echo
109 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
110 |
111 | latex:
112 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
113 | @echo
114 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
115 | @echo "Run \`make' in that directory to run these through (pdf)latex" \
116 | "(use \`make latexpdf' here to do that automatically)."
117 |
118 | latexpdf:
119 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
120 | @echo "Running LaTeX files through pdflatex..."
121 | $(MAKE) -C $(BUILDDIR)/latex all-pdf
122 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
123 |
124 | text:
125 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
126 | @echo
127 | @echo "Build finished. The text files are in $(BUILDDIR)/text."
128 |
129 | man:
130 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
131 | @echo
132 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
133 |
134 | texinfo:
135 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
136 | @echo
137 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
138 | @echo "Run \`make' in that directory to run these through makeinfo" \
139 | "(use \`make info' here to do that automatically)."
140 |
141 | info:
142 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
143 | @echo "Running Texinfo files through makeinfo..."
144 | make -C $(BUILDDIR)/texinfo info
145 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
146 |
147 | gettext:
148 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) locale
149 | @echo
150 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
151 |
152 | changes:
153 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
154 | @echo
155 | @echo "The overview file is in $(BUILDDIR)/changes."
156 |
157 | linkcheck:
158 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
159 | @echo
160 | @echo "Link check complete; look for any errors in the above output " \
161 | "or in $(BUILDDIR)/linkcheck/output.txt."
162 |
163 | doctest:
164 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
165 | @echo "Testing of doctests in the sources finished, look at the " \
166 | "results in $(BUILDDIR)/doctest/output.txt."
167 |
--------------------------------------------------------------------------------
/docs/locale/extensions.pot:
--------------------------------------------------------------------------------
1 | # SOME DESCRIPTIVE TITLE.
2 | # Copyright (C) 2014, Maxim Avanov
3 | # This file is distributed under the same license as the Plim package.
4 | # FIRST AUTHOR , YEAR.
5 | #
6 | #, fuzzy
7 | msgid ""
8 | msgstr ""
9 | "Project-Id-Version: Plim 0.9\n"
10 | "Report-Msgid-Bugs-To: \n"
11 | "POT-Creation-Date: 2015-06-22 20:43+0800\n"
12 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 | "Last-Translator: FULL NAME \n"
14 | "Language-Team: LANGUAGE \n"
15 | "MIME-Version: 1.0\n"
16 | "Content-Type: text/plain; charset=UTF-8\n"
17 | "Content-Transfer-Encoding: 8bit\n"
18 |
19 | #: ../extensions.rst:2
20 | # 512b2f11fc2c47188aa0cb21a07c1033
21 | msgid "Extensions"
22 | msgstr ""
23 |
24 | #: ../extensions.rst:5
25 | # b4752206bd5548558b18df8bd86b37d5
26 | msgid "Standard extensions"
27 | msgstr ""
28 |
29 | #: ../extensions.rst:8
30 | # 6c674f211c5b49fa979aa8d13fa61571
31 | msgid "CoffeeScript"
32 | msgstr ""
33 |
34 | #: ../extensions.rst:10
35 | # a18c113401fa4867bf17786a267446d7
36 | msgid "Plim uses `Python-CoffeeScript `_ package as a bridge to the JS `CoffeeScript `_ package to translate `SCSS/SASS `_ package to translate `stylus `_ package for the ``-markdown`` (or ``-md``) extension."
89 | msgstr ""
90 |
91 | #: ../extensions.rst:186
92 | # 339c154b88054eb9ac81154671c115d7
93 | msgid "reStructuredText"
94 | msgstr ""
95 |
96 | #: ../extensions.rst:188
97 | # 2ea8e053eb63419d84780d54b8c1b498
98 | msgid "Plim uses `Docutils for introductory docs.
6 | :Author: David Goodger
7 | :Date: $Date: 2011-06-17 10:50:48 +0000 (Fri, 17 Jun 2011) $
8 | :Revision: $Revision: 7056 $
9 | :Description: This is a "docinfo block", or bibliographic field list
10 |
11 | Section Structure
12 | =================
13 | Section titles are underlined or overlined & underlined.
14 |
15 | Body Elements
16 | =============
17 | Grid table:
18 |
19 | +--------------------------------+-----------------------------------+
20 | | Paragraphs are flush-left, | Literal block, preceded by "::":: |
21 | | separated by blank lines. | |
22 | | | Indented |
23 | | Block quotes are indented. | |
24 | +--------------------------------+ or:: |
25 | | >>> print 'Doctest block' | |
26 | | Doctest block | > Quoted |
27 | +--------------------------------+-----------------------------------+
28 | | | Line blocks preserve line breaks & indents. [new in 0.3.6] |
29 | | | Useful for addresses, verse, and adornment-free lists; long |
30 | | lines can be wrapped with continuation lines. |
31 | +--------------------------------------------------------------------+
32 |
33 | Simple tables:
34 |
35 | ================ ============================================================
36 | List Type Examples
37 | ================ ============================================================
38 | Bullet list * items begin with "-", "+", or "*"
39 | Enumerated list 1. items use any variation of "1.", "A)", and "(i)"
40 | #. also auto-enumerated
41 | Definition list Term is flush-left : optional classifier
42 | Definition is indented, no blank line between
43 | Field list :field name: field body
44 | Option list -o at least 2 spaces between option & description
45 | ================ ============================================================
46 |
47 | ================ ============================================================
48 | Explicit Markup Examples (visible in the `text source `_)
49 | ================ ============================================================
50 | Footnote .. [1] Manually numbered or [#] auto-numbered
51 | (even [#labelled]) or [*] auto-symbol
52 | Citation .. [CIT2002] A citation.
53 | Hyperlink Target .. _reStructuredText: http://docutils.sf.net/rst.html
54 | .. _indirect target: reStructuredText_
55 | .. _internal target:
56 | Anonymous Target __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html
57 | Directive ("::") .. image:: images/biohazard.png
58 | Substitution Def .. |substitution| replace:: like an inline directive
59 | Comment .. is anything else
60 | Empty Comment (".." on a line by itself, with blank lines before & after,
61 | used to separate indentation contexts)
62 | ================ ============================================================
63 |
64 | Inline Markup
65 | =============
66 | *emphasis*; **strong emphasis**; `interpreted text`; `interpreted text
67 | with role`:emphasis:; ``inline literal text``; standalone hyperlink,
68 | http://docutils.sourceforge.net; named reference, reStructuredText_;
69 | `anonymous reference`__; footnote reference, [1]_; citation reference,
70 | [CIT2002]_; |substitution|; _`inline internal target`.
71 |
72 | Directive Quick Reference
73 | =========================
74 | See for full info.
75 |
76 | ================ ============================================================
77 | Directive Name Description (Docutils version added to, in [brackets])
78 | ================ ============================================================
79 | attention Specific admonition; also "caution", "danger",
80 | "error", "hint", "important", "note", "tip", "warning"
81 | admonition Generic titled admonition: ``.. admonition:: By The Way``
82 | image ``.. image:: picture.png``; many options possible
83 | figure Like "image", but with optional caption and legend
84 | topic ``.. topic:: Title``; like a mini section
85 | sidebar ``.. sidebar:: Title``; like a mini parallel document
86 | parsed-literal A literal block with parsed inline markup
87 | rubric ``.. rubric:: Informal Heading``
88 | epigraph Block quote with class="epigraph"
89 | highlights Block quote with class="highlights"
90 | pull-quote Block quote with class="pull-quote"
91 | compound Compound paragraphs [0.3.6]
92 | container Generic block-level container element [0.3.10]
93 | table Create a titled table [0.3.1]
94 | list-table Create a table from a uniform two-level bullet list [0.3.8]
95 | csv-table Create a table from CSV data (requires Python 2.3+) [0.3.4]
96 | contents Generate a table of contents
97 | sectnum Automatically number sections, subsections, etc.
98 | header, footer Create document decorations [0.3.8]
99 | target-notes Create an explicit footnote for each external target
100 | math Mathematical notation (input in LaTeX format)
101 | meta HTML-specific metadata
102 | include Read an external reST file as if it were inline
103 | raw Non-reST data passed untouched to the Writer
104 | replace Replacement text for substitution definitions
105 | unicode Unicode character code conversion for substitution defs
106 | date Generates today's date; for substitution defs
107 | class Set a "class" attribute on the next element
108 | role Create a custom interpreted text role [0.3.2]
109 | default-role Set the default interpreted text role [0.3.10]
110 | title Set the metadata document title [0.3.10]
111 | ================ ============================================================
112 |
113 | Interpreted Text Role Quick Reference
114 | =====================================
115 | See for full info.
116 |
117 | ================ ============================================================
118 | Role Name Description
119 | ================ ============================================================
120 | emphasis Equivalent to *emphasis*
121 | literal Equivalent to ``literal`` but processes backslash escapes
122 | math Mathematical notation (input in LaTeX format)
123 | PEP Reference to a numbered Python Enhancement Proposal
124 | RFC Reference to a numbered Internet Request For Comments
125 | raw For non-reST data; cannot be used directly (see docs) [0.3.6]
126 | strong Equivalent to **strong**
127 | sub Subscript
128 | sup Superscript
129 | title Title reference (book, etc.); standard default role
130 | ================ ============================================================
131 |
--------------------------------------------------------------------------------
/docs/locale/zh_CN/LC_MESSAGES/extensions.po:
--------------------------------------------------------------------------------
1 | #
2 | msgid ""
3 | msgstr ""
4 | "Project-Id-Version: Plim 0.9\n"
5 | "Report-Msgid-Bugs-To: \n"
6 | "POT-Creation-Date: 2015-06-12 16:42+0800\n"
7 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
8 | "Last-Translator: FULL NAME \n"
9 | "Language-Team: LANGUAGE \n"
10 | "MIME-Version: 1.0\n"
11 | "Content-Type: text/plain; charset=UTF-8\n"
12 | "Content-Transfer-Encoding: 8bit\n"
13 |
14 | #: ../extensions.rst:2
15 | msgid "Extensions"
16 | msgstr "扩展"
17 |
18 | #: ../extensions.rst:5
19 | msgid "Standard extensions"
20 | msgstr "标准扩展"
21 |
22 | #: ../extensions.rst:8
23 | msgid "CoffeeScript"
24 | msgstr ""
25 |
26 | #: ../extensions.rst:10
27 | msgid ""
28 | "Plim uses `Python-CoffeeScript `_ package as a bridge to the JS `CoffeeScript "
30 | "`_ 包"
34 | "作为 JS 与 `CoffeeScript `_ package to translate "
44 | "`SCSS/SASS `_ 包将 "
49 | "`SCSS/SASS `_ package to "
70 | "translate `stylus `_ 包来翻译 "
75 | "`stylus `_ "
85 | "package for the ``-markdown`` (or ``-md``) extension."
86 | msgstr ""
87 | "Plim 使用 `python-markdown2 `_ "
88 | "包处理 ``-markdown`` （或者 ``-md``）扩展"
89 |
90 | #: ../extensions.rst:186
91 | msgid "reStructuredText"
92 | msgstr ""
93 |
94 | #: ../extensions.rst:188
95 | msgid ""
96 | "Plim uses `Docutils v documentation".
108 | #html_title = None
109 |
110 | # A shorter title for the navigation bar. Default is the same as html_title.
111 | #html_short_title = None
112 |
113 | # The name of an image file (relative to this directory) to place at the top
114 | # of the sidebar.
115 | #html_logo = None
116 |
117 | # The name of an image file (within the static path) to use as favicon of the
118 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
119 | # pixels large.
120 | #html_favicon = None
121 |
122 | # Add any paths that contain custom static files (such as style sheets) here,
123 | # relative to this directory. They are copied after the builtin static files,
124 | # so a file named "default.css" will overwrite the builtin "default.css".
125 | html_static_path = ['_static']
126 |
127 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128 | # using the given strftime format.
129 | #html_last_updated_fmt = '%b %d, %Y'
130 |
131 | # If true, SmartyPants will be used to convert quotes and dashes to
132 | # typographically correct entities.
133 | #html_use_smartypants = True
134 |
135 | # Custom sidebar templates, maps document names to template names.
136 | #html_sidebars = {}
137 |
138 | # Additional templates that should be rendered to pages, maps page names to
139 | # template names.
140 | #html_additional_pages = {}
141 |
142 | # If false, no module index is generated.
143 | #html_domain_indices = True
144 |
145 | # If false, no index is generated.
146 | #html_use_index = True
147 |
148 | # If true, the index is split into individual pages for each letter.
149 | #html_split_index = False
150 |
151 | # If true, links to the reST sources are added to the pages.
152 | #html_show_sourcelink = True
153 |
154 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
155 | #html_show_sphinx = True
156 |
157 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
158 | #html_show_copyright = True
159 |
160 | # If true, an OpenSearch description file will be output, and all pages will
161 | # contain a tag referring to it. The value of this option must be the
162 | # base URL from which the finished HTML is served.
163 | #html_use_opensearch = ''
164 |
165 | # This is the file name suffix for HTML files (e.g. ".xhtml").
166 | #html_file_suffix = None
167 |
168 | # Output file base name for HTML help builder.
169 | htmlhelp_basename = 'Plimdoc'
170 |
171 |
172 | # -- Options for LaTeX output --------------------------------------------------
173 |
174 | latex_elements = {
175 | # The paper size ('letterpaper' or 'a4paper').
176 | #'papersize': 'letterpaper',
177 |
178 | # The font size ('10pt', '11pt' or '12pt').
179 | #'pointsize': '10pt',
180 |
181 | # Additional stuff for the LaTeX preamble.
182 | #'preamble': '',
183 | }
184 |
185 | # Grouping the document tree into LaTeX files. List of tuples
186 | # (source start file, target name, title, author, documentclass [howto/manual]).
187 | latex_documents = [
188 | ('index', 'Plim.tex', u'Plim Documentation',
189 | u'Maxim Avanov', 'manual'),
190 | ]
191 |
192 | # The name of an image file (relative to this directory) to place at the top of
193 | # the title page.
194 | #latex_logo = None
195 |
196 | # For "manual" documents, if this is true, then toplevel headings are parts,
197 | # not chapters.
198 | #latex_use_parts = False
199 |
200 | # If true, show page references after internal links.
201 | #latex_show_pagerefs = False
202 |
203 | # If true, show URL addresses after external links.
204 | #latex_show_urls = False
205 |
206 | # Documents to append as an appendix to all manuals.
207 | #latex_appendices = []
208 |
209 | # If false, no module index is generated.
210 | #latex_domain_indices = True
211 |
212 |
213 | # -- Options for manual page output --------------------------------------------
214 |
215 | # One entry per manual page. List of tuples
216 | # (source start file, name, description, authors, manual section).
217 | man_pages = [
218 | ('index', 'plim', u'Plim Documentation',
219 | [u'Maxim Avanov'], 1)
220 | ]
221 |
222 | # If true, show URL addresses after external links.
223 | #man_show_urls = False
224 |
225 |
226 | # -- Options for Texinfo output ------------------------------------------------
227 |
228 | # Grouping the document tree into Texinfo files. List of tuples
229 | # (source start file, target name, title, author,
230 | # dir menu entry, description, category)
231 | texinfo_documents = [
232 | ('index', 'Plim', u'Plim Documentation',
233 | u'Maxim Avanov', 'Plim', 'One line description of project.',
234 | 'Miscellaneous'),
235 | ]
236 |
237 | # Documents to append as an appendix to all manuals.
238 | #texinfo_appendices = []
239 |
240 | # If false, no module index is generated.
241 | #texinfo_domain_indices = True
242 |
243 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
244 | #texinfo_show_urls = 'footnote'
245 |
246 |
247 | # -- Options for Epub output ---------------------------------------------------
248 |
249 | # Bibliographic Dublin Core info.
250 | epub_title = u'Plim'
251 | epub_author = u'Maxim Avanov'
252 | epub_publisher = u'Maxim Avanov'
253 | epub_copyright = u'2014, Maxim Avanov'
254 |
255 | # The language of the text. It defaults to the language option
256 | # or en if the language is not set.
257 | #epub_language = ''
258 |
259 | # The scheme of the identifier. Typical schemes are ISBN or URL.
260 | #epub_scheme = ''
261 |
262 | # The unique identifier of the text. This can be a ISBN number
263 | # or the project homepage.
264 | #epub_identifier = ''
265 |
266 | # A unique identification for the text.
267 | #epub_uid = ''
268 |
269 | # A tuple containing the cover image and cover page html template filenames.
270 | #epub_cover = ()
271 |
272 | # HTML files that should be inserted before the pages created by sphinx.
273 | # The format is a list of tuples containing the path and title.
274 | #epub_pre_files = []
275 |
276 | # HTML files shat should be inserted after the pages created by sphinx.
277 | # The format is a list of tuples containing the path and title.
278 | #epub_post_files = []
279 |
280 | # A list of files that should not be packed into the epub file.
281 | #epub_exclude_files = []
282 |
283 | # The depth of the table of contents in toc.ncx.
284 | #epub_tocdepth = 3
285 |
286 | # Allow duplicate toc entries.
287 | #epub_tocdup = True
288 |
289 |
290 | # Example configuration for intersphinx: refer to the Python standard library.
291 | intersphinx_mapping = {'http://docs.python.org/': None}
292 |
--------------------------------------------------------------------------------
/docs/locale/zh_CN/LC_MESSAGES/changes.po:
--------------------------------------------------------------------------------
1 | #
2 | msgid ""
3 | msgstr ""
4 | "Project-Id-Version: Plim 0.9\n"
5 | "Report-Msgid-Bugs-To: \n"
6 | "POT-Creation-Date: 2015-06-12 16:42+0800\n"
7 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
8 | "Last-Translator: FULL NAME \n"
9 | "Language-Team: LANGUAGE \n"
10 | "MIME-Version: 1.0\n"
11 | "Content-Type: text/plain; charset=UTF-8\n"
12 | "Content-Transfer-Encoding: 8bit\n"
13 |
14 | #: ../../CHANGES:2
15 | msgid "Changelog"
16 | msgstr "变更记录"
17 |
18 | #: ../../CHANGES:5
19 | msgid "Version 0.9"
20 | msgstr ""
21 |
22 | #: ../../CHANGES:7
23 | msgid "0.9.11"
24 | msgstr ""
25 |
26 | #: ../../CHANGES:9
27 | msgid ""
28 | "Hotfix: Fix incorrect parsing of templates with windows-style newlines "
29 | "(CR+LF)."
30 | msgstr "Hotfix: Windows-样式换行（CR+LF）的错误解析修复"
31 |
32 | #: ../../CHANGES:11
33 | msgid "0.9.10"
34 | msgstr ""
35 |
36 | #: ../../CHANGES:13
37 | msgid ""
38 | "Hotfix: Fix ``plimc``'s inability to find a custom preprocessors module in "
39 | "the current working dir."
40 | msgstr "Hotfix: 修复 ``plimc`` 无法使用当前目录下的预处理器模块问题。"
41 |
42 | #: ../../CHANGES:15
43 | msgid "0.9.9"
44 | msgstr ""
45 |
46 | #: ../../CHANGES:17
47 | msgid ""
48 | "Hotfix: Fix UnicodeEncodeError in ``-def`` blocks with unicode strings as "
49 | "default argument values."
50 | msgstr "Hotfix: 修复 ``-def`` 代码块中使用 unicode 字符引起的 UnicodeEncodeError 问题。"
51 |
52 | #: ../../CHANGES:19
53 | msgid "0.9.8"
54 | msgstr ""
55 |
56 | #: ../../CHANGES:21
57 | msgid "Change: Stylus extension no longer depends on the ``nib`` package."
58 | msgstr "Change: Stylus 扩展不再依赖于 ``nib`` 包。"
59 |
60 | #: ../../CHANGES:23
61 | msgid "0.9.7"
62 | msgstr ""
63 |
64 | #: ../../CHANGES:25
65 | msgid "Hotfix: Include requirements.txt into the distribution."
66 | msgstr "Hotfix: 将 requirements.txt 包含进发行版中。"
67 |
68 | #: ../../CHANGES:27
69 | msgid "0.9.6"
70 | msgstr ""
71 |
72 | #: ../../CHANGES:29
73 | msgid ""
74 | "Hotfix: Conditional statements parser now can handle strings containing "
75 | "inline tag separator sequences (#27)."
76 | msgstr ""
77 | "Hotfix: Conditional statements parser now can handle strings containing "
78 | "inline tag separator sequences (#27)."
79 |
80 | #: ../../CHANGES:31
81 | msgid "0.9.5"
82 | msgstr ""
83 |
84 | #: ../../CHANGES:33
85 | msgid ""
86 | "Hotfix: Fix ``plimc`` unicode decoding regression introduced by the previous"
87 | " hotfix."
88 | msgstr "Hotfix: 修复在上一个 Hotfix 中引入的 ``plimc`` 解码 Unicode 正则表达式的问题。"
89 |
90 | #: ../../CHANGES:36
91 | msgid "0.9.4"
92 | msgstr ""
93 |
94 | #: ../../CHANGES:39
95 | msgid ""
96 | "Hotfix: ``plimc`` no longer crashes with TypeError in Python3 environments"
97 | msgstr "Hotfix: ``plimc`` 在 Python 3 环境下不会因 TypeError 而崩溃了。"
98 |
99 | #: ../../CHANGES:39
100 | msgid "when it writes bytes to sys.stdout."
101 | msgstr "将输出指向 sys.stdout 。"
102 |
103 | #: ../../CHANGES:41
104 | msgid "0.9.3"
105 | msgstr ""
106 |
107 | #: ../../CHANGES:43
108 | msgid "Hotfix: Fix UnicodeEncodeError in ``plimc`` when it writes to STDOUT."
109 | msgstr "Hotfix: 修复 ``plimc`` 将输出指向 STDOUT 时的 UnicodeEncodeError。"
110 |
111 | #: ../../CHANGES:45
112 | msgid "0.9.2"
113 | msgstr ""
114 |
115 | #: ../../CHANGES:47
116 | msgid ""
117 | "Feature: added support for `Custom Parsers "
118 | "`_."
120 | msgstr ""
121 | "Feature: 添加 `自定义解释器 "
122 | "`_ 特性。"
124 |
125 | #: ../../CHANGES:49
126 | msgid "0.9.1"
127 | msgstr ""
128 |
129 | #: ../../CHANGES:51
130 | msgid ""
131 | "New Syntax: `New-style Python Blocks "
132 | "`_."
133 | msgstr ""
134 | "新语法： `新式 Python 代码块 `_."
136 |
137 | #: ../../CHANGES:55
138 | msgid "0.9.0"
139 | msgstr ""
140 |
141 | #: ../../CHANGES:57
142 | msgid ""
143 | "Change: Pyramid adapter now relies on Pyramid>=1.5a2 and "
144 | "pyramid_mako>=0.3.1."
145 | msgstr "变动：Pyramid 适配器现在依赖于 Pyramid>=1.5a2 以及 pyramid_mako>=0.3.1 。"
146 |
147 | #: ../../CHANGES:58
148 | msgid "Change: The package now depends on Mako>=0.9.0."
149 | msgstr "变动：Plim 现在需要 Mako>=0.9.0 支持。"
150 |
151 | #: ../../CHANGES:59
152 | msgid "Change: Sass/Scss extension now requires PyScss>=1.2.0.post3."
153 | msgstr "变动： Sass/Scss 扩展现在需要 PyScss>=1.2.0.post3 。"
154 |
155 | #: ../../CHANGES:61
156 | msgid ""
157 | "Change: Pyramid adapter's ``plim.file_extension`` configuration option is "
158 | "deprecated."
159 | msgstr "变动：Pyramid 适配器的 ``plim.file_extension`` 设置选项已被标记为不推荐使用。"
160 |
161 | #: ../../CHANGES:61
162 | msgid ""
163 | "The ``config.add_plim_renderer()`` `directive is provided instead "
164 | "`_."
165 | msgstr ""
166 | "``config.add_plim_renderer()`` 已 `被替换 "
167 | "`_ 。"
168 |
169 | #: ../../CHANGES:64
170 | msgid "Version 0.8"
171 | msgstr ""
172 |
173 | #: ../../CHANGES:66
174 | msgid "0.8.9"
175 | msgstr ""
176 |
177 | #: ../../CHANGES:68
178 | msgid "Bugfix: Use sys.maxsize instead of unavailable sys.maxint on Python 3."
179 | msgstr ""
180 |
181 | #: ../../CHANGES:70
182 | msgid "0.8.8"
183 | msgstr ""
184 |
185 | #: ../../CHANGES:72
186 | msgid ""
187 | "Hotfix: Make Plim working with a development version of pyScss for "
188 | "Python-3.x setups."
189 | msgstr ""
190 |
191 | #: ../../CHANGES:74
192 | msgid "0.8.7"
193 | msgstr ""
194 |
195 | #: ../../CHANGES:76
196 | msgid ""
197 | "Bugfix: Pyramid adapter is now compatible with the 1.5a2+ version of the "
198 | "framework."
199 | msgstr ""
200 |
201 | #: ../../CHANGES:78
202 | msgid ""
203 | "Change: `default template file extension "
204 | "`_"
205 | msgstr ""
206 |
207 | #: ../../CHANGES:78
208 | msgid "used in pyramid bindings is changed from \".plm\" to \".plim\"."
209 | msgstr ""
210 |
211 | #: ../../CHANGES:80
212 | msgid "0.8.6"
213 | msgstr ""
214 |
215 | #: ../../CHANGES:82
216 | msgid "Hotfix: fixed assertion error in handlebars parser."
217 | msgstr ""
218 |
219 | #: ../../CHANGES:84
220 | msgid "0.8.5"
221 | msgstr ""
222 |
223 | #: ../../CHANGES:86
224 | msgid ""
225 | "Feature: added support for `Handlebars blocks "
226 | "`_."
227 | msgstr ""
228 |
229 | #: ../../CHANGES:88
230 | msgid "0.8.4"
231 | msgstr ""
232 |
233 | #: ../../CHANGES:90
234 | msgid "Hotfix: updated links to github."
235 | msgstr ""
236 |
237 | #: ../../CHANGES:92
238 | msgid "0.8.3"
239 | msgstr ""
240 |
241 | #: ../../CHANGES:94
242 | msgid ""
243 | "Hotfix: prevent lexer from parsing embedded markup inside ``style`` and "
244 | "``script`` blocks."
245 | msgstr ""
246 |
247 | #: ../../CHANGES:96
248 | msgid "0.8.2"
249 | msgstr ""
250 |
251 | #: ../../CHANGES:98
252 | msgid ""
253 | "Feature: added support for `Embedded Markup "
254 | "`_."
255 | msgstr ""
256 |
257 | #: ../../CHANGES:99
258 | msgid "Feature: plimc utility is now able to output plain HTML."
259 | msgstr ""
260 |
261 | #: ../../CHANGES:101
262 | msgid "0.8.1"
263 | msgstr ""
264 |
265 | #: ../../CHANGES:103
266 | msgid ""
267 | "Feature: added support for `Inline Statements "
268 | "`_."
269 | msgstr ""
270 |
271 | #: ../../CHANGES:105
272 | msgid "0.8.0"
273 | msgstr ""
274 |
275 | #: ../../CHANGES:107
276 | msgid ""
277 | "Feature: added support for dynamic attributes unpacker (an equivalent to "
278 | "Slim's splat attributes)."
279 | msgstr ""
280 |
281 | #: ../../CHANGES:111
282 | msgid "Version 0.7"
283 | msgstr ""
284 |
285 | #: ../../CHANGES:113
286 | msgid "0.7.14"
287 | msgstr ""
288 |
289 | #: ../../CHANGES:115
290 | msgid "Hotfix: fixed bug with unicode handling."
291 | msgstr ""
292 |
293 | #: ../../CHANGES:117
294 | msgid "0.7.13"
295 | msgstr ""
296 |
297 | #: ../../CHANGES:119
298 | msgid "Hotfix: fixed bug with static unicode attributes."
299 | msgstr ""
300 |
301 | #: ../../CHANGES:121
302 | msgid "0.7.12"
303 | msgstr ""
304 |
305 | #: ../../CHANGES:123
306 | msgid ""
307 | "Unnecessary newline characters at the end of literal blocks have been "
308 | "removed."
309 | msgstr ""
310 |
311 | #: ../../CHANGES:124
312 | msgid "Added the command-line tool ``plimc``."
313 | msgstr ""
314 |
315 | #: ../../CHANGES:126
316 | msgid "0.7.11"
317 | msgstr ""
318 |
319 | #: ../../CHANGES:128
320 | msgid ""
321 | "Fixed bug that had to do with incorrect parsing of multi-line dynamic class "
322 | "attributes."
323 | msgstr ""
324 |
325 | #: ../../CHANGES:129
326 | msgid ""
327 | "Fixed bug that had to do with passing incorrect data to plim parser in babel"
328 | " adapter."
329 | msgstr ""
330 |
331 | #: ../../CHANGES:131
332 | msgid ""
333 | "0.7.10 Fixed bug with unicode error in python block. Thanks to "
334 | "sqrabs@github!"
335 | msgstr ""
336 |
337 | #: ../../CHANGES:134
338 | msgid "0.7.9 Added babel message extraction plugin."
339 | msgstr ""
340 |
341 | #: ../../CHANGES:137
342 | msgid ""
343 | "0.7.8 Expanded range of possible numeric values that don't require double-"
344 | "quoting."
345 | msgstr ""
346 |
347 | #: ../../CHANGES:140
348 | msgid "0.7.7"
349 | msgstr ""
350 |
351 | #: ../../CHANGES:142
352 | msgid "Fixed bug with linebreaks without trailing newline character."
353 | msgstr ""
354 |
355 | #: ../../CHANGES:143
356 | msgid ""
357 | "Fixed bug with missing explicit whitespace after ``=,`` and ``==,`` line "
358 | "indicators."
359 | msgstr ""
360 |
361 | #: ../../CHANGES:145
362 | msgid "0.7.6 Fixed bug with incorrect parsing of static boolean attributes."
363 | msgstr ""
364 |
365 | #: ../../CHANGES:148
366 | msgid ""
367 | "0.7.5 Fixed bug with comment and content blocks separated by empty lines."
368 | msgstr ""
369 |
370 | #: ../../CHANGES:151
371 | msgid "0.7.4 Added -stylus extension."
372 | msgstr ""
373 |
374 | #: ../../CHANGES:154
375 | msgid "0.7.3 Fix bug with literal one-liners."
376 | msgstr ""
377 |
378 | #: ../../CHANGES:157
379 | msgid "0.7.1 Fixed installation error caused by missing README.rst."
380 | msgstr ""
381 |
382 | #: ../../CHANGES:160
383 | msgid "0.7.0 Initial public release."
384 | msgstr ""
385 |
386 | #: ../../CHANGES:52
387 | msgid ""
388 | "New Syntax: `New-style Module-level Blocks "
389 | "`_."
391 | msgstr ""
392 | "新语法： `模块级代码块的新式写法 `_ 。"
394 |
395 |
--------------------------------------------------------------------------------
/docs/extensions.rst:
--------------------------------------------------------------------------------
1 | Extensions
2 | ===========
3 |
4 | Standard extensions
5 | -------------------
6 |
7 | CoffeeScript
8 | ~~~~~~~~~~~~
9 |
10 | Plim uses `Python-CoffeeScript `_ package
11 | as a bridge to the JS `CoffeeScript `_ package to translate
51 | `SCSS/SASS `_ package to translate
86 | `stylus `_ package
130 | for the ``-markdown`` (or ``-md``) extension.
131 |
132 | For example,
133 |
134 | .. code-block:: plim
135 |
136 | - markdown
137 | A First Level Header
138 | ====================
139 |
140 | A Second Level Header
141 | ---------------------
142 |
143 | Now is the time for all good men to come to
144 | the aid of their country. This is just a
145 | regular paragraph.
146 |
147 | The quick brown fox jumped over the lazy
148 | dog's back.
149 |
150 | ### Header 3
151 |
152 | > This is a blockquote.
153 | >
154 | > This is the second paragraph in the blockquote.
155 | >
156 | > ## This is an H2 in a blockquote
157 |
158 |
159 | produces
160 |
161 | .. code-block:: html
162 |
163 |
217 |
218 |
248 |
249 |
250 | Handlebars
251 | ~~~~~~~~~~
252 |
253 | Plim supports a special tag ``handlebars`` that is translated to a handlebars section declaration:
254 |
255 | .. code-block:: html
256 |
257 |
258 |
259 |
260 | This is particularly useful to developers using `Ember.js https?://[^>]+)+\s+>\s+(?P.*)')
308 |
309 |
310 | def parse_http_link(indent_level, current_line, matched, source, syntax):
311 | url = matched.group('url')
312 | url_title = matched.group('title')
313 | rt = '<a href="{}">{}</a>'.format(url, url_title)
314 | return rt, indent_level, '', source
315 |
316 |
317 | CUSTOM_PARSERS = [
318 | (PARSE_HTTP_LINKS_RE, parse_http_link)
319 | ]
320 |
321 |
322 | custom_preprocessor = preprocessor_factory(custom_parsers=CUSTOM_PARSERS, syntax='mako')
323 |
324 |
325 | The ``parse_http_link()`` function is defined according to the strict API.
326 |
327 | Every parser accepts five input arguments:
328 |
329 | 1) ``indent_level`` - an indentation level of the current line. When the parser reaches a line
330 | which indentation is lower or equal to ``indent_level``, it returns control to a top-level function.
331 | 2) ``current_line`` - a line which is being parsed. This is the line that has been matched by
332 | ``matched`` object at the previous parsing step.
333 | 3) ``matched`` - an instance of :class:`re.MatchObject` of the regex associated with the current parser.
334 | 4) ``source`` - an instance of an enumerated object returned by :func:`plim.lexer.enumerate_source`.
335 | 5) ``syntax`` - an instance of one of :class:`plim.syntax.BaseSyntax` children.
336 |
337 | Every parser returns a 4-tuple of:
338 |
339 | 1) parsed_data - a string of successfully parsed data
340 | 2) tail_indent - an indentation level of the ``tail line``
341 | 3) tail_line - a line which indentation level (``tail_indent``) is lower or equal to
342 | the input ``indent_level``.
343 | 4) ``source`` - an instance of enumerated object returned by :func:`plim.lexer.enumerate_source`
344 | which represents the remaining (untouched) plim markup.
345 |
346 |
347 | From now on, we can use ``custom_preprocessor`` in exactly the same manner as the standard
348 | ``plim.preprocessor``.
349 |
350 | Let's create a plim document with extended syntax:
351 |
352 | .. code-block:: plim
353 | :linenos:
354 |
355 | / hamilton.plim
356 | ---------------
357 | html
358 | head:title Alexander Hamilton
359 | body
360 | h1 Alexander Hamilton
361 | ul
362 | li: http://en.wikipedia.org/wiki/Alexander_Hamilton > Wikipedia Article
363 | li: http://www.amazon.com/Alexander-Hamilton-Ron-Chernow/dp/0143034758 > Full-length Biography
364 |
365 | Here is how we can compile this document into a valid HTML (note the ``-p`` argument):
366 |
367 | .. code-block:: bash
368 |
369 | $ plimc -H -p my_module:custom_preprocessor hamilton.plim
370 |
371 | The result:
372 |
373 | .. code-block:: html
374 | :linenos:
375 |
376 | <html>
377 | <head>
378 | <title>Alexander Hamilton
379 |
380 |
381 |
14 |
15 | -include profile.html
16 |
17 | /-------------------------------------
18 | ${test.variable}
19 | (${test.variable})
20 | {${test.variable}}
21 | [${test.variable}]
22 |
23 | ——
24 | 0
25 | 1.
26 | 2.
27 | 2.1
28 | 3 -
29 | 4)
30 |
31 | / -----------------------------------------------
32 | Test non-ASCII one-liners and capitalized words
33 | -----------------------------------------------
34 | Abcde
35 | абвгд
36 | Ö
37 | 汉语/漢語
38 | / -----------------------------------------------
39 | Test implicit literals
40 | -----------------------------------------------
41 | This is a test
42 | of implicit literal.
43 | You must capitalize the first letter
44 | and then indent each following line to make it working.
45 |
46 | если строки вашего текста начинается с символа, не входящего
47 | в состав ASCII-символов в диапазоне от 33 до 126,
48 | то вы можете смело оставлять их "как есть".
49 |
50 |
113 | p Mix raw HTML and Plim markup
114 |
115 |
116 | -md
117 | Use Markdown
118 | ============
119 |
120 | See the syntax on [this page][1].
121 |
122 | [1]: http://daringfireball.net/projects/markdown/basics
123 |
124 | -rest
125 | or Use reStructuredText
126 | =======================
127 |
128 | See the syntax on `this page`_.
129 |
130 | .. _this page: http://docutils.sourceforge.net/docs/user/rst/quickref.html
131 |
132 |
133 | -if items
134 | table: -for item in items: tr
135 | td = item.name
136 | td = item.price
137 | -elif show_empty
138 | p No items found
139 | -else
140 | a href=request.route_url('items.add') =, _('Add items')
141 |
142 | -unless user.authenticated
143 | p Please, sign in.
144 | -else
145 | p Welcome, ${user.name}!
146 | ul
147 | --- i = 0
148 | limit = 5
149 |
150 | -while i < limit
151 | li#idx-${i}.up: a href='#' title="Title" == i
152 | --- i += 1
153 |
154 | -until i < 0
155 | li#idx-${i}.down-${i}: a href='''#''' title="""Title""" ==, i
156 | --- i -= 1
157 |
158 | #footer
159 | Copyright © 2014.
160 | -include footer_links.html
161 |
162 | = render('tracking_code')
163 |
164 |
165 | Main Documentation
166 | ===================
167 |
168 | .. toctree::
169 | :maxdepth: 3
170 |
171 | syntax
172 | differences
173 | extensions
174 | frameworks
175 | cli
176 | license
177 | authors
178 | related
179 | changes
180 |
181 |
182 | Indices and tables
183 | ==================
184 |
185 | * :ref:`genindex`
186 | * :ref:`modindex`
187 | * :ref:`search`
188 |
189 |
--------------------------------------------------------------------------------
/CHANGES:
--------------------------------------------------------------------------------
1 | Changelog
2 | ================
3 |
4 | 1.0.0
5 | -----
6 |
7 | - Dropped support for Python 2.x
8 | - Test suite switched from Nose to Pytest
9 | - CI switched from Travis CI to Github Actions
10 |
11 | Version 0.9
12 | -------------
13 |
14 | - 0.9.12
15 |
16 | - Feature: dashes are now allowed in html tag names.
17 |
18 | - 0.9.11
19 |
20 | - Hotfix: Fix incorrect parsing of templates with windows-style newlines (CR+LF).
21 |
22 | - 0.9.10
23 |
24 | - Hotfix: Fix ``plimc``'s inability to find a custom preprocessors module in the current working dir.
25 |
26 | - 0.9.9
27 |
28 | - Hotfix: Fix UnicodeEncodeError in ``-def`` blocks with unicode strings as default argument values.
29 |
30 | - 0.9.8
31 |
32 | - Change: Stylus extension no longer depends on the ``nib`` package.
33 |
34 | - 0.9.7
35 |
36 | - Hotfix: Include requirements.txt into the distribution.
37 |
38 | - 0.9.6
39 |
40 | - Hotfix: Conditional statements parser now can handle strings containing inline tag separator sequences (#27).
41 |
42 | - 0.9.5
43 |
44 | - Hotfix: Fix ``plimc`` unicode decoding regression introduced by the previous hotfix.
45 |
46 |
47 | - 0.9.4
48 |
49 | - Hotfix: ``plimc`` no longer crashes with TypeError in Python3 environments
50 | when it writes bytes to sys.stdout.
51 |
52 | - 0.9.3
53 |
54 | - Hotfix: Fix UnicodeEncodeError in ``plimc`` when it writes to STDOUT.
55 |
56 | - 0.9.2
57 |
58 | - Feature: added support for `Custom Parsers A First Level Header
164 | 165 |A Second Level Header
166 | 167 |Now is the time for all good men to come to 168 | the aid of their country. This is just a 169 | regular paragraph.
170 | 171 |The quick brown fox jumped over the lazy 172 | dog's back.
173 | 174 |Header 3
175 | 176 |177 |183 | 184 | 185 | reStructuredText 186 | ~~~~~~~~~~~~~~~~ 187 | 188 | Plim uses `DocutilsThis is a blockquote.
178 | 179 |This is the second paragraph in the blockquote.
180 | 181 |This is an H2 in a blockquote
182 |
Grid table:
216 || Header 1 220 | | Header 2 221 | | Header 3 222 | |
|---|---|---|
| body row 1 227 | | column 2 228 | | column 3 229 | |
| body row 2 232 | | Cells may span columns. 233 | | |
| body row 3 236 | | Cells may span rows. 237 | |
238 |
|
| body row 4 246 | | ||
Alexander Hamilton
382 |-
383 |
- Wikipedia Article 384 |
- Full-length Biography 385 |