svgedit/docs/from-old-wiki/Summer_of_Code_2010.md

159 lines
5.9 KiB
Markdown
Raw Normal View History

- Security fix: 'extPath', 'imgPath', 'extIconsPath', 'canvgPath', 'langPath', 'jGraduatePath', and 'jspdfPath' were not being prevented - Breaking change: Rename "svgutils.js" to "utilities.js" (make in conformity with JSDoc module naming convention) - Breaking change: Rename "svgedit.js" to "namespaces.js" (to make clear purpose and avoid confusing with editor) - Breaking change: Rename "jquery-svg.js" to "jQuery.attr.js" - Breaking change: Rename "jquery.contextMenu.js" to "jQuery.contextMenu.js" - Breaking change: Rename "jquery.jpicker.js" to "jQuery.jPicker.js" - Breaking change: Rename "JQuerySpinBtn.css" to "jQuery.SpinButton.css" - Breaking change: Rename "JQuerySpinBtn.js" to "jQuery.SpinButton.js" (to have file name more closely reflect name) - Breaking change: Rename "jquery.svgicons.js" to "jQuery.svgIcons.js" - Breaking change: Rename "jquery.jgraduate.js" to "jQuery.jGraduate.js" - Breaking change: Rename "pathseg.js" to "svgpathseg.js" (as it is a poyfill of SVGPathSeg) - Breaking change: Rename `addSvgElementFromJson()` to `addSVGElementFromJson` for consistency - Breaking change: Rename `changeSvgContent()` to `changeSVGContent()` for consistency - Breaking change: Have `exportPDF` resolve with `output` and `outputType` rather than `dataurlstring` (as type may vary) - Breaking change: Rename `extensions/mathjax/MathJax.js` to `extensions/mathjax/MathJax.min.js` - Breaking change: Avoid recent change to have editor ready callbacks return Promises (we're not using and advantageous to keep sequential) - Breaking change: Avoid recent addition of locale-side function in ext-imagelib for l10n - Breaking change: Change name of ext-arrows.js from `Arrows` to `arrows` for sake of file path (not localized anyways). - Breaking change: Change `addlangData` extension event to `addLangData` for consistency with method name - Breaking change: Have `readLang` return lang and data but do not call `setLang` - Fix: Have general locales load first so extensions may use - Fix: Provide `importLocale` to extensions `init` so it may delay adding of the extension until locale data loaded - Fix: Ensure call to `rasterExport` without `imgType` properly sets MIME type to PNG - Fix: Wrong name for moinsave - Update: Update WebAppFind per new API changes - Enhancement: Make `setStrings` public on editor for late setting (used by `ext-shapes.js`) - Enhancement: Add `extensions_added` event - Enhancement: Add `message` event (Relay messages including those which have been been received prior to extension load) - Enhancement: Allow SVGEdit to work out of the box--avoid need for copying sample config file. Should also help with Github-based file servers - Enhancement: Allow avoiding "name" in extension export (just extract out of file name) - Enhancement: Add stack blur to canvg by default (and refactoring it) - Enhancement: Return `Promise` for `embedImage` (as with some other loading methods) - Enhancement: Supply `importLocale` to `langReady` to facilitate extension locale loading - Enhancement: Recover if an extension fails to load (just log and otherwise ignore) - Enhancement: More i18n of extensions (also fixed issue with some console warnings about missing locale strings); i18nize Hello World too - Enhancement: Allowing importing of locales within `addLangData` - npm: Update devDeps - Docs: Migrate copies of all old wiki pages to docs/from-old-wiki folder; intended for a possible move to Markdown, so raw HTML (with formatting) was not preserved, though named links had their absolute URL links preserved - Docs: Begin deleting `SvgCanvas.md` as ensuring jsdoc has replacements - Docs: Add Edtior doc file for help to general users - Docs: Clarify/simplify install instructions - npm/Docs (JSDoc): Add script to check for overly generic types - Docs (JSDoc): For config/prefs and extension creating, link to tutorials (moved tutorials to own directory to avoid recursion problems by jsdoc) - Docs (JSDoc): Add modules (upper case for usual main entrance files or regular names) - Docs (JSDoc): Fill out missing areas; indicate return of `undefined`; consistency with `@returns` - Docs (JSDoc): Add our own layout template to support overflow - Docs (JSDoc): Use cleverLinks and disallow unknown tags - Docs (JSDoc): Insist on "pedantic" flag; put output directory in config - Docs (JSDoc): Use more precise Integer/Float over number, the specific type of array/function/object - Docs (JSDoc): Use `@throws`, `@enum`, `@event`/`@fires`/`@listens` - Docs: Generally update/improve docs (fixes #92) - Docs: Update links to `latest` path (Avoid needing to update such references upon each release) - Docs: 80 chars max - Refactoring: Drop code for extension as function (already requiring export to be an object) - Refactoring: Object destructuring, `Object.entries`, Object shorthand, array extras, more camelCase variable names - Refactoring: Add a `Command` base class - Refactoring: Simplify svgicons `callback` ready detection - Refactoring: Put `let` or `const` closer to scope - Refactoring: Remove unneeded `delimiter` from regex escaping utility - Refactoring: Clearer variable names - Refactoring: Use (non-deprecated) Event constructors - Testing: Use new Sinon
2018-06-06 07:26:20 +00:00
Introduction
This is our page of ideas for the [Google Summer of Code 2010](http://socghop.appspot.com/). If you are a student, you can participate by developing one of the projects we describe here (or propose an idea of your own!), and get paid through a stipend by Google. Read the [Google Summer of Code 2010 FAQ](http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs) for more details about the program.
Important dates
March 08 to March 12 - Mentor organization application period
March 18 - Announcement of accepted mentor organizations.
March 29 to April 09 - Student application period
April 26 - Announcement of accepted students
May 24 to August 16 - Coding period
See the [authorative timeline](http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/timeline) for more details.
Information for students
The Google Summer of Code is a program for students in most countries. You will participate by writing code for a free software project. Students who finish their work satisfactorily will get a stipend of 4500 US Dollars.
Do this if you want to participate:
Start by reading the [Google Summer of Code FAQ](http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs)
See which of the Ideas below you find interesting or come up with your own idea.
Get in contact with the community
Submit your proposal on the Google Summer of Code website
Your proposal should include this information:
Give a detailed idea of what you want to accomplish in your project. Don't just quote what the project's abstract says! Think of how you will actually implement it, and describe that.
Give a general idea of your skills. If you have participated in a free software project before, say so and if possible point to your contributions.
Give a rough timeline for your work, with milestones. For example: "week 1, get the code to build and start familiarizing myself with it. Week 2, implement the first refactoring patch. Week 3, try such and such thing."
Basically, let us know why you are the perfect person to implement the project you picked :)
Ideas
This is a list of ideas for projects which could be done as part of the Google Summer of Code program. If you have an idea and want to mentor it, please add it to the list.
If you are a student and want to work on an idea, submit a proposal. You are not limited to the ideas listed here. If you have an own idea or want to approach an idea in a completely different way, feel free to submit this as proposal as well. Sometimes these are the best projects. Creativity and initiative are highly appreciated.
Path Tool Enhancements
Required knowledge: SVG, JS, CSS, jQuery
Skill level: Advanced
Mentor: TBD
Student: TBD
Description:
add/delete arbitrary points on a path
join points/paths
continue from endpoint
click-drag makes curve/bezier point instead of corner point
simplify path algorithms
drag from lines as well as points
Objects on Path
Required knowledge: SVG, JS, CSS, jQuery
Skill level: Experienced
Mentor: TBD
Student: TBD
Description:
Multiple duplicate object/instances along a path with either evenly spaced (user configurable) or at each point on the path.
Object along Path Enhancements
Required knowledge: SVG, JS, CSS, jQuery
Skill level: Advanced
Mentor: TBD
Student: TBD
Description:
Object A is stretched along a path B.
Union/Intersection/Difference for shapes
Required knowledge: SVG, JS, CSS, jQuery
Skill level: Advanced
Mentor: TBD
Student: TBD
Description:
2 or more overlapping objects when selected are either a) Combined to make one object from the outline of both or b) Like a Venn diagram we take only the shared intersecting area or c) Take the area of the two objects that are not intersecting
Rulers/Guides/Units Enhancements
Required knowledge: SVG, JS, CSS, jQuery
Skill level: Experienced
Mentor: TBD
Student: TBD
Description:
Add rules and guides with configurable units
Bring forward/Send backward incremental
Required knowledge: SVG, JS, CSS, jQuery
Skill level: Experienced
Mentor: TBD
Student: TBD
Description:
Currently moving an object all the way forward or backward is the only option, but adding the functionality to move forward or backward one object at a time is much better.
Layer Drag and Drop Enhancement
Required knowledge: JS, CSS, jQuery
Skill level: Novice
Mentor: TBD
Student: TBD
Description:
Enable Users to move the layers around by dragging them to change the order
History Interface in Sidebar
Required knowledge: JS, CSS, jQuery
Skill level: Novice
Mentor: TBD
Student: TBD
Description:
A visual representation of the undo/redo stack with the ability to go back n number of steps at will.
Pattern Fills
Required knowledge: SVG, JS, CSS, jQuery
Skill level: Experienced
Mentor: TBD
Student: TBD
Description:
Use a pattern to define a fill pattern
Documentation Enhancements
Required knowledge: Must possess technical writing skills and experience with graphics applications is a big plus.
Skill level: Novice
Mentor: TBD
Student: TBD
Description:
User Docs and Guides
API/Extensions
{IDEA_TITLE_TO_BE_REPLACED}
Required knowledge: What does the prospective student need to know before attempting this idea?.
Skill level: How difficult would this idea be to implement if the student has the required knowledge
Mentor: Your name and contact will go here.
Student: Your name and contact will go here.
Description of idea goes here, try and be as detailed as possible.
Links
http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs'>Google Summer of Code FAQ
http://code.google.com/soc/'>Google Summer of Code main page