Write: Difference between revisions

From OLPC
Jump to navigation Jump to search
m (Reverted edits by Quentinscott (Talk) to last revision by Alsroot)
 
(51 intermediate revisions by 23 users not shown)
Line 1: Line 1:
{{Activity migrated to sl.o
| download=http://activities.sugarlabs.org/en-US/sugar/addon/4201
| git=http://git.sugarlabs.org/projects/write
}}

{{ Translations }}
<center>''other languages: see [[쓰기]]''</center>
<center>''other languages: see [[쓰기]]''</center>
{{Olpcboxtop|toptext=[[{{PAGENAME}}|Write]]}}
{{Olpcboxtop|toptext=[[{{PAGENAME}}|Write]]}}
{{ OBX activity |[[Image:Write.png]]|core<!--|{{{text}}}--> }}
{{ OBX activity |[[Image:Write.png]]|core<!--|{{{text}}}--> }}
{{ OBX source dev|projects/write}}
{{ OBX source dev|git://git.sugarlabs.org/write/mainline.git}}
{{ OBX test |[[Tests/Write|Write]]<!--|2007-09-18--> }}
{{ OBX test |[[Tests/Write|Write]]<!--|2007-09-18--> }}
{{ OBX devtickets |measure-activity}}
{{ OBX devtickets |write-activity+%28abiword%29}}
{{ OBX pootle|1=http://dev.laptop.org/git?p=projects/write;a=blob_plain;f=po/write.pot;hb=HEAD|2=xocore}}
{{ OBX pootle|1=http://dev.laptop.org/git?p=projects/write;a=blob_plain;f=po/write.pot;hb=HEAD|2=xocore}}
{{ OBX team |J.M. Maurer}}
{{ OBX team |J.M. Maurer}}
Line 18: Line 24:
===Summary===
===Summary===


The Write activity will serve as the basic text editing application on the laptops. Its simple interface will provide an easy starting point for children, presenting tools that make writing a story, poem or essay simple and straightforward. It will also support basic tools for inserting images, creating tables, and performing basic layout operations as children begin to require some of these features often associated with word processors.
The Write activity serves as the basic text editing application on the laptops. Its simple interface provides an easy starting point for children, presenting tools that make writing a story, poem or essay simple and straightforward. It also supports basic tools for inserting images, creating tables, and performing basic layout operations as children begin to require some of these features often associated with word processors. (For developer-level [[Linux]] text editing, see [[Nano]].)


===Goals===
===Current Use ===
See the [[Write/Escribir|visual step-by-step example]] of how to use Write (Escribir). It illustrates the steps described below and also demonstrates insertion of a picture in a Write document.


How do you save it?
How do you save your writing?
:Your work is automatically saved in the Journal: no need to ever do a "save".
:Your work is automatically saved in the Journal as "Write Activity" or the name you last gave it.


How do you save to a different location?
How do you name it?
:Click the Activity tab and replace the words "Write activity" with the name you want displayed in the Journal. Specific names will help you find your work. (You also can edit the name in the [[Journal]] later.)
:Open write, write something and then "keep" to Journal and exit. Open Journal and look for your freshly written document then simply click on the document (holding the button down) and drag the document to one of the additional location located at the bottom of Journal. The additional location will be an SD card or a USB storage device.
When should you use the "Keep" button in the Activity tab?
:When you want to save a copy, or save a copy in another format, such as plain text, HTML or RTF.
'''Additional instructions should be added when more formats are working properly.
See [[Talk:Write|Discussion]] on early-2008 problems with RTF.'''


How do you save to a new location, such as an SD card or USB storage device?
How do you spellcheck a document?
:See [[Journal]]. Insert the storage device. Wait until its icon is visible at the bottom of the Journal.

:#Find your document in the Journal list.
:#Point to the document name, click, hold the left trackpad button, and drag the document name to the bottom of Journal.
:#Release when the pointer is over the icon for your storage device.
:#While copying is in progress, the XO shows a small document icon on top of the USB device, possibly hidden by the pointer. When that small document icon disappears, the copy is complete.
:#Wait for one document to finish copying before you copy another.

How do you open a plain text document from an SD card or USB storage device?
:Make sure the device is mounted, as described above.
:Click on the device icon at the bottom of the Journal.
:Wait for the Journal to display the contents of your storage device.
:Click on the document name.

How do you transfer documents between XO Write and Microsoft Word?
:As of early 2008, XO Write saved its document in AbiWord format, which could not be opened by Microsoft Word without conversion.

:Workaround 1: <strong>If</strong> you have access to a Windows, Mac,or Linux PC, XO Write's parent program, AbiWord, will help. AbiWord can read and write Word files. You should be able to open XO Write documents in AbiWord, then save in RTF or MS Word ".doc" format -- or continue working on the document in AbiWord itself. See http://www.abisource.com/download/

:Workaround 2: Use plain text. To transfer FROM the XO, first "Keep" the document as plain text. To transfer TO the XO, you can create a document with MS Word or another program and save it as plain text before putting it on a USB drive for transfer, or e-mailing it to an address you access from the XO.
::Note: Plain text saves only the words and paragraph breaks, but often is a "good enough" solution for many writing activities.

:Future: Write's Keep button also offers the alternatives of saving as HTML or RTF, both of which should preserve font characteristics and page layout. However, the RTF conversion was not functioning on G1G1 XOs delivered in December 2007. See this page's discussion tab.


===Collaboration===
===Collaboration===


Write will feature collaborative real time editing. Integrated with the mesh network and presence services, this feature will allow kids to work together easily and seamlessly in a text editing environment. This feature is made possible via the [http://www.abisource.com/twiki/bin/view/Abiword/AbiCollab Abi Collab] research performed by the Abiword development team.
Write features collaborative real time editing. Integrated with the mesh network and presence services, this feature allows kids to work together easily and seamlessly in a text editing environment. This feature is made possible via the [http://www.abisource.com/wiki/AbiCollab AbiCollab] research performed by the Abiword development team.


===Localization===
In order to provide text in the local language of the deployment we need to provide fonts which show the glyphs of the language. It would be very useful if local experts could fill in the Table below with their suggestion for the font that provides the best glyphs for their language as well as the locale(s) for which the font is useful. This table has an entry corresponding to each [[Keyboard layouts#OLPC keyboard layouts|OLPC keyboard layout]] and some extras.
{| class="wikitable"
|-
! Language
! Font Family
! Font shipped with XO?
! Locale
! Dominant Direction
|-
| Western European Languages
| DejaVu Serif
| Yes
|
| LTR
|-
| Arabic
| DejaVu Sans
| Yes
|
| RTL
|-
| Urdu (Arabic)
| Nafees
|
|
|
|-
| Dari/Eastern Farsi (Arabic)
|
|
|
|
|-
| Pashto (Arabic)
|
|
|
|
|-
| Farsi (Arabic)
| Nazli
|
|
|
|-
| Amharic
| Abyssinica SIL
|
| "am-ET"
|
|-
| Igbo
|
|
|
|
|-
| Hausa
|
|
|
|
|-
| Yoruba
|
|
|
|
|-
| Khmer
| KhmerOS Siemreap
|
|
|
|-
| Russian (Cyrillic)
| Doulos SIL
|
| "ru-RU"
| LTR
|-
| Mongolian (Cyrillic)
| Arhangai
|
|
|
|-
| Kazakh (Cyrillic)
|
|
|
|
|-
| Uzbek (Cyrillic)
|
|
|
|
|-
| Chinese Traditional & Simplified
| Arphic UMing
|
| "zh-CH"
|
|-
| Japanese Kana + Kanji
| Kochi Mincho
|
| "ja-JP"
| LTR
|-
| Korean Hangeul + Hanja
| UNBatang
|
|
|LTR
|-
| Lao
| Phetsarath
|
|
|
|-
| Burmese
| Padauk
|
|
|
|-
| Sinhalese
| Sinhala LKLUG
|
|
|
|-
| Bengali
| Lohit Bengali
|
|
|
|-
| Devanagari (Hindi, Marathi, Nepali...)
| Lohit Hindi
|
|
|
|-
| Gujarati
| Rekha
|
|
|
|-
| Punjabi (Gurmukhi)
| Saab
|
|
|
|-
| Kannada
| Kedage
|
|
|
|-
| Malayalam
| Meera
|
|
|
|-
| Oriya
| Samyak-Oriya
|
|
|
|-
| Tamil
| TAMu_Kadampari
|
|
|
|-
| Telugu
| Pothana2000
|
|
|
|-
| Thai
| Kinnari
|
|
|
|-
| Georgian
| BPG Unicode Standard
|
|
|
|-
| Dzongkha, Bhutan
| Jomolhari
|
|
|
|-
| Tibetan
| Tibetan Machine Uni
|
|
|
|}


==Visual Design==
==Visual Design==
Line 46: Line 298:
<br clear='all'>
<br clear='all'>


===Screenshots===
===<s>Screenshots</s> Mockups===


{|style="border: solid 1px gray; margin: 1em auto 1em; auto"
{|style="border: solid 1px gray; margin: 1em auto 1em; auto"
Line 65: Line 317:
|-
|-
|}
|}

21Jan2008 -- These pictures are really misleading: 1) They are not "Screenshots" 2) They do not accurately show the program screens. -- SFDave


{{Developers}}
{{Developers}}

==Development==
==Development==


Line 73: Line 328:
Microsoft Word capability
Microsoft Word capability
:Write (Abiword) already supports .doc; Journal support for "save as" needs to be exposed in the interface.
:Write (Abiword) already supports .doc; Journal support for "save as" needs to be exposed in the interface.
::I disagree that write should have an option to save to the proprietary and vendor-locked .doc format. Its use should not be encouraged by OLPC.


'''Publish''' Function
'''Publish''' Function

Publish to PDF for Final Output
Publish to HTML/XTML
:Publish to PDF for Final Output

:Publish to HTML/XHTML


Double spacing in the format section
Double spacing in the format section
Line 82: Line 340:
=====[[Talk:Write#Implementation Discussion|Implementation Discussion]]=====
=====[[Talk:Write#Implementation Discussion|Implementation Discussion]]=====
=====[[Write/Versions|Version History]]=====
=====[[Write/Versions|Version History]]=====

=====[[Reporting bugs]]=====
Write is based on the Abiword code core, and so in some cases, in order to get fixes, it will be essential to work with the AbiWord upstream, they have been very supportive of OLPC and we FOSS folks need to work together to improve tools for all.

AbiWord-2.6.4 is available for many linux distros now and provides the same rendering mechanism as Write in the sugar-0.82 release. Please make it clear if your bug reports are for either AbiWord-2.6.4 or Write for sugar-0.82. Write bugs can be reported into the OLPC [[Trac]] system as described on the [[Reporting bugs]] page.

Bugs requiring fixes in the upstream AbiWord code can be reported directly to:
* http://bugzilla.abisource.com/


===Source===
===Source===


http://dev.laptop.org/git.do?p=projects/write
http://dev.laptop.org/git?p=projects/write


===RPMs===
===RPMs===
Line 108: Line 374:
[[Category:Developers]]
[[Category:Developers]]
[[Category:Sugar]]
[[Category:Sugar]]
{{Activity page
|icon=Image:Write.png
|genre=Documents (Read, Write, and Share)
|activity group=Activities/G1G1
|short description=TODO! the basic text editing application on the laptops.
|contact person=User uwog/jmaurer - account needed?
|activity source=http://dev.laptop.org/git?p=projects/write
|bundle URL=http://dev.laptop.org/~morgan/bundles/other/Write-60.xo
|activity version=60
|releases=8.2.0 (767)
|devel status=5. Production-stable
}}

Latest revision as of 13:43, 31 May 2011

?Sugar icon}}    This activity is now hosted at the Sugar Activity Library.

The information here is likely to be out-of-date. Consult the new pages for "Write" first:

  español HowTo [ID# 256696]  +/-  
other languages: see 쓰기
Write.png This activity was core
TST Write
Trac print.png Tickets all - active - new
OlpcProject.png J.M. Maurer

see more templates or propose new


  For the general public

Description & Goals

Write activity

Summary

The Write activity serves as the basic text editing application on the laptops. Its simple interface provides an easy starting point for children, presenting tools that make writing a story, poem or essay simple and straightforward. It also supports basic tools for inserting images, creating tables, and performing basic layout operations as children begin to require some of these features often associated with word processors. (For developer-level Linux text editing, see Nano.)

Current Use

See the visual step-by-step example of how to use Write (Escribir). It illustrates the steps described below and also demonstrates insertion of a picture in a Write document.

How do you save your writing?

Your work is automatically saved in the Journal as "Write Activity" or the name you last gave it.

How do you name it?

Click the Activity tab and replace the words "Write activity" with the name you want displayed in the Journal. Specific names will help you find your work. (You also can edit the name in the Journal later.)

When should you use the "Keep" button in the Activity tab?

When you want to save a copy, or save a copy in another format, such as plain text, HTML or RTF.
Additional instructions should be added when more formats are working properly. 
See Discussion on early-2008 problems with RTF.

How do you save to a new location, such as an SD card or USB storage device?

See Journal. Insert the storage device. Wait until its icon is visible at the bottom of the Journal.
  1. Find your document in the Journal list.
  2. Point to the document name, click, hold the left trackpad button, and drag the document name to the bottom of Journal.
  3. Release when the pointer is over the icon for your storage device.
  4. While copying is in progress, the XO shows a small document icon on top of the USB device, possibly hidden by the pointer. When that small document icon disappears, the copy is complete.
  5. Wait for one document to finish copying before you copy another.

How do you open a plain text document from an SD card or USB storage device?

Make sure the device is mounted, as described above.
Click on the device icon at the bottom of the Journal.
Wait for the Journal to display the contents of your storage device.
Click on the document name.

How do you transfer documents between XO Write and Microsoft Word?

As of early 2008, XO Write saved its document in AbiWord format, which could not be opened by Microsoft Word without conversion.
Workaround 1: If you have access to a Windows, Mac,or Linux PC, XO Write's parent program, AbiWord, will help. AbiWord can read and write Word files. You should be able to open XO Write documents in AbiWord, then save in RTF or MS Word ".doc" format -- or continue working on the document in AbiWord itself. See http://www.abisource.com/download/
Workaround 2: Use plain text. To transfer FROM the XO, first "Keep" the document as plain text. To transfer TO the XO, you can create a document with MS Word or another program and save it as plain text before putting it on a USB drive for transfer, or e-mailing it to an address you access from the XO.
Note: Plain text saves only the words and paragraph breaks, but often is a "good enough" solution for many writing activities.
Future: Write's Keep button also offers the alternatives of saving as HTML or RTF, both of which should preserve font characteristics and page layout. However, the RTF conversion was not functioning on G1G1 XOs delivered in December 2007. See this page's discussion tab.

Collaboration

Write features collaborative real time editing. Integrated with the mesh network and presence services, this feature allows kids to work together easily and seamlessly in a text editing environment. This feature is made possible via the AbiCollab research performed by the Abiword development team.


Localization

In order to provide text in the local language of the deployment we need to provide fonts which show the glyphs of the language. It would be very useful if local experts could fill in the Table below with their suggestion for the font that provides the best glyphs for their language as well as the locale(s) for which the font is useful. This table has an entry corresponding to each OLPC keyboard layout and some extras.

Language Font Family Font shipped with XO? Locale Dominant Direction
Western European Languages DejaVu Serif Yes LTR
Arabic DejaVu Sans Yes RTL
Urdu (Arabic) Nafees
Dari/Eastern Farsi (Arabic)
Pashto (Arabic)
Farsi (Arabic) Nazli
Amharic Abyssinica SIL "am-ET"
Igbo
Hausa
Yoruba
Khmer KhmerOS Siemreap
Russian (Cyrillic) Doulos SIL "ru-RU" LTR
Mongolian (Cyrillic) Arhangai
Kazakh (Cyrillic)
Uzbek (Cyrillic)
Chinese Traditional & Simplified Arphic UMing "zh-CH"
Japanese Kana + Kanji Kochi Mincho "ja-JP" LTR
Korean Hangeul + Hanja UNBatang LTR
Lao Phetsarath
Burmese Padauk
Sinhalese Sinhala LKLUG
Bengali Lohit Bengali
Devanagari (Hindi, Marathi, Nepali...) Lohit Hindi
Gujarati Rekha
Punjabi (Gurmukhi) Saab
Kannada Kedage
Malayalam Meera
Oriya Samyak-Oriya
Tamil TAMu_Kadampari
Telugu Pothana2000
Thai Kinnari
Georgian BPG Unicode Standard
Dzongkha, Bhutan Jomolhari
Tibetan Tibetan Machine Uni

Visual Design

Media

Document Description
Activity Mockup (2MB) history Adobe Illustrator file containing mockups for each toolbar


Screenshots Mockups

Edit commands
Text editing
Image manipulation
Table adjustment
Format document
View options

21Jan2008 -- These pictures are really misleading: 1) They are not "Screenshots" 2) They do not accurately show the program screens. -- SFDave


  For Developers

Development

Feature Requests

Microsoft Word capability

Write (Abiword) already supports .doc; Journal support for "save as" needs to be exposed in the interface.
I disagree that write should have an option to save to the proprietary and vendor-locked .doc format. Its use should not be encouraged by OLPC.

Publish Function

Publish to PDF for Final Output
Publish to HTML/XHTML

Double spacing in the format section

Implementation Discussion
Version History
Reporting bugs

Write is based on the Abiword code core, and so in some cases, in order to get fixes, it will be essential to work with the AbiWord upstream, they have been very supportive of OLPC and we FOSS folks need to work together to improve tools for all.

AbiWord-2.6.4 is available for many linux distros now and provides the same rendering mechanism as Write in the sugar-0.82 release. Please make it clear if your bug reports are for either AbiWord-2.6.4 or Write for sugar-0.82. Write bugs can be reported into the OLPC Trac system as described on the Reporting bugs page.

Bugs requiring fixes in the upstream AbiWord code can be reported directly to:

Source

http://dev.laptop.org/git?p=projects/write

RPMs

Resources

Functional Test

Open the Write activity.

Type some text. Change the font. Ensure that bold and underline work properly.

Save the document.

Close the activity; ensure that it closes properly.

Activity Summary

Icon: Sugar icon::Image:Write.png
Genre: Activity genre::Documents (Read, Write, and Share)
Activity group: ,|x|Activity group::x}}
Short description: Short description::TODO! the basic text editing application on the laptops.
Description:
Maintainers: ,|x|Contact person::x}}
Repository URL: Source code::http://dev.laptop.org/git?p=projects/write
Available languages: ,|x|Available languages::x}}
Available languages (codes): ,|x|Language code::x}}
Pootle URL:
Related projects: Related projects,|x|Related projects::x}}
Contributors: ,|x|Team member::x}}
URL from which to download the latest .xo bundle Activity bundle::http://dev.laptop.org/~morgan/bundles/other/Write-60.xo
Last tested version number: Activity version::60
The releases with which this version of the activity has been tested. ,|x|Software release::x}}
Development status: Devel status::5. Production-stable
Ready for testing (development has progressed to the point where testers should try it out): ,|x|Ready for testing::x}}
smoke tested :
test plan available :
test plan executed :
developer response to testing :
Retrieved from "http://wiki.laptop.org/mediawiki/index.php?title=Write&oldid=256696"