dreameditor.js Documentation
dreameditor.js open-source version 5.2.7
(Note: This Document is incomplete and may conatain typos/incomplete information)
Introduction:
dreameditor.js is built using open web technologies so if you can understand html CSS and JavaScript you will understand dreameditor.js source code and can take full advantage of all resources provided with dreameditorjs.zip
System requirements:
Latest version of Firefox or Chrome recommended.
Other Web Browsers may still work.
JavaScript must be enabled to use dreameditor.js
Starting dreameditor.js:
Unzip the latest version and open dreameditorjs.html inside a web browser of your choice. JavaScript must be enabled. This file can be renamed to anything you want.
Using dreameditorjs:
After launching dreameditor.js it may be used just like any other text editor. Use the file menu to save or change settings and use the workspace to edit text. Browser zoom controls can be used to zoom in and out. Desktop version supports draging text around inside of editor workspace.
Folders:
-Dreameditorengine:
Contains all logic for file menu and other services.
-Dreameditorservices:
Contains all files needed to run syntax engine.
CSS Theme settings:
dreameditor.js core CSS theme settings are located @ /dreameditorengine/theme1.css for light mode and /dreameditorengine/theme2.css for darkmode.
Edit these files to change the CSS of dreameditorjs.html page.
If these files are renamed be sure to also rename them inside the main html file (dreameditorjs.html) to load them properly.
dreameditor.js Event Listeners:
All event listeners for button clicks and other user interactions are contained @ /dreameditorengine/dreameditor.js
All application events listeners should be added to this file.
Codemirror Syntax Engine:
All files for codemirror syntax engine are contained @ /dreameditorservices Remember not to rename files here unless you change the files names in other parts of dreameditor.js code.
Custom Syntax Modes:
Custom syntax modes should be placed @ /dreameditorservices
Custom syntax mode files should also be added to html code inside dreameditorjs.html file to load them properly.
Disclaimer and Usage Notice:
Usage of dreameditor.js shows your acceptance to all agreements stated in the license @ dreameditorjs.org/license.html. blountmedia.net reserves the right to use dreameditor.js logo and name to distribute, update and maintain its own primary version. All rights to dreameditorjs.org website reserved to blountmedia.net
License Information:
To view full license visit dreameditorjs.org/license.html
Below if a brief overview of the license/agreements on that page.
-MIT License:
This applies to dreameditorjs.zip only. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
-blountmedia.net Proprietary License Information:
This applies to dreameditor.js web app, Android app, Chrome web-extension, Firefox web-extension, Proprietary license describes how blountmedia.net distributes paid or closed source applications. All proprietary software from blountmedia.net follows the same model. One time fee or sometimes free. Lifetime updates and support unless otherwise noted. No refunds can be issued on any digital software license. You also agree to never copy, change, resale or redistribute software or it's source code including but not limited to python, c, javascript, php and execution/package file distributions like .EXE & .APK files. If the software is open source these terms do not apply. You also must follow any additional terms included with any software provided by blountmedia.net. For more information about this license visit dreameditorjs.org/license.html
Important Information To Remember:
We recommend not renaming files inside dreameditorservices folder unless necessary.
Remember that changing file names will require you to change names of files inside other associated documents.
Before modifying files inside dreameditorservices we recommend viewing the code mirror documentation.
Want to submit a bug report or have a suggestion?
Visit https://blountmedia.org
Rights to use dreameditor.js logo and app name are reserved to blountmedia.net
This document is still actively being developed and will be changed and updated overtime.
Remember this document is incomplete some information may be missing or not yet documented.
All feedback and suggestions are welcome. Last updated on 9/30/2024