You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Sep 11, 2019. It is now read-only.
We should not require developers to put whole HTML content in the file.
We should limit it only to the sample content itself.
eg.
<h1>Abbreviation <small>(Custom Plugin with Dialog, Context Menu and ACF)</small><aclass="documentation" href="http://docs.ckeditor.com/#!/guide/plugin_sdk_sample_1">Documentation</a></h1><p>
This sample demonstrates the <strong>Abbreviation</strong> plugin that was created in the
<ahref="http://docs.ckeditor.com/#!/guide/plugin_sdk_sample_1">Simple Plugin tutorial series</a>
from the Plugin SDK section of the <ahref="http://docs.ckeditor.com/#!/guide">CKEditor Developer's Guide</a>.
</p>
Meta Tags
I see that meta elements might be a concern. We should be able to specify meta tags at the begining.
Since we need also to provide a value for <title/> element, we might also provide a <title/> element along with meta tags, and it would be moved to <head/>.
Eventually we can use <meta name="title" content="foobar"/>, which would move foobar to <title/> element in head.
But I would stay with first proposition, because it's simpler.
Result
So at the end we would end up with a sample like:
<metaname="description" content="Abbreviation Plugin"><metaname="keywords" content="ckeditor, editor, wysiwyg, plugin, plugins, addon, add-on, timestamp, sdk, custom, development, tutorial, example, sample"><metaname="sdk-samples" content="Abbreviation plugin"><title>Abbreviation Plugin</title><h1>Abbreviation <small>(Custom Plugin with Dialog, Context Menu and ACF)</small><aclass="documentation" href="http://docs.ckeditor.com/#!/guide/plugin_sdk_sample_1">Documentation</a></h1><p>
This sample demonstrates the <strong>Abbreviation</strong> plugin that was created in the
<ahref="http://docs.ckeditor.com/#!/guide/plugin_sdk_sample_1">Simple Plugin tutorial series</a>
from the Plugin SDK section of the <ahref="http://docs.ckeditor.com/#!/guide">CKEditor Developer's Guide</a>.
</p>
That would make source files so much more readable IMHO.
The text was updated successfully, but these errors were encountered:
As discussed a few minutes ago with @mlewand, the proposed simplified structure makes sense, however we cannot proceed with it yet due to inconvenience that it would cause during the daily work on SDK.
Basically, what is the most important for us at this moment is the ability to change and quickly see the results of changes, without having to build SDK after each change, because this is a quite time consuming task. @mlewand pointed out that having a grunt watch task that is watching file changes and builds just a selected sample once it's modified would do the trick.
This is an interesting idea, however until we have all the necessary scripts that can do this, we shall continue working in the way we worked so far.
Keep samples source DRY
Sample HTML
We should not require developers to put whole HTML content in the file.
We should limit it only to the sample content itself.
eg.
Meta Tags
I see that meta elements might be a concern. We should be able to specify meta tags at the begining.
Title
Since we need also to provide a value for
<title/>
element, we might also provide a<title/>
element along with meta tags, and it would be moved to<head/>
.Eventually we can use
<meta name="title" content="foobar"/>
, which would movefoobar
to<title/>
element in head.But I would stay with first proposition, because it's simpler.
Result
So at the end we would end up with a sample like:
That would make source files so much more readable IMHO.
The text was updated successfully, but these errors were encountered: