This year Inkscape is going to participate, yet again, in Google's Summer of Code 2007. Help us come up with some solid places to innovate and push forward.

== Project Ideas ==

'''NOTE: These are the examples from 2006. They need to be adjusted.'''

=== A. PDF Export Extension ===

PDF is the most important graphic document interchange format, but Inkscape's current capability is woefully inadequate (we export to postscript and use ps2pdf). This project would focus on establishing a solid solution to this need.

An implementation approach for this would be to create a new Inkscape extension, "crs2pdf", which links to the [http://cairographics.org/ Cairo] library for [http://www.cairographics.org/manual/cairo-PDF-Surfaces.html PDF rendering] capability, and to [http://scratchcomputing.com/projects/vectorsection Vector Section] for parsing the SVG into CRS.

This work may also require making some alterations to Cairo and/or VectorSection to improve the quality of the throughput.

The tool must successfully convert at least half of the about screens used in Inkscape versions 0.35-0.44. Major kudos if you can convert all of them.

Mentor: [[EricWilhelm]]

=== B. EPS Import ===

While SVG is becoming a common format for exchanging data between graphics programs, EPS is currently much more common. Inkscape's current EPS support is flakey and poorly maintained. The plan is to switch to use of Scribus' EPS Import Library.

This project would involve creating a new Inkscape extension, "eps2crs", which links to Scribus' EPS import library and exports into the [http://scratchcomputing.com/projects/vectorsection Vector Section] CRS format.

This work may also require making some alterations to the Scribus PDF library and/or VectorSection to improve the quality of the throughput.

Mentor: [[EricWilhelm]]

=== C. Memory Optimization ===

Inkscape is a bit heavy in its memory use, and is tough to use on computers with limited RAM. This project would seek to analyze and understand Inkscape's memory usage, identify and correct major memory leaks, and decrease memory usage for typical cases by a nontrivial amount. Ultimately, the project should result in Inkscape running smoothly on lower RAM systems than currently.

Mentor: MentalGuy

=== D. Inkboard Portability ===

Last year we had a successful project to integrate the SVG online whiteboard capability, called Inkboard, into Inkscape. Unfortunately, it does not work on Windows, so many users are missing out on this capability.

This work may involve [http://svn.sourceforge.net/viewcvs.cgi/inkscape/inkscape/branches/INKBOARD_PEDRO/src/jabber_whiteboard/protocol/ formalizing and extending the Inkboard communication protocol] and [http://svn.sourceforge.net/viewcvs.cgi/inkscape/inkscape/branches/INKBOARD_PEDRO/src/jabber_whiteboard/ working on the INKBOARD_PEDRO branch])

Mentor: Ted

=== E. New Grids ===

Inkscape currently has square grids that can be snapped to. Extend this to allow other kinds of grids: Perspective, hex, iso, etc.

This will involve modifying the grid code to support the ability to have multiple kinds of grids, implementing at least 3 new grids, and adding the UI elements to allow users to make use of them.

Mentor: TBD

=== F. SVG Filters ===

Filters are a very important SVG capability, that allows giving special features to drawing objects, including shadows, blurs, etc. Inkscape currently does not support this capability, but it's high on the list of desires.

This project would consist of two parts: (1) adding a SPObject for filters and CSS support for referencing them; (2) adding renderer support for doing the actual filter effects when rendering. Completing this project requires implementing at least one filter, 'Gaussian blur' as a proof of concept.

Mentor: Bulia

=== G. Adding bitmap capabilities to Inkscape ===

While the purpose of Inkscape is to be a vector editor, design in the real world requires dealing with bitmaps too. Inkscape can import the bitmaps, and have them as full canvas objects, but there is no significant bitmap operations in Inkscape. While there is no reason for Inkscape to replicate the functionality of The GIMP, it would be desirable to have a few simple operations available from Inkscape.

This project will use the Inkscape extensions system to add a series of bitmap effects. The majority of the effects will be achieved through the integration of the ImageMagick bitmap handling libraries. GIMP may be another source. These effects can then be run on bitmap graphics within Inkscape.

The work should be encapsulated in such a way that in theory, other vector graphics applications (such as Xara), could also use the work. However, for the scope of this project we only require demonstration of the capabilities in Inkscape.

Project Timeline:

* Implement first effect. This involves building Inkscape, linking in ImageMagick and getting one effect written (6 weeks)
* Implement remaining effects within ImageMagick (3 weeks)
* Build a test suite for operations and complete all Doxygen documentation of code (3 weeks)

Mentor: Ted

=== H. Inkscape / GIMP Bitmap Editing Integration ===

Currently, you can embed raster/bitmap images into Inkscape drawings, but editing them is a bit of a hassle because Inkscape isn't really "aware" of external bitmap editing tools.

This project would seek to correct this by modifying inkscape's image embedding code to interoperate more directly with external bitmap programs. For instance, there would be an "open external editor" command that could be used when one or more bitmap images are selected. Another idea would be to include some common bitmap modification commands from the external program, that can be run entirely within Inkscape. A third idea is drag and drop of selections from the bitmap editor to Inkscape, and SVG selections from Inkscape to the bitmap tool.

As a proof of concept, the result should demonstrate this interoperability with GIMP. Note that the code should be developed such that in theory it should work with any bitmap editor, but we would only require demonstration of working with GIMP.

Also see: http://sourceforge.net/tracker/index.php?func=detail&aid=862655&group_id=93438&atid=604309

Mentor: TBD

=== I. Text Tool Improvements ===

Inkscape's text tool is handy, but still lacks many of the niceties that users would like. This project would seek to address this by implementing various improvements that users have requested.

Some ideas for improvements:
* Make flowed text respect the default style of the text tool
* when flowing a text which already contains line breaks, provide a way for the line breaks to be conserved.
* when the style selected in the the Text and Font dialog is applied it erases any other style applied to some part of the text (like italics on some words, bold on others...), it would also be better to keep them where appropriate.
* Search through the Inkscape RFE list for other text and font improvement ideas

See: http://valessio.ul-jb.org/projetos/inkscape/inkscribus.htm

Mentor: TBD

=== J. Color Adjustment Dialog ===

Currently, it is possible to select, say, 12 objects in the drawing and set them to the same color/gradient/pattern. This project would go a step further, allowing multiple objects of differing color to have aspects of their color (such as brightness/contrast, HSL, etc.) altered, and to operate on vector objects with different fill styles (flat, gradient, or pattern fills), and to bitmaps.

Mentor: Bulia

=== K. External CSS Support ===

Inkscape currently has good support for inline CSS, and limited read-only support for an internal stylesheet in a <style> element, and no support for external stylesheets. Support for editing non-inline CSS would allow better expressiveness and adaptation, and smaller SVG files, and better support for SVG generated by other programs that use non-inline CSS.

Mentor: Peter Moulder

=== L. Bucket fill tool ===

This feature provides a new tool that generates a vector object with the desired color. This would allow, for example, the artist to draw a set of intersecting lines, and paint the blank spaces in between.

Two approaches have been proposed: The first would render the current image to a in-memory bitmap, perform a flood-fill (borrow the algorithm e.g. from Gimp), then trace the result and insert the resulting vector object into the drawing. The second would strive to detect the surrounding vector objects and perform a boolean path operation to construct a matching shape with the desired fill. Both approaches have their pros and cons; please select either and explain why you wish to do it that way, and how you would do it.

More discussion is available here: http://sourceforge.net/tracker/index.php?func=detail&aid=1123138&group_id=93438&atid=604309

Mentor: Bulia

=== M. Justified Text ===

The lack of this feature is perhaps one of the reasons why Inkscape is currently unusable for many applications. Justified text is very useful, and is currently missing. Justification options to offer might be some subset of those proposed at http://www.w3.org/TR/css3-text/.

One reasonable starting point if you want to support text-in-shape and TeX-like line-breaking and hyphenation is the work of the Monash University group, who have a command-line tool that can justify some small subset of XHTML, and fit into a shape that can grow/shrink in a user-defined way to fit the text, and produces SVG output: http://bowman.csse.monash.edu.au/~pmoulder/text-in-shape.tar.gz. A disadvantage of this starting point is that the tool was not designed with editing in mind.

'''Mentor:''' Peter Moulder

== Past Years ==

* [[Googles Summer of Code 2006]]
* Googles Summer of Code 2005
** [[SOC Accepted Proposals]]
** [[SOC Writing Project Proposals]]
** [[SOC Selection Criteria]]
** [[SOC Original Project Prompts]]

Google Summer of Code 2007

2007-02-23T22:51:09Z

Jon Phillips: /* Ideas */

Google Summer of Code 2006

2007-02-23T22:48:57Z

Jon Phillips: Googles Summer Of Code 2006 moved to Googles Summer of Code 2006: bad spelling

=== SOC 2006 ===

[http://code.google.com/soc/ Google] has been kind enough to invite Inkscape to participate as a mentoring organization in the Summer of Code 2006. The students and developers had a lot of fun last year, and resulted in some _great_ additions to the software, so we are very enthused about this year.

Below is a list of ideas that Inkscape developers think might make good projects. Please do not let this list constrain you; if you have a good idea beyond what is listed we'd love to see it!

Also, we would strongly encourage students to contact us on the Inkscape developer's list prior to submitting your proposal. This gives us a chance to get to know you and to give you feedback that will strengthen your proposal.

No more applications are accepted for Summer of Code 2006. Google has a [http://code.google.com/soc/inkscape/about.html list] of accepted proposals.

There is also a wiki page for [[Filter Effects]] SoC project.

== Project Ideas ==

=== A. PDF Export Extension ===

PDF is the most important graphic document interchange format, but Inkscape's current capability is woefully inadequate (we export to postscript and use ps2pdf). This project would focus on establishing a solid solution to this need.

An implementation approach for this would be to create a new Inkscape extension, "crs2pdf", which links to the [http://cairographics.org/ Cairo] library for [http://www.cairographics.org/manual/cairo-PDF-Surfaces.html PDF rendering] capability, and to [http://scratchcomputing.com/projects/vectorsection Vector Section] for parsing the SVG into CRS.

This work may also require making some alterations to Cairo and/or VectorSection to improve the quality of the throughput.

The tool must successfully convert at least half of the about screens used in Inkscape versions 0.35-0.44. Major kudos if you can convert all of them.

Mentor: [[EricWilhelm]]

=== B. EPS Import ===

While SVG is becoming a common format for exchanging data between graphics programs, EPS is currently much more common. Inkscape's current EPS support is flakey and poorly maintained. The plan is to switch to use of Scribus' EPS Import Library.

This project would involve creating a new Inkscape extension, "eps2crs", which links to Scribus' EPS import library and exports into the [http://scratchcomputing.com/projects/vectorsection Vector Section] CRS format.

This work may also require making some alterations to the Scribus PDF library and/or VectorSection to improve the quality of the throughput.

Mentor: [[EricWilhelm]]

=== C. Memory Optimization ===

Inkscape is a bit heavy in its memory use, and is tough to use on computers with limited RAM. This project would seek to analyze and understand Inkscape's memory usage, identify and correct major memory leaks, and decrease memory usage for typical cases by a nontrivial amount. Ultimately, the project should result in Inkscape running smoothly on lower RAM systems than currently.

Mentor: MentalGuy

=== D. Inkboard Portability ===

Last year we had a successful project to integrate the SVG online whiteboard capability, called Inkboard, into Inkscape. Unfortunately, it does not work on Windows, so many users are missing out on this capability.

This work may involve [http://svn.sourceforge.net/viewcvs.cgi/inkscape/inkscape/branches/INKBOARD_PEDRO/src/jabber_whiteboard/protocol/ formalizing and extending the Inkboard communication protocol] and [http://svn.sourceforge.net/viewcvs.cgi/inkscape/inkscape/branches/INKBOARD_PEDRO/src/jabber_whiteboard/ working on the INKBOARD_PEDRO branch])

Mentor: Ted

=== E. New Grids ===

Inkscape currently has square grids that can be snapped to. Extend this to allow other kinds of grids: Perspective, hex, iso, etc.

This will involve modifying the grid code to support the ability to have multiple kinds of grids, implementing at least 3 new grids, and adding the UI elements to allow users to make use of them.

Mentor: TBD

=== F. SVG Filters ===

Filters are a very important SVG capability, that allows giving special features to drawing objects, including shadows, blurs, etc. Inkscape currently does not support this capability, but it's high on the list of desires.

This project would consist of two parts: (1) adding a SPObject for filters and CSS support for referencing them; (2) adding renderer support for doing the actual filter effects when rendering. Completing this project requires implementing at least one filter, 'Gaussian blur' as a proof of concept.

Mentor: Bulia

=== G. Adding bitmap capabilities to Inkscape ===

While the purpose of Inkscape is to be a vector editor, design in the real world requires dealing with bitmaps too. Inkscape can import the bitmaps, and have them as full canvas objects, but there is no significant bitmap operations in Inkscape. While there is no reason for Inkscape to replicate the functionality of The GIMP, it would be desirable to have a few simple operations available from Inkscape.

This project will use the Inkscape extensions system to add a series of bitmap effects. The majority of the effects will be achieved through the integration of the ImageMagick bitmap handling libraries. GIMP may be another source. These effects can then be run on bitmap graphics within Inkscape.

The work should be encapsulated in such a way that in theory, other vector graphics applications (such as Xara), could also use the work. However, for the scope of this project we only require demonstration of the capabilities in Inkscape.

Project Timeline:

* Implement first effect. This involves building Inkscape, linking in ImageMagick and getting one effect written (6 weeks)
* Implement remaining effects within ImageMagick (3 weeks)
* Build a test suite for operations and complete all Doxygen documentation of code (3 weeks)

Mentor: Ted

=== H. Inkscape / GIMP Bitmap Editing Integration ===

Currently, you can embed raster/bitmap images into Inkscape drawings, but editing them is a bit of a hassle because Inkscape isn't really "aware" of external bitmap editing tools.

This project would seek to correct this by modifying inkscape's image embedding code to interoperate more directly with external bitmap programs. For instance, there would be an "open external editor" command that could be used when one or more bitmap images are selected. Another idea would be to include some common bitmap modification commands from the external program, that can be run entirely within Inkscape. A third idea is drag and drop of selections from the bitmap editor to Inkscape, and SVG selections from Inkscape to the bitmap tool.

As a proof of concept, the result should demonstrate this interoperability with GIMP. Note that the code should be developed such that in theory it should work with any bitmap editor, but we would only require demonstration of working with GIMP.

Also see: http://sourceforge.net/tracker/index.php?func=detail&aid=862655&group_id=93438&atid=604309

Mentor: TBD

=== I. Text Tool Improvements ===

Inkscape's text tool is handy, but still lacks many of the niceties that users would like. This project would seek to address this by implementing various improvements that users have requested.

Some ideas for improvements:
* Make flowed text respect the default style of the text tool
* when flowing a text which already contains line breaks, provide a way for the line breaks to be conserved.
* when the style selected in the the Text and Font dialog is applied it erases any other style applied to some part of the text (like italics on some words, bold on others...), it would also be better to keep them where appropriate.
* Search through the Inkscape RFE list for other text and font improvement ideas

See: http://valessio.ul-jb.org/projetos/inkscape/inkscribus.htm

Mentor: TBD

=== J. Color Adjustment Dialog ===

Currently, it is possible to select, say, 12 objects in the drawing and set them to the same color/gradient/pattern. This project would go a step further, allowing multiple objects of differing color to have aspects of their color (such as brightness/contrast, HSL, etc.) altered, and to operate on vector objects with different fill styles (flat, gradient, or pattern fills), and to bitmaps.

Mentor: Bulia

=== K. External CSS Support ===

Inkscape currently has good support for inline CSS, and limited read-only support for an internal stylesheet in a <style> element, and no support for external stylesheets. Support for editing non-inline CSS would allow better expressiveness and adaptation, and smaller SVG files, and better support for SVG generated by other programs that use non-inline CSS.

Mentor: Peter Moulder

=== L. Bucket fill tool ===

This feature provides a new tool that generates a vector object with the desired color. This would allow, for example, the artist to draw a set of intersecting lines, and paint the blank spaces in between.

Two approaches have been proposed: The first would render the current image to a in-memory bitmap, perform a flood-fill (borrow the algorithm e.g. from Gimp), then trace the result and insert the resulting vector object into the drawing. The second would strive to detect the surrounding vector objects and perform a boolean path operation to construct a matching shape with the desired fill. Both approaches have their pros and cons; please select either and explain why you wish to do it that way, and how you would do it.

More discussion is available here: http://sourceforge.net/tracker/index.php?func=detail&aid=1123138&group_id=93438&atid=604309

Mentor: Bulia

=== M. Justified Text ===

The lack of this feature is perhaps one of the reasons why Inkscape is currently unusable for many applications. Justified text is very useful, and is currently missing. Justification options to offer might be some subset of those proposed at http://www.w3.org/TR/css3-text/.

One reasonable starting point if you want to support text-in-shape and TeX-like line-breaking and hyphenation is the work of the Monash University group, who have a command-line tool that can justify some small subset of XHTML, and fit into a shape that can grow/shrink in a user-defined way to fit the text, and produces SVG output: http://bowman.csse.monash.edu.au/~pmoulder/text-in-shape.tar.gz. A disadvantage of this starting point is that the tool was not designed with editing in mind.

'''Mentor:''' Peter Moulder

== Additional Ideas ==

* SVG support in OpenOffice (not exactly Inkscape development, but would allow Inkscape users to paste in art rather than having to export to png and really promote usuage of Inkscape). Not to mention eliminating all those duplicate svg/png image files!

* More potrace/SIOX/etc. style features/development

* Extending the online InkscapeSVG stuff - might be very cool for sharing sketches, etc

* Building a public whiteboard server for Inkscape users, with a web site of its own, user galleries, interest groups, scheduled drawathons, connections to OCAL, etc.

* Skeletal Strokes and Effect Lines - A few links: Our wiki page on Expression [[http://wiki.inkscape.org/wiki/index.php/Expression]], Technical papers on Skeletal Strokes [[http://portal.acm.org/citation.cfm?id=192186]], Examples - [[http://northlite.50megs.com/expr/effectlines.htm]], [[http://www.wa.commufa.jp/~ksg/p_pfwp5_cgf.htm]], [[http://personal-computer-tutor.com/abc4/v36/sara36.htm]].

* Improve the functionality and ease of use of the python effects API (see my proposal in the [[ImprovingPythonExtensionAPI]] page )

* Standalone palette editor

* Converter from Visio to VectorSection's CRS format

* Converter from CorelDraw (CDR) to VectorSection's CRS format

* Converter enhancements for VectorSection (dxf2rzp, rzp2dxf, rzp2crs, crs2rzp, etc.)

* Converter from Flash (SWF) to VectorSection's CRS format

* Implementation of scissors and razor tools. Yes, these blunt tools are so necessary to quickly cut paths.

* Add user profiles (some nice graphical interface) to store different sets of default metadata that can be used quickly

* upgrade the metadata and licensing dialogs with more options and general licenses checking (upgrade cc license selection to using web services

* Advanced grade tool. Each node of a shape could have a different color. Inkscape fills in with a complex grade.

* Begin work on adding animation features to inkscape. If animated SVG is to ever truely compete with Macromedia Flash, then we'll need a good editor to create them with ;)

Perhaps we can move the ideas that are not being done as SOC projects to other pages in the wiki.

=== SOC 2005 ===
* [[SOC Accepted Proposals]]
* [[SOC Writing Project Proposals]]
* [[SOC Selection Criteria]]
* [[SOC Original Project Prompts]]

[[Category:Developer Discussion]]
[[Category:Needs Work]]

Google Summer of Code 2007

2007-02-23T22:47:48Z

Jon Phillips:

This year Inkscape is going to participate, yet again, in Google's Summer of Code 2007. Help us come up with some solid places to innovate and push forward.

== Ideas ==

=== Add your idea ===

Here!

== Past Years ==

* [[Googles Summer of Code 2006]]
* Googles Summer of Code 2005

2006-02-27T05:42:30Z

Jon Phillips: /* Making Your Changes Live on Inkscape.org */

Once you have developer-level access to the project, you can also help with maintenance of the Inkscape website.

== CVS Checkout of the Website Module ==

To checkout the website cvs module:

:Type <pre>svn co https://svn.sourceforge.net/svnroot/inkscape/inkscape_web/trunk inkscape_web</pre> after you have logged in with your username/password

For more info, see See [[WorkingWithSVN]].

== Testing your website changes locally ==

Once you have checked out (see previous heading) the website module, then make a symbolic link to your web root directory. To do this for apache on redhat9 the best way is to navigate to <pre>/var/www/html</pre> and then type:

:<pre>ln -s /usr/src/inkscape-project/inkscape_web</pre> (NOTE: that the path you pass should be relative/absolute to the inkscape_web module you just checked out)

Thus, once you have done this, then you will be able to view the Inkscape website at <pre>http://localhost/inkscape_web/</pre> on your computer via a web browser.

Hopefully, you have apache configured properly and it is running.

== Making Your Changes Live on Inkscape.org ==

# Make your changes to your local inkscape_web module.
# Commit your changes, ensuring that you provide ample notes in your commit log message.
# ssh -l <your sf username> ssh.sourceforge.net *
# cd inkscape/inkscape_web
# ./publish_web.sh

(*)
If you haven't done this before, you need to set up a link to the inkscape_web folder in your home directory.
ln -s /home/groups/i/in/inkscape inkscape

== Adding News to the Site ==

If you have CVS access, you can add news to the site. First, you should add your signature to /includes/signatures.inc.

Create your news in english always! create a new file in the news/en/<this-year>/<this-month> folder, and give it the next highest number. (if there are files named 001.inc and 002.inc, name yours 003.inc) You can use this as a template:
<pre>
<div class="item">
<h3>HEADER</h3>
MONTH DAY, YEAR
MESSAGE

<?php echo $[[SIG_YOURNAME]]; ?>
</div>
</pre>
Add new paragraphs if needed and dont forget to change the signature.

If you want, translate the news to your language and save it in news[[/XX]]/<this-year>/<this-month>

If you really want to add news only in your language (not english), it might probably be the better way to modify your localized header (/index.xx-header.php). If you really think you need to have a local-only news, then please add an empty file with the same name (number) in the english directory and add a comment:



Make your changes live as described above.

== Adding Screenshots to the Site ==

The best way to add screenshots to the website is not by emailing them to the list or to any one developer unless you are not a developer. Instead, the best way is to create a screenshot for whatever screen size your system is set to (preferably a standard size like 1024 by 768), creating it in the PNG file format and then give it a descriptive name.

Then the resulting thumbnail should be of the resolution 267 pixels wide by 200 pixels high in PNG format. The naming must be in relationship to the screenshot.

Naming convention is:

:inkscape-<version>-<id>-<name>.png
:inkscape-<version>-<id>-<name>_thumb.png

Example:

:inkscape-0.43-01-myfeature.png
:inkscape-0.43-01-myfeature_thumb.png

<id> is ment to be something like 01, 02, 03... but you can also use 10a, 10b, 10c. this affects the order in the gallery. use zzz to place a sceenshot on top.
(NOTE: <id> wasnt there before. but i suggest using it beginning with 0.43)

save your shot into the "screenshots/gallery" folder, the thumb into "screenshots/gallery/thumbs".

Once the graphics are in the right folder, my lovely PHP script will display them automatically on the main page of the website.
They also appear on the screenshots/index.php page, therefore you must create a description file:

:inkscape-<version>-<id>-<name>.en

You may also create translations of description files. Just replace .en with the language code. Example:

:inkscape-0.43-01-myfeature.en
:inkscape-0.43-01-myfeature.de
:inkscape-0.43-01-myfeature.es

Store them in "screenshots/gallery/info"

Then make sure that you add your new images and description files and any changes to the SVN repository. For more info, see [[WorkingWithSVN]].

== Translating the Inkscape Website ==

1. Do a CVS checkout of the website module.

IMPORTANT: all files you change MUST be UTF-8 encoded!!!
else, you will get broken output.
See UT-8 note below, please.

2. Add your language by these steps:
- update the following line includes/header.php
$LANGUAGES = array("en", "de", "es"); // available languages

- Add a flag for your language in the images directory. It should be named inkscape_web/images/flag-XX.png. (where XX is your language code). Size is 34x20px.

- Add a line to css/base.css, similar to the following: (place your flag 50px left of the others)
#lang-xx { left:225px; }

- Add a link for your flag in includes/header.php

- create a copy of includes/localized-en.inc for your language. (like includes/localized-fr.inc) and translate the values of the strings.

- copy and translate index.en-header.php to your language.

- copy the subdirectory structure news/en/ to news/xx/ and, if you want, translate the news. (you can delete all news that you will not translate. the script will use the original news of /news/en then)

- you may add a signature to includes/signatures.inc and use it for news you create.

3. Look into other pages to see what needs to be done to translate them. (in general you need to create an inclusion file)
Files you need to translate: (at least you must create a copy for your language, or those pages will fail to open)
discussion-en.inc
download-en.inc
mailing_lists-en.inc
report_bugs-en.inc
submit2webmaster-en.inc
submit2webmaster-en-form.inc
doc/index-en.inc
status/index-en.inc

You also may translate news, screenshot comments and status files.

Note: The tutorial translations in the doc/ directory are handled
separately from the website translation. These are the files in
inkscape_web/doc/*/ that have .XX.html extensions. You do not need
to do anything about these pages.

Note: The translation of doxygen, wiki, and the various SF pages
are separate from the website translation. You do not need to do
anything about these pages.

5. Add a news item to the index page announcing your translation. You are encouraged to write it in both English and your native language. Use UTF-8 character set (or character entities if you prefer).
You do this by adding a file like /news/en/200x/xx/0xx.inc and write your announcement.
IMPORTANT: all files you change MUST be UTF-8 encoded!!! else, you will break get broken output.
See UT-8 note below, please.

Note: Even if the announcement does not need to be translated,
you should copy it to your languages folder also.
Reason: Same news must have same file names. If your announcement
is 010.inc, and then the next news is 011.inc, if you translate
that news only, your announcement will no more be shown. This is
because if you have 11 localized news and there are 12 in /en/,
the 11th will be shown in english. Now, if the 11th file in your
folder is the translation of the 12th file in /en/, it will be
displayed wrong

6. If you have CVS access, then commit your changes to the site. See the Website Editing and Working With CVS documentation for directions.

If you do not have CVS access, then show your translation to one of the Inkscape administrators for review. They will then give you access to CVS and the website, so you can deploy your changes.

== There are no UTF-8 entities !!! ==

As i heared different people talking about UTF-8 entities, i thought this should be clarified: THERE IS NO SUCH THING!

There are HTML entities. (that's what you think of) This is not an encoding, it is a (somewhat) human readable transliteration. They look like
<pre> & (& a m p ;) --- ř (& # 3 4 5 ;) --- Ä (& A u m l ;)</pre>
The cool thing about them is, that you don't need to care about encoding with them, as only the lower 128 of 256 ASCII-Characters are used to describe characters that normally are in the upper 128 or even don't exist in ASCII. The upper 128 are different, for example in Windows codepages or whatever, at least they are system dependant.

Now, if we talk about UTF-8, this is an encoding! And it's one for UNIcode. The 8 means, that the most important chars need 8bit to store. (i think these are the same chars as the lower 128 in ASCII) All the other UNIcode chars are stored using 2, 3 or 4 bytes. And if your editor is not capable of UTF-8, youll see a mess instead of special chars like äüößéńí etc.

So, if you edit existing pages, you need to have an UTF-8 capable editor. (Kate for example is capable, but you might need to check the encoding in the extras menu.)

Please do not use HTML-entities! We should all use the same system, which should be utf-8 encoding. If you have questions about this, please ask.

Reference: HTML Entities: http://www.w3schools.com/tags/ref_entities.asp

User:Jon Phillips

2006-02-27T05:28:45Z

Jon Phillips: added my page

http://www.rejon.org/

Editing Inkscape's website

2006-02-27T05:13:35Z

Jon Phillips: /* CVS Checkout of the Website Module */

Once you have developer-level access to the project, you can also help with maintenance of the Inkscape website.

== CVS Checkout of the Website Module ==

To checkout the website cvs module:

:Type <pre>svn co https://svn.sourceforge.net/svnroot/inkscape/inkscape_web/trunk inkscape_web</pre> after you have logged in with your username/password

For more info, see See [[WorkingWithSVN]].

== Testing your website changes locally ==

Once you have checked out (see previous heading) the website module, then make a symbolic link to your web root directory. To do this for apache on redhat9 the best way is to navigate to <pre>/var/www/html</pre> and then type:

:<pre>ln -s /usr/src/inkscape-project/inkscape_web</pre> (NOTE: that the path you pass should be relative/absolute to the inkscape_web module you just checked out)

Thus, once you have done this, then you will be able to view the Inkscape website at <pre>http://localhost/inkscape_web/</pre> on your computer via a web browser.

Hopefully, you have apache configured properly and it is running.

== Making Your Changes Live on Inkscape.org ==

# Make your changes to your local inkscape_web cvs module.
# Commit your changes, ensuring that you provide ample notes in your commit log message.
# ssh -l <your sf username> ssh.sourceforge.net *
# cd inkscape/inkscape_web
# ./publish_web.sh

(*)
If you haven't done this before, you need to set up a link to the inkscape_web folder in your home directory.
ln -s /home/groups/i/in/inkscape inkscape

== Adding News to the Site ==

If you have CVS access, you can add news to the site. First, you should add your signature to /includes/signatures.inc.

Create your news in english always! create a new file in the news/en/<this-year>/<this-month> folder, and give it the next highest number. (if there are files named 001.inc and 002.inc, name yours 003.inc) You can use this as a template:
<pre>
<div class="item">
<h3>HEADER</h3>
MONTH DAY, YEAR
MESSAGE

<?php echo $[[SIG_YOURNAME]]; ?>
</div>
</pre>
Add new paragraphs if needed and dont forget to change the signature.

If you want, translate the news to your language and save it in news[[/XX]]/<this-year>/<this-month>

If you really want to add news only in your language (not english), it might probably be the better way to modify your localized header (/index.xx-header.php). If you really think you need to have a local-only news, then please add an empty file with the same name (number) in the english directory and add a comment:



Make your changes live as described above.

== Adding Screenshots to the Site ==

The best way to add screenshots to the website is not by emailing them to the list or to any one developer unless you are not a developer. Instead, the best way is to create a screenshot for whatever screen size your system is set to (preferably a standard size like 1024 by 768), creating it in the PNG file format and then give it a descriptive name.

Then the resulting thumbnail should be of the resolution 267 pixels wide by 200 pixels high in PNG format. The naming must be in relationship to the screenshot.

Naming convention is:

:inkscape-<version>-<id>-<name>.png
:inkscape-<version>-<id>-<name>_thumb.png

Example:

:inkscape-0.43-01-myfeature.png
:inkscape-0.43-01-myfeature_thumb.png

<id> is ment to be something like 01, 02, 03... but you can also use 10a, 10b, 10c. this affects the order in the gallery. use zzz to place a sceenshot on top.
(NOTE: <id> wasnt there before. but i suggest using it beginning with 0.43)

save your shot into the "screenshots/gallery" folder, the thumb into "screenshots/gallery/thumbs".

Once the graphics are in the right folder, my lovely PHP script will display them automatically on the main page of the website.
They also appear on the screenshots/index.php page, therefore you must create a description file:

:inkscape-<version>-<id>-<name>.en

You may also create translations of description files. Just replace .en with the language code. Example:

:inkscape-0.43-01-myfeature.en
:inkscape-0.43-01-myfeature.de
:inkscape-0.43-01-myfeature.es

Store them in "screenshots/gallery/info"

Then make sure that you add your new images and description files and any changes to the SVN repository. For more info, see [[WorkingWithSVN]].

== Translating the Inkscape Website ==

1. Do a CVS checkout of the website module.

IMPORTANT: all files you change MUST be UTF-8 encoded!!!
else, you will get broken output.
See UT-8 note below, please.

2. Add your language by these steps:
- update the following line includes/header.php
$LANGUAGES = array("en", "de", "es"); // available languages

- Add a flag for your language in the images directory. It should be named inkscape_web/images/flag-XX.png. (where XX is your language code). Size is 34x20px.

- Add a line to css/base.css, similar to the following: (place your flag 50px left of the others)
#lang-xx { left:225px; }

- Add a link for your flag in includes/header.php

- create a copy of includes/localized-en.inc for your language. (like includes/localized-fr.inc) and translate the values of the strings.

- copy and translate index.en-header.php to your language.

- copy the subdirectory structure news/en/ to news/xx/ and, if you want, translate the news. (you can delete all news that you will not translate. the script will use the original news of /news/en then)

- you may add a signature to includes/signatures.inc and use it for news you create.

3. Look into other pages to see what needs to be done to translate them. (in general you need to create an inclusion file)
Files you need to translate: (at least you must create a copy for your language, or those pages will fail to open)
discussion-en.inc
download-en.inc
mailing_lists-en.inc
report_bugs-en.inc
submit2webmaster-en.inc
submit2webmaster-en-form.inc
doc/index-en.inc
status/index-en.inc

You also may translate news, screenshot comments and status files.

Note: The tutorial translations in the doc/ directory are handled
separately from the website translation. These are the files in
inkscape_web/doc/*/ that have .XX.html extensions. You do not need
to do anything about these pages.

Note: The translation of doxygen, wiki, and the various SF pages
are separate from the website translation. You do not need to do
anything about these pages.

5. Add a news item to the index page announcing your translation. You are encouraged to write it in both English and your native language. Use UTF-8 character set (or character entities if you prefer).
You do this by adding a file like /news/en/200x/xx/0xx.inc and write your announcement.
IMPORTANT: all files you change MUST be UTF-8 encoded!!! else, you will break get broken output.
See UT-8 note below, please.

Note: Even if the announcement does not need to be translated,
you should copy it to your languages folder also.
Reason: Same news must have same file names. If your announcement
is 010.inc, and then the next news is 011.inc, if you translate
that news only, your announcement will no more be shown. This is
because if you have 11 localized news and there are 12 in /en/,
the 11th will be shown in english. Now, if the 11th file in your
folder is the translation of the 12th file in /en/, it will be
displayed wrong

6. If you have CVS access, then commit your changes to the site. See the Website Editing and Working With CVS documentation for directions.

If you do not have CVS access, then show your translation to one of the Inkscape administrators for review. They will then give you access to CVS and the website, so you can deploy your changes.

== There are no UTF-8 entities !!! ==

As i heared different people talking about UTF-8 entities, i thought this should be clarified: THERE IS NO SUCH THING!

There are HTML entities. (that's what you think of) This is not an encoding, it is a (somewhat) human readable transliteration. They look like
<pre> & (& a m p ;) --- ř (& # 3 4 5 ;) --- Ä (& A u m l ;)</pre>
The cool thing about them is, that you don't need to care about encoding with them, as only the lower 128 of 256 ASCII-Characters are used to describe characters that normally are in the upper 128 or even don't exist in ASCII. The upper 128 are different, for example in Windows codepages or whatever, at least they are system dependant.

Now, if we talk about UTF-8, this is an encoding! And it's one for UNIcode. The 8 means, that the most important chars need 8bit to store. (i think these are the same chars as the lower 128 in ASCII) All the other UNIcode chars are stored using 2, 3 or 4 bytes. And if your editor is not capable of UTF-8, youll see a mess instead of special chars like äüößéńí etc.

So, if you edit existing pages, you need to have an UTF-8 capable editor. (Kate for example is capable, but you might need to check the encoding in the extras menu.)

Please do not use HTML-entities! We should all use the same system, which should be utf-8 encoding. If you have questions about this, please ask.

Reference: HTML Entities: http://www.w3schools.com/tags/ref_entities.asp