[ON HOLD] The Style Editor and its requirement

General discussion of development ideas and the approaches taken in the 3.x branch of phpBB. The next feature release of phpBB 3 will be 3.3/Proteus.
Forum rules
Please do not post support questions regarding installing, updating, or upgrading phpBB 3.2.x. If you need support for phpBB 3.2.x please visit the 3.2.x Support Forum on phpbb.com.

If you have questions regarding writing extensions please post in Extension Writers Discussion to receive proper guidance from our staff and community.
Post Reply
User avatar
hanakin
Front-End Dev Team Lead
Front-End Dev Team Lead
Posts: 907
Joined: Sat Dec 25, 2010 9:02 pm
Contact:

[ON HOLD] The Style Editor and its requirement

Post by hanakin »

*******NOTE THAT THIS WAS ORIGINALLY POSTED MONTHS AGO AS A GENERAL WRITE-UP TO THE TEAM****** Everything in here is posted as a starting point for disscussion, it has not been updated in a while and some things have/will change. I will update this once we get a more concrete idea of the structure of the theme. WE WILL NOT BE WORKING ON THIS UNTIL AFTER THE RELEASE OF CHAMELEON!!!!

The Editor

At its core the concept of the editor is a dynamic documentation system. In that it lets you view, manipulate, tweak, and even create individual components of the theme all within a simple to use user interface. It provides the ability to both view and modify the twig code and the CSS. Furthermore because the CSS is built using SCSS it allows for the creation and editing of variables directly on the page. Important note is that this is its own full fledged self contained app.

The Backend (Backend DEV)

Under the hood the editor will require several libraries across several different techs to make everything work. Since the editor is essentially building the page views based on reading the template files directly this requires strict formatting of the SCSS files via @ hooks. The backend can be coded in either PHP or NodeJS and really is just performing static file based DB operations using the file read/write functionality. It will read all the files and build the required API for which we can then construct the interface.

NodeJS will be required however for the build phase of the theme which is why I would prefer everyhting to be done in NodeJS or simplicity. We will need to include scss and twig(nunjucks Twig equivalent with cusstom extensions to fill in any needed gapped functionality is backend is NodeJs based) rendering in the front-end to render the scss and twig on the fly in the editor.

The structure required for the all folder is as follows
  • All
    • CSS
      • theme.css
    • JS
    • SCSS
      • settings
      • tools
      • objects
      • components
      • theme.css
    • TWIG
    • IMG
  • Second Theme
    • CSS
      • theme.css
    • JS
    • SCSS
      • objects
      • components
      • theme.scss
    • TWIG
    • IMG

Required Configuration:
  • need to be able to point to and read/write to a local phpbb install via an option? So set path for styles folder. If not then all should be provided and will not be editable!
  • needs to be installable
  • needs to be lockable in that if its setup on a server and hosted we need to be able to configure it to not be able to edit global but instead convert to theme and edit.
Required Functionality:
  • array: settings, base, objects, components, theme
  • get list of themes: (route /themes) - should ignore all folder
  • get file tree: (route /tree)
    • returns obj similar to the following
      • settings
      • base
        • each file in all/scss/base
      • objects
        • each file in all/scss/objects
      • components
        • each file in all/scss/components
      • “theme”
        • objects
          • each file in “theme”/scss/objects
        • components
          • each file in “theme”/scss/components
        • theme
          • each file in “theme/scss/theme
  • get specified scss file contents: (route /“folder”/“filename”) where folder is either all or “theme”
    • returns object like such:
      • name
      • description
      • settings
        • each layout with its value
        • each theme setting with its value
      • scss code
      • twig code from corresponding twig file (if scss file is from all folder than twig file is in all/twig, if scss file is from “theme” folder than twig file is from “theme”/twig)
  • put settings (route /update/settings)
    • updates settings in specified specified scss file
  • put name (route /update/name)
    • renames specified scss & twig file
    • updates name in header of specified scss file
  • put description (route update/description)
    • updates description in specified scss file
  • put scss (route /update/scss)
    • replaces the scss in specified scss file
  • put twig (route update/twig)
    • replaces the twig in specified twig file
  • create(name, theme, layer) (route /add)
    • makes new scss file using local generic template var for contents
    • makes new empty twig file
The Interface (Frontend DEV)

To provide all the interactivity required we will use VueJS(better than AngularJS) to handle all the AJAX based CRUD routing calls.

We will require some jquery for the scaling functionality

We will also leverage some third party libraries for the editor interface.

Additional Possible Requirements

Will probably need some mock phpbb JSON for the editor to use to render the TWIG

Hopefully I have covered everything, I will update this as the discussion/progression moves forward. I will say that the backend can be coded in php to speed up the work on it, but think that at somepoint it should be converted to node if so as its easier to work with one coding language not to mention the fact that its a front-end tool and will no doubt attract front-end devs to help maintain it.
Donations welcome via Paypal Image

User avatar
Meis2M
Registered User
Posts: 433
Joined: Fri Apr 23, 2010 10:18 am
Contact:

Re: [ON HOLD] The Editor and its requirement

Post by Meis2M »

Hello that is very well. thank you for your working.

i think you can use students of GSOC 2019 to move faster. i hope see RC versions in new year.

User avatar
david63 Online
Registered User
Posts: 287
Joined: Mon Feb 07, 2005 7:23 am
Location: Lancashire, UK

Re: [ON HOLD] The Editor and its requirement

Post by david63 »

Could the title be changed to be "Style Editor" as at first seeing it I thought that it was a Text Editor and was about WYSIWYG
David
Remember: You only know what you know -
and you do not know what you do not know!

User avatar
hanakin
Front-End Dev Team Lead
Front-End Dev Team Lead
Posts: 907
Joined: Sat Dec 25, 2010 9:02 pm
Contact:

Re: [ON HOLD] The Style Editor and its requirement

Post by hanakin »

@david63 done @Meis2M no to that it’s too complicated a project and we are no where near ready to start it.
Donations welcome via Paypal Image

Post Reply