Skip to content

Add notes on limitations and trade-off, and cache busting #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 16, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions spelling_word_list.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
backtrace
Bing
Blackshaw
contenteditable
de
fallback
Flysystem
filesystem
foo
foobar
Google
hotfix
Jonge
Expand Down
12 changes: 8 additions & 4 deletions symfony/edit-in-place.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
Symfony Edit In Place
=====================

The Symfony Edit In Place feature allow to edit translations directly in the context of the page, without altering the display styles and presentation.
The Symfony Edit In Place feature allow to edit translations directly in the context of a page, without altering the display styles and presentation. It provides an easy to use interface, even in production.

Users are able to change any translated text directly on a web page, and save them to your configured translation configurations.
Users are able to change any translated text directly on the web page, and save them to the configured translation configurations.

.. figure:: /assets/image/edit-in-place-demo.gif
:width: 900px
:align: center
:alt: Demonstration of the Edit In Place feature

*Some translated string can't be translated via this feature, like HTML Input placeholder or title tag for example. The JavaScript part is using ContentTools by Anthony Blackshaw, which use the HTML contenteditable attribute.*
Limitations and trade-off
-------------------------

- Some translated string can't be translated via this feature, like HTML Input placeholder or title tag for example. The JavaScript part is using ContentTools by Anthony Blackshaw, which use the HTML contenteditable attribute;
- Upon saving, the Symfony translation cache is re-generated to allow the user to see the new content. This can be an issue on read-only deployments.

Configuration
-------------
Expand Down Expand Up @@ -39,7 +43,7 @@ Configuration
that saves the modifications you should be aware of the following:

- The routes **must** be in a protected area of your application
- The routes **must** be in the production routing file if you want allow real users to use the feature.
- The routes **should** be in the production routing file if you want allow real users to use the feature.


.. note::
Expand Down