Commit Graph

39 Commits (bbded75c54c8e1cbcde1e0de1712d71ad370c0e9)

Author SHA1 Message Date
Brett Zamir bbded75c54 - ExtensionDocs update 2018-05-31 17:09:53 +08:00
Brett Zamir a27a5d5637 - Docs: Exclude from jsdoc firefox-extension, opera-widget, screencasts, test folders and build.html.js/rollup files
- Docs: Further JSDoc of methods
- Docs: Transfer some changes from ExtensionDocs on wiki (need to fully reconcile)
- Refactoring (minor): variadic args through ellipsis
2018-05-31 16:07:44 +08:00
Brett Zamir f2b1a1ff0c - Enhancement: Allow callback argument and return promise
for canvas methods: `rasterExport` and `exportPDF`
2018-05-30 16:47:43 +08:00
Brett Zamir 41201cf452 - Docs: Reference JSDocs in README
- Docs (ReleaseInstructions): Clarify README changing; lbs
2018-05-30 11:40:55 +08:00
Brett Zamir df69ba2b72 - Move jsdoc output to public directory so may be visible on releases (while still having in a `.gitignore`) 2018-05-30 11:32:56 +08:00
Brett Zamir f1bdd668c6 - Docs (ReleaseInstructions): Avoid referencing binary files for now;
include mention of ES6 Module HTML file and need to copy
    config files (without `.git`/`.gitignore` files); mention reviewing
    Github release format
2018-05-30 11:16:54 +08:00
Brett Zamir 3b04fe0c63 - Docs: Add README link to pre-release
- Docs (ReleaseInstructions): Comment out Makefile-related instructions for now and
    add to-dos (README referencing current version and `package-lock.json`, tagging)
- npm: Bump to 3.0.0-alpha.4
2018-05-30 10:57:28 +08:00
Brett Zamir 8c9e40d349 - Breaking change: Rename config file to `svgedit-config-iife.js` (or for the module version, `svgedit-config-es.js`);
also expect one directory higher; incorporates #207 (@iuyiuy)
- Breaking change: Separate `extIconsPath` from `extPath` (not copying over icons)
- Breaking change: Don't reference `custom.css` in HTML; can instead be referenced in JavaScript through
    the config file (provided in `svgedit-config-sample-iife.js`/`svgedit-config-sample-es.js` as `svgedit-custom.css` for
    better namespacing); incorporates #207 (@iuyiuy)
- Breaking change: Remove minified jgraduate/spinbtn files (minified within Rollup routine)
- Fix: Zoom when scrolled; incorporates #169 (@AndrolGenhald), adapting for conventions; also allow avoidance when shift key pressed
- Fix: Update Atom feed reference in HTML
- Fixes related to recent commits: Some path and method name fixes needed, function order, missing methods, variable scope declaration, no need for DOMContentLoaded listeners in modules, switch back to non-default export, avoid trimming nullish, deal with mock tests, fix `math.matrixMultiply`, use jquery-svg where needed for array/SVG attributes; add babel-polyfill and defer script to imagelib; other misc. fixes
- Enhancement: Move config-sample.js out of `editor` directory
- Enhancement: For `callback`-style extensions, also provide config object; add following
   to that object: buildCanvgCallback, canvg, decode64, encode64, executeAfterLoads, getTypeMap, isChrome, ieIE, NS, text2xml
- Enhancement: Complete ES6 modules work (extensions, locales, tests), along with Babel;
    make Node build routine for converting modular source to non-modular,
    use `loadStylesheets` for modular stylehsheet defining (but parallel loading);
- Enhancement: Add `stylesheets` config for modular but parallel stylesheet loading with `@default` option for simple inclusion/exclusion of defaults (if not going with default).
- Refactoring: Clean up `svg-editor.html`: consistent indents; avoid extra lbs, avoid long lines
- Refactoring: Avoid embedded API adding inline JavaScript listener
- Refactoring: Move layers and context code to `draw.js`
- Refactoring: Move `pathActions` from `svgcanvas.js` (though preserve aliases to these methods on `canvas`) and `convertPath` from `svgutils.js` to `path.js`
- Refactoring: Move `getStrokedBBox` from `svgcanvas.js` (while keeping an alias) to `svgutils.js` (as `getStrokedBBoxDefaultVisible` to avoid conflict with existing)
- Docs: Remove "dependencies" comments in code except where summarizing role of jQuery or a non-obvious dependency
- Refactoring/Linting: Enfore `no-extra-semi` and `quote-props` rules
- Refactoring: Further avoidance of quotes on properties (as possible)
- Refactoring: Use `class` in place of functions where intended as classes
- Refactoring: Consistency and granularity in extensions imports
- Testing: Update QUnit to 2.6.1 (node_modules) and Sinon to 5.0.8 (and add sinon-test at 2.1.3) and enforce eslint-plugin-qunit linting rules; update custom extensions
- Testing: Add node-static for automating (and accessing out-of-directory contents)
- Testing: Avoid HTML attributes for styling
- Testing: Add npm `test` script
- Testing: Comment out unused jQuery SVG test
- Testing: Add test1 and svgutils_performance_test to all tests page
- Testing: Due apparently to Path having not been a formal class, the test was calling it without `new`; refactored now with sufficient mock data to take into account it is a class
- npm: Update devDeps
- npm: Add html modules and config build to test script
2018-05-25 20:03:14 +08:00
Brett Zamir ae2394f086 (INCOMPLETE: ES6 Module conversion and linting)
- Breaking change: Require `new` with `EmbeddedSVGEdit` (allows us to use `class` internally)
- Breaking change: If `svgcanvas.setUiStrings` must now be called if not using editor in order
    to get strings (for sake of i18n) (and if using path.js alone, must also have its `setUiStrings` called)
- Breaking change (ext-overview-window): Avoid global `overviewWindowGlobals`
- Breaking change (ext-imagelib): Change to object-based encoding for namespacing of
    messages (though keep stringifying/parsing ourselves until we remove IE9 support)
- Breaking change: Rename `jquery.js` to `jquery.min.js`
- Breaking change: Remove `scoped` attribute from `style`; it is now deprecated and
    obsolete; also move to head (after other stylesheets)
- Enhancement: Make SpinButton plugin independent of SVGEdit via
    generic state object for tool_scale
- Enhancement: Remove now unused Python l10n scripts (#238)
- Enhancement: ES6 Modules (including jQuery plugins but not jQuery)
- Enhancement: Further JSDoc (incomplete)
- Enhancement (Optimization): Compress images using imageoptim (and add
    npm script) (per #215)
- Fix: i18nize path.js strings and canvas notifications
- Fix: Attempt i18n for ext-markers
- Refactoring (ext-storage): Move locale info to own file imported by the extension (toward modularity; still should be split into separate files by language and *dynamically* imported, but we'll wait for better `import` support to refactor this)
- Refactoring: For imagelib, add local jQuery copy (using old 1.4.4 as had
    been using from server)
- Refactoring: For MathJax, add local copy (using old 2.3 as had been using from
    server); server had not been working
- Refactoring: Remove `use strict` (implicit in modules)
- Refactoring: Remove trailing whitespace, fix some code within comments
- Refactoring: Expect `jQuery` global rather than `$` for better modularity
    (also to adapt line later once available via `import`)
- Refactoring: Prefer `const` (and then `let`)
- Refactoring: Add block scope keywords closer to first block in which they appear
- Refactoring: Use ES6 `class`
- Refactoring `$.isArray` -> `Array.isArray` and avoid some other jQuery core methods
    with simple VanillaJS replacements
- Refactoring: Use abbreviated object property syntax
- Refactoring: Object destructuring
- Refactoring: Remove `uiStrings` contents in svg-editor.js (obtains from locale)
- Refactoring: Add favicon to embedded API file
- Refactoring: Use arrow functions for brief functions (incomplete)
- Refactoring: Use `Array.prototype.includes`/`String.prototype.includes`;
    `String.prototype.startsWith`, `String.prototype.trim`
- Refactoring: Remove now unnecessary svgutils do/while resetting of variables
- Refactoring: Use shorthand methods for object literals (avoid ": function")
- Refactoring: Avoid quoting object property keys where unnecessary
- Refactoring: Just do truthy/falsey check for lengths in place of comparison to 0
- Refactoring (Testing): Avoid jQuery usage within most test files (defer script,
    also in preparation for future switch to ES6 modules for tests)
- Refactoring: Make jpicker variable declaration indent bearable
- Refactoring (Linting): Finish svgcanvas.js
- Docs: Mention in comment no longer an entry file as before
- Docs: Migrate old config, extensions, and FAQ docs
- Licensing: Indicate MIT is license type of rgbcolor; rename/add license file name for
    jgraduate and screencast to reflect type (Apache 2.0); rename file to reflect it
    contains license information (of type MIT) for Raphael icons
2018-05-22 18:02:57 +08:00
Brett Zamir 1f3b8dad52 - Apply tabs->4 spaces to Markdown code and remove extra WS (more like ESLint "standard")
- Apply spaces in README (now tabs confined to Python, Makefile, chrome.manifest, vendor code, and few test files for formatting)
2018-05-18 14:57:02 +08:00
Brett Zamir dc6ab72480 - Update Opera and jQuery links
- Use `https://` (fix #172), including in prompt for URL and relevant code comments (where available and naturally not on namespaces)
- Comment out broken link in svg-editor.html
- Trailing space
2018-05-18 13:48:47 +08:00
Brett Zamir a3b3525789 - Linting (ESLint): Finish
- Fix: Globals (x, y) in `mouseMove`
- Fix: Global (element, d_attr->dAttr) in `mouseDown`
- Fix: Avoid `drawnPath` not defined error
- Docs: sp.
2018-05-17 11:34:21 +08:00
Brett Zamir 38d6274723 - Linting (HTML): Use double-quotes for attributes, remove redundant `type=text/css`,
indent/lbs, consistent non-use of HTML namespace, consistent indents, consistent charset
    casing
- Linting (Markdown): Add `.remarkrc`, use proper hierarchical headings, use consistent
    heading format, trailing spaces
- `composer.json`: consistent property spacing
- License: Add `.txt` extension, update copyright date, and reflect type (MIT) in file name
- Credits: Add self
- npm: Add `package.json` (version 3.0.0-alpha.1 for npm release only; just reserving name)
2018-05-13 09:58:13 +08:00
Chris DeLuca a80467c5d8
Fix documentation markdown
Github changed it's markdown parser, requiring a space between the hash and the text for headings.
2017-08-03 19:49:39 -04:00
Dennis Y. Parygin b7c52fad75 Add complete markdown converted SvgCanvas documentation 2016-03-24 17:52:33 +05:00
Philip Rogers f6005d6ac5 Update instructions to use binary attachments
Instead of storing compressed zip and tar.gz files on gh-pages, just link directly to them from the releases page (https://github.com/progers/svgedit/releases).
2015-11-24 18:41:38 -08:00
Philip Rogers 25900663cb Migrate Acknowledgements to markdown docs
This file has been manually converted to markdown from https://code.google.com/p/svg-edit/wiki/Acknowledgements. A few urls have been updated but there are otherwise no changes.
2015-11-24 17:18:23 -08:00
Philip Rogers b0f1cee47a Create ReleaseInstructions.md 2015-11-24 16:53:55 -08:00
Philip Rogers 98523876f3 Remove outdated SvgCanvas docs 2015-11-24 16:14:34 -08:00
Brett Zamir fc41825010 Convert remaining eval()-ish items in repo
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@2586 eee81c28-f429-11dd-99c0-75d572ba1ddd
2013-10-14 00:00:40 +00:00
Brett Zamir d625e03e89 Remove unnecessary eval() dependency for tooltip hiding (also removed in commented out portion) (though this commit does not convert string-based setTimeout's into function-based ones)
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@2572 eee81c28-f429-11dd-99c0-75d572ba1ddd
2013-10-12 00:04:22 +00:00
Alexis Deveria f679554ce4 Added extension to offer server-based import/open ability to browsers without File API support
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1621 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-07-01 20:14:12 +00:00
Alexis Deveria d96ddad902 More wacky internal changes and documentation updates
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1620 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-30 18:27:36 +00:00
Alexis Deveria 3d351fa0c7 More optimization/docs work
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1619 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-29 20:43:44 +00:00
Alexis Deveria a9b2010b28 Optimized some stroke/fill functions, more documentation
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1618 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-28 20:09:34 +00:00
Alexis Deveria 00ef6f5d74 Fixed issue 587, more code reorganization/documentation
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1617 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-28 13:10:22 +00:00
Alexis Deveria 42dd162ffe More code reorganization/documentation
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1616 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-22 18:17:42 +00:00
Alexis Deveria 63407c7542 Removed code for Opera/Win/Non-en bugs that were fixed in Opera 10.50. More code reorganization
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1615 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-22 14:52:51 +00:00
Alexis Deveria 93b509dd8e Reorganized undo related functions, added more docs, updated German lang file
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1612 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-21 18:06:21 +00:00
Alexis Deveria 4cd1fbf995 More internal code improvements/documentation
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1610 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-21 15:05:41 +00:00
Alexis Deveria e420c6beba More documentation changes
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1609 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-18 21:02:44 +00:00
Alexis Deveria f561211268 Start of new thorough code documentation effort
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@1607 eee81c28-f429-11dd-99c0-75d572ba1ddd
2010-06-18 20:35:47 +00:00
Jeff Schiller 22bac1eac5 Refresh API docs
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@827 eee81c28-f429-11dd-99c0-75d572ba1ddd
2009-10-14 05:21:40 +00:00
Jeff Schiller 87811c0fb8 More tweaking to the Layers panel. Added some missing API doc files.
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@820 eee81c28-f429-11dd-99c0-75d572ba1ddd
2009-10-14 02:50:07 +00:00
Jeff Schiller 91d450b5cb More SvgCanvas API docs updates
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@811 eee81c28-f429-11dd-99c0-75d572ba1ddd
2009-10-13 02:48:27 +00:00
Jeff Schiller 588902cecf More API Docs updates
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@810 eee81c28-f429-11dd-99c0-75d572ba1ddd
2009-10-13 02:35:36 +00:00
Jeff Schiller 47852b96a0 Updated API docs
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@809 eee81c28-f429-11dd-99c0-75d572ba1ddd
2009-10-13 01:40:38 +00:00
Jeff Schiller 8afac891c9 Correction to Makefile to remove naturaldocs config directory, not docs directory. Add main index.html doc file for API
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@790 eee81c28-f429-11dd-99c0-75d572ba1ddd
2009-10-09 19:15:18 +00:00
Jeff Schiller 469fc09f65 Starter documentation
git-svn-id: http://svg-edit.googlecode.com/svn/trunk@789 eee81c28-f429-11dd-99c0-75d572ba1ddd
2009-10-09 19:08:59 +00:00