Apache OpenOffice Wiki - User contributions [en]

User:Kirk

2016-01-23T03:46:18Z

Kirk:

Current user of Open Office since version 3.1 in Windows and version 3.0 in Ubuntu.

https://wiki.openoffice.org/wiki/Documentation/UserGuide/Calc

[[Special:Uncategorizedpages]]

Education ClassRoom/Previous Logs/Hybrid Model of Teaching OpenSource

2009-12-31T06:24:35Z

Kirk:

== '''Commented version of the IRC meeting''' ==

'''A clean commented version of the meeting can be found at : [http://flosscom.net/index.php?option=com_content&task=view&id=93 Link to the Commented version]

Thanks to Andreas Meiszner for his work.'''


== '''Original log''' ==

[17:07] <andreasmeiszner> Ok, so shall we start with questions / comments on the suggested hybrid approach to SE. Thus it would be clear to all what it is about?

[17:08] * ericb2 searching the links

[17:08] <chacha_chaudhry> http://www.slideshare.net/andreasmeiszner/breaking-the-silence-taking-learning-online-presentation

[17:08] <chacha_chaudhry> http://www.scribd.com/doc/10933440/A-HYBRID-APPROACH-TO-COMPUTER-SCIENCE-EDUCATION

[17:08] <chacha_chaudhry> ericb2: ^^

[17:09] <ericb2> chacha_chaudhry: thanks :)

[17:09] <andreasmeiszner> thx!

[17:09] <chacha_chaudhry> andreasmeiszner: I haven't gone through the approach .. may you explain briefly how it is different from common
open source development model.

[17:10] * wtebbens (n=wouter@ip115-58-210-87.adsl2.static.versatel.nl) has joined #education.openoffice.org

[17:10] <andreasmeiszner> ok, so basically it is a open approach to courses which is dervived from the way open source communities, but also
the web more in general works.

[17:10] * andreasma (n=andreasm@p3E9D2296.dip.t-dialin.net) has joined #education.openoffice.org

[17:11] <wtebbens> good afternoon all!

[17:11] <andreasmeiszner> hi wouter, welcome!

[17:11] <chacha_chaudhry> wtebbens: hello meeting has already started.

[17:11] <sroy> good evening . it is 21:45 hrs here

[17:11] <andreasma> hi all

[17:11] <wtebbens> hi andreas, sorry I am late (and can only stay for half an hour)

[17:12] <chacha_chaudhry> andreasm wtebbens: we are already following andreasmeiszner .. andreasmeiszner may we continue

[17:12] <andreasmeiszner> the hybrid approach aims to bring together the different involved stakeholders (students & educators from different
institutions, open source practitioners & free learners outside of formal education) within a "semi-structured" way

[17:13] <andreasmeiszner> often formal education - even if about open source - follows the traditional "style": closed, isolated, disconnected,
static,...

[17:13] <andreasmeiszner> does this still makes sense?

[17:14] <chacha_chaudhry> yep very much.

[17:14] <andreasmeiszner> ok

[17:14] <andreasmeiszner> so just as an example

[17:14] <andreasmeiszner> "learning processess" in open source are often visible and become learning resources for many others

[17:15] <andreasmeiszner> in formal education however - they are normally "lost" or disconnected from learning materials

[17:15] <andreasmeiszner> so this is the learning process side that we e.g. want to adress with the hybrid approach

[17:16] <andreasmeiszner> within an open environment, such as the piloted www.netgeners.net side (still just early playing), the different
stakeholders might engage analogue to the way it can be seen in open source

[17:17] <andreasmeiszner> therefore providing a richer learning experience, sharing the burden amongst different institutions on providing
basic information and allowing e.g. that contributions to an open source student by student A could be a useful learning resource for students
X,Y,Z

[17:18] <andreasmeiszner> this means "semi-structured", because contributions could also be found by students XYZ, if they "search the web" - but like this it would be more convenient for them

[17:18] <andreasmeiszner> uff - hope you are still with me

[17:19] daeseon david_jaco

[17:19] >david_jaco< : the log will be available there :
http://wiki.services.openoffice.org/wiki/Education_ClassRoom/Previous_Logs/Hybrid_Model_of_Teaching_OpenSource

[17:19] <chacha_chaudhry> yes

[17:19] <ericb2> andreasmeiszner: sure :)

[17:19] <david_jaco> sure

[17:20] <fardad> yes

[17:20] <wtebbens> sounds good

[17:20] <andreasmeiszner> ok - such an hybrid approach should be "less" conflicting with the educational structures we are operating at

[17:21] <andreasmeiszner> because teachers can still "lecture" their courses as the need to (legal constraints), yet an environment like e.g.
netgeners provides a more informal collaborative space

[17:22] <andreasmeiszner> such an environment could than be - step by step - improved to gradually advance ans slowly mature

[17:22] <andreasmeiszner> to respect e.g. legal and cultural constraints of formal education

[17:22] <andreasmeiszner> this is the sshort to medium aspect, in the long term certainly there would be much more in it

[17:23] <andreasmeiszner> e.g. virtual internships, certification against for paid assessment for "free learners outside of formal education",
etcetc

[17:23] <andreasmeiszner> ideally all involved sides should gain

[17:24] <andreasmeiszner> ok - questions? before this ends up in a monologue?

[17:24] <ericb2> andreasmeiszner: no, it isn't

[17:25] <ericb2> andreasmeiszner:

[17:25] <ericb2> I think the Education Project is already another model of hybrid approach, because we :

[17:25] <ericb2> - work with schools, and profs

[17:25] <ericb2> - we are involved in the project

[17:25] <ericb2> - we propose real tasks, in production mode

[17:25] <ericb2> andreasmeiszner: I don't know how close are both (your hybrid approach and Education Project approach), but they look
similar

[17:25] <ericb2> andreasmeiszner: excepted we have no resources

[17:26] <ericb2> andreasmeiszner: but both are winner-winner models

[17:26] <andreasmeiszner> yes, your work is close to this - except maybe to provide a more convenient space to make students work visible
and relate it as well to educational materials as to their work in open source - but in principle your work is very close

[17:26] * Sowe (n=Sowe@ws017.intech.unu.edu) has joined #education.openoffice.org

[17:27] <andreasmeiszner> Hello Sulayman / Sowe

[17:27] <Sowe> Hello all

[17:27] <Sowe> Hello Andreas

[17:27] <ericb2> andreasmeiszner: I think this will improve : I met the Computing Department director saturday, and he was very enthousiast
to know what we do. He even invited me to present the project asap

[17:27] <andreasmeiszner> Let me shortly introduce Sulayman: he started the work at Aristotle, sending out students to open source projects

[17:27] <ericb2> Sowe: be welcome :)

[17:28] <wtebbens> I wonder what differences there are between the two mentioned approaches, for the fact of the having or not having
resources. ericb2 and andreasmeiszner any comment?

[17:28] <andreasmeiszner> eric, this is perfect. and i think what would be a good way forward is to put the concepts together and build on our
current works - type of sherry picking

[17:28] <wtebbens> (if I understand correctly :))

[17:29] <ericb2> wtebbens: better organization from andreasmeiszner side ? More advanced state too maybe

[17:29] <ericb2> andreasmeiszner: I forgot : Computing Department director of UTBM (my school)

[17:29] <andreasmeiszner> but less practical experiences - by now we mainly have set up the models / structures

[17:30] <andreasmeiszner> means - our work is less advanced than OO work

[17:30] <Sowe> The Auth approach, now called the outside approach worked well for us and our students

[17:30] <andreasmeiszner> in practical terms

[17:31] <andreasmeiszner> as detailed at the paper http://www.scribd.com/doc/10933440/A-HYBRID-APPROACH-TO-COMPUTER-SCIENCE-
EDUCATION

[17:31] <Sowe> the limitation we found out as highlighted with the flosscom project is that the students have less opportunity to interact with
the "outside word"

[17:31] <andreasmeiszner> we tried to map existing approaches to be found to models

[17:32] <Sowe> i think this is where the Netgeners project by Andreas comes to be very important

[17:32] <andreasmeiszner> and found out that universities either send their students out (outside approach) into well established communities

[17:32] <andreasmeiszner> or tried to apply the principles of virtual communities within their institution (inside approach)

[17:33] <andreasmeiszner> however, the highest value would be a mix of both - the hybrid approach

[17:33] <andreasmeiszner> and this is what we suggest

[17:34] <Sowe> The SE education model for the outside approach can be found here:
http://sweng.csd.auth.gr/~sksowe/SE%20Education%20FLOSS%20Model/

[17:34] <andreasmeiszner> wtebbens: not sure if the differnce is clear?!?

[17:34] <ericb2> Sowe: thanks :)

[17:35] * danielbw (n=Daniel@secured2.monstertool.com) has joined #education.openoffice.org

[17:35] <danielbw> ericb2, ping?

[17:35] daeseon danielbw david_jaco

[17:37] <ericb2> danielbw: hello

[17:38] <wtebbens> andreasmeiszner: the outside and inside approaches seem intuitive to me. however I wonder in how far can learners who
are not registered as students in your institution join the learning process?

[17:38] <IZBot> News from cws: fwk99: nominated || macmiscfixes: nominated

[17:38] * jza (n=jza@189.132.187.165) has joined #education.openoffice.org

[17:38] <jza> hey ericb2

[17:38] <jza> just made it

[17:39] <ericb2> jza: hello. meeting ;)

[17:39] <ericb2> andreasmeiszner: how do you proceed to evaluate the candidates +?

[17:40] <andreasmeiszner> ericb2: which candidates?

[17:40] <ericb2> andreasmeiszner: the students

[17:40] <andreasmeiszner> this is done by the Aristotle team

[17:40] <ericb2> andreasmeiszner: I'm not sure of the words, but thre are two types of courses : evaluative and informative

[17:40] <Sowe> wtebbens: the idea is that if our students should expose and discuss their assignments (software testing, requirement analysis,
coding) on the netgeners platform, other students and free learners can engage them and exchange ideas

[17:41] <andreasmeiszner> http://www.slideshare.net/andreasmeiszner/open-source-software-engineering-aristotle-students-guide-
english-presentation

[17:41] <andreasmeiszner> at this presentation they indicate to the students how they would be eveluated

[17:42] <andreasmeiszner> one aspect still missing would be "peer-review" - for which a hybrid model might allow

[17:42] <ericb2> andreasmeiszner: indeed. essential

[17:42] <Sowe> previously (2005 -2008) student only downloaded software from projects, reported bugs and were only in contact with their
respective project communities

[17:43] <ericb2> andreasmeiszner: from my side, I proposed to define a list of expected know how and so on. and the student should proof he
validated every during the project

[17:43] <andreasmeiszner> ericb2: yes, e.g. the netgeners page has the (joomla) commenting and ranking option that could "complement"
evaluations

[17:44] <andreasmeiszner> ericb2: one option would be to have A. the students work in progress and B. let them produce an outcome to be made publicly available

[17:46] <ericb2> andreasmeiszner: it was an open question :) In fact, I often see the applied task (on the outside side), as the particular case.
and the inside case more generic. Hot to be sure the "generic" is validated working on the outside side ?

[17:47] <ericb2> andreasmeiszner: means how to be sur the student understood the concept and not solved one case only, means it's not sure
he will solve another similar problem

[17:49] <andreasmeiszner> ericb2: understood. yes this is a challenge. on the theoretical side I also find this approach close to what we do:
http://www.helsinki.fi/science/networkedlearning/eng/delete.html

[17:49] <andreasmeiszner> ericb2: The PI model applied within project based students work

[17:51] <ericb2> andreasmeiszner: bookmarked. Thanks :)

[17:52] <Sowe> good helsinki approach

[17:52] <Sowe> many educators seems to be doing the same thing around the globe

[17:53] <Sowe> Comment on evaluation

[17:53] <andreasmeiszner> Sowe: yes, with many different names - but often going into the same direction

[17:53] <ericb2> andreasmeiszner: as a partial answer, in the Education Project, we have choosen to delegate the evaluation to the prof
managing the student. But this is just a workaround

[17:54] <Sowe> Netgeners participants from auth are still students expecting grades in their project work. how will 'self evaluation' and peer review compliment their grades?

[17:55] <andreasmeiszner> ericb2: regarding "workaround" - I think for the time being "workarounds" are important to slowly build up virtual
learning arrangements / environments. Means to improve them based on identified NEEDS, instead of just going back to the elearning hype
mistakes and designing complex systems that than won't work as hoped

[17:55] <Sowe> ericb2 do you have you evaluation process discussed somewhere?

[17:56] <ericb2> Sowe: I started long time ago, but so far not too much of people were interested

[17:56] <ericb2> Sowe: but this will become concrete with our growing visibility

[17:57] fredus froumi

[17:57] <ericb2> Sowe: e.g. Ecole Centrale Nantes appreciated what we did, and we'll discuss how to improve concretely around end of March

[17:58] <ericb2> Sowe: same for UTBM , more easy, because local for me :)

[17:59] <ericb2> andreasmeiszner: we build everything from scratch : often the most difficult task

[17:59] <ericb2> andreasmeiszner: that's the reason why I'm glad to learn of you and all other approaches

[18:00] <Sowe> ok ericb2. if you have access to the OSS 2006 proceedings, i discussed our evaluation procedure

[18:00] <andreasmeiszner> ericb2: Any concrete roadmap forward? regarding "from scratch" - the netgeners space is - obvioulsy - open
source components and easily to identified needs

[18:00] <andreasmeiszner> sorry for the english

[18:00] <Sowe> or send me email and i send you some doc on some of our experience at Auth in implementing the outside approach

[18:01] <ericb2> andreasmeiszner: we need help. We wrote a lot, but don't have enough of people helping. this is another problem we have

[18:01] <ericb2> Sowe: I don't think I have access.

[18:02] <ericb2> andreasmeiszner: the roadmap is have results with Seneca College students (11), ECN students ( 4) and UTBM students ( 4) +
finalize the work a student from Epitech did

[18:02] <andreasmeiszner> ericb2: what i meant is: the netgeners space consists of open source solutions, and if you don't want to start from
scratch be welcome to use the space or software.

[18:03] <ericb2> andreasmeiszner: we don't start from scratch. I'm used to manage projcts too (I did for the Mac port previously). What we
need is more people involved. There is too much to do

[18:04] <ericb2> andreasmeiszner: in the roadmap, fardad should help me soon :)

[18:04] <ericb2> andreasmeiszner: and I expect other will join, to teach what we do

[18:05] <fardad> andreasmeiszner: I think what you suggest is very close to what we do in seneca where students form a small community in
college and do "Open WorkShops". They can use any Open resource in the world to do their tasks. When they understand how "Open Source"
work in general, they join open source communites and work on real projects.

[18:05] <andreasmeiszner> ericb2: do you know if someone from here be at the educamp workshop? We are currently setting up a proposal for
the Erasmus call to request funding to get this work further - though the funding available is max 300k per project over 2 years (at 75%) funding
rate

[18:06] <ericb2> andreasmeiszner: excepted me - I have to change my plane - I don't think thre will someone else, but I hope I'm wrong :)

[18:07] <ericb2> andreasmeiszner: I'm not sure to understand how OOo Education Project could be concerned, sorry

[18:07] <andreasmeiszner> fardad: this seems to be very close - what I think could still be missing is to have all of those different initiatives linked in a more structured way (like netgeners / hybrid approach suggests).

[18:08] <andreasmeiszner> ericb2: andreasmeiszner: I'm not sure to understand how OOo Education Project could be concerned, sorry - could you explain this please, i don't understand it

[18:09] <ericb2> andreasmeiszner: yes, if I'm not wrong Erasmus is for schools, or at least official institutions, right ?

[18:09] <ericb2> andreasmeiszner: we are nothing of that

[18:10] <andreasmeiszner> Specific call objective: 2.2.2. Projects focusing on cooperation between higher education institutions and
enterprises

[18:10] <ericb2> andreasmeiszner: the only official thing we have around is the non profit association, allowing us to manipulate money

[18:10] <Sowe> My sincere apology for leaving this very interesting discussion....i have an appointment now

[18:10] <andreasmeiszner> see ya sulayman!

[18:10] <ericb2> Sowe: the log will be available there :
http://wiki.services.openoffice.org/wiki/Education_ClassRoom/Previous_Logs/Hybrid_Model_of_Teaching_OpenSource

[18:10] <ericb2> (partial log for now of course :)

[18:10] <Sowe> Andreas: hopefully we should this kind of session again.

[18:10] * fredus has quit (Read error: 110 (Connection timed out))

[18:11] <ericb2> Sowe: you're welcome :)

[18:11] <Sowe> ah thanks ericb2 for the logs

[18:11] <jza> for log porpouses can someone list the conclusion

[18:11] <Sowe> bye for now

[18:11] <ericb2> Sowe: bye

[18:12] <jza> it would be easier now that the information is still fresh

[18:12] * Sowe has quit ("Leaving")

[18:12] <andreasmeiszner> jza: I think we haven't summed it up yet (but should do)

[18:15] <andreasmeiszner> From my side two conclusions would be A. to see if the open office educational projects and the netgeners / hybrid
idea could be aligned. E.g. also Mozilla is working in the same direction https://wiki.mozilla.org/Foundation:Planning:Education

[18:16] * Eleni (i=econst@sweng10.csd.auth.gr) has joined #education.openoffice.org

[18:16] * ericb2 thinks the presentation is extremely important, because available documents are a good starting point

[18:16] <ericb2> Eleni: hello :)

[18:16] <andreasmeiszner> IMO there is much room to avoid duplicate work, look for common grounds,save resources and create triple win
scenarios

[18:16] <Eleni> hello!

[18:16] <ericb2> andreasmeiszner: exactly. We can save years

[18:16] <andreasmeiszner> hi eleni!

[18:16] <Eleni> i am sorry for the delay

[18:17] <andreasmeiszner> no prob

[18:17] <ericb2> andreasmeiszner: I'll do my best to attend the Camp

[18:17] >Eleni< the log is there :
http://wiki.services.openoffice.org/wiki/Education_ClassRoom/Previous_Logs/Hybrid_Model_of_Teaching_OpenSource

[18:18] <andreasmeiszner> and B. would be (in the case there is a common ground) to put in a joint project proposal for funding - Erasmus call
would be the first option, but likely further to come

[18:18] <andreasmeiszner> so we would have a better (financial) base - because by now also our work is "non-funded"

[18:20] * katerina (i=katerina@swengpc5.csd.auth.gr) has joined #education.openoffice.org

[18:20] <katerina> hello

[18:20] <ericb2> katerina: hello :)

[18:20] <katerina> sorry for the delay

[18:20] <jza> hi katerina

[18:20] >katerina< : FYI the log is there :
http://wiki.services.openoffice.org/wiki/Education_ClassRoom/Previous_Logs/Hybrid_Model_of_Teaching_OpenSource

[18:20] <andreasmeiszner> hi katerina!

[18:21] <andreasmeiszner> Katerina & Eleni are from the Aristotl course team btw. They continue the work that Sowe started

[18:21] * jza_ (n=jza@189.132.187.165) has joined #education.openoffice.org

[18:22] <andreasmeiszner> @all: further sum up suggestions?

[18:22] <ericb2> In the conclusion, things are clear for me: we should really take care to avoid duplicated efforts

[18:22] <ericb2> the reflexion is imho enough advanced, and it's time for choose / stick to a model , or at least define rules to work together

[18:22] <fardad> amen to that...

[18:24] <david_jaco> I have to leave, but I'll check the wiki and documents, there's certainly room for collaboration with some of the projects
we're working on

[18:24] <david_jaco> see you all!

[18:24] <ericb2> david_jaco: see you :)

[18:24] <andreasmeiszner> ericb2: I agree as there is no added value for no side. Also: whichever "virtual solution" chosen is fine for me - but I
think that it should not be a one to many approach (e.g. one university to several open source projects, or several universities to one open source projects) - max value would be a many to many solution

[18:24] <andreasmeiszner> by david!

[18:25] * david_jaco has quit ("Ex-Chat")

[18:26] <ericb2> another question nobody asked. what is the most interesting ? create OpenOffice.org developers from inside or from outside
the OpenOffice.org project. So far this is a uniq case for me

[18:26] <andreasmeiszner> ericb2: ? sorry, I am lost on this?

[18:26] <ericb2> fardad: if I'm not wrong, the Seneca college is not Mozila , isn't it ?

[18:26] <fardad> ericb2: Oh, now I got it,

[18:27] <ericb2> andreasmeiszner: OpenOffice.org Education Project aims to find developers, and teahc them everything. At least that's what I
do for all the students I mentored

[18:27] <fardad> no, seneca works Most activly with Mozilla, then Fedora, IBM Eclipse and then OOo

[18:27] <ericb2> andreasmeiszner: so far, only OpenOffice.org does that. My question was : is it a good thing ?

[18:28] * fredus (n=fredus@ip-166.net-80-236-11.asnieres.rev.numericable.fr) has joined #education.openoffice.org

[18:28] <ericb2> fardad: here it is one to one

[18:28] <andreasmeiszner> ericb2: it is clear to me that each open source project is looking for ways to get in contributers, but yet I think a
common (many to many) approach has more to offer - at least if all sides are to win

[18:30] <andreasmeiszner> ericb2: so what would be the way forward? meeting at educamp, if you can make it?

[18:31] <ericb2> andreasmeiszner: this is an important point, indeed. When we discussed the point some times ago, the reason we found was:
there is so much of code in OpenOffice.org that you can do approximatively everything

[18:31] <ericb2> andreasmeiszner: I'll try

[18:31] <ericb2> andreasmeiszner: once sure, I'll tell you

[18:31] <ericb2> andreasmeiszner: not siple to change a plane once booked

[18:31] <ericb2> simple

[18:31] <andreasmeiszner> ericb2: ok, alternative ways forward?

[18:32] <ericb2> andreasmeiszner: meeting at educamp is imho the best

[18:32] <ericb2> andreasmeiszner: because lot of other proposals will be presented I guess

[18:33] <fardad> ok, i think I missed it, educamp?

[18:33] <ericb2> fardad: Mozilla organizes an Educamp in Bruxelles the 6th of february

[18:33] <andreasmeiszner> fardad: Events/EduCamp@FOSDEM2009 - MozillaWiki

[18:33] <andreasmeiszner> sorry

[18:33] <fardad> I see...

[18:33] <andreasmeiszner> https://wiki.mozilla.org/Events/EduCamp@FOSDEM2009

[18:34] <ericb2> fardad: Mark surman announced me that 10 minutes after I booked my plane :/

[18:35] <andreasmeiszner> fardad: This event should be a good opportunity to reflect on way forwards and as it looks a diverse number of
people would be present

[18:36] <fardad> I see

[18:38] <ericb2> Other questions ?

[18:38] <andreasmeiszner> so, to sum it up: we try meeting at educamp to discuss ways forward, in the case this won't work - what is the plan
b?

[18:39] <ericb2> andreasmeiszner: when will you quit Bruxelles ?

[18:39] <fardad> Well, I'll read about it :)

[18:39] <andreasmeiszner> ericb2: i will arrive on the 6th at 9.00 and leave on - let me check

[18:40] <andreasmeiszner> ok, flight back is on the 7th at 11.45

[18:41] <ericb2> andreasmeiszner: oops, will be difficult. So I must change my plane. I'll try asap

[18:41] <ericb2> andreasmeiszner: oops, will be difficult. So I must change my plane. I'll try asap

[18:42] <andreasmeiszner> ericb2: ok, so let me know - if not we can come up with a plan b

[18:43] <ericb2> andreasmeiszner: yes, as I said, I'll try asap. Say in 10 minutes

[18:43] <andreasmeiszner> Wouter / Eleni / Katerina - is there still anything from your side?

[18:43] <andreasmeiszner> ericb2: ok

[18:44] <jza_> conference call might be a good way to further this without relying on an event IMHO

[18:44] <fardad> jza_: agreed...

[18:45] <fardad> cheers...

[18:45] <ericb2> jza_: this event is very close and extremely important. Anyway, I'll notice everything

[18:45] * fardad is now known as fardad_afk

[18:45] jza jza_

[18:45] <ericb2> jza_: and FYI, I'll have to pay a supplement to change my plane. Nobody will fund that

[18:45] <andreasmeiszner> jza_: conference call could be a plan b - or follow up after the educamp

[18:46] <katerina> no

[18:47] <andreasmeiszner> jza_: if you want we can use the Open University's flashmeeting videoconferencing system - sessions can also be recorded, so others could watch them later

[18:50] <jza_> andreasmeiszner: I think is a very viable and cheap way to move on this affairs

End of meeting

[[category:Education/Classroom]]

Education ClassRoom/Previous Logs

2009-12-31T06:23:14Z

Kirk:

== Previous Logs ==

[[Education_ClassRoom/Previous Logs/MercurialMigration | '''OpenOffice.org Mercurial migration''' ( Heiner Rechtien, 11th of November 2009 ) ]]

[[Education_ClassRoom/Previous Logs/git | '''Introduction to git''' ( Jérémie Laval, 11th of June 2009 ) ]]

[[Education_ClassRoom/Previous Logs/Hybrid_Model_of_Teaching_OpenSource | '''Hybrid Model of Teaching OpenSource''' ( Andreas Meiszner, 26th of January 2009 ) ]]

[[Education_ClassRoom/Previous Logs/OpenOffice.org_Coding_Guidelines | '''OOo Coding Guidelines''' ( Thorsten Behrens, 13rd of November 2008 ) ]]

[[Education_ClassRoom/Previous Logs/OOo_svn_migration | '''OOo migration to svn''' ( Heiner Rechtien, 8th of October 2008 ) ]]

[[Education_ClassRoom/Previous Logs/be_warning_free | '''Write warning free code''' ( Eric Bachard, 26th of July 2008 ) ]]

[[Education_ClassRoom/Previous Logs/cwstooling_part1 | '''CWS Tools (part 1)''' ( Eric Bachard, 28th of June 2008 ) ]]

[[Education_ClassRoom/Previous Logs/framework_part1 | '''Framework Project (part 1) ''' ( Mathias Bauer 3rd June 2008) ]]

[[Education_ClassRoom/Previous Logs/gsl | '''GSL Project ''' ( Philipp Lohmann 21st May 2008) ]]

[[Education_ClassRoom/Previous Logs/tinderboxes| '''All about tinderboxes''' ( Christian Lohmaier 19th May 2008) ]]

[[Education_ClassRoom/Previous Logs/Introduction| '''OpenOffice.org Development Introduction''' ( Eric Bachard 7th May 2008) ]]

[[category:Education/Classroom]]

Education ClassRoom/Practice

2009-12-31T06:22:28Z

Kirk:

Draft

Since we use subversion, some parts are obsolete, and need to be updated

Objective : create exercices, to practice OpenOffice.org tools used for development

TODO : define a list of items

== Join the Project ==

=== Login and accounts ===

* Create your login on the OpenOffice.org wiki
* Become member of Education Project, using the Education Project wiki page : http://wiki.services.openoffice.org/wiki/Education_Project

=== Find a page or a document ===

* Find the web page for your own locale in OpenOffice.org project ( e.g. nl.openoffice.org )
* Find the OpenOffice.org Coding Guidelines on the Wiki ( and read it ... )
* Find the page about cws ( Child Workspace )
* Find dev@gsl.openoffice.org mailing list archive
* Subscribe to dev@education.openoffice.org mailing list if you didn't yet
* Extract mails 10 to 14 from any mailing list

=== Bonsai use ===

* Discover Bonsai
* Visualize changes in a cws
1) Go to http://bonsai.go-oo.org/cvsqueryform.cgi

We'll try to do a request :)

2) Don't modify Module (must be All files in the repository ) Remark : note the name "repository "

3) In the Field "Branch" replace HEAD with cws_dev300_aquavcl07

4) in the field "Date" check "Since the beginning of time "

5) do not modify the other fields

6) Click "Run Query"

=> all the changes in the code, based on DEV300_m9 ( we'll explain later) are on the page !!

7) To see the diff for any commit, click in the Rev. columns. Back to retrieve the current page.

Strongly advised : 8) Look carefully at other changes, what information you can obtain here.

Remark: Bonsai helps when you are searching for changes in the code, author date .. precise information about CODE

=== SVN use ===

[[User:Ericb|Ericb]] 16:53, 17 February 2009 (UTC)

==== Outline of the ClassRoom ====

1) Create patches using svn

2) apply a patch

3) rebuild a module

4) rebuild a module including symbols

5) run OOo with gdb (introduction of gdb use)

Introduction : in this part, we will create, apply patches using svn tool. To simplify, we'll suppose the patches are in unified mode. Means:

- 3 lines of context before the change

- a line who starts with " - " means the line before the old version (if the old version was existing)

- a line starting with " + " means after the change(s), if a new version does exist

- 3 lines of context after the change

For example :

ordinateur-de-eric-b-2:~/Desktop/ecntablet01 ericb$ svn diff sd/source/ui/slideshow/slideshow.hrc
<pre>
Index: sd/source/ui/slideshow/slideshow.hrc
===================================================================
--- sd/source/ui/slideshow/slideshow.hrc (revision 267130)
+++ sd/source/ui/slideshow/slideshow.hrc (working copy)
@@ -38,8 +38,10 @@
#define CM_SCREEN_BLACK 5
#define CM_SCREEN_WHITE 6
#define CM_ENDSHOW 7
-#define CM_FIRST_SLIDE 8
-#define CM_LAST_SLIDE 9
-#define CM_SLIDES 10
+#define CM_ERASE_ALLINK 8
+#define CM_ERASE_INK 9
+#define CM_FIRST_SLIDE 10
+#define CM_LAST_SLIDE 11
+#define CM_SLIDES 12

#endif
</pre>

==== Create patches using svn ====

Lot of possibilities. Below some of them. Probably better solutions do exist. This is just a little inventory of the possibilities.

* you got a tree, did some modifications, and you want to send the patch to a friend

=> The idea is to compare your current tree with the one *before* the changes.

To visualize the changes :
ordinateur-de-eric-b-2:~/Desktop/moz2seamonkey01 ericb$ svn diff slideshow/source/inc/userpainteventhandler.hxx

The command (without the prompt) is :

svn diff slideshow/source/inc/userpainteventhandler.hxx

The result is :
<pre>
Index: slideshow/source/inc/userpainteventhandler.hxx
===================================================================
--- slideshow/source/inc/userpainteventhandler.hxx (revision 267652)
+++ slideshow/source/inc/userpainteventhandler.hxx (working copy)
@@ -53,6 +53,9 @@
virtual ~UserPaintEventHandler() {}

virtual bool colorChanged( RGBColor const& rUserColor ) = 0;
+
+ virtual bool eraseAllInkChanged(bool const& rEraseAllInk) =0;
+ virtual bool eraseInkChanged(bool const& rEraseInk) =0;
virtual bool disable() = 0;
};
</pre>

To create the patch for true, the command is :
svn diff slideshow/source/inc/userpainteventhandler.hxx > my pretty patch.diff

And " my_pretty_patch.diff " will contain the same.

* you want to create a patch between a cws and a milestone (the one the cws is based on )

For example, to extract the changes in helpcontent2, ab65 introduced

svn diff http://svn.services.openoffice.org/ooo/tags/DEV300_m35/helpcontent2 http://svn.services.openoffice.org/ooo/cws/ab65/helpcontent2 > mydiff.diff

* you want to create a patch between two svn revisions for a given cws

IMPORTANT: you can follow the recent commits there : http://cia.vc/stats/project/OOo

Example of change (in one line) :

svn diff http://svn.services.openoffice.org/ooo/cws/ooo31gsl2/vcl@268180 http://svn.services.openoffice.org/ooo/cws/ooo31gsl2/vcl@268182

* using svn log, you want to create the diff between two revisions of the same file

For example :

ordinateur-de-eric-b-2:~/Desktop/moz2seamonkey01 ericb$ svn log configure.in
Enter passphrase for key '/Users/ericb/.ssh/id_dsa_ooo_svn':
------------------------------------------------------------------------
r267684 | ericb | 2009-02-12 18:13:52 +0100 (Thu, 12 Feb 2009) | 1 line

#i94628# fix a path issue for finding seamonkey01
------------------------------------------------------------------------
r267656 | ericb | 2009-02-12 14:13:21 +0100 (Thu, 12 Feb 2009) | 1 line

#i94628# other missing changes for Windows

==== Apply a patch ====

Essential options :

--dry-run : fakes the patch application *extremely usefull* if you want to check whether a patch will apply, without create garbage in your tree

-R : reverse it -> we suppose you already applied the patch, did no change and want to reverse the patch, to retrieve the same code as before

-p0 : apply a patch using the exact path the files have. Important: your tree does match with the path of the file the patch will be applied, *AND*
you apply it form the right location

-p1 : you remove the first subdir of the path for every to be patched file listed in th patch

Correct way of application :

Fake the application :

patch --dry-run -p0 < my_patch.diff

If nothing wrong occurs :

patch -p0 < my_patch.diff

Other possibility, not recommended because of the UUOC (useless use of cat) :

cat my_patch.diff | patch -p0

Depth of the application:

e.g. let's suppose a patch has to modify :

vcl/source/aqua/source/window/salframeview.mm
vcl/source/aqua/source/gdi/salprn.cxx
vcl/source/aqua/inc/salframeview.h

You can :

apply the patch from

* the root of the sources :

patch -p0 < my_patch.diff

* inside vcl :

patch -p1 < my_patch.diff

* inside vcl/aqua

patch -p2 < my_patch.diff

You cannot apply patch from elsewhere, because the paths will no longer match with the one every of the file contained in it.

* mix of applying patches + svn use

e.g. you did a wrong change in a module, and you want to reverse it directly :

cd module

svn diff apath/afile.cxx | patch -R -p0

for the entire local tree :

svn diff . | patch -R -p0

==== Rebuild a module where a patch has been applied ====

* Introduction

We suppose we modified some files, and we need to rebuild a lib. The scheme is always the same, in every module concerned by the build.

- the first prj/build.lst does contain the modules dependencies, means all the listed modules are prerequisites
- everything built inside a module is put in type_os_proc.pro

e.g. on Mac OS X, type == unx , os == macx , I for Intel -> output dir is unxmacxi.pro

Note: have a look in solenv/inc -> all the possible arch/os have their own makefile, containing the essential for the build.

The last modification date is used to check the dependencies.

Rule : If a .o is older than it's depenencies, it is rebuild
-> once you modified a file ( touch file is enough) , build in a module will create a new lib

* rebuild libvclmxi.dylib on Mac ( .so on Linux, .dll on Windows )

Hypothesis : we suppose the build is completed, and successfull.

cd vcl
touch aqua/source/gdi/sallayout.cxx
build

If you are in aqua/source/gdi , and you want to rebuild *only* the files listed in the makefile in the current dir, do :

dmake killobj
build

Once done, and if you want to see the changes packaged, :

deliver
cd ../instsetoo_native
build # will rebuild a new installset

Else, if you just want to test your lib, put it in the right subdir
(probably in <Install_dir>/OpenOffice.org.app/Contents/basis-link/program on Mac OS X )

==== Build including symbols ====

Example

-> in vcl

cd vcl
mv unxmacxi.pro unxmacxi.pro_back # keep the normal build
build debug="a_non_empty_sting" # means " build debug=t " is ok

The final lib, including symbols for debugging, will be in unxmacxi.pro/lib (on Mac OS X )

Replace the one already in <Install_dir>/OpenOffice.org.app/Contents/basis-link/program on Mac OS X

To debug using gdb,do :

cd <Install_dir>/OpenOffice.org.app/Contents/program

gdb --args soffice apath/afile

"r" (to start) .. and so on;

Happy debugging !

=== gdb basics ===

FIXME : make the look of the log more .. appealing ;)

Candidates ?

TODO : add my document providing the most usefull gdb commands

Outline of the ClassRoom

* Prerequisites for the test
* Reminder about what happens when building in a module
* Add symbols in a library
* Introduction of gdb use
* Launch OOo using gdb
* Play with it (discovery)

[18:05] ericb2 So today, we'll start playing with gdb + Ooo

[18:05] ericb2 who does have a full OOo build at hand ?

[18:06] ericb2 ok :)

[18:06] ericb2 As pre-requisites , I'll suppose :

[18:06] ericb2 - there is a complete build working already

[18:06] ericb2 - there is a working installset , and we will launch it using the terminal
[18:06] ericb2 Thus, if you want to redo at home, or later, you just have to read and try

[18:07] ericb2 Reminder : what happens when something is built

[18:07] ericb2 we'll use <module> for whatever subdir of the OOo tree, aka "module" most of the time

[18:08] ericb2 <module>/prj/build.lst does contain the list of the subdirs containing a makefile

[18:08] ericb2 Means: Every product is built in the output dir. e.g. : unxmacxi.pro on Mac Intel

[18:08] ericb2 we have the same tree inside all the modules:

[18:08] ericb2 unxmacxi.pro/bin

[18:09] ericb2 unxmacxi.pro/lib

[18:09] ericb2 unxmacxi.pro/inc

[18:09] ericb2 ... and so on (look yourself )

[18:09] ericb2 to rebuild a module, just remove this directory

[18:09] ericb2 Once all the .o are build, the libs, and/or the binaries / resources / whatever are "delivered" from the unxmacxi.pro dir to
the solver

[18:11] ericb2 The information providing the list of what has to be delivered is always in : <module>/prj/d.lst

[18:12] ericb2 these files are text files, using a "Windows" separator, but this is not a problem at all

[18:12] * l_zahir (n=chatzill@142.204.16.10) has joined #education.openoffice.org

[18:13] ericb2 If we summarize : a normal build provides binaries like libraries, who are stripped when the are delivered. Between the
unxmacxi.pro and their place in the "solver "

[18:14] ericb2 Important: to be able to trace using gdb, we'll need to add symbols, lines of code and a lot of information inside the binaries

[18:14] ericb2 Howto add symbols in a library ?

[18:14] ericb2 1) first approach

[18:15] ericb2 -> look at configure extra option : --disable-strip-solver

[18:15] ericb2 To verify by yourself, just place you at the root of the sources (since DEV300_m40, there is no longer config_office subdir)

[18:15] ericb2 and do : ./configure --help | grep -4 solver

[18:16] ericb2 you'll have several lines explaining the right option

[18:16] ericb2 Tip : if you're familiar with configure, better read configure itself, more informative ;-)

[18:17] ericb2 and if you know a bit of autoconf, you can even hack configure.in, and run autoconf to regenerate a new configure :)

[18:18] ericb2 The first approach has a drawback : just a bit of information is inside the binary, and that's not enough most of the time,

when you have a complex problem to solve

[18:19] ericb2 2) second approach

[18:19] ericb2 consider only a part of the code, for tracing

[18:20] ericb2 The method is equivalent to use --enable-debug at configure time, but nobody uses this option. the reason is simple : all
libraries become huges, and OOo won't probably launch correctly.

[18:21] ericb2 e.g. : the libsw (writer) becomes 660MB heavy

[18:22] fardad ericb2: when you say correctly, does it mean it will be too slow, or it will not function properly?

[18:22] Kamots wow, that's a lot of extra weight

[18:23] ericb2 fardad: yes, imagine 10 libs of 500MB every + some other 100MB and so on

[18:23] ericb2 Kamots: I'll explain you how to proceed

[18:23] fardad wow, :o

[18:24] ericb2 Other important information

[18:24] ericb2 about assertions

[18:24] ericb2 There is another option in configure

[18:24] ericb2 --enable-dbgutil

[18:25] ericb2 Include additional debugging utilities, such assertions, object counting, etc. Larger build.

[18:25] ericb2 Independent from --enable-debug

[18:25] ericb2 the *second one* does concern assertions in the code :

[18:25] ericb2 DBG_ASSERT( !(rALR.flags & kATSGlyphInfoTerminatorGlyph),

[18:25] ericb2 "ATSLayout::InitGIA(): terminator glyph not marked as deleted!" );

[18:26] ericb2 -> if the condition is not verified -> boom .. and a window will appear, containing the message

[18:26] ericb2 if --enable-dbgutil is not in the configure command line, assertions are not included

[18:27] ericb2 As you understood, assertions are for development, not for end users ;-)

[18:27] ericb2 So, we use to add symbols for debugging for some libs, in a given module only

[18:27] ericb2 Counterpart : needs to rebuild the module

[18:28] ericb2 The process is very simple :

[18:28] ericb2 cd <module>

[18:28] ericb2 mv unxmacxi.pro unxmacxi.pro_backup

[18:28] ericb2 build debug=t

[18:28] ericb2 Do *always* a backup of your build, because the binaries in the output tree, do match with stamps in the solver

[18:29] ericb2 if you modify something, you'll have to redo a build, and a "deliver". Elser, the build can break at postprocess, or at then end,
because the stamp between the solver and the module do not match

[18:29] ericb2 that's just harmless, but if you are not aware, you can lose a while before someone explains you what happens

[18:31] ericb2 As example, I'll rebuild a little lib , to show you the difference

[18:31] ericb2 cd apple_remote/

[18:32] ericb2 source ../MacOSXX86Env.Set.sh

[18:32] ericb2 sorry, I forgot :-)

[18:32] ericb2 mv unxmacxi.pro unxmacxi.pro_back

[18:32] ericb2 build debug=t

[18:32] ericb2 Important: whatever you put, will work

[18:33] ericb2 t is one letter, but once the string is not empty, debug is true

[18:33] ericb2 means all the code included between #ifdef DEBUG ... #endif or some other macros, will be included

[18:34] ericb2 e.g. :

[18:34] ericb2 #ifdef DEBUG

[18:34] ericb2 // debug purpose

[18:34] ericb2 NSLog(@"reset... (after listening to remote)");

[18:34] ericb2 #endif

[18:34] ericb2 -> in the terminal, I'll see the information

[18:34] ericb2 NSLog is sort of cout

[18:35] fardad ic,

[18:35] ericb2 After the rebuild :

[18:35] ericb2 ls -l unxmacxi.pro/lib/libAppleRemotemxi.dylib

[18:35] * lgodard has quit ("Leaving.")

[18:35] ericb2 -rwxr-xr-x 1 ericb ericb 159932 Feb 19 18:31 unxmacxi.pro/lib/libAppleRemotemxi.dylib

[18:35] ericb2 ls -l unxmacxi.pro_back/lib/libAppleRemotemxi.dylib

[18:36] ericb2 -rwxr-xr-x 1 ericb ericb 52436 Feb 12 14:31 unxmacxi.pro_back/lib/libAppleRemotemxi.dylib

[18:37] ericb2 the first one does contain strings and a lot of other stuff

[18:37] ericb2 Now .. Launch OOo in a terminal :)

[18:37] ericb2 before, we'll copy the lib in the bundle

[18:37] IZBot News from cws: native227: created

[18:38] ericb2 For the rest, my bundle is in the Desktop/test_eraser folder (I'm on Mac OS X )

[18:38] ericb2 Means, the Bundle is the dir : ~/Desktop/test_eraser/OpenOffice.org.app

[18:38] ericb2 So, I'll open a terminal, and I'll do :

[18:39] ericb2 cd ~/Desktop/test_eraser/OpenOffice.org.app/Contents/program

[18:39] ericb2 the idea, is to start gdb form the directory containing soffice (the binary )

[18:39] ericb2 and the command line is :

[18:40] ericb2 gdb --args ~/Desktop/est.odp

[18:40] ericb2 you'll see gdb tell you a lot of things. If you don't want to see that the next time, you can add -q (for quiet) option

[18:41] ericb2 as you can see nothing happens :)

[18:41] ericb2 the reason is: the binary is not "running"

[18:42] ericb2 oops, sorry

[18:42] ericb2 gdb --args soffice ~/Desktop/est.odp

[18:42] ericb2 is the right command line

[18:42] ericb2 to redo; just enter "q"

[18:42] ericb2 and type the correct command

[18:43] ericb2 now, type r ( shortcut for "run" )

[18:43] ericb2 -> OOo will start

[18:43] ericb2 and open the file

[18:44] ericb2 in the terminal, you no longer have the control. To stop the execution, do "CTRL-C"

[18:44] ericb2 Program received signal SIGINT, Interrupt.

[18:44] ericb2 0x90009cd7 in mach_msg_trap ()

[18:44] ericb2 (gdb)

[18:44] ericb2 OOo is stopped

[18:44] ericb2 you can enter whatever command, like " info frame "

[18:45] ericb2 to continue, type : c

[18:45] ericb2 The result is : (gdb) c

[18:45] ericb2 Continuing.

[18:45] ericb2 and OOo is no longer stopped

[18:45] ericb2 Add a breakpoint

[18:45] fardad amazing...

[18:46] ericb2 fardad: I know this is difficult like that, but people will redo later, and ask whenever they want

[18:46] ericb2 on the channel

[18:46] ericb2 we'll explain them

[18:46] fardad I understand

[18:47] ericb2 Let's add a breakpoint now

[18:47] ericb2 to know whether breakpoints are set or not, the command is :

[18:47] ericb2 info b

[18:47] ericb2 (means info breakpoints)

[18:48] ericb2 exactly :

[18:48] ericb2 CTRL-C

[18:48] ericb2 info b

[18:48] ericb2 The result is :

[18:48] ericb2 (gdb) info b

[18:48] ericb2 No breakpoints or watchpoints.

[18:48] ericb2 of course

[18:48] ericb2 so let's set one

[18:49] ericb2 Since only libAppleRemotemxi.dylib has symbols, I'll have to set one in whatever file included

[18:49] ericb2 say RemoteMainController.m

[18:49] ericb2 We can either choose a method

[18:50] ericb2 Syntax : b 'class:myMethod'

[18:50] ericb2 or at some line :

[18:50] ericb2 Syntax : b RemoteMainController.m:118

[18:50] ericb2 The result is :

[18:50] ericb2 (gdb) b RemoteMainController.m:118

[18:50] ericb2 Breakpoint 1 at 0x338e1ea: file RemoteMainController.m, line 118.

[18:51] ericb2 and using the up/down arrow, the history is available (no need to type several times the same command ;)

[18:51] ericb2 (gdb) info b

[18:51] ericb2 Num Type Disp Enb Address What

[18:51] ericb2 1 breakpoint keep y 0x0338e1ea in -[MainController remoteButton:pressedDown:clickCount:] at
RemoteMainController.m:118

[18:52] ericb2 The line is inside a method, I'll hit every time I'll be in presentation mode, and when I'll hit a key

[18:53] ericb2 start the presentation, and when I type a key, I see:

[18:53] ericb2 Breakpoint 1, -[MainController remoteButton:pressedDown:clickCount:] (self=0x3433bf0, _cmd=0x338f994,
buttonIdentifier=kRemoteButtonPlay, pressedDown=1 '\001', clickCount=1) at RemoteMainController.m:118

[18:53] ericb2 118 pressed = @"(pressed)";

[18:54] ericb2 and the presentation is stopped

[18:54] ericb2 to continue, I have several choices :

[18:54] ericb2 n -> next instruction

[18:54] ericb2 s -> next group of instruction

[18:54] ericb2 c -> continue

[18:54] ericb2 l does list the matching code

[18:55] ericb2 For instance :

[18:55] ericb2 (gdb) l

[18:55] ericb2 113 #ifdef DEBUG

[18:55] ericb2 114 NSString* buttonName = nil;

[18:55] ericb2 115 #endif

[18:55] ericb2 116 if (pressedDown)

[18:55] ericb2 117 {

[18:55] ericb2 118 pressed = @"(pressed)";

[18:55] ericb2 119

[18:55] ericb2 120 #ifdef DEBUG

[18:55] ericb2 121 switch(buttonIdentifier)

[18:55] ericb2 122 {

[18:55] ericb2 Current language: auto; currently objective-c

[18:55] ericb2 (gdb)

[18:55] ericb2 I can go up or continue

[18:55] ericb2 and if I need info, I can check for the stack of frames

[18:56] ericb2 (gdb) bt

[18:56] ericb2 -> will return the frames, in *reverse* order. Means, the #0 is the last one, and #1 the one before .. and so on
[
18:56] IZBot no issue with number 1

[18:56] ericb2 ooops :-)

[18:57] ericb2 Lets choose "n" for next

[18:57] ericb2 The result is :

[18:57] ericb2 (gdb) n

[18:57] ericb2 121 switch(buttonIdentifier)

[18:57] ericb2 IMPORTANT: the current line is NOT executed yet

[18:57] ericb2 e.g. if you have a= 10;

[18:57] ericb2 p a

[18:57] ericb2 can return whatevert

[18:58] ericb2 *only* n will validate the line. This is the context

[18:58] ericb2 execution context

[18:58] ericb2 n will continue ..

[18:58] ericb2 (gdb) n

[18:58] ericb2 126 case kRemoteButtonPlay: buttonName = @"Play"; break; // MEDIA_COMMAND_PLAY

[18:59] ericb2 and of course, we can check for the variable :

[18:59] ericb2 (gdb) p buttonIdentifier

[18:59] ericb2 $1 = kRemoteButtonPlay

[18:59] ericb2 so, it means the slideshow will start ...

[19:00] ericb2 Next instruction :

[19:00] ericb2 (gdb) n

[19:00] ericb2 140 [ self postTheEvent:buttonIdentifier modifierFlags: 0 ];

[19:00] ericb2 -> means the remote sent a "Play" and I'll inform the vcl there is an event, containing the "Play" information. vcl will forward
to Impress, and the slideshow will start

[19:01] * jza (n=jza@189.132.182.161) has joined #education.openoffice.org

[19:02] * xerakko (n=Miguel@debian/developer/xerakko) has joined #education.openoffice.org

[19:02] ericb2 This is only the introduction (if people are intersted, we can do another workshop about gdb another day )

[19:02] ericb2 To quit *cleanly*

[19:02] ericb2 delete the brekapoints :

[19:02] ericb2 d

[19:02] ericb2 confirm with yest

[19:02] ericb2 yes

[19:02] * lgodard (n=lgodard@LAubervilliers-153-51-9-99.w193-252.abo.wanadoo.fr) has joined #education.openoffice.org

[19:02] ericb2 c

[19:02] ericb2 to continue

[19:02] ericb2 and then Quit OOo using CMD Q

[19:03] ericb2 The result is :

[19:03] ericb2 Program exited normally.

[19:03] ericb2 (gdb)

[19:03] ericb2 Then quit gdb :

[19:03] ericb2 q

[19:03] ericb2 -> will give you the normal prompt

[19:03] ericb2 back

[19:03] ericb2 Questions ?

[19:04] * WFred__ (n=chatzill@net1.senecac.on.ca) has joined #education.openoffice.org

[19:04] BartB not at the moment, might have some later

[19:05] ericb2 I forgot, to affect a value, the command is "set"

[19:05] ericb2 e.g. :

[19:05] MrBraini ericb2: last lecture you stated the notes from the lectures will be placed on the wiki? where can we find the notes in the wiki?

[19:05] ericb2 (gdb) : set a=10

[19:05] daeseon_ not now may be later.

[19:05] ericb2 MrBraini: I'll put them on the wiki, yes

[19:05] l_zahir is there a y way so we can see multiple line before their execution?

[19:05] l_zahir lgodard

[19:05] ericb2 l_zahir: list ?

[19:05] ericb2 l_zahir: l is the shortcut

[19:06] ericb2 l_zahir: I forgot, there is another way to break, using conditional breakpoint

[19:06] l_zahir oksu during debugging or before?

[19:06] ericb2 l_zahir : you can go up and down in the frames

[19:06] l_zahir lgodard

[19:06] ericb2 l_zahir to retrieve a context

[19:06] l_zahir ok , thanks

[19:07] ericb2 l_zahir: I think, the best is to redo a workshop, with everything ready

[19:07] ericb2 l_zahir: but nothing will replace the experiences
[
19:07] l_zahir sure

[19:08] <ericb2> l_zahir: no problem.

[19:08] <ericb2> BTW, I provided a patch for rhino and scripting

[19:08] <l_zahir> Oh, good :)

[19:08] <ericb2> was my fault: two modules where concerned, and this is what caused some issues

[19:08] <ericb2> l_zahir: one minute, I'll retrive the URL

[19:09] <l_zahir> thanks

[19:09] <l_zahir> :)

[19:09] <ericb2>
http://eric.bachard.free.fr/mac/aquavcl/patches/aqua_February2009/17th_february/complete_rhino_and_scripting_patch.diff

[19:09] <ericb2> l_zahir: this patch should apply cleanly on m40

[19:09] <ericb2> l_zahir: not sure it will work, I'm not a Java specialist ;)

[19:10] <ericb2> ok, I'll have to stop.

[19:10] <l_zahir> I'll try

[19:10] <ericb2> If you have further questions, ask directly, and if I see them, I'll answer

[19:10] * Remaille (n=remi@abo-166-155-68.bdx.modulonet.fr) has joined #education.openoffice.org

[19:10] * ChanServ gives channel operator status to Remaille

[19:11] <l_zahir> sure

[19:11] <ericb2> Other questions ?

[19:12] <ericb2> If you have no other questions, I'll stop for a while, but in ~2 hours max, I'll be back.

[19:12] <ericb2> The content of the classroom will be on the wiki

=== LXR use ===

[Complete me]

=== Checkout the code ===

Preliminary:

- we suppose you have some bash knowledge, and some programming skills

- your .cvsrc file is ok (else ask on #education.openoffice.org )

Now, open a terminal, use bash, and do :

0 ) create the environment

<div align="left" style="color:green; font-size:16px">'''If you don't have a proxy, do , '''(in a terminal) :</div>

'''export CVSROOT=":pserver:anoncvs@anoncvs.services.openoffice.org:/cvs"'''

<div align="left" style="color:red; font-size:16px">'''There is a proxy, and nothing works using the line above, do, '''(in a terminal) :</div>

Let the proxy be 100.101.102.103 ( name proxy.machine.education.org ) , and the open port 1234, then just do :

'''export CVSROOT=":pserver;proxy=100.101.102.103;proxyport=1234:anoncvs@anoncvs.services.openoffice.org:/cvs"'''

<div align="left" style="color:red; font-size:16px">'''And if you ignore the IP address of the gateway, but you know its name, do, '''(in a terminal) :</div>

'''export CVSROOT=":pserver;proxy=proxy.machine.education.org;proxyport=1234:anoncvs@anoncvs.services.openoffice.org:/cvs"'''

'''IMPORTANT''' : proxy.machine.education.org is just a fake name, as example. Please replace it with the one in your network :)

... it should work now (else, contact your sys admin).

For the next step, create TMP dir (command: mkdir TMP )

cd TMP

1) checkout vcl module from DEV300_m31

cvs co -r DEV300_m31 dtrans

Question: what happens ?

Download all OpenOffice.org tree :

mkdir DEV300_m31

cd DEV300_m31

cvs -4 co -r DEV300_m31 OpenOffice2

( -z4 is optional )

-> once done ( can be very long), and if no error occurs, you got all OpenOffice.org source code from DEV300_m31 Milestone !!

=== Create a patch ===

2) Modify one file, do "cvs up" , and comment on the result

3) using grep , retrieve the name of the milestone in the sources

4) checkout vcl from a cws under development

cvs -z4 co -r cws_dev300_aquavcl07 vcl

5) retrieve the cwsname in the sources

6) analyse the list of the subdirectories vcl contains

7) modify the code in vcl/source/gdi/sallayout.cxx

(write whatever you want, respecting C++ syntax prefered ;)

8) create a diff with the OpenOffice.org repository

change directory outside of vcl

in the current dir ( TMP ) , do :

cvs diff -u vcl > my_pretty_patch.diff

9) What does contain the patch ?

=== Apply and Reverse a patch ===

* Simulate a patch application

* Apply it for true

10) How reverse your changes ?

11) Be sure you have enough place on your hard disk ( count 2GB )

=== Fix a build breaker (most common breakages ) ===

==== A) Building OpenOffice.org ====

Note: add your own experience here !

=====Building on Ubunutu 7.10=====

-----------------------------------------------------
Ubuntu version : 7.10 - Gutsy Gibbon

Estimated time for the cnofiguration: 1h30

-----------------------------------------------------

1) Download OpenOffice.org source code

install subversion :
sudo apt-get install subversion

Command line for the download :
svn checkout svn://svn.services.openoffice.org/ooo/tags/DEV300_m39

-----------------------------------------------------

2) Java

'''Prefer the Sun JDK '''

Version of the installed Java (mini 1.5.0 )
Command line to check : java -version

In config_office tcsh was not found

'''Solution''' it to use the following option :
--with-use-shell=bash

-----------------------------------------------------

Archive::Zip is missing :

checking for required Perl modules... Can't locate Archive/Zip.pm in @INC (@INC contains: /etc/perl /usr/local/lib/perl/5.8.8 /usr/local/share/perl/5.8.8 /usr/lib/perl5 /usr/share/perl5 /usr/lib/perl/5.8 /usr/share/perl/5.8 /usr/local/lib/site_perl .) at -e line 1.
BEGIN failed--compilation aborted at -e line 1.
configure: error: Failed to find some modules

'''Solution''' :

apt-cache search archive | grep perl

Returns

libarchive-zip-perl - Module for manipulation of ZIP archives

'''Solution'''
sudo apt-get install libarchive-zip-perl

-----------------------------------------------------

'''Cups''' :
checking for cups/cups.h... no
configure: error: cups/cups.h could not be found. libcupsys2-dev or cups???-dev

'''Solution''':
sudo apt-get install libcupsys2-dev

pam :

checking for security/pam_appl.h... no
configure: error: pam_appl.h could not be found. libpam-dev or pam-devel missing?

'''Solution''':
sudo apt-get install libpam0g-dev

-----------------------------------------------------

javac:
checking for javac... no
configure: error: javac not found set with_jdk_home

'''Solution''':

Install Sun Java 1.5.0 from the URL below:

http://java.sun.com/javase/downloads/index_jdk5.jsp

JDK2 installed in /usr/local, means the following option is mandatory :

--with-jdk-home=/usr/local/jdk1.5.0_17

-----------------------------------------------------

Gperf:
checking for gperf... no
configure: error: gperf not found but needed. Install it.

Solution:
sudo apt-get install gperf

-----------------------------------------------------

unowinreg.dll:

checking whether to build the ODK... yes

checking for external/unowinreg/unowinreg.dll... configure: WARNING: not found, will be cross-built using mingw32

Looking at external/unowinreg, the readme invites to download unowinreg.dll at

http://tools.openoffice.org/unowinreg_prebuild/680

cd ../DEV300_m39/external/unowinreg/

'''Solution''':

wget http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll

-----------------------------------------------------

gtk+ stuff :

checking whether freetype is available... checking for pkg-config... /usr/bin/pkg-config
checking for freetype2 >= 2.0 ... Package freetype2 was not found in the pkg-config search path

Solution : install all the gtk+ stuff (first is freetype )

sudo apt-get install libfreetype6-dev

-----------------------------------------------------

Mozilla :

checking for mozilla-source-1.7.5.tar.gz... not found
checking for mozilla-source-1.7.5.tar.bz2... not found
configure: error: Mozilla source archive not found.
Please copy mozilla-source-1.7.5.tar.bz2 or mozilla-source-1.7.5.tar.gz to moz/download/.
The archives can be found here:
http://ftp.mozilla.org/pub/mozilla.org/mozilla/releases/mozilla1.7.5/source/

use prebuilt-archives downloadable from
http://tools.openoffice.org/source/browse/tools/www/moz_prebuild/680/

For Linux: LINUXGCCIinc.zip LINUXGCCIlib.zip LINUXGCCIruntime.zip

-----------------------------------------------------

Xaw:

checking X11/Xaw/Label.h usability... no
checking X11/Xaw/Label.h presence... no
checking for X11/Xaw/Label.h... no
configure: error: Xaw include headers not found

Solution :

sudo apt-get install libxaw6-dev

-----------------------------------------------------

Fontconfig:

checking fontconfig/fontconfig.h usability... no
checking fontconfig/fontconfig.h presence... no
checking for fontconfig/fontconfig.h... no
configure: error: fontconfig/fontconfig.h could not be found. libfontconfig1-dev or fontconfig???-devel missing?

Solution:
sudo apt-get install libfontconfig1-dev

-----------------------------------------------------

Xrandr:

checking for X11/extensions/Xrandr.h... no
configure: error: X11/extensions/Xrandr.h could not be found. X11 dev missing?

Solution:
sudo apt-get install libxrandr-dev

-----------------------------------------------------

Bison:

checking for bison... no
configure: error: no bison found in $PATH, install bison

Solution: sudo apt-get install bison

-----------------------------------------------------

Flex:
checking for flex... no
configure: error: no flex found in $PATH, install flex

Solution: sudo apt-get install flex

-----------------------------------------------------

Gconf-2.0:

checking whether to enable GConf support... yes
checking for gconf-2.0 ... Package gconf-2.0 was not found in the pkg-config search path. Perhaps you should add the directory containing `gconf-2.0.pc' to the PKG_CONFIG_PATH environment variable No package 'gconf-2.0' found
configure: error: Library requirements (gconf-2.0 ) not met; consider adjusti

Solution:
sudo apt-get install libgconf2-dev

-----------------------------------------------------

Gnomevfs:

checking for gnome-vfs-2.0 >= 2.6.0 ... Package gnome-vfs-2.0 was not found in the pkg-config search path. Perhaps you should add the directory containing `gnome-vfs-2.0.pc' to the PKG_CONFIG_PATH environment variable No package 'gnome-vfs-2.0' found
configure: error: Library requirements (gnome-vfs-2.0 >= 2.6.0 ) not met; cons

Solution:
sudo apt-get install libgnome-vfs-dev

WARNING: not available -> use the --disable-gnome-vfs option solved the issue

-----------------------------------------------------

libgtk+-2.0 missing:

Solution:
sudo apt-get install libgtk2.0-dev

-----------------------------------------------------

Ant missing:

checking for ant.cmd... no
configure: error: Ant not found - Make sure it's in the path or use --with-ant-home

Solution
Download apache-ant from (e.g.) :
http://archive.apache.org/dist/ant/binaries/

Install the decompressed archive in /usr/local

use : --with-ant-home=/usr/local/apache-ant-1.7.1

-----------------------------------------------------

'''EXTRA INSTALLATION'''

Use as much as possible system libs:

libxml : --with-system-openssl

To avoid broken dependencies, libxml2 + matching libxslt (development archives) must be installed.

sudo apt-get install libxslt1-dev libxslt1.1

Finaly,use the foloowing option to successfully pass configure : --with-system-libxml

openssl : --with-system-openssl

checking for openssl ... Package openssl was not found in the pkg-config search path. Perhaps you should add the directory containing `openssl.pc' to the PKG_CONFIG_PATH environment variable No package 'openssl' found

Solution:

sudo apt-get install libssl-dev

expat : --with-system-expat

berkeleydb : --with-system-db

checking for db.h... no
checking for db4/db.h... no
configure: error: no. install the db4 libraries

Solution : sudo apt-get install libdb4.4-dev

icu: --with-system-icu

checking for genbrk... no
configure: error: \genbrk\ not found in $PATH, install the icu development tool \genbrk""

Solution : sudo apt-get install libicu36-dev

neon : --with-system-neon

checking which neon to use... external
checking for neon >= 0.24.0... configure: error: you need neon >= 0.24.x for system-neon

Solution:
sudo apt-get install libneon26-dev

-----------------------------------------------------

Install ccache :

sudo apt-get install ccache

edit the ~/.bashrc and add the lines :

CC="ccache gcc"
CXX="ccache g++"
export CC CXX

save, close and open a new term => ccache will be detected at the next configure

-----------------------------------------------------

Final configure command line ( experimental, might be modified) :

<pre>
./configure \
--with-use-shell=bash \
--with-jdk-home=/usr/local/jdk1.5.0_17 \
--disable-build-mozilla \
--disable-gnome-vfs \
--with-ant-home=/usr/local/apache-ant-1.7.1 \
--with-lang=fr \
--with-system-libxml \
--with-system-libxslt \
--with-system-openssl \
--with-system-expat \
--with-system-db \
--with-system-icu \
--with-system-neon
</pre>

And configure is successfull :-)

Bootstrap :

cd $ROOT_SOURCES

./bootstrap # builds dmake

either :

dmake

or :

cd instsetoo_native

build --all -P4

Starts the build

See you tomorrow :)

===== Missing modules =====

e.g. missing alias in DEV300_m13 : hyphen module is not checked, causing missing headers, never delivered and then, a breakage in lingucomponent because of undefined functions/methods and so on

Solution: check out hyphen

export CVSROOT=":pserver:anoncvs@anoncvs.services.openoffice.org:/cvs"

Note: there is another solution for experimented devs, using tunnel

cvs co -r DEV300_m13 hyphen

===== Missing Files =====

===== Warnings =====

===== Missing headers =====

===== (deprecated) gcc parser issues =====

====B) Hacking OpenOffice.org ====

===== Syntax Errors =====

===== Missing headers =====

===== Multi inclusions =====

===== Linking issues =====

===== Visibility =====

[[category:Education/Classroom]]

Community Council/Funding And Budgets/Developer

2009-12-04T06:42:58Z

Kirk:

= Dashboard for the CC Developer Budget =

{| class="wikitable" border="1"
|-
! Action
! Requester
! Status
! PO
|-
| Renaissance meeting
| Christoph Noak
| approved
| open
|-
| [[BugBountyProgram | Bug Bounty Program]]
| Martin Hollmichel
| open
| -
|-
| SVG Implementation
|
| open, waiting for concept proposal (Kai Ahrens)
| -
|-
| Tinderbox: Windows and C++ license
| Florian Effenberger
| open, need to evaluate prices
| -

|}

[[Category:Community Council]]

Community Council/Items/Candidate Answers 200910

2009-12-04T06:42:19Z

Kirk:

= Elections 2009 =

For the community council elections in October/November 2009, the candidates and a link to mails in which they tell some more about their ideas, are:

* Alexandro Colorado [http://www.openoffice.org/servlets/ReadMsg?list=discuss&msgNo=65003 mail] (for Product Development Representative)
* Charles-H. Schulz [http://www.openoffice.org/servlets/ReadMsg?list=discuss&msgNo=65010 mail] and [[Introducing_Charles | wiki]] (for NLC Representative)
* Juergen Schmidt [http://www.openoffice.org/servlets/ReadMsg?list=discuss&msgNo=65098 mail] (for Code Contributor Representative)
* Christoph Noach [http://www.openoffice.org/servlets/ReadMsg?list=discuss&msgNo=65091 mail] (for Product Development Representative)

[[Category:Community Council]]

Community Council

2009-12-04T06:41:15Z

Kirk: /* Elections 2009 */

== Introduction ==

The origins and purpose of the OpenOffice.org Community Council are explained on the [http://council.openoffice.org/ main Community Council site], where you will also find a list of the current members.

These wiki pages are used to record the day to day running of the Council - agendas and minutes of meetings, budgets, etc.

== Meetings ==

* To raise an issue at the next Community Council Meeting, add it to the [[Community_Council/Agenda | Agenda of the next meeting]]. You must be an OpenOffice.org community member. The term, "Community Member," is described in our [http://www.openoffice.org/dev_docs/guidelines.html Guidelines].
* Minutes of past meetings are [[Community_Council/Minutes | here]]
* A Calendar of future meetings is [[Community_Council/Calendar | here]]
* Channel: #OOoCouncil (freenode)

== Council coordinator ==

Starting from May 28 2009, the council works with a internal coordinator.

The idea:
* appoint a council coordinator every 4 to 5 months
* he/she is chosen from the council members
* no formal change of rules intended.
Responsibility during that time:
* looking after planning, progress of AI's
* so basically: poking the colleagues ;-)
Expected:
* will improve overall cc-performance
* will help to share the feeling of really being part of, of joined responsibility
Approved:
* Cor Nouws is the first to take this role
* Stefan Taxhet will be the next
* and in 4 months, the third person for this fine job will be choosen

== Budget ==

Information about the Community Council budget and payments procedure is [[Community_Council/Funding_And_Budgets | here]].

== Improving the project ==

Watch and help the page for [[Community_Council/Project_Improvements | improvements in the project]].

== Elections 2009 ==

The results of the November 2009 election are:

*Code Contributor Representative: Juergen Schmidt
51 Yes, 9 No (68)

*NLC Representative: Charles-H. Schulz
39 Yes, 3 No (111)

*Product Development Representative: Christoph Noack
31 Votes Christoph Noack
9 Votes Alexandro Colorado
(49)

The observers, Sophie Gautier, Drew Jensen, and Mechtilde Stehmann, have all approved and confirmed the results. Our welcome and congratulations to the new Council members!

[[Category:Community Council]]

Calc:Tab Color Patches

2009-12-04T06:39:15Z

Kirk: /* See Also */

== Code Change Justifications and Explanation ==

=== Tab Color Core Support ===
:officecfg/registry/data/org/openoffice/Office/UI/CalcCommands.xcu
::Add entries for ".uno:SetTabBgColor" and ".uno:TabBgColor"
----
:sc/inc/globstr.hrc
::Define Global Strings
----
:sc/inc/scextopt.hxx
::Add Color maTabBgColor and BOOL IsDefaultTabBgColor() to the ScExtTabSettings Struct
----
:sc/inc/sc.hrc
::Define ID's for the CalcCommand
::Define Sc Strings
::Define the dialog id
----
:sc/inc/tabbgcolor.hxx (new)
::Define a struct: "ScUndoSetTabBgColorInfo" to store Tab Color Undo information
::Declare a list: "ScUndoSetTabBgColorInfoList" of "ScUndoSetTabBgColorInfo"
----
:sc/inc/unonames.hxx ***NEED TO ADD TO SPECS!!
::define the uno name SC_UNO_TABCOLOR as "TabColor" for ODS XML label
----
:sc/inc/ViewSettingsSequenceDefines.hxx
::Add SC_TABLE_TAB_BG_COLOR to the Table View Settings Sequence
----
:sc/sdi/docsh.sdi
::Add FID_TAB_SET_TAB_BG_COLOR command to TableSelection interface
----
:sc/sdi/scalc.sdi
::Add SvxColorItem TabBgColor FID_TAB_SET_TAB_BG_COLOR definition
::Add SfxVoidItem SetTabBgColor FID_TAB_MENU_SET_TAB_BG_COLOR(SvxColorItem TabBgColor FID_TAB_SET_TAB_BG_COLOR) definition
----
:sc/sdi/tabvwsh.sdi
::Add FID_TAB_MENU_SET_TAB_BG_COLOR command to Tables interface
----
:sc/source/ui/docshell/docfunc.cxx
::Add Source for ScDocFunc::SetTabBgColor
----
:sc/source/ui/inc/docfunc.hxx
::Define ScDocFunc::ScTabBgColor
----
:sc/source/ui/inc/undotab.hxx
::Define ScUndoSetTabBgColor Class
----
:sc/source/ui/inc/viewdata.hxx
::Define Private Color aTabBgColor in ScViewDataTable Class
::Define Private BOOL IsDefaultTabBgColor(...) in ScViewDataTable Class
::Define Public void SetTabBgColor(...) in ScViewData Class
::Define Public BOOL IsDefaultTabBgColor(...) in ScViewData Class
::Define Public Color GetTabBgColor(...) in ScViewData Class
----
:sc/source/ui/inc/viewfunc.hxx
::Define Public BOOL SetTabBgColor(...) in ScViewFunc Class
----
:sc/source/ui/src/globstr.src
::Add String data to Global Strings
----
:sc/source/ui/src/popup.src
::Add Separator
::Add FID_TAB_MENU_SET_TAB_BG_COLOR to RID_POPUP_TAB
----
:sc/source/ui/src/scstring.src
::Add String data to Sc Strings
----
:sc/source/ui/undo/undotab.cxx
::Add ScUndoSetTabBgColor as an SfxUndoAction class
::Undo/Redo action supports single and multiple tab color operations
::When a single tab is colored, then set the comment to Global String: STR_UNDO_SET_TAB_BG_COLOR
::When multiple tabs were colored, then set the comment to Global String: STR_UNDO_SET_MULTI_TAB_BG_COLOR
----
:sc/source/ui/view/scextopt.cxx
::Set maTabBgColor to COL_AUTO on ScExtTabSettings::ScExtTabSettings()
----
:sc/source/ui/view/tabcont.cxx
::Add the following logic to ScTabControl::ScTabControl(...)
:::Check to see if the current tab has a tab color value not equal to COL_AUTO
::::Call ScTabControl::SetTabBgColor which belongs to the TabBar Class
::Invalidate FID_TAB_SET_TAB_BG_COLOR with the rest of the items from the table Interface in ScTabControl::Select()
::Add the following logic to ScTabControl::UpdateStatus()
:::Check to see if new color is the same as the old color.
::::If the color is different set bModified to TRUE
:::Check to see if the current tab has a tab color value not equal to COL_AUTO
::::Call ScTabControl::SetTabBgColor which belongs to the TabBar Class
----
:sc/source/ui/view/tabvwshf.cxx
::Add code to execute the Dialog and save the color information.
::Add code to invalidate the menu items according to criteria in spec
----
:sc/source/ui/view/viewdata.cxx
::Add code to set aTabBgColor to COL_AUTO on ScViewDataTable::ScViewDataTable()
::Add support to save to ODS in ScViewDataTable::WriteUserDataSequence(...)
::Add support to read from ODS in ScViewDataTable::ReadUserDataSequence(...)
::Add code for ScViewData::SetTabBgColor(...)
::Add code for ScViewData::GetTabBgColor(...)
::Add code for ScViewData::IsDefaultTabBgColor(...)
::Add code to save the color to the ScExtTabSettings Struct in ScViewData::WriteExtOptions(...)
::Add code to read the color from the ScExtTabSettings Struct in ScViewData::ReadExtOptions(...)
----
:sc/source/ui/view/viewfun2.cxx
::Add code for ScViewFunc::SetTabBgColor(...)
----
:sc/uiconfig/scalc/menubar/menubar.xml
::Add Separator
::Add Menu Item .uno:SetTabBgColor to FormatMenu->SheetMenu
----
:svtools/inc/tabbar.hxx
::Add definition for Public Color GetTabBgColor(...) in Class TabBar
::Add definition for Public void SetTabBgColor(...) in Class TabBar
::Add definition for Public BIIL IsDefaultTabBgColor(...) in Class TabBar
----
:svtools/source/control/tabbar.cxx
::Add Color maTabBgColor to ImplTabBarItem struct
::Add Color maTabTextColor to ImplTabBarItem struct
::Add bool IsDefaultTabBgColor() to ImplTabBarItem struct
::Add bool IsDefaultTabTextColor() to ImplTabBarItem struct
::Set maTabBgColor and maTabTextColor to COL_AUTO in ImplTabBarItem::ImplTabBarItem(...)
::Change aLightFont weight to WEIGHT_NORMAL instead of WEIGHT_LIGHT in TabBar::Paint()
::Add code to fill tab with custom background color when tab is unselected in TabBar::Paint()
::Add code to draw a 2px sliver on the bottom of selected tab(s) with custom background color in TabBar::Paint()
::Add code for TabBar::GetTabBgColor
::Add code for TabBar::SetTabBgColor
:::Add code to auto select font color based on the luminance of the color.
::Add code to choose proper Drop Position Arrow colors in TabBar::ShowDropPos(...)

=== Tab Color Dialog ===
:sc/inc/scabstdlg.hxx
::Add class: AbstractScTabBgColorDlg a VclAbstractDialog class
:sc/source/ui/attrdlg/scdlgfact.cxx
::Add IMPL_ABSTDLG_BASE(AbstractTabDialog_Impl)
::Add AbstractScTabBgColorDlg_Impl::GetSelectedColor(...) implementation
::Add AbstractScTabBgColorDlg * ScAbstractDialogFactory_Impl::CreateScTabBgColorDlg (...) implementation
:sc/source/ui/attrdlg/scdlgfact.hxx
::Add class AbstractScTabBgColorDlg_Impl a AbstractScTabBgColorDlg class
::Add Public virtual AbstractScTabBgColorDlg * CreateScTabBgColorDlg (...) to ScAbstractDialogFactory_Impl
:sc/source/ui/inc/miscdlgs.hrc
::Add definitions for Dialog and Dialog Controls
:sc/source/ui/inc/tabbgcolordlg.hxx (new)
::Add class: ScTabBgColorDlg a ModalDialog class
:sc/source/ui/miscdlgs/makefile.mk
::Add tabbgcolordlg.obj to make file
:sc/source/ui/miscdlgs/tabbgcolordlg.cxx (new)
::Add code for the Color Dialog according to specs
:sc/source/ui/src/miscdlgs.src
::Add Dialog and Dialog Control properties
:sc/util/makefile.mk
::Add tabbgcolordlg.obj to make file

=== Excel 2003 Binary Support ===
:sc/source/filter/excel/read.cxx
:sc/source/filter/excel/xestyle.cxx
:sc/source/filter/excel/xeview.cxx
:sc/source/filter/excel/xichart.cxx
:sc/source/filter/excel/xiview.cxx
:sc/source/filter/excel/xlview.cxx
:sc/source/filter/inc/xestyle.hxx
:sc/source/filter/inc/xeview.hxx
:sc/source/filter/inc/xiview.hxx
:sc/source/filter/inc/xlview.hxx

=== Excel 2003 XML Support ===
:filter/source/xslt/export/spreadsheetml/formular.xsl
:filter/source/xslt/import/spreadsheetml/spreadsheetml2ooo.xsl

=== Excel 2007 Binary / OOX Support ===
:oox/inc/oox/xls/viewsettings.hxx
:oox/source/xls/chartsheetfragment.cxx
:oox/source/xls/viewsettings.cxx
:oox/source/xls/worksheetfragment.cxx
:oox/source/xls/worksheethelper.cxx
:oox/source/xls/worksheetsettings.cxx

== Patch Download List ==
:*Download Patch

== See Also ==
*[[User:Danielbw]]
----
[[User:Danielbw|Danielbw]] 01:23, 22 January 2009 (UTC)
----

[[Category:Calc]]

Calc/Performance/Specific Bottlenecks

2009-12-04T06:38:33Z

Kirk: /* other */

== The Zaske case ==

Done. Content relocated to [[Calc/Performance/The_Zaske_case]], section preserved for external references linking here.

== Sorting values within functions ==

Done. Content relocated to [[Calc/Performance/sorting_values_within_functions]], section preserved for external references linking here.

== other ==

For other performance optimization tasks previously located here please see the individual pages listed under [[Calc/Performance]].

[[Category:Calc]]

Calc/Performance/ALL

2009-12-04T06:37:07Z

Kirk:

<noinclude>{{DISPLAYTITLE:List of all Calc related performance pages}}</noinclude>

== To-Do ==
{{:Calc/To-Dos/Performance}}

== In progress ==
{{:Calc/InProgress/Performance}}

== Done ==
{{:Calc/Done/Performance}}

[[Category:calc]]

CJK Group Log 20090424

2009-12-04T06:32:43Z

Kirk:

<pre>

<jeongkyu> Hi everybody
<Forestcheng> hello to all
<maho> Hello all
<zlh> Hi, khirano, maho, Forestcheng, and all
<zlh> I'm Zhu Lihua
<maho> yes i know :)
<zlh> from Redflag
<maho> hello
<khirano> hi all
<maho> zlh : redflag office? redoffice?
<maho> your e-mail address is redoffice
<zlh> It's a pity that I was abcent from the first meeting because of out of internet connection.
<maho> hi khirano!
<Forestcheng> formal name: RedOffice
<maho> oh thanks
<jeongkyu> How's weather over there, guys? It just started raining my home town, GwangJu.
<zlh> Yes, Redoffice is product name, and redflag is company name.
<Forestcheng> It's cloudy in Beijing. a little bit cold.
<khirano> hi sdq
<maho> bit cloudy in Saitama
<zlh> khirano: sdq is my workmate. I'm not sure he is here right now. because it's right the lunch time:)
<Forestcheng> Have you had lunch in Korea or Japan? :)
<khirano> zlh: I see. :) Can you introduce sdq for us? His/Her full name?
<khirano> Forestcheng: No not yet! I am hungry :)
<jeongkyu> Me neither~
<Forestcheng> So am I :(
<khirano> Hey Jeongkyu, you are coming! Thank you very much!
<jeongkyu> khirano: Thanks. I am sorry not to post my comment on the agenda. :-)
<khirano> jeongkyu: No problem. It's very good to have you here.
<zlh> khirano: sdq's Full name is Sun Dequan. He mainly contribute in automation.
<khirano> zlh: Great to hear! We have another Automation Guy! :)
<maho> great :)
<zlh> khirano: Yes, he is not very experienced yet, He sure will learn more from you :)
<khirano> zlh: Not from me but from Maho! :)
<khirano> Forestcheng: Is Peter coming? do you know?
<maho> recently I don't do but matuaki-san does automated test :)
<Forestcheng> No, Peter is absent.
<khirano> Forestcheng: OK. thanks.
<khirano> Shall we start?
<maho> yes
<jeongkyu> Sure, go ahead
<Forestcheng> Yes
<zlh> Yes, please
<khirano> Who is very kind to take a log of this meeting? :)
<maho> me
<jeongkyu> Thanks maho.
<khirano> maho: thanks
<khirano> The meeting starts now.
<khirano> Agenda is here: http://wiki.services.openoffice.org/wiki/CJK_Group/Agenda
<khirano> 1. 3.1 Release QA Status
<khirano> How is it going with you?
<maho> Enoki -san has been doing a good release qa management with me.
<maho> we have four testers.
<maho> matuaki-san likes to do automated test VCLTestTool
<khirano> maho: Who is Enoki-san?
<maho> Kunimoto-san and matayoshi-san do TCM test
<maho> :) you know :) Enoki-san is a release qa manager from Good-Day
<maho> Good-Day Inc.
<maho> Meguro-san does a release sanity test in the Forum
<Forestcheng> Great! Are there still bugs blocking release?
<khirano> OK, now zh and ko friends know who Enoki-san is :)
<jeongkyu> There are not many testers in Korean team, so we focus on release sanity test with the latest RC.
<maho> Forestcheng : no our team is not so organized to raise issues :)
<maho> jeongkyu: right, and how you find testers?
<jeongkyu> maho: We have a community site for Korean community, http://openoffice.or.kr/main/
<jeongkyu> And the site has basic information on how to join Korean team as tester, blogger, etc.
<jeongkyu> Some people show there interest in joining the team, but the problem is that they can't participate in the activity continously.
<Forestcheng> Yes, It's hard to keep volunteers always active.
<khirano> jeongkyu: I see the situation.
<jeongkyu> So, for now, we are focus on release sanity test with few dedicated testers.
* hanthana (n=hanthana@124.43.39.31) は #ooonlc へ参加しました。
<maho> so jeongkyu, testers are usually participate only once?
<jeongkyu> maho: It depends on.
<maho> Oh
<khirano> maho: We are trying to fix testers, right? Can you show us the QA project member list on the wiki?
<jeongkyu> Team members are interested in the activities including testing, but they are usually *very busy* with their company work.
<maho> http://wiki.services.openoffice.org/wiki/JA/QA/Members
<maho> now we have five members
<khirano> maho: Thanks!
<maho> I think making such table is nice, as people don't feel lonely
<maho> and encourage people to write thier names on wiki
<Forestcheng> Great idea!
<maho> (thanks khirano)
<khirano> To get fixed testers is a tough work!, you know :)
<khirano> we have to keep encourging them,
<jeongkyu> Is there any reward or compensation for being testers in your community?
<maho> No, nothing, but release
<khirano> keep providing up-to-date infomation to them
<khirano> jeongkyu: No reward. But we are happy when our language OpenOffice.org is released to the public.
<jeongkyu> When there are user contributions such as good article or nice user support in KO community, I try to give small gift such as book or DVD.
<jeongkyu> But I haven't done it for testers. :-)
<maho> jeongkyu: you can ask community council budget for some supports
<khirano> Users are always waiting for nice and good and new releases of their language, I am sure.
<maho> khirano right
<jeongkyu> Right
<Forestcheng> community council budget? I just get to know.
<maho> Forestcheng: http://blog.livedoor.jp/maho_nakata/archives/51110252.html
<Forestcheng> Maho: thanks!
<khirano> Let us keep sharing our experience including "budget" on the list ? :)
<Forestcheng> yes
<maho> I was asked by a person in FreeBSD community that please update your port and I'll give you 100Euro :)
<jeongkyu> But, I believe that donation could be a way to participate in the community.
<maho> jeongkyu: right:
<khirano> jeongkyu: Indeed!
<khirano> If you get an idea to how to promote donation, please give us those ideas to the list.
<Forestcheng> The better marketing, the more users, and the more contributions.
<khirano> Any question on the 3.1 releases?
<khirano> Forestcheng: Yes!
<jeongkyu> If there is no question then let's move into next item.
<Forestcheng> OK!
<maho> ok
<khirano> 2. RegiCon Asia 2010 Spring in Seoul
<khirano> Jeongkyu: Have you talked with Peter about his visit to Korea?
* Jihui_Choi (n=Jihui_Ch@219.248.47.90) は #ooonlc へ参加しました。
<maho> Hi Jihui
<jeongkyu> khirano: Not yet.
<khirano> Hi JiHui
<jeongkyu> Hi JiHui
<Forestcheng> Welcome! JiHui
<Jihui_Choi> hi,all.
<Jihui_Choi> I'm sorry. I'm late. ^^;
<khirano> jeongkyu: OK. Do you have any concrete plan about the RegiCon?
<Forestcheng> No so late! We're talking RegiCon Asia 2010 Spring in Seoul
<khirano> jeongkyu: Venue? Date? Sponsors?
<jeongkyu> khirano: Not yet.
<Jihui_Choi> Forestcheng: Thank you. And it's Great. I'm really exciting about it.
<jeongkyu> khirano: Before making concrete plan, I want to talk about 'what we want to achieve through RegiCon'.
<khirano> jeongkyu: Sure, you are right.
<khirano> "What to Achieve through RegiCon"
<Jihui_Choi> So.. What do you expect through RegiCon, jeongkyu and khirano?
<Jihui_Choi> I'd like to know your(both) thoughts.
<khirano> To start discussion about "What to Achieve through RegiCon" on the list will be my AI :)
<khirano> But I tell you now. How to get quality localized OpenOffice.org for Asian people
<khirano> Then we can make good marketing of OpenOffice.org in Asia :)
<maho> aha - that's a point
<Forestcheng> I think the OOo quality is quite good, But compared with MS Office, there're still some bugs or inconvenience.
<maho> khirano : and this can be "egg" or "chicken" problem IMHO
<khirano> Forestcheng: Right. So we have to get more Asian developers and contributors.
<Forestcheng> :)
<Jihui_Choi> I agree with Forestcheng. But I'm feeling to need something more. especially about marketing and education.
<jeongkyu> For me, 'to get familiar with each other' is the most important thing in the RegiCon. :-)
<khirano> So we have many things to achieve through the Regicon in Seoul, right?
<Forestcheng> I don't know if some new great chance for OOo after Oracle bought Sun.
<maho> khirano: :)
<maho> jeongkyu: +1 and I 've never been to Seoul
<maho> and I'd like to go.
<khirano> Forestcheng: It is a Chance!
<Jihui_Choi> How many OOo developers are in china and japan?
<maho> very small
<Forestcheng> Seoul is friendly city! I got two help when going to hotel from airport by subway.
<khirano> Forestcheng: You should keep watching what our Marketing project lead and colead are saying about Oracle buying Sun :)
<maho> "good" developers usually very busy so they only subscribe mainstream mailing list
<maho> Forestcheng : http://www.linux-magazine.com/online/news/openoffice_future_uncertain
<khirano> Forestcheng: Do you have a plan to go to Seoul with Peter?
<Forestcheng> Khirano: Thanks for your remind.
<maho> this is what khirano e-mailed to me today
<Forestcheng> Not yet.
<khirano> Forestcheng: But it can be realized, right?
<Forestcheng> Maybe :)
<khirano> I will talk with Peter about your trip to Seoul and meeting with Jeongkyu and JiHui.
<jeongkyu> khirano: Sounds good.
<khirano> JiHui: How long does it take for you to go to Seoul from your place?
<Jihui_Choi> khirano: Oh god.. I'm afraid of I can't see you.
<Jihui_Choi> I may go to Canada in early July.
<Forestcheng> IBM has a develop team, but I don't how many contribution from them.
<jeongkyu> khirano: It takes 5 hours by bus and 1 hour my air from my place to seoul.
<maho> Forestcheng: right. I don't see postings to MLs. Klaus (IIRC) told us that their contribuiton to the community is "C"
<Jihui_Choi> khirano: and I moved in seoul.
<jeongkyu> khirano: JuHui is currently living in Seoul.
<khirano> Jihui: Maybe we can discuss when Peter, Forestcheng and others will come to Seoul :)
<jeongkyu> khirano: Sure.
<khirano> jeongkyu: Good News!
<Forestcheng> Maho: what's meaning "C"
<maho> A is the best, and B is the second. C is not so good @OOoCon2008 Beijing
<khirano> OK, our AI: we will talk with Peter about Seoul traveling schedule :)
<jeongkyu> khirano: Good! Let's talk about what I have to prepare in Seoul, and what you guys can help in detail when we meet.
<khirano> Any question about RegiCon in Seoul?
<jeongkyu> No question, then let's move into next item.
<khirano> OK, we move to More CJK Group Coordinators
<Forestcheng> No more.
<khirano> did you find any kind volunteer? :)
<Forestcheng> no one from volunteer :(
<Jihui_Choi> What is the CJK Group Coordinator?
<khirano> if you see: http://wiki.services.openoffice.org/wiki/CJK_Group/Minutes#The_1st_IRC_meeting_2009-03-21
<jeongkyu> here is Korean explanation
<jeongkyu> http://openoffice.or.kr/blog/?p=735
<Jihui_Choi> Thank you, khirano and jeongkyu. :)
<khirano> Thanks, joengkyu!
<jeongkyu> JiHui: I though you already saw it.
<Jihui_Choi> I alreay read both article.
<khirano> Jihui: I am sure you are one of good candidates :)
<Jihui_Choi> I wanted something more. However now I think I get it. :)
<khirano> Jihui: Good! you want to volunteer?
<Jihui_Choi> khirano: I really want. But I'll stay in cadata from july this year to May next year.
<Jihui_Choi> in Canada ;;
<Forestcheng> So long
<khirano> Jihui: No problem. You can help us from any part of the world :)
<maho> :)
<khirano> Jihui: Help us from Canda
<khirano> Canda/Canada
<Jihui_Choi> Yes I know But I'm afraid of I can't do anything to help about Seoul Reicon.
<Jihui_Choi> Anyway even I'm a very poor guy but if you're ok, I want to get it.
<khirano> Jihui: Yes you can! You give us good ideas.
<khirano> All: We have got a new CJK group coordinator now!
<Forestcheng> JiHui: you can tell your friends in Canada to use OOo. That'll be great help to OOo!
<khirano> JiHui: I am happy to work with you :)
<Jihui_Choi> thank you khirano. I don't know exactly what shall I do. But I'll do my best.
<Jihui_Choi> :)
<maho> congratulations
<Forestcheng> +1
<jeongkyu> +1
<khirano> Thanks all, then we move to next item.
<Jihui_Choi> thank you, all.
<maho> applause
<khirano> 4. Zh is planning to translate OOo3.0 UserGuide in OOoAuthors
<maho> Really?????? great news
<Jihui_Choi> khirano: you mean OOO 3.0 getting started ?
<khirano> Which English version are you translating? Forestcheng?
<Forestcheng> it's OOo 3.0 in http://oooauthors.org/en
<Jihui_Choi> Great.
<Jihui_Choi> We're also translating it. http://openoffice.or.kr/blog/?p=623
<Forestcheng> It's time consuming work. How Ko and Ja think of this? Do you have OOo UserGuide in local language? or related documents such as: tips,skills,advanced or useful features...?
<Jihui_Choi> I translated to ch5
<Forestcheng> Great to Ko!
<maho> Forestcheng: no hesitations to say go for JA. We can expect a lot of volunteers :)
<khirano> maho: does ja have Japanese version of this document?
<maho> IIRC no
<jeongkyu> And I translated the guide some years ago, and now outdated. It is 120 page manual.
<jeongkyu> version. Here
<jeongkyu> http://openoffice.or.kr/blog/?p=234
<Jihui_Choi> Right. We-ko- have two version of that documents.
<khirano> jeongkyu. jihui: Great! isn't it!
<maho> yes great! ko team
<Forestcheng> for Now: Do you translate from beginning of guide or just select some chapters?
<jeongkyu> As Forestcheng said, it is very time consuming to translated the every chapter of the guides.
<Jihui_Choi> But I envy you, ja. we don't have any book material. something for education.
<khirano> how many korean friends did that translation?
<jeongkyu> So, my initial work was to translate chapters for overall features and well used programs, such as writer, calc, and impress.
<maho> translation is one good step to contribute to OOo
<Jihui_Choi> Forestcheng: In case of jeongkyu, I think he translated what he needed. But in my case, I'm translating from start to end
<Jihui_Choi> khirano: unfortunately, but many.
<Jihui_Choi> Maybe jeongkyu and me?
<khirano> Jihui: Only two translators did that work!
<maho> Kubota Takaya san (now he is the coordinator) does good coordination
<Jihui_Choi> yes. jeongkyu translated at first. and now I'm translating new and improving his works.
<khirano> Forestcheng: What do you need to get the translation completed?
<Jihui_Choi> Forestcheng: And How many people and how long do you expect for it?
<Forestcheng> We've got volunteers about 5 person.
<khirano> "Five" is a great number.
<Jihui_Choi> wow.. cool
<maho> great
<Forestcheng> I think we need to translate efficient. To translate what users really need to read.
<zlh> Yes, I agree.
<maho> do you use SUN's translation memory?
<Forestcheng> Not to translate everything. We've had some guide. We need re-organizing these documents.
<Jihui_Choi> right. there're reawlly many document in wiki. But we have to make the order of priority.
<khirano> Maybe Jeongkyu and JiHui can advise Forestcheng about priority, I mean which chapter should be translated first
<Jihui_Choi> khirano: yes. but I think Forestcheng and all already know.
<Forestcheng> Maho, we used Sun's TM in pootle translation.
<maho> thanks
<maho> Jihui and jeongkyu do you use SUN's translation memory
<zlh> I think one of the material users need most is How to achieve the functions that operations other than MS office operation
<Forestcheng> Jihui: you're welcome to tell me your thinking.
<jeongkyu> khirano: I figured out the priority from the number of questions in KO forum. The number reflects which application is used most.
<Jihui_Choi> Sure. we used the TM from Sun's and our own TM.
<khirano> jeongkyu: That will be good infomation
<zlh> I offen hear from users: How to do this? how to do that? they used to operation like MS office. and they don't know how to do the same thing with OOo.
<jeongkyu> khirano: have a look at the number at the right - http://openoffice.or.kr/forums/
<maho> zlh : yes. this is what I hear from the community
<Jihui_Choi> zlh: me, too. But because of it, we have to make and translate documents.
<jeongkyu> khirano: In Korea, writer and calc are absolutely popular then other applications.
<khirano> jeongkyu: I see it. Good one.
<maho> zlh : if you have a list, please publish. Then all will start translation really immedeately!
<maho> a list = some operations that do in the way like MS Office
<zlh> maho: I'll collect some.
<maho> ok really important. you can post to [qa-dev] ML!
<zlh> Ok
<maho> oh UX ML might be appropreate
<maho> more appropreate
<maho> thanks zlh
<zlh> You're welcome.
<khirano> We have had good info from ko and zh community now.
<khirano> AI for me: I will make a wiki page to show these good info :)
<khirano> And new CJK coordinator will help me :)
<Forestcheng> Khirano: thanks!
<jeongkyu> Sounds good.
<maho> thanks
<khirano> OK, next item.
<khirano> Next Meeting and How to get more people who can attend an IRC meeting
<zlh> I found OOo3.1 has fixed 27 bugs submitted by our team.
<maho> zlh can you blog it?
<maho> do you have a blog?
<zlh> Yes, I will.
<zlh> 20 of them are submitted after OOo300m9.
<maho> please do so. you can ask planet.go-oo.org too
<maho> all good developers read planet.go-oo.org every day.
<khirano> zlh: I am looking forward to seeing your blog :)
<maho> and you must show up as another hero
<zlh> thanks:)
<khirano> Next Meeting and How to get more people who can attend an IRC meeting
<maho> Get members in subproject and find motivated members :)
<khirano> maho: Yes we will.
<Forestcheng> Sure!
<khirano> Aroud 13:00-14:00 is good for you all?
<zlh> I think How to join the meeting is a important information. So I add Server and Channel section in Wiki page of CJK group
<jeongkyu> khirano: No problem for me.
<maho> zlh: good point. marketing
<khirano> zlh: you are right! I will.
<maho> marketing, marketing
<khirano> maho: :)
<zlh> I added.
<maho> great
<Forestcheng> :)
<khirano> zlh: Thanks!
<zlh> How about choose a time that nobody's lunch time?
<khirano> zlh: :)
<maho> take lunch eariler or prepare a lunch box (I bought a lunch box and onigiri today)
<khirano> Yes, I am sure I will think about it indeed!
<khirano> I am hungry really.
<maho> :)
<Forestcheng> You can mark busy during lunch time :)
<zlh> maybe someone like sdq must go for lunch, or they will miss the lunch time and have nothing to eat. so they have to absent.
<jeongkyu> me too!
<maho> :(
<maho> 14:00-16:00?
<Forestcheng> Great time!
<jeongkyu> nice for me.
<zlh> very good for us:)
<maho> ok to me too :)
<Jihui_Choi> yes. it's good. actuall I'm hungry, too
<khirano> OK, all
<Forestcheng> I must have something to eat!
<maho> oh all are hugry except for me
<khirano> I will propose around 14:00-16:00 next time :)
<zlh> I have had some cookies just now:)
<khirano> OK, everyone, any question?
<Forestcheng> Have a good appetite! So would we finish?
<jeongkyu> No question for me.
<maho> no questions
<zlh> No questions.
<Jihui_Choi> me, too
<Forestcheng> Then See you! Bye!
<khirano> Thanks all, now I will get someting to eat now.
<khirano> The meeting is closing
<Jihui_Choi> yeah. Thank you, all see you next
<maho> see you all thank you all!
<jeongkyu> Bye now... See you again!
* jeongkyu (n=chatzill@125.136.69.54) は #ooonlc から離れました。
<khirano> Thanks all, see you!
<zlh> so long, have a great day!

</pre>

[[Category:CJK issues]]

CJK Group Log 20090321

2009-12-04T06:31:49Z

Kirk:

= Log of the first CJK IRC Meeting on March 21, 2009 =
It started around 18:00 and ended around 19:45 [http://www.timeanddate.com/worldclock/fixedtime.html?day=21&month=3&year=2009&hour=18&min=0&sec=0&p1=235 Seoul Time].
The log of the meeting was taken by maho.

Attendees: Aijin Kim(aijin), Lin, Cheng(forestcheng), Jeongkyu Kim(jeongkyu), Kazunari Hirano(khirano), Katsuya Kobayashi(kynh), Li Heng(liheng), Nakata, Maho(maho_), Peter Junge(peter13j), Sophie Gautier(sophi1). [http://ui.openoffice.org/VisualDesign/OOo_poster.html#l10n_1 You can meet them.] See [http://wiki.services.openoffice.org/wiki/CJK_Group/Minutes#Minutes Minutes].
<pre>
<nowiki>
* forestcheng (n=forestch@61.51.151.252) は #ooonlc へ参加しました。
<forestcheng> Hi, Khirano San
<forestcheng> and hello to maho :)
<maho_> HI all, khirano!
<khirano> Hi Cheng Lin
<maho_> hello forestcheng
<khirano> Hi Maho
<maho_> ah - you are chengling
<forestcheng> yes, I'm Cheng Lin
<forestcheng> forestcheng is my OOo account name.
<maho_> ling = forest, right?
<forestcheng> Yes, 林 = forest, CHENG is my family name.
<maho_> We also pronounce as "lin"
* liheng (n=temp@114.255.42.178) は #ooonlc へ参加しました。
<forestcheng> Great!
<liheng> forestcheng:Hi :)
<maho_> hi liheng
<forestcheng> Hi, Liheng is coming in. He's my colleague, lead of OOo
performance.
* kynh (n=kynh@i121-113-71-120.s42.a013.ap.plala.or.jp) は #ooonlc へ参加
しました。
<liheng> Thank you, forestcheng!
<liheng> Hi, maho_
* jeongkyu (n=chatzill@125.136.69.121) は #ooonlc へ参加しました。
<kynh> Hi all, connected as kynh. I'm Katsuya Kobayashi, JA marketing
project member.
<maho_> Hi kobayashi-san, (kynh)
* peter13j (n=peter13j@222.28.253.158) は #ooonlc へ参加しました。
<peter13j> Hi everyone :)
<forestcheng> Hi, Peter, Liheng and me is here.
<peter13j> Great!
<liheng> Hi, peter13j good afternoon
<peter13j> Hi Li Heng
<maho_> Hello Peter13j
<peter13j> Hi maho_
<kynh> Hi peter, I'm glad to see you all again since OOoCON2008.
<peter13j> Hi kynh
<khirano> 안녕하세요? Hello in Korean :)
<jeongkyu> Hello~
<jeongkyu> You're Korean is nice :-)
<khirano> 你好 Hello in Chinese :)
<maho_> Hello jeongkyu
<jeongkyu> Hello Maho
<peter13j> Hi Hirano-san, thanks for pushing the OOoRegioCon :)
<maho_> khirano: how you type chinese and korean?
<khirano> こんにちは　Hello in Japanese :)
<maho_> yes OOo regicon is very important
<sophi1> Hi all :)
<khirano> Hi Sophie
<khirano> Nice to have you here :)
<maho_> Hello Sophie
<maho_> thanks for attending...
<kynh> Thanks logon from fr.
<sophi1> khirano: maho_: thank you and thank you also for organizing
this meeting
<forestcheng> Good morning to France.
<sophi1> thank all you for you welcome :)
<maho_> no just khirano is organizing...
<khirano> Hi all, glad to have you all here to meet and talk.
<khirano> Can we start the meeting?
<kynh> This is 1st meeting covered 5 lang or more, is'nt it?
<maho_> maybe :(
<maho_> maybe :)
<maho_> sorry
<khirano> Can I chair this meeting?
<forestcheng> Japanese, Korean, Chinese, Franch, German.
<liheng> English ;)
* peter13j thinks khirano should chair the meeting
<kynh> Sure you are chair, pls khirano.
<maho_> khirano, yes. could you please start?
<khirano> Thanks.
<khirano> Who's taking a log of this meeting?
<maho_> ok I'll do
* aijin (n=aijin@123.113.113.63) は #ooonlc へ参加しました。
<khirano> I "often" fail to log IRC meetings ;) Thanks, Maho :)
<maho_> hi aijin
<khirano> Hi Aijin!
<jeongkyu> Hi Aijin
<aijin> hi all
<khirano> 안녕하세요?
<maho_> annonhasimunika
<aijin> khirano, maho_ ,안녕하세요!
<khirano> Log of this meeting will be published on the wiki.
<maho_> +1
<liheng> +1
<forestcheng> +1
<peter13j> +1
<sophi1> khirano: +1 and great, it will help other group
<khirano> OK, now I hope you all have read agenda :)
<maho_> sure
<khirano> 1. How to get more QA and L10N TCM testers for quick and
stable releases
<khirano> 2. Possibilities of OpenOffice.org Regional Conference in Asia
<forestcheng> yes, The same question as: How do your OOo community
call for more volunteers? Or how about marketing? how to get more
people to know OOo?
<khirano> 3. Benefits of the group in general
<khirano> 4. More coordinators for the group
<khirano> 5. Next IRC meeting
<khirano> forestcheng: Right!
<khirano> OK, let us start with 1.
<forestcheng> How about us? My question: Though my work is related to
OOo, I can only spent part time on OOo. How about you? are you full
time or part time? can you get paid from OOo work?
<maho_> JA resut for 1. four testers + two managers, total five person
(one manger was tester)
<kynh> Nice viewpoint, forestcheng, It's a marketing matter.
<khirano> I am just a volunteer :)
<forestcheng> Great to Khirano!
<maho_> me too;)
<forestcheng> But Maho, it seems You've been spending much time on OOo.
<maho_> haha
<maho_> I e-mail while compiling ;)
<forestcheng> compiling OOo?
<maho_> it takes very small time, many parts are automated.
<khirano> Let me start with these questions, - How was 3.0.1 QA? How
many testers did you get?
<maho_> but - sometimes it takes very loooong time
<maho_> okay khirano
<peter13j> My question would be: Will more testers really help quick
and stable releases? ...
<khirano> forestcheng: can you tell us about zh project?
<maho_> jeongkyu : how about ko?
<maho_> Mechtilde how about de?
<forestcheng> We got about 10 testers in 3.0 and 3.1
<maho_> sophi1: how about fr?
<forestcheng> but most of testers are from our company. :(
<liheng> peter13j:Yes, I think how to finish the test is more
important for helping releases
<jeongkyu> We had 4 testers for 3.0.
<maho_> jeongkyu : thanks, are they volunteers?
<sophi1> for fr there is between 10 and 15 testers it depends of the
period, they are all volunteers
<peter13j> liheng: well, following the mailing lists, the current
problems seem mostly be before QA
<jeongkyu> Sure, everybody in Koerean community is volunteer.
<liheng> peter13j:Okay
<khirano> jeongkyu: Thanks. do you need more testers?
<maho_> khirano: thanks for good question
<forestcheng> as for zh, we can get near 10 volunteers, but often they
can't be available during testing period.
<sophi1> peter13j: I think the first step is to have more testers for
rc, then we will be able to attract them also for testing dev release
and have more testers earlier in the QA process
<maho_> sophi1: interesting.
<maho_> JA proejct has a very good tester, matuaki-san
<kynh> Important point, Sophie.
<maho_> he always publish his results when rc s are available.
<peter13j> sophi1: That's the problem. large testting effort starting
at rc is probably too late
<maho_> our release heavily depend on his activity
<forestcheng> yes, kynh, how about OOo marketing in Japan? it should
be helpful to more testers.
<kynh> In JA, full time few Sun mambers join with us, but they work
with all OSS products of Sun, as G11n, do'nt you maho?.
<maho_> yes.
<maho_> so - SUN empolyees not always participate release process.
<forestcheng> it's same with Sun Beijing G11n. right? Aijin.
<aijin> actually Sun people run test OO.o build on Solaris platform.
<khirano> jeongkyu and aijin: - How was 3.1 L10N TCM? How many testers
did you get?
<maho_> JA marketing project is now preparing. khirano is the coordinator.
<sophi1> peter13j: too late for the release, but it allows to build a
group. Rc are less frightening than dev releases :)
<maho_> JA: the number of participant is about 20.
<maho_> for l10n TCM.
<peter13j> sophi1: :)
<forestcheng> Great, Can you share your marketing idea?
<maho_> I asked Naoyuki-san (sun) and write an announcement
<maho_> actually I wrote it
<maho_> announcement should contain all relevant infomation
<maho_> wait...
<maho_> slow ja.oo.o site...
<aijin> khirano, I did run test in l10n TCM, not sure if other Korean
members used TCM for testing. jeongkyu, can you confirm?
<maho_> the announement contains : object
<jeongkyu> khirano: We could not do 3.1 L10n testing through TCM this time.
<maho_> method, who can participate, period, and details.
<maho_> also - title is important.
<kynh> announcement and show prosess of testing is important,
<maho_> usually JA people want to test how well localized to Japanese
<maho_> kynh : yes
<jeongkyu> khirano: Instead, 3 testers including me had done basic
testing outside of TCM.
<kynh> In fr, de, does the testers understand the process of feedback
bug issue when RC phase testing?
<khirano> aijin and jeongkyu: Thanks! Do you think more testers will
be helpful for quick and stable releases of Korean builds?
<maho_> so the title was "to reduce the Japanese related bugs for 3.1
release, call for testers for l10n TCM"
<sophi1> kynh: yes, they report issue they meet during testing on our qa
list
<forestcheng> Another problem: When build RedOffice from OOo, our
testers often find much more bugs, but many of bugs can't be solved
quickly. More developers are needed!
<kynh> sphi1: do you have any meeting as IRC in fr qa project?
<aijin> khirano, it should be, and I think it's important to get some
testers who can continueously participate.
<khirano> aijin: Right!
<maho_> ome testers who can continueously participate. : aijin : right
<liheng> foreshcheng:All software is same, but we need only decide
which bugs must be solved
<kynh> aijin: +1
<jeongkyu> khirano: Aijin said what I wanted to say. :-)
<khirano> Jeongkyu: Sure I see :)
<khirano> So we will share our experience how to get more testers and
developers
<forestcheng> khirano: Great! Thanks!
<khirano> please help, maho, sophie and others, ok?
<maho_> yes.
<khirano> Let us do share them on the list,
com@native-lang.openoffice.org later :)
<sophi1> on the marketing side, I think l10n testing could be directed
to trainers because they have to know about new features for their
work
<sophi1> khirano: ok :)
<khirano> sophi1: right!
<maho_> trainers?
<kynh> trainer task, good point!
<forestcheng> sophi1: Yes, we've translated OOo 3.1 new feature in
Chinese and posted in zh project.
<sophi1> maho_: people who give lessons on OOo practice
<khirano> forestcheng: great!
<maho_> okay
<sophi1> forestcheng: very good idea :)
<khirano> forestcheng: we are doing the same on the wiki now :)
<maho_> forestcheng : great.
<maho_> yes :)
<forestcheng> And we're trying to get terry to help us setting up
Chinese OOo forum.
<forestcheng> Forum is better than mailinglist for training.
<forestcheng> and discussion.
<maho_> why?
<forestcheng> why to what?
<maho_> discussion. topics are not lost and shared by users?
<khirano> OK, we share our works, what good we are doing, what tools
like announce list, wiki, forum and others do we use to promote QA
testing etc, on the com@native-lang.openoffice.org
<khirano> What do you think?
<forestcheng> ++1
<sophi1> khirano: +1
<maho_> +1
<aijin> +1
<jeongkyu> +1
<liheng> +1
<peter13j> +1
<khirano> Now we move to 2. Possibilities of OpenOffice.org Regional
Conference in Asia
<kynh> +1, and Specification fixing time is late, but we need to
understand what will we need to define new test case for the new
featueres.
<kynh> go ahead.
<forestcheng> +1 After OOoCon2009Orvieto
<khirano> kynh: Thanks. I got the point.
<khirano> forestcheng: OK, can you give us a reason?
* peter13j seconds forestcheng
<khirano> Peter: OK, can you give us a reason?
<peter13j> khirano: RegioCon should be not too close too OOoCon ...
<forestcheng> We need enough time to find topics in ReginalCon.
<peter13j> ... if we have it lets say in August it's not so much time
to organize it
<kynh> How is kr?
<khirano> If you say after Orvieto, it may be held around December or
2009 January or 2009 Spring?
<jeongkyu> kyhn: Are you asking about time frame?
<kynh> No, need F2F or not soon, kr.
<peter13j> khirano: I guess you mean 2010 spring?! Yes, would be a good
time
<khirano> Sorry yes, 2010 Spring ;)
<peter13j> So,we could have RegioCon in spring OOoCon in autumn
<peter13j> That would be a good frequency for the future
<maho_> +1 for peter13j
<liheng> +1 for peter13j
<forestcheng> +1 for peter.
<jeongkyu> +1 for 2010 spring
<kynh> +1, and Before end of 2010 goals, I hope that it is mature each
lang project governance. So after Orvieto is better, I think.
<aijin> +1
<khirano> Spring is a good season for Asia, warm :)
<peter13j> :)
<maho_> flower powder is serious in Japan
<maho_> :)
<khirano> jeongkyu: Now can you host RegiCon Asia in 2010 Spring?
<jeongkyu> The decision for the location was already made? :-)
<khirano> Not Yet!
<khirano> You decide :)
<jeongkyu> ha ha... Let's talk about the location now.
<peter13j> jeongkyu: Would Seoul apply?
<maho_> Souel?
<maho_> Seoul
<maho_> sorry
<kynh> jeongkyu: yes, you just proposed on com@
<khirano> Jeongkyu: Seoul sounds good!
<jeongkyu> If you don't object, then I'd like to host the conference.
* peter13j applauds :)
<jeongkyu> :-)
* sophi1 joins peter13j :)
<maho_> great
<kynh> Where is easier to join for zh mambers?
<forestcheng> both of Korea and Japan is OK
<kynh> OK, Peter will help how to hosting the meeting. :)
<khirano> OK, we will start a planning discussion "RegiCon Asia 2010
Spring in Seoul" on com@native-lang.openoffice.org, OK :)
<peter13j> +1
<aijin> +1
<jeongkyu> +1
<sophi1> khirano: +1
<kynh> khirano: +1
<peter13j> kynh: Yes.
<kynh> Thanks, peter.
<khirano> Thanks all, then we move to 3. Benefits of the group in general
<maho_> +1
<kynh> okay
<forestcheng> +1
<khirano> - What have Group helped group member projects such as zh,
ko, ja projects?
<khirano> Is the group helpful? :)
<forestcheng> Yes! CJK has many common layout and align feature.
<maho_> yes. recently we are talking about such kind of things
<liheng> +1
<aijin> we can share common issues. I know 'cjk' keyword are used in
IssueTracker.
<forestcheng> It's much better if getting developer from CJK together.
<maho_> yes I introduced this keyword
<maho_> "CJK"
<aijin> maho_: great!
<maho_> please use "cjk" keyword if you find CJK issues.
<maho_> in IssueTracker.
<khirano> maho: For Issue Tracker, right?
<maho_> yes
<khirano> Right.
<jeongkyu> (Sorry, I got to go now. I will check IRC log later and
join the discussion at mailing list.)
<maho_> thanks jeongkyu
<khirano> Sure, jeongkyu
<jeongkyu> :-)
<maho_> see you seoul
<aijin> jeongkyu: see you
<kynh> thanks jeongkyu
<khirano> Nice to have you here and thanks for RegiCon in Seoul :)
<sophi1> jeongkyu: bye !
<forestcheng> thanks and see you to Jeongkyu.
<khirano> Continues..., then - How can Group help group member
projects such as ko, zh, ja projects more?
<khirano> What do you expect more?
<maho_> I'm tracking [Issue 84405] meta issue to track issues
discovered by RedFlag2000 QA
<khirano> I do too, maho
<kynh> What is our common issues?
<maho_> Sundongmei from RedOffice e-mail us helping implement grid layout
...
<maho_> via forestcheng.
<maho_> khirano do you subscribe dev@zh or dev@ko
<maho_> ?
<khirano> Yes, I do :)
<maho_> great.
<khirano> Even if I don't read Korean and Chinese :)
<kynh> I think that marketing matter for each lang refered another
lang is important.
<maho_> kynh : for common issue, we can make use of issue tracker with
"CJK" keyword
<forestcheng> Great to Khirano, Now you've chance to learn Korean and
Chinese. :)
<maho_> "CJK" is not common currently though.
<kynh> maho: I see.
<maho_> kynh : yes.
<khirano> forestcheng: Right! I am happy to learn them
<maho_> Sundongmei cannot read my e-mail using Kanji.
<maho_> her e-mail client doesn't support Japnese Kanji ;(
<khirano> With Group, "sharing many things like issues, experiences
etc." is important.
<maho_> do we read/write CJK characters? can we exchange e-mails ?
<forestcheng> if you use UTF-8 encoding, I think she should can.
<maho_> yes.
<sophi1> maho_: may be you should mail about CJK keyword ont the QA
and l10n list, so every body is aware and can add it to the issue
related to CJK ?
<forestcheng> it's better to use UTF-8 encoding in email for CJK.
<maho_> sophi1 " thanks
<khirano> We should utilize various tools to promote "sharing"
<maho_> forestcheng : right. even though Japanese should use
ISO-2022JP for e-mails
<maho_> sophi1: this is marketing issue :)
<sophi1> maho_: yes :)
<khirano> like issue tracker, wiki, mailing list and so on, we can use
them to share many things.
<kynh> Sophie: yes :)
<maho_> forestcheng, aijin : which encoding do you use?
<aijin> maho_: i use utf-8 , but some ko members use euc-kr
<maho_> okay.
<forestcheng> My email client can use many encoding. I often need to
set UTF-8 if CJK.
<kynh> I think that technical matter for 2bye area is same as other
lang locations , is't it? How do you think?
<kynh> But the standards of code is deferent in each lang by national
policy.
<khirano> Let us talk about "encoding" another chance? :)
<maho_> yes.
<kynh> +1: khirano.
<khirano> OK, Group is helpful :) And we can do more to share
<khirano> I think, to do more, 4. More coordinators for the group, needed
:)
<forestcheng> +1 khirano
<maho_> coordinate the subproject within native lang project.
<maho_> ?
<aijin> khirano: can we define the detail role of coordinator?
<khirano> aijin: yes.
<khirano> CJK group coorinators "coordinate" :)
<khirano> Coordinate means gettng touch with member project leads,
listening to their needs
<khirano> Taking up issues and putting them on agenda, and leading
discussion
<kynh> khirano: over?
<khirano> for example, the wiki, the IRC meeting, raising issues on
the mailing list and so on
<khirano> http://wiki.services.openoffice.org/wiki/CJK_Group
<khirano> This wiki page is not organized, not updated
<khirano> I need help, good idea and making this page more informative
and helpful for group member projects
<kynh> maho: do you mean that leagional group of NLC will make
relations with each coordination subproject in each lang prject,
right?
<maho_> naively, right.
<khirano> A biggest task for CJK group coordinators will be Organizing
OOoRegiCon Asia 2010 Seoul :)
<maho_> right.
<khirano> - Can we have coordinators from ko and zh?
<sophi1> maho_: I think it's a good idea, it's still early because
there is only few groups and this one is the most active
<khirano> Candiates? Nomination?
<maho_> ah - understand
<kynh> Sophie, How does the other leaginal group make relations , do you
know?
<maho_> sophi1 : thanks
<maho_> kynh : thanks for good question
<sophi1> kynh: I'm not sure they are active currently, but we should
ask on the list to try to make them share their experience
<khirano> forestcheng: Can we have a coordinator form zh community
for CJK group ?
<kynh> Sorry, I have to logoff. I'll check the LOG later. Thank you so
much.
<maho_> kynh : thanks for participating!
<khirano> Thanks, kynh
<sophi1> kynh: bye !
<kynh> Thanks all.
<aijin> kynh: bye
<forestcheng> :) I'm thinking. Coor is important to CJK group. We'll
try find a suitable person.
* kynh は IRC から離れました ("Leaving...")
<aijin> khirano: We may need to call for volunteers in each lang team.
<khirano> aijin: right!
<maho_> khirano : who will be for JA? you? :)
<khirano> I will ask jeongkyu to call for volunteers in korean community :)
<aijin> khirano: thanks.
<khirano> forestcheng: Can you call for volunteers in zh community?
<forestcheng> yes
<khirano> Thanks!
<khirano> maho: Can you call for volunteers in ja community? :)
<maho_> sure!
<khirano> Thanks!
<forestcheng> if no one can be found, I'll try to do such role.
<khirano> forestcheng: Thanks!
<khirano> 5. Next IRC meeting
<forestcheng> Looking forward to next IRC :)
<maho_> me too.
<khirano> forestcheng: Is it a good idea to have an IRC meeting in week
days?
<khirano> Some don't want to attend a meeting on Saturdays?
<maho_> :)
<forestcheng> Yes, i think most people can be available on weekend.
<khirano> You mean Saturdays are OK for IRC meeting?
<forestcheng> Maybe some want Sunday.
<khirano> I see
<khirano> OK, we will find best day on com@native-lang.openoffice.org then.
<aijin> +1
<forestcheng> +1 khirano
<sophi1> khirano: +1
<maho_> +1
<khirano> I will compile a minute and put it up to the wiki, and the
log of this meeting also will be uploaded
<sophi1> khirano: do you know http://www.doodle.com/ ?
<aijin> khirano: thanks!
<khirano> sophie, what is it?
* peter13j has to leave. appointment at 7
* peter13j は IRC から離れました ("Goodbye folks!")
<maho_> see you
<sophi1> khirano: it's a tool that help you to organize meeting :)
<khirano> meeting organizer or something?
<forestcheng> see you, Peter
<sophi1> khirano: yes
<khirano> Oh, yes, I will check it up
<khirano> Peter, thanks
<khirano> Any more questions?
<sophi1> khirano: not from my side, thanks a lot for the meeting, it
was great :)
<khirano> Great! OK, we will see on com@native-lang.openoffice.org
and the next IRC meeting.
<aijin> khirano: not from me. thanks much for orgarnizing the meeting.
<forestcheng> no more question. Thank khirano very much for this IRC.
I'm glad to be here.
<khirano> Thanks, aijin!
<khirano> Thanks, forenstcheng!
<maho_> thanks, no question from me. thanks again for great IRC
<khirano> Thanks, Sophie for your attendance!
<forestcheng> Good bye to all, Have a nice weekend!
<khirano> Yes, have a nice weekend!
<maho_> I also thanks for Sophie
<maho_> khirano : please call close
<liheng> bye all
* liheng (n=temp@114.255.42.178) は #ooonlc から離れました。
<sophi1> maho_: khirano: you're welcome, I'm very pleased :)
<khirano> The meeting is closing, thanks all
</nowiki>
</pre>

[[Category:CJK issues]]

CJK Group/Agenda

2009-12-04T06:30:48Z

Kirk:

= Agenda for the next Meeting =
== Next meeting: Starts from 13:00 Seoul Time on April 24th 2009 ==

# 3.1 Release QA Status
# RegiCon Asia 2010 Spring in Seoul
# More CJK Group Coordinators
# Zh is planning to translate OOo3.0 UserGuide in [http://oooauthors.org/en OOoAuthors]. It's time consuming work. How Ko and Ja think of this? Do you have OOo UserGuide in local language? or related documents such as: tips,skills,advanced or useful features...? How can community help users quickly find usage answer?
# Next Meeting
# How to get more people who can attend an IRC meeting :)
# (Please add yours)

== Minutes of Previous Meetings ==
See [[CJK_Group/Minutes | here]]

[[Category:CJK issues]]

Database/Drivers/MySQL Native/1.0/Known Issues

2009-11-23T01:10:27Z

Kirk:

{{DISPLAYTITLE:MySQL Connector for OpenOffice.org 1.0 - Known Issues}}

__TOC__

=== Accessing non-intranet servers by IP address might fail ===

If you set up a connection to a MySQL server outside your intranet, which is known by IP address, this might fail with an error code of 10060, effectively saying "Can't connect". The problem is not fully analyzed, yet, so the problem description here is somewhat rough at the moment.

[[Category:Database Drivers]]

Database/Drivers/MySQL Native/Architecture

2009-11-23T01:03:18Z

Kirk:

__TOC__
=== Wrapped Access ===
The below picture illustrates the current architecture for the existing MySQL driver, where a generic driver (JDBC/ODBC) is wrapped
[[image:Mysql_driver_architecture_old.png|center|frame|MySQL Driver architecture - present]]
'''Notes'''
* Note the additional layer consisting of the JDBC/ODBC->SDBC bridge, which introduces additional complexity, and loss of information (as every abstraction layer)
* The picture is not strictly correct. The applications usually do not work directly on the SDBCX layer, but instead on a layer providing yet more convenience ([http://api.openoffice.org/docs/common/ref/com/sun/star/sdb/module-ix.html SDB]).

=== Direct Access ===
The below picture illustrates the new architecture, where a dedicated C++ driver (Connector/OOo) talks to the MySQL server using the MySQL client library (libmysql)
[[image:Mysql_driver_architecture_new.png|center|frame|MySQL Driver architecture - future]]
''''Notes''''
* Currently, the MySQL Client Library is linked to / shipped with the MySQL native driver, thus effectively part of OpenOffice.org.

[[Category:Database Drivers]]

Database/Drivers/MySQL Native/1.0

2009-11-23T01:02:30Z

Kirk:

{{DISPLAYTITLE:MySQL Connector for OpenOffice.org 1.0}}

== Introduction ==

MySQL Connector for OpenOffice.org is a [http://www.mysql.org MySQL] driver for [http://www.openoffice.org/ OpenOffice.org]. It can be used to connect from [http://download.openoffice.org OpenOffice.org 3.1] to a MySQL server 5.1 or newer.

Before MySQL Connector for OpenOffice.org became available you'd have to use [http://dev.mysql.com/downloads/connector/j/ MySQL Connector/J (JDBC)] or [http://dev.mysql.com/downloads/connector/odbc/ MySQL Connector for ODBC] to connect to a MySQL server.

Therefore the driver is also referred to as a native driver in the context of OpenOffice.org. The term native driver clashes with the MySQL definition of a native driver: MySQL Connector for OpenOffice.org does not implement the MySQL Client Server protocol. Technically speaking the MySQL Connector for OpenOffice.org is implemented as a proxy on top of the [http://dev.mysql.com/doc/refman/5.1/en/connector-cpp.html MySQL Connector/C++].

The driver is delivered as an OpenOffice.org extension.

=== Advantages ===

Using MySQL Connector for OpenOffice.org has the following advantages:

* Easy installation through the OpenOffice.org Extension Manager.
* Seamless integration into OpenOffice.org.
* Work on multiple MySQL schemata (databases) simultaneously
* Connect to MySQL servers using named pipes (Windows) or Sockets (Unix)
* No need to go through an additional Connector installation routine (ODBC/JDBC)
* No need to configure or register an additional Connector (ODBC)
* No need to install or configure a driver manager (ODBC)
* No need for a Java Runtime Environment (JDBC)

=== Status ===

The MySQL Connector for OpenOffice.org is released in version 1.0, in production quality.

== Installation ==

=== Install or upgrade to OpenOffice.org 3.1 ===

OpenOffice.org 3.1 is available from OpenOffice.org's [http://download.openoffice.org download site]. The driver does not work together with earlier versions of OpenOffice.org. It will also run in OpenOffice.org when it becomes available, but not in current developer snapshots (up to, anticipated, DEV300.m57).

Please use "vanilla" OpenOffice.org: As with all extensions containing binary code, they're potentially incompatible with other OpenOffice.org distributions (like the one from your favorite Linux distribution), and are not necessarily expected to work with them. If you're using an OpenOffice.org build obtained elsewhere, e.g. by your favorite Linux distributor, then please ask this source to also provide the MySQL Connector for OpenOffice.org.

=== Download MySQL Connector for OpenOffice.org ===

The extension is available from the [http://extensions.services.openoffice.org/project/mysql_connector OpenOffice.org extensions repository]. It is provided for the usual 6 platforms (Windows, Linux Intel 32 Bit, Linux Intel 64 Bit, Solaris Sparc, Solaris Intel 32 Bit, Mac OS X Intel).

Download the file to a location of your choice, for example <code>My Documents</code> or <code>~/Documents</code>.

=== Users of the Beta version please note ===

If you have installed the previous Beta version please uninstall it first manually in the Extension Manager. The final version has a new product name and therefore it is not possible to update it via the extension mechanism. Also delete the cached database connection that was previously created as it cannot be re-used again (e.g., Windows: <code>"C:\Documents and Settings\<user>\Application Data\OpenOffice.org\3\user\uno_packages\cache\registry\*"</code> or Unix: <code>"/home/<user>/.openoffice.org/3/user/uno_packages/cache/registry/*"</code>).

=== Installing the extension ===

Add the <code>.oxt</code> extension through the Extension Manager of OpenOffice.org. In OpenOffice.org, select <code>Tools, Extension Manager...</code> and specify the <code>.oxt</code> file as a new extension. When done, MySQL Connector for OpenOffice.org should show up as a new extension under <code>My Extensions</code>.

[[Image:Conn_ooo_1.0_GA_extensions.png]]

Restart OpenOffice.org to complete the installation.

== Getting Started: Connecting to MySQL ==

MySQL Connector for OpenOffice.org allows you to access the MySQL Server and its schemata from the OpenOffice.org suite.

The following example demonstrates the creation of a new OpenOffice.org Base database which uses a local MySQL Server for storage and the new connector for connecting.

=== Select the database ===

Create a new database (<code>File, New, Database</code>). This starts a wizard that allows you to create a new, open an existing, or connect to existing database. Select the latter option.

From the drop-down list, select <code>MySQL</code>. Click <code>Next >></code>.

[[Image:Conn_ooo_alpha_wizard1.png]]

=== Select the type of the driver ===

You can use three different MySQL drivers for connecting to MySQL from OpenOffice.org. You can choose a generic ODBC or JDBC connection method or the native driver. Select <code>Connect native</code>. Click <code>Next >></code>.

[[Image:Conn_ooo_alpha_wizard2.png]]

=== Setting up the database connection ===

Set up the database connection. Put the schema (database) you want to connect to into <code>Name of the database</code>. Enter the URL (host name, or simply type <code>localhost</code> when connecting to the server on your own PC), Port and Socket (or leave socket empty) of your MySQL Server. Click <code>Next >></code>.

[[Image:Conn_ooo_alpha_wizard3.png]]

=== Fill in user credentials ===

Provide the user credentials for connecting to your MySQL Server. Click <code>Next >></code>.

[[Image:Conn_ooo_alpha_wizard4.png]]

=== Save and proceed ===

Finish the wizard. All defaults are a safe choice. Click <code>Finish >></code>.

[[Image:Conn_ooo_alpha_wizard5.png]]

== Getting Started: Usage Examples ==

=== Listing Tables ===

In the Database area of the Base main window, select Tables. If this is the first time you're accessing the database you'll be prompted for your credentials (username and password); you can store these settings for your current Base session.

[[Image:Conn ooo alpha base.png]]

Depending on your connection settings you will now see all databases with all their tables, or just the database you've specified in the connection settings.

== Known Issues ==

There is currently [[Database/Drivers/MySQL Native/1.0/Known Issues|1 known issue]] in MySQL Connector for OpenOffice.org. We decided to nonetheless release version 1.0, since we think that it's better for all users, which do not encounter this particular problem, to benefit from this great extension.

== Contact ==

If you discover a bug, or just want to give any kind of feedback on the connector, please send an email to [mailto:users@dba.openoffice.org users@dba.openoffice.org]. It's a low-volume list with less than 10 mails per day. If you prefer reading it by means other than subscribing to it, see [[Base Mailing List|here]].

[[Category:Database Drivers]]

Database/Drivers

2009-11-23T01:00:49Z

Kirk:

{{DISPLAYTITLE:Database Drivers}}
<DPL>
titlematch=Database/Drivers/%
nottitlematch=Database/Drivers/%/%
replaceintitle=#Database/Drivers/#,
</DPL>

[[Category:Database Drivers]]

AQUA NATIVE MENUS

2009-11-23T00:26:53Z

Kirk:

= AQUA_NATIVE_MENUS =

If you need to solve problems with the implementation of native menu bars for the Aqua port then it might be useful to know the environment variable AQUA_NATIVE_MENUS.

Native menus are defaults. If you want to use vcl menus, do:

<pre>
AQUA_NATIVE_MENUS=FALSE ./soffice.bin
</pre>

Note: options to not recover is -norestore , and to bypass the user informations to fill in, use -nofirststartwizard

AQUA_NATIVE_MENUS=FALSE ./soffice.bin -nofirststartwizard -norestore

You can also insert environement variables in a Dictionary Class of Info.plist located in the Contents directory of OpenOffice.org bundle.

For example, you can add the following XML in a text editor (or make it generated by Property List Editor) in your Info.plist :

<key>LSEnvironment</key>
<dict>
<key>AQUA_NATIVE_MENUS</key>
<string>TRUE</string>
<key>OOO_DISABLE_RECOVERY</key>
<string>TRUE</string>
<key>SAL_NO_NWF</key>
<string>TRUE</string>
<dict>

Notice that in order to work, the OOO_DISABLE_RECOVERY variable detection must be manually inserted in OOo code using the following patch :
http://www.go-oo.org/patches/src680/disable-recovery.diff

This patch is outdated, but you can make the modifications yourself.

Notice the enviroment variable here. AQUA_NATIVE_MENUS is experimental stuff created by Pavel, SAL_NO_NWF was created some times ago, and is located in vcl/source/window/window.cxx . At the moment we have:

{| border="1" cellpadding="15" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_NWF=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=FALSE || disable native menus code
|}

Both changes are marked with comments in the source code, and when we remove them in the future, native controls and native menus will be enabled by default.
[[category:Aqua]]

Accessibility Test OOo30

2009-11-23T00:25:21Z

Kirk:

This page describes The results of the accessibility tests on OpenOffice.org, version OOO300m1.

= Test Results - Overview =

{| class="prettytable"
|
| <center>'''Solaris 11'''</center>
| <center>'''Windows'''</center>
| <center>'''MAC OSX'''</center>

|-
| '''Speech/Braille'''
| <center>Passed</center>
| <center>Passed</center>
| <center>Passed</center>

|-
| '''Keyboard Navigation'''
| <center>Passed</center>
| <center>Passed</center>
| <center>Passed</center>

|-
| '''High Contrast'''
| <center>Passed</center>
| <center>Passed</center>
| <center>n/a</center>

|}

Those results are based on the [http://wiki.services.openoffice.org/wiki/Accessibility_Test_OOo30#Test_Plan_Specification_.2F_Documentation Plan Specifications and Documentation] below

= Environnement Details =

== Solaris (11)==

* AT-Tool - Speech/Braille: Orca with braille monitor
* Helpers: at-poke, accersizer

== Windows ==

* AT-Tool - Speech: ZoomText
* Helpers: JavaMonkey, JavaFerret
* Java Access Bridge: 2.0.1
* JRE 1.6_04

== MAC OSX ==

* AT-Tools: VoiceOver

Note: High-Contrast on Mac is not a "real" High Contrast. More a video variation without software automatc switch

= Test Plan Specification / Documentation =

* [http://wiki.services.openoffice.org/wiki/Accessibility_Test_GUI_All | General User Interface Test] (Speech/Braille) common to all applications.

* [http://wiki.services.openoffice.org/wiki/Accessibility_Test_KBD_All | Keyboard Test] common to all applications.

* High Contrast: no specific guidelines. The environment theme is switch on the Windows and Solaris to High Contrast Black (or similar). SO/OOo's UI must follow the theming.
[[Category:Accessibility]]

Accessibility Test KBD All

2009-11-23T00:24:48Z

Kirk:

'''Goal:'''

Guidleine for StarOffice / OpenOffice.org Keyboard Testing

= 1. General Settings =

{| class="prettytable"
! What
! Action
! Key
! UNIX

|-
| '''a pane -> task pane '''''(in the program window).''

* '''Canvas''' (Writer document, Draw document, ..., working area)
* '''Floats''' (Navigator, Stylist, Help Agent, Tear Down Toolboxes)
* '''Toolbars''' (Object bar, Work bar)
* '''Non modal dialogs''' (URL dialog, Search Dialog, Add Index Entry Dlg.)

* '''Splitted document view''', (help window, dialogs with an external preview)

| '''''Jump to/Travel'''''
| '''<nowiki>[F6]</nowiki>'''
| '''2 cases:- '''''If Floatings (Navigator, Stylist)'' ''OFF''<nowiki>: [F6]*** cycles between menu bar > toolbars > document - </nowiki>''If Floatings (Navigator, Stylist) ON: ''<nowiki>[F6]*** cycles between document > menu bar > toolbars > STOP</nowiki><nowiki>*** Depending of the key mapping of the window environnement.</nowiki>

|-
| '''a pane -> another pane'''''in the program window (counterclockwise direction) ''
| '''''Move'''''
| '''<nowiki>[Shift]+[F6]</nowiki>'''
| ''Same as Windows but see bellow''

|-
| '''-> main document pane'''
| '''''Move'''''
| '''<nowiki>[Ctrl]+[F6]</nowiki>'''
| Same (if not other mapping: Linux=go to desktop 6)

|-
| '''-> menu bar'''
| '''''Places focus'''''
| '''<nowiki>[Alt] </nowiki>'''or '''<nowiki>[F10]</nowiki>'''
| '''<nowiki>[F10]</nowiki>'''

|-
| '''active menu'''/'''toolbar '''-> '''task pane'''
| '''''Move to'''''
| '''<nowiki>[F6]</nowiki>'''or''' <nowiki>[Ctrl]+[Tab] </nowiki>'''or'''<nowiki> [Ctrl]+[Shift]+[Tab] </nowiki>'''''(reverse order)''
| Same (if not other mapping)

Same (if not other mapping â Linux=go to next desktop)

|-
| '''next/previous option''' ''(In active task pane)''.
| '''''Select'''''
| '''<nowiki>[Tab] </nowiki>'''or'''<nowiki> [Shift]+[Tab] </nowiki>'''
| Same

|-
| - Among '''choices''' ''(in a selected submenu)''or:- Among certain '''options''' ''(in a group of options)''
| '''''Move'''''
| '''<nowiki>[Down] </nowiki>'''or'''<nowiki> [Up]</nowiki>'''
| Same

|-
| '''Selected menu'''
| '''''Open'''''
| '''<nowiki>[Space] </nowiki>'''or'''<nowiki> [Enter]</nowiki>'''
| Same

|-
| '''Selected button'''
| '''''Perform action'''''
| '''<nowiki>[Space] </nowiki>'''or'''<nowiki> [Enter]</nowiki>'''
| Same

|-
| '''Context menu'''
| '''''Open'''''
| '''<nowiki>[Shift]+[F10] </nowiki>'''
| Same

|-
| '''First/last command''' ''(of a selected (sub)menu)''
| '''''Select'''''
| '''<nowiki>[Home] </nowiki>'''or'''<nowiki> [End]</nowiki>'''
| Same

|-
| '''Selected list'''
| '''''Scroll up/down'''''
| '''<nowiki>[PgUp] </nowiki>'''or'''<nowiki> [PgDn] </nowiki>'''
| Same

|-
| '''Selected list'''
| '''''Move to top/bottom'''''
| '''<nowiki>[Ctrl]+[Home] </nowiki>'''or'''<nowiki> [Ctrl]+[End] </nowiki>'''
| Same

|-
| '''Document'''
| '''''Back to'''''
| '''<nowiki>[Esc]</nowiki>'''
| Same

|}
= 2. Access and use menus and toolbars =

{| class="prettytable"
! What
! Action
! Key
! UNIX

|-
| the '''menu bar'''
| '''Select'''
| '''<nowiki>[F10]</nowiki> '''or'''<nowiki> [Alt]</nowiki>'''
| '''<nowiki>[F10] </nowiki>'''

|-
| '''menu and submenu''' at the same time ''(when opened)''.
| '''Close'''
| '''<nowiki>[F10]</nowiki> '''or'''<nowiki> [Alt]</nowiki>'''
| '''<nowiki>[F10] </nowiki>'''

|-
| (next/previous) '''toolbar '''''(when the menu bar or an other toolbar is selected)''
| '''Select''' (previous)
| ''<nowiki>([Shift]+)</nowiki>'''''<nowiki>[F6]</nowiki>'''or'''<nowiki>[Ctrl]+</nowiki>'''''<nowiki>([Shift]+)</nowiki>'''''<nowiki>[Tab] </nowiki>'''
| SameSame (if not other mapping â Linux=go to next desktop)

|-
| (next/previous) '''button''' or '''menu''' ''(when a toolbar/menu bar selected)''
| '''Select (previous)'''
| '''<nowiki>[Tab] </nowiki>'''or'''<nowiki> [Shift]+[Tab] </nowiki>'''
| Same

|-
| '''selected menu'''
| '''Open'''
| '''<nowiki>[Enter]</nowiki>'''
| Same

|-
| '''selected button'''
| '''Perform action'''
| '''<nowiki>[Enter]</nowiki>'''
| Same

|-
| '''Context menu''' ''(for an item)''
| '''Open'''
| '''<nowiki>[Shift]+</nowiki><nowiki>[F10]</nowiki> '''
| Same

|-
| '''Context menu''' ''(of the window = "Control Menu")''
| '''Open'''
| '''<nowiki>[Alt]+[Space] </nowiki>'''
| <nowiki>Same (if not other mapping â Linux = sometimes [Alt]+[F3])</nowiki>

|-
| (next/previous) '''command''' ''(when menu/submenu open)''
| '''Select'''
| '''<nowiki>[Down] </nowiki>'''or'''<nowiki> [Up]</nowiki>'''
| Same

|-
| '''menu''' to the left or right. When a submenu is open, switch between the main menu and the submenu.
| '''Select'''
| '''<nowiki>[Left] </nowiki>'''or'''<nowiki> [Right]</nowiki>'''
| Same

|-
| (first/last) '''command''' (''on the menu or submenu)''
| '''Select'''
| '''<nowiki>[Home] </nowiki>'''or'''<nowiki> [End]</nowiki>'''
| Same

|-
| '''Submenu''' only ''(not the main menu)''
| '''Close'''
| '''<nowiki>[Esc]</nowiki>'''
| Same

|-
| '''List of commands''' when a menu is selected.
| '''Open'''
| '''<nowiki>[Down]</nowiki>'''
| Same

|}
= 3. Moving Focus In Dialogs =

{| class="prettytable"
| '''''What'''''
| '''''Action'''''
| '''''Key'''''
| '''''Unix'''''

|-
| '''Dialog'''
| '''''Close'''''
| '''<nowiki>[Esc]</nowiki>'''
| Same

|-
| '''Tab page'''
| '''''Switch '''(to next/previous)''
| '''<nowiki>[Ctrl]+[Tab] </nowiki>'''/ '''<nowiki>[Ctrl]+[Shift]+[Tab] </nowiki>'''
| <nowiki>Same (or depending on sys config [Alt]+, [Ctrl]+, [PgUp]/[PgDn] or arrow keys)</nowiki>

|-
| '''Option'''/'''option group'''
| '''''Move '''(to next/previous)''
| '''<nowiki>[Tab] </nowiki>'''/''' <nowiki>[Shift]+[Tab] </nowiki>'''
| Same

|-
| between '''options '''in '''drop-down lists'''/'''group of options'''
| '''''Move'''''
| '''Arrow keys '''
| Same

|-
| '''Option'''
| '''Select'''
| '''<nowiki>[Alt]+the letter underlined in an option </nowiki>'''''(="Mnemonic")''
| Same

|-
| '''Check box/radio button'''
| '''''(Un)check'''''/'''''(des)activate''''' ''(only if mnemonic is '''NOT''' double!!! )''
| '''<nowiki>[Alt]+the letter underlined in an option </nowiki>'''''(="Mnemonic")''
| Same

|-
| '''Check box'''
| '''''(Un)check'''''
| '''<nowiki>[Space] </nowiki>'''
| Same

|-
| '''Button'''
| '''''Perform the action'''''
| '''<nowiki>[Space] </nowiki>'''
| Same

|-
| '''Drop-down listbox'''
| - '''Open''' ''(if list was close)''
| '''<nowiki>- [Alt]+[Down]</nowiki>'''
| Not possible

|-
| '''Drop-down listbox'''
| '''''- Jump (to the next option which names begins with this letter)'''''
| '''- First letter of an option / arrow keys'''
| same

|-
| '''Drop-down listbox '''
| '''''Close'''''
| '''<nowiki>[Esc]</nowiki> '''
| same

|-
| '''Command'''
| '''''Cancel'''''
| '''<nowiki>[Esc]</nowiki>'''
| same

|-
| '''Default button'''
| '''''Perform the action'''''
| '''<nowiki>[Enter]</nowiki>'''
| same

|-
| '''TreeView node'''
| '''''Open/Close'''''
| '''<nowiki><+> or <right></nowiki>/<nowiki><-></nowiki><nowiki> or <left></nowiki>'''
| same

|-
| '''TreeView node'''
| '''''Travel'''''
| '''<nowiki>[Up]/[Down]</nowiki>'''
| same

|}
= 4. Use edit fields / boxes within dialog boxes =

{| class="prettytable"
! Direction/Amplitude
! Action
! Key
! Unix

|-
| ''to the '''beginning''' / '''end '''of the '''''entry'''
| '''''Move'''''
| '''<nowiki>[Home] </nowiki>'''/'''<nowiki> [End]</nowiki> '''
| same

|-
| '''one character''' to the '''left''' / '''right'''
| '''''Move'''''
| '''<nowiki>[Left] </nowiki>'''/'''<nowiki> [Right]</nowiki>'''
| same

|-
| '''one word''' to the '''left''' / '''right'''
| '''''Move'''''
| '''<nowiki>[Ctrl]+([Left] </nowiki>'''/'''<nowiki> [Right]</nowiki>''')
| same

|-
| '''one character''' to the '''left''' / '''right'''
| '''''(Un)Select'''''
| '''<nowiki>[Shift]+</nowiki>'''('''<nowiki>[Left] </nowiki>'''/'''<nowiki> [Right]</nowiki>''')
| same

|-
| '''one word''' to the '''left''' / '''right'''
| '''''(Un)Select'''''
| '''<nowiki>[Ctrl]+[Shift]+</nowiki>'''('''<nowiki>[Left] </nowiki>'''/'''<nowiki> [Right]</nowiki>''')
| same

|-
| ''to the '''beginning''' / '''end '''of the '''''entry'''
| '''''Select'''''
| '''<nowiki>[Shift]+(</nowiki><nowiki>[Home] </nowiki>'''/'''<nowiki> [End]</nowiki>''')
| same

|}
= 5. Move and Resize task panes =

{| class="prettytable"
! Item
! Action
! Key
! Comment
! Unix

|-
| '''ToolbarsMenusTask panes'''
| '''''Select'''''
| # <nowiki>[Alt] / [F10]</nowiki>
# '''<nowiki>[Ctrl]+[Tab] / [F6]</nowiki>'''

| ''-> (select the menu bar)''

''-> (travel through toolbars or task panes)''
| <nowiki>[F10]</nowiki>

<nowiki>[F6]</nowiki>

|-
| '''''Resize'''''
| # <nowiki>[Ctrl]+[Space]</nowiki>
# choose "'''Size'''<nowiki>"+[Enter] </nowiki>
# '''''<nowiki><arrow_keys></nowiki>'''''

''Or '''<nowiki>[Ctrl]+<arrow_keys</nowiki>'''>''
| ''-> displays the "Options" menu''

''->resize''

''->resize pixel to pixel''
| <nowiki>Same (if not other mapping â Linux = sometimes [Alt]+[F3])</nowiki>Solaris: '''''<nowiki>[Ctrl]+<arrow_keys</nowiki>'''> = large steps,'''<nowiki> without [Ctrl] = </nowiki>'''pixel to pixel''

|-
| '''''Move'''''
| # ''<nowiki>[Ctrl]+[Space] </nowiki>''
# choose "'''Move'''<nowiki>"+[Enter] </nowiki>
# '''''<nowiki><arrow_keys></nowiki>'''''

''Or '''<nowiki>[Ctrl]+<arrow_keys></nowiki>'''''
| ''-> displays the "Options" menu''

''->resize''

''->resize pixel to pixel''
| <nowiki>Same (if not other mapping â Linux = sometimes [Alt]+[F3])</nowiki>Solaris: '''''<nowiki>[Ctrl]+<arrow_keys</nowiki>'''> = large steps,''' <nowiki>without [Ctrl] = </nowiki>'''pixel to pixel''

|-
| '''''Dock'''''
| '''''<nowiki>[F4]</nowiki>'''''
| ''only docking on the original place or on the left (Navigator, Stylist)''
| Same

|-
| '''''Undock'''''
| '''''<nowiki>[F4]</nowiki>'''''
|  
| Same

|}

{| class="prettytable"
! Item
! Action
! Key
! Comment

|-
| '''Windows'''''(Resizable/movable Windows without menu***)''
| '''Move'''
| '''<nowiki>[Alt]+<arrow_keys></nowiki>'''
| <nowiki>***Ex: the Table controls in the Query Design component.</nowiki>

|-
| '''Drawing object'''
| '''Select '''
| ES: ------- depends on the application: must be reviewed -------

# <nowiki>[F10] </nowiki>''(menu bar)''
# <nowiki>[Ctrl]+[Tab] </nowiki>''(until the Drawing toolbar)''
# <nowiki>[Right] </nowiki>''("'''Select Objects'''")''
# '''<nowiki>[Ctrl]+[Enter]</nowiki>''' ''(selects the first drawing object)''
# <nowiki>[</nowiki>'''<nowiki>Tab]/[Shift]+[Tab] </nowiki>'''''(cycle back/forward between objects)''

''<nowiki>------------------</nowiki>''
|

|}
= 6. Multi selection using keyboard =
<nowiki>Normally [Ctrl] and a click of the mouse selection button extends a current selection with the new selected object or text</nowiki>

''FL: Needs to be discussed.''

ES:

<nowiki>- [Shift]+[F8] = toggles between STD/ADD selection Modes</nowiki>

<nowiki>- Normal text selection using [Shift]+([Ctrl])+<arrow keys>, [Home] or [End].</nowiki>

- AFAIK: only possible in Writer and no implementation possibility for Draw/Impress

= 7. System Keyboard Setting =
== 7.1. Reserved Keyboard Mappings for Mobility Access Feature ==
* consecutive clicks of Shift key On/Off for '''StickyKeys'''
* Shift key held down for 8 seconds On/Off for SlowKeys and RepeatKeys
* consecutive clicks of Control key On/Off for screen reader numeric keypad
* consecutive clicks of Alt key Future Access use

== 7.2. Reserved System Keyboard Mappings for Windows ==
Some of the content in this topic may not be applicable to some languages.

{| class="prettytable"
! Key
! Action

|-
| '''<nowiki>[Alt]+[Tab] </nowiki>'''
| Switch to the next window

|-
| '''<nowiki>[Alt]+[Shift]+[Tab] </nowiki>'''
| Switch to the previous window

|-
| '''<nowiki>[Ctrl]+W or [Ctrl]+F4 </nowiki>'''
| Close the active window

|-
| '''<nowiki>[Ctrl]+F5 </nowiki>'''
| Restore the size of the active window after you've maximized it

|-
| '''F6 '''
| Move to a task pane from another pane in the program window (clockwise direction). You may need to press F6 more than once.

|-
| '''<nowiki>[Shift]+F6 </nowiki>'''
| Move to a pane from another pane in the program window (counterclockwise direction)

|-
| '''<nowiki>[Ctrl]+F6 </nowiki>'''
| When more than one window is open, switch to the next window

|-
| '''<nowiki>[Ctrl]+[Shift]+F6 </nowiki>'''
| Switch to the previous window

|-
| '''<nowiki>[Ctrl]+F7 </nowiki>'''
| When a document window is not maximized, performs the Move command (on the Control menu for the window). Use the arrow keys to move the window, and, when finished, press ESC.

|-
| '''<nowiki>[Ctrl]+F8 </nowiki>'''
| When a document window is not maximized, performs the Size command (on the Control menu for the window). Use the arrow keys to resize the window, and, when finished, press ESC.

|-
| '''<nowiki>[Ctrl]+F9 </nowiki>'''
| Minimize a window to an icon (works only for some Microsoft Office programs)

|-
| '''<nowiki>[Ctrl]+F10 </nowiki>'''
| Maximize or restore a selected window

|}
= 8. The Gallery =
== 8.1. Common Shortcuts ==

{| class="prettytable"
! Item
! Action
! Key
! Comment

|-
| '''Controls'''
| '''Travel for|backward'''
| '''<nowiki>([Shift])+[Tab]*</nowiki>'''
| ''' '''

|}
<nowiki>*Those are very standard shortcuts which should be intuitive enough</nowiki>

== 8.2. In the Themes Listbox ==

{| class="prettytable"
! Item
! Action
! Key
! Comment

|-
| '''Theme'''
| '''Travel to up/down'''
| '''<nowiki>[Up]/[Down]*</nowiki>'''
| ''' '''

|-
| '''Theme'''
| '''Show Properties'''
| '''<nowiki>[Ctrl]+[Enter]</nowiki>'''
| ''' '''

|-
| '''Theme context menu'''
| '''Open'''
| '''<nowiki>[Shift] + F10*</nowiki>'''
| ''' '''

|-
| '''Theme'''
| '''Update'''
| '''<nowiki>[Ctrl] + U </nowiki>'''
| ''' '''

|-
| '''Theme'''
| '''Rename'''
| '''<nowiki>[Ctrl] + R </nowiki>'''
| ''' '''

|-
| '''Theme'''
| '''Delete'''
| '''<nowiki>[Ctrl] + D</nowiki>'''
| ''' '''

|-
| '''Theme'''
| '''Create'''
| '''<nowiki>[Ins]</nowiki>'''
| ''' '''

|}
''<nowiki>*Those are very standard shortcuts which should be intuitive enough</nowiki>''

== 8.3. Grid Preview (Detailed or Inconized) ==

{| class="prettytable"
! Item
! Action
! Key
! Comment

|-
| '''Image'''
| '''Travel to first/last/left/right/up/down'''
| '''<nowiki>[Home] / [End] / [Left] / [Right] / [Up] / [Down]*</nowiki>'''
| ''' '''

|-
| '''Grid Preview'''
| '''Travel to one page up/down'''
| '''<nowiki>[Pg Up] / [Pg Dn]</nowiki>'''
| ''' '''

|-
| '''Image '''
| '''Paste a copy into current doc'''
| '''<nowiki>[Ctrl] + I</nowiki>'''
| ''' '''

|-
| '''Image '''
| '''Paste a linked copy into current doc'''
| '''<nowiki>[Ctrl] + [Shift] + I</nowiki>'''
| ''' '''

|-
| '''Image title'''
| '''Edit'''
| '''<nowiki>[Ctrl] + T,</nowiki>'''
| ''' '''

|-
| '''Grid Preview'''
| '''Toggle to preview'''
| '''<nowiki>[Ctrl] + P, [Space], [Enter] </nowiki>'''
| ''' '''

|-
| '''Image'''
| '''Delete'''
| '''<nowiki>[Ctrl] + D</nowiki>'''
| ''' '''

|}
''<nowiki>*Those are very standard shortcuts which should be intuitive enough</nowiki>''

== 8.4. Preview Mode (Preview is active) ==

{| class="prettytable"
! Item
! Action
! Key

|-
| '''Image'''
| '''Travel to next'''
| '''''<nowiki>[Right], </nowiki><nowiki>[Up]</nowiki><nowiki> /[Left], </nowiki><nowiki>[Down]</nowiki>''<nowiki>*</nowiki>'''

|-
| '''Image'''
| '''Travel to first/last'''
| '''<nowiki>[Home] / [End]</nowiki>'''

|-
| '''Grid Preview'''
| '''Toggle to preview'''
| '''<nowiki>[Ctrl] + P, [Space], [Enter] </nowiki>'''

|-
| '''Grid Preview'''
| '''Toaggle back'''
| '''<nowiki>[Backspace]</nowiki>'''

|-
| '''Image '''
| '''Paste a copy into current doc'''
| '''<nowiki>[Ctrl] + I</nowiki>'''

|-
| '''Image'''
| '''Paste a linked copy into current doc'''
| '''<nowiki>[Ctrl] + [Shift] + I</nowiki>'''

|-
| '''Theme context menu'''
| '''Open'''
| '''<nowiki>[Shift] + F10*</nowiki>'''

|-
| '''Image title'''
| '''Edit'''
| '''<nowiki>[Ctrl] + T</nowiki>'''

|-
| '''Image'''
| '''Delete'''
| '''<nowiki>[Ctrl] + D</nowiki>'''

|}
''<nowiki>*Those are very standard shortcuts which should be intuitive enough</nowiki>''

= 9. Customize Toolbars =

{| class="prettytable"
! [[Image:customize_toolbars.jpg]]

|-

|}
'''Extra Shortcuts'''

{| class="prettytable"
! Item
! Action
! Key

|-
| Entry
| Add
| '''''<nowiki>[Insert] / [Alt] + mnemonic of the 'Add' button</nowiki>'''''

|-
| Entry
| Remove
| '''''<nowiki>[Del] / [Alt] + mnemonic of the 'Remove' button</nowiki>'''''

|}
<nowiki>-------------------------------------------------------------------</nowiki>

Last modified by AAA BBB on 2008, Sep 09 at 15:47:01

[[Category:Accessibility]]

Accessibility Test GUI All

2009-11-23T00:24:03Z

Kirk:

'''Goal:'''

Guideline for StarOffice / OpenOffice.org GUI Testing - Speech / Braille output

{| class="prettytable"
| '''''GUI Elements / '''''Properties and actions
| '''''Sample Description'''''

|-
| '''''Frame:'''''
|

|-
| Window title
| Verify that AT-Tools reports the correct window titles at switching between several StarOffice application windows, e.g. "Switch to window, Untitled1 - StarOffice"

|-
| Open/Close Dialog
| Verify that AT-Tools respects a StarOffice dialog that is opened/closed, e.g. "Create window Open, Switch to window"

|-
| Open/Close Toolbox
| Verify that AT-Tools respects a StarOffice toolbox that is opened/closed, e.g. "Create window Navigator, Switch to window"

|-
| '''''Menu:'''''
|

|-
| Name, Role, shortcut/accelerator
| Verify that AT-Tools reports the name, role and number of items of menu, e.g. "View, menu, twenty-two items"

|-
| '''''Push button:'''''
|

|-
| Name, Role, shortcut/accelerator
| Verify that AT-Tools reports the name, role and shortcut of push button, e.g. "Help, push button, shortcut Alt+H"

|-
| '''''Toggle button:'''''
|

|-
| Name, Role, state
| Verify that AT-Tools reports the name, role and state of toggle button, e.g. "Bold, toggle button, unpressed"

|-
| State change
| Change the state from unpressed to pressed (or vice versa) and verify that AT-Tools reports the new state

|-
| '''''Radio button:'''''
|

|-
| label, current selection, role and state
| Verify that AT-Tools reports the label, current selection, role and state of radio button, e.g. "Quality Default, radio button, shortcut Alt+D, checked"

|-
| '''''Checkbox:'''''
|

|-
| label, current selection, role and state
| Verify that AT-Tools reports the name, role, shortcut and state of checkbox, e.g. "Read-only, checkbox, shortcut Alt+R, checked"

|-
| State change
| Change the state from checked to unchecked (or vice versa) and verify that AT-Tools reports the new state

|-
| '''''Textfield:'''''
|

|-
| Name, Role, Content
| Verify that AT-Tools reports the name, role and content of textfield, e.g. "Company, text, StarOffice"

|-
| Input
| Type text in the textfield and verify that AT-Tools reports every single character at cursor position

|-
| Deletion
| Delete text and verify that AT-Tools reports every single character at cursor position

|-
| Travel
| Move cursor in the text and verify that AT-Tools reports every single character at cursor position

|-
| '''''Spin button:'''''
|

|-
| Name, Role, Content
| Verify that AT-Tools reports the name, role and value of spin button, e.g. "number of steps, text, twenty"

|-
| Content change
| Change the value of the spin button and verify that AT-Tools reports the entire new value

|-
| Input
| Type a value in the textfield and verify that AT-Tools reports every single number at cursor position

|-
| Deletion
| Delete a number and verify that AT-Tools reports every single number at cursor position

|-
| Travel
| Move cursor in the value and verify that AT-Tools reports every single number at cursor position

|-
| '''''Drop down box:'''''
|

|-
| Name, Role
| Verify that AT-Tools reports name, role of visible item, e.g. "File type, list, Drawings"

|-
| Content change
| Select another item and check that AT-Tools reports the name and role of that item.

|-
| '''''Combo box:'''''
|

|-
| Name, Role
| Verify that AT-Tools reports reports name, role of visible item, e.g. "Font, list, Helvetica"

|-
| Content change
| Select another item and check that AT-Tools reports the name and role of that item.

|-
| Input
| Type text in the textfield and verify that AT-Tools reports every single character at cursor position

|-
| Deletion
| Delete text and verify that AT-Tools reports every single character at cursor position

|-
| Travel
| Move cursor in the text and verify that AT-Tools reports every single character at cursor position

|-
| '''''List box:'''''
|

|-
| Name, Role
| Verify that AT-Tools reports name, role of visible item, e.g. "Category, list, 11 items, Currency"

|-
| Content change
| Select another item of the list and check that AT-Tools reports the name and role of that item.

|-
| '''''Tab Page:'''''
|

|-
| Label and role
| Verify that AT-Tools reports the label and role of page tab, e.g. "Font, page tab"

|-
| '''''Tree list:'''''
|

|-
| Name, Role
| Verify that AT-Tools reports the current selected tree item with name and role e.g. "StarOffice, tree item"

|}

[[Category:Accessibility]]

API/UNO AWT

2009-11-23T00:21:09Z

Kirk:

{{DISPLAYTITLE:UNO AWT Toolkit}}

...

==UNO AWT Controls==
<DPL> category=API
category=UNO AWT</DPL>

[[Category:UNO AWT]]

API/UNO AWT

2009-11-23T00:18:44Z

Kirk:

{{DISPLAYTITLE:UNO AWT Toolkit}}

...

==UNO AWT Controls==
<DPL> category=API
category=UNO AWT</DPL>

{{category:API}}

Documentation/OOo3 User Guides/Calc Guide/Examples of functions

2009-10-06T05:47:35Z

Kirk:

{{DISPLAYTITLE:Examples of functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Finding and fixing errors
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using regular expressions in functions
}}
For novices, functions are one of the most intimidating features of OpenOffice.org's Calc. New users quickly learn that functions are an important feature of spreadsheets, but there are almost four hundred, and many require input that assume specialized knowledge. Fortunately, Calc includes dozens of functions that anyone can use.

== Basic arithmetic and statistic functions ==
The most basic functions create formulas for basic arithmetic or for evaluating numbers in a range of cells.

=== Basic arithmetic ===
The simple arithmetic operations are addition, subtraction, multiplication, and division.

Except for subtraction, each of these operations has a related function. You can use SUM for addition, PRODUCT for multiplication, and QUOTIENT for division. Traditionally, subtraction does not have a function.

SUM, PRODUCT and QUOTIENT are useful for entering ranges of cells in the same way as any other function, with arguments in brackets after the function name.

However, for basic equations, many users prefer the time-honored computer symbols for these operations, using the plus sign (+) for addition, the hyphen (–) for subtraction, the asterisk (*) for multiplication and the forward slash (/) for division. These symbols are quick to enter without requiring your hands to stray from the keyboard.

A similar choice is also available if you want to raise a number by the power of another. Instead of entering =POWER(A1;2), you can enter =A1^2.

Moreover, they have the advantage that you enter formulas with them in an order that more closely approximates human readable format than the spreadsheet-readable format used by the equivalent function. For instance, instead of entering =SUM (A1:A2), or possibly =SUM (A1;A2), you enter =A1+A2. This almost-human readable format is especially useful for compound operations, where writing <nowiki>=A1*(A2+A3) is briefer and easier to read than =PRODUCT(A1;SUM(A2:A3)).</nowiki>

The main disadvantage of using arithmetical operators is that you cannot directly use a range of cells. In other words, to enter the equivalent of =SUM (A1:A3), you would need to type =A1+A2+A3.

Otherwise, whether you use a function or an operator is largely up to you—except, of course, when you are subtracting. However, if you use spreadsheets regularly in a group setting such as a class or an office, you might want to standardize on an entry format so that everyone who handles a spreadsheet becomes accustomed to a standard input.

=== Simple statistics ===
Another common use for spreadsheet functions is to pull useful information out of a list, such as a series of test scores in a class, or a summary of earnings per quarter for a company.

You can, of course, scan a list of figures if you want basic information such as the highest or lowest entry or the average. The only trouble is, the longer the list, the more time you waste and the more likely you are to miss what you’re looking for. Instead, it is usually quicker and more efficient to enter a function. Such reasons explain the existence of a function like COUNT, which does no more than give the total number of entries in the designated cell range.

Similarly, to find the highest or lowest entry, you can use MIN or MAX. For each of these formulas, all arguments are either a range of cells, or a series of cells entered individually.

Each also has a related function, MINA or MAXA, which performs the same function, but treats a cell formatted for text as having a value of 0 (The same treatment of text occurs in any variation of another function that adds an "A" to the end). Either function gives the same result, and could be useful if you used a text notation to indicate, for example, if any student were absent when a test was written, and you wanted to check whether you needed to schedule a makeup exam.

For more flexibility in similar operations, you could use LARGE or SMALL, both of which add a specialized argument of rank. If the rank is 1 used with LARGE, you get the same result as you would with MAX. However, if the rank is 2, then the result is the second largest result. Similarly, a rank of 2 used with SMALL gives you the second smallest number. Both LARGE and SMALL are handy as a permanent control, since, by changing the rank argument, you can quickly scan multiple results.

You would need to be an expert to want to find the Poisson Distribution of a sample, or to find the skew or negative binominal of a distribution (and, if you are, you will find functions in Calc for such things). However, for the rest of us, there are simpler statistical functions that you can quickly learn to use.

In particular, if you need an average, you have a number to choose from. You can find the arithmetical means—that is, the result when you add all entries in a list then divided by the number of entries by enter a range of numbers when using AVERAGE, or AVERAGE A to include text entries and to give them a value of zero.

In addition, you can get several other forms of averages:

* '''MEDIAN:''' The entry that is exactly half way between the highest and lowest number in a list.
* '''MODE:''' The most common entry in a list of numbers.
* '''QUARTILE:'''The entry at a set position in the array of numbers. Besides the cell range, you enter the type of Quartile: O for the lowest entry, 1 for the value of 25%, 2 for the value of 50%, 3 for 75%, and 4 for the highest entry. Note that the result for types 1 through 3 may not represent an actual item entered.
* '''RANK:''' The position of a given entry in the entire list, measured either from top to bottom or bottom to top. You need to enter the cell address for the entry, the range of entries, and the type of rank ('''0''' for the rank from the highest, or '''1''' for the rank from the bottom.

Some of these functions overlap; for example, MIN and MAX are both covered by QUARTILE. In other cases, a custom sort or filter might give much the same result. Which you use depends on your temperament and your needs. Some might prefer to use MIN and MAX because they are easy to remember, while others might prefer QUARTILE because it is more versatile.

=== Using these functions ===
In some cases, you may be able to get similar results to some of these functions by setting up a filter or a custom sort. However, in general, functions are more easily adjusted than filters or sorts, and provide a wide range of possibilities.

At times, you may just want to enter one or more formulas temporarily in a convenient blank square, and delete it once you have satisfied your curiosity. However, if you find yourself using the same functions constantly, you should consider creating a template and including space for all the functions you use, with the cell to their left used as a label for them. Once you have created the template, you can easily update each formula as entries change, either automatically and on-the-fly or pressing the ''F9'' key to update all selected cells. The choice, really, is yours.

No matter how you use these functions, you will probably find them simple to use and adaptable to many purposes. And, by the time you have mastered this handful, you will be ready to try more complex functions.

== Rounding off numbers ==
For statistical and mathematical purposes, Calc includes a variety of ways to round off numbers. If you’re a programmer, you may also be familiar with some of these methods. However, you don’t need to be a specialist to find some of these methods useful. You may want to round off for billing purposes, or because decimal places don’t translate well into the physical world—for instance, if the parts you need come in packages of 100, then the fact you only need 66 is irrelevant to you; you need to round up for ordering. By learning the options for rounding, you can make your spreadsheets more immediately useful.

When you use a rounding function, you have two choices about how to set up your formulas. If you choose, you can nest a calculation within one of the rounding functions. For instance, the formula =ROUND((SUM(A1;A2)) adds the figures in cells A1 and A2, then rounds them off to the nearest whole number. But, even though you don’t need to work with exact figures every day, you may still want to refer to them occasionally. If that is the case, then you are probably better off separating the two functions, placing =SUM(A1;A2) in cell A3, and =ROUND (A3) in A4, and clearly labelling each function. Which choice you make for layout depends largely on your work habits.

=== Rounding methods ===
The most basic function for rounding numbers in Calc is ROUND. This function will round off a number according to the usual rules of symmetric arithmetic rounding: a decimal place of .4 or less gets rounded down, while one of .5 or more gets rounded up. However, at times, you may not want to follow these rules. For instance, if you are one of those contractors who bills a full hour for any fraction of an hour you work, you would want to always round up so you didn’t lose any money. Conversely, you might choose to round down to give a slight discount to a long-established customer. In these cases, you might prefer to use ROUNDUP or ROUNDDOWN, which, as their names suggest, round a number to the nearest integer above or below it.

All three of these functions require the single argument of number—the cell or number to be rounded. Used with only this argument, all three functions round to the nearest whole number, so that 46.5 would round to 47 with ROUND or ROUNDUP and 46 with ROUNDDOWN. However, if you use the optional count argument, you can specify the number of decimal places to include. For instance, if number was set to 1, then 48.65 would round to 48.7 with ROUND or ROUNDUP and to 48.6 with ROUNDDOWN.

As an alternative to ROUNDDOWN when working with decimals, you can use TRUNC (short for truncate). It takes exactly the same arguments as ROUNDDOWN, so which function you use is a matter of choice. If you aren't working with decimals, you might choose to use INT (short for integer), which takes only the number argument.

Another option is the ODD and EVEN pair of functions. ODD rounds up to the nearest odd number if what is entered in the number argument is a positive number, and rounds down if it is a negative number, while EVEN does the same for an even number.

Still another option are the CEILING and FLOOR functions. As you can guess from the names, CEILING rounds up and FLOOR rounds down. For both functions, the number that they round to is determined by the closest multiple of the number that you enter as the significance argument. For instance, if your business insurance is billed by the work week, the fact that you were only open three days one week would be irrelevant to your costs; you would still be charged for an entire week, and therefore might want to use CEILING in your monthly expenses. Conversely, if you are building customized computers and completed 4.5 in a day, your client would only be interested in the number ready to ship, so you might use FLOOR in a report of your progress.

Besides number and significance, both CEILING and FLOOR include an optional argument called mode, which takes a value of 0 or 1. If mode is set to 0, and both the number and the significance are negative numbers, then the result of either function is rounded up; if it is set to 1, and both the number and the significance are negative numbers, the the results are rounded down. In other words, if the number is -11 and the significance is -5, then the result is -10 when the mode is set to 0, but -15 when set to 1.

However, if you are exchanging spreadsheets between Calc and MS Excel, remember that the mode argument is not supported by Excel. If you want the answers to be consistent between the two spreadsheets, set the mode in Calc to -1.

A function somewhat similar to CEILING and FLOOR is MROUND. Like CEILING AND FLOOR, MROUND requires two arguments, although, somewhat confusingly, the second one is called multiple rather than significance, even though the two are identical. The difference between MROUND and CEILING and FLOOR is that MROUND rounds up or down using symmetric arithmetic rounding. For example, if the number is 77 and the multiple is 5, then MROUND gives a result of 75. However, if the multiple is changed to 7, then MROUND's result becomes 77.

Once you tease the various rounding functions out of Calc’s long, undifferentiated list of functions, you can start to decide which is most useful for your purposes.

However, one last point is worth mentioning: If you are working with more than two decimal places, don't be surprised if you don’t see the same number of decimal places on the spreadsheet as you do on the function wizard. If you don’t, the reason is that '''Tools > Options > OpenOffice.org Calc > Calculate > Decimal Places''' defaults to 2. Change the number of decimal places, and, if necessary, uncheck the '''Precision as shown''' box on the same page, and the spreadsheet will display as expected.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-29T03:44:55Z

Kirk: /* Operators in formulas */ Cleanup editing

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
By convention, only three kinds of data can be entered in a cell. Text, Numbers, and Formulas. You can enter formulas in two ways, either in the cell itself, or at the input line. Either way you will need to start it with one of the following symbols: "=", "+" or "-". Starting with anything else will cause the formula to be treated as if it were text.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Entering data is accomplished simply by typing in the cell and moving to the next cell or pressing Enter. With formulas the equals sign indicates that the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5e.png]]

|-
|
| [[Image:CG3Ch3F5d.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Note that the formula was shown as =B3 + B4. The plus sign indicates that the contents of cells B3 and B4 are to be added together and then have the result in the cell holding the formula. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These cell references allow formulas to use data from anywhere in the worksheet being worked on or from any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or <nowiki>#</nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
In its simplest form a reference refers to a single cell. But references can also refer to a rectangle or cuboid range or a reference is a list of references. To build such references you need reference operators.

An individual cell is identified by the column identifier (characters) located along the upper edge of the spreadsheet and a row identifier (number) found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''A single cell reference'']]

====Range operator====

The range operator is written as colon. An expression using the range operator has the syntax

reference left ''':''' reference right

The range operator builds a reference to the smallest range including both the cells referenced with the left reference and the cells referenced with the right reference.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference to a rectangle range.'']]

''The picture should be exchanged with one using the new transparent highlighting for selections. ''[[User:Regina|Regina]] 18:33, 19 September 2009 (UTC)

In the upper left corner of the figure above, the reference A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range.

''The following is about selecting and naming cells and should be moved somewhere else or be dropped.''[[User:Regina|Regina]] 18:33, 19 September 2009 (UTC)

[start to move or drop]
This same range could also be created <--wrong term! by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator <--wrong term! can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

[end to move or drop]

Examples

{|
|-
|style="width:14em"|A2:B4
|Reference to a rectangle range with 6 cells, 2 column width × 3 row height. When you click on the reference in the formula in the input line, a border indicates the rectangle.
|-
|(A2:B4):C9
|Reference to a rectangle range with cell A2 top left and cell C9 bottom right. So the range contains 24 cells, 3 column width × 8 row height.
|-
|Sheet1.A3:Sheet3.D4
|Reference to a cuboid range with 24 cells, 4 column width × 2 row height × 3 sheets depth.
|}

When you enter B4:A2 or A4:B2 directly, then OOo will turn it to A2:B4. So the left top cell of the range is left of the colon and the bottom right cell is right of the colon. But if you name the cell B4 for example with '_start' and A2 with '_end', you can use _start:_end without any error.

OOo can not reference a whole column of unspecified length via A:A or a whole row via 1:1 yet as you might know from other spreadsheet programs, see {{bug|20495}}.

====Reference Concatenation Operator====

The concatenation operator is written as tilde. An expression using the concatenation operator has the syntax

reference left '''~''' reference right

The result of such an expression is a reference list, which is an ordered list of references. Some functions can take a reference list as argument, SUM, MAX or INDEX for example.

The reference concatenation is sometimes called 'union'. But it is no set union. COUNT(A1:C3~B2:D2) returns 12 (=9+3), whereas looking at it as set of cells, it has only 10 cells.

Notice that SUM(A1:C3;B2:D2) is different from SUM( A1:C3~B2:D2) although they give the same result. The first is a function call with 2 parameters, each of them is reference to a range. The second is a function call with 1 parameter, which is a reference list.

====Intersection Operator====

The intersection operator is written as exclamation mark. An expression using the intersection operator has the syntax

reference left ! reference right

If the references refer to single ranges, the result is a reference to a single range, containing all cells, which are both in the left reference and in the right reference.

If the references are reference lists, than each list item from the left is intersected with each one from the right and these results are concatenated to a reference list. The order is, to first intersect the first item from the left with all items from the right, then intersect the second item from the left with all items from the right, and so on.

Examples

{|
|-
|style="width:20em"|A2:B4 ! B3:D6
|This results a reference to the range B3:B4, because these cells are inside A2:B4 and inside B3:D4.
|-
|(A2:B4~B1:C2) ! (B2:C6~C1:D3)
|First the intersections A2:B4!B2:C6, A2:B4!C1:D3, B1:C2!B2:C6 and B1:C2!C1:D3 are calculated. This results in B2:B4, empty, B2:C2, and C1:C2. Then these results are concatenated, dropping empty parts. So the final result is the reference list B2:B4 ~ B2:C2 ~ C1:C2.
|}

You can use the intersection operator to refer a cell in a cross tabulation in an good understandable way. If you have columns labeled 'Temperature' and 'Precipitation' and the rows labeled 'January', 'February', 'March',… then the expression

'February' ! !Temperature'

will reference to the cell containing the temperature in February.

The intersection operator ! should have a higher precedence than the concatenation operator ~, but in OOo3.1 it is wrong implemented. Therefore you should not rely on precedence, but always put the part which to be first calculated in parentheses.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluates the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Talk:Documentation/OOo3 User Guides/Calc Guide/Using functions

2009-09-18T05:53:56Z

Kirk: (checkpoint save)

+ and * are not functions but operators. The umbrella term for 2+3 and sin(0.3) and PRODUCT(3;SUM(4;5)) is 'expression'.

SUM and + are not the same, and PRODUCT and * are not the same too. You see the difference, when you use ranges as parameter, or when you use them with empty cells or with cells, which contain text.

The terms 'function' and 'formula' are sometimes not clear, sometimes false. For example:
*"Like most functions, this one starts with an equal sign."

: Formulas start with an equal sign but functions never start with an equal sign, but simple start with their function name. (To please Excel users, entering formulas can also start with a + or a - sign and the equal sign will be added automatically.) Formulas are identified by starting with an equal sign. Formulas have the syntax =expression

*"Strictly speaking, when all the arguments are entered and a function is ready to run, it becomes a formula."
: Something like =7 is a formula although it doesn't contain any function. Functions are part of a formula, but the function alone is not a formula and will not become a formula.

*"because a formula can use functions as an argument."
: The term 'argument' is inapplicable to 'formula', but is a mathematical term in connection with functions.

"separated by semicolons, with no space between the arguments and the semicolons." That is wrong, you can use spaces if you want. White space is ignored.

"A formula, however, is limited by the fact that it can only do one function at a time." I do not understand that. What do you mean with "do one function at a time"?

Your description of nesting does not fit to the example
=IF(A1<>0; A1*SIN(1/A1); 0).

[[User:Regina|Regina]] 22:32, 26 May 2009 (UTC)

The above issues have been dealt with, though there is still a bit of final editing to be done. --[[User:Kirk|Kirk]] 05:53, 18 September 2009 (UTC)

Documentation/OOo3 User Guides/Calc Guide/Using functions

2009-09-18T05:50:47Z

Kirk: /* Advanced structure */

{{DISPLAYTITLE:Understanding functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Creating formulas
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Finding and fixing errors
}}
Calc includes over 350 functions to help you analyze and reference data. Many of these functions are for use with numbers, but many others are used with dates and times, or even text. A function may be as simple as adding two numbers together, or finding the average of a list of numbers. Alternatively, it may be as complex as calculating the standard deviation of a sample, or a hyperbolic tangent of a number. See a list of all functions in '''[[Documentation/How_Tos/Calc: Functions listed by category|functions listed by category]]'''.

Typically, the name of a function is an abbreviated description of what the function does. For instance, the FV function gives the future value of an investment, while BIN2HEX converts a binary number to a hexadecimal number. By tradition, functions are entered entirely in upper case letters, although Calc will read them correctly if they are in lower or mixed case, too.

A few basic functions are somewhat similar to operators. Examples:
:"+", this operator will add two numbers together for a result. SUM() on the other hand will add a contiguous '''''range''''' of numbers together.
:"*", this operator will multiply to numbers together for a result. PRODUCT() does the same for multiplying, that SUM() does for adding.

Each function has a number of ''arguments'' used in the calculations. These arguments may or may not have their own name. Your task is to enter the arguments needed to run the function. In some cases, the arguments have pre-defined choices, and you may need to refer to the online help or Appendix B (Description of Functions) in this book to understand them. More often, however, an argument is a value that you enter manually, or one already entered in a cell or range of cells on the spreadsheet. In Calc, you can enter values from other cells by typing in their name or range, or by selecting cells with the mouse. Should the values in the cells change, the result of the function will be automatically updated.

For compatibility, functions and their arguments in Calc have almost identical names to their counterparts in Microsoft Excel. However, both Excel and Calc have functions that the other lacks. Occasionally, too, functions with the same names in Calc and Excel have different arguments, or slightly different names for the same argument—neither of which can be imported to the other. However, perhaps nine-tenths of functions can be imported between Calc and Excel without any problems.

== Understanding the structure of functions ==
All functions have a similar structure. If you use the right tool for entering a function, you can escape learning this structure, but it is still worth knowing for troubleshooting.

To give a typical example, the structure of a function to find cells that match entered search criteria is:

<nowiki>= DCOUNT (Database;Database field;Search_criteria)</nowiki>

Since a function cannot exist on its' own, it must always be part of a formula. Consequently, even if the function represents the entire formula, there must be an "=" sign at the start of the formula. Regardless of where in the formula a function is, the Function will start with the function's name, DCOUNT in the example above. After the name of the function comes its arguments. All arguments are required, unless specifically listed as optional.

Arguments are added within the brackets (parentheses) and separated by semicolons. Many arguments will be a number. A Calc function can take up to thirty numbers as an argument. That may not sound like much at first. However, when you realize that the number can be not only a number or a single cell, but also an array or range of cells that contain several or even hundreds of cells, then the apparent limitation vanishes.

Depending on the nature of the function arguments may be entered as follow:

:{|Border="1"
|"text data"||The quotes establish that text or string data has been entered
|-
|9||In this case the number nine has been entered as a number
|-
|"9"||In this case the number nine is being entered as text
|-
|A1|| The address for whatever is in Cell A1 is being entered
|}

== Nested functions ==

Functions can also be used as arguments within other functions.

<nowiki>=SUM(2;PRODUCT(5;7))</nowiki>

To get an idea of what nested functions can do, imagine that you are designing a self-directed learning module. During the module, students do three quizzes, and enter the results in cells A1, A2, and A3. In A4, you can create a nested formula that begins by averaging the results of the quizzes with the formula <nowiki>=AVERAGE(A1:A3)</nowiki>. The formula then uses the IF function to give the student feedback that depends upon the average grade on the quizzes. The entire formula would read:

<nowiki>=IF(AVERAGE(A1:A3) >85; "Congratulations! You are ready to advance to the next module";
"Failed. Please review the material again. If necessary, contact your instructor for help")</nowiki>

Depending on the average, the student would receive the message for either congratulations or failure.

If you are new to spreadsheets, the best way to think of functions is as a scripting language. We've used simple examples to explain more clearly, but, through nesting of functions, a Calc formula can quickly become complex.

'''New in 3.1''' 
Calc now keeps the syntax of a formula displayed in a tooltip next to the cell as a handy memory aid as you type.

A more reliable method is to use the ''Function List''. Available from the '''Insert''' menu, the Function List automatically docks as a pane on the right side of the Calc editing window. If you wish, you can ''Control+double-click'' on a blank space at the top of the pane to undock this pane and make it a floating window.

The Function List includes a brief description of each function and its arguments; highlight the function and look at the bottom of the pane to see the description. If necessary, hover the cursor over the division between the list and the description; when the cursor becomes a two-headed arrow, drag it upwards to increase the space for the description. Double-click on a function’s name to add it to the current cell, together with placeholders for each of the function’s arguments.

Using the Function List is almost as fast as manual entry, and has the advantage of not requiring that you memorize a formula that you want to use. In theory, it should also be less error-prone. In practice, though, some users may fumble when replacing the placeholders with values. Another handy feature is the ability to display the last formulas used.

[[Image:CG3Ch3F1.png|thumb|none|500px|''Function List docked to right side of Calc window.'']]

The most commonly used input method is the ''Function Wizard''. To open the Function Wizard, select '''Insert > Function''', or click its button on the Function tool bar, or press ''Ctrl+F2''. Once open, the Function Wizard provides the same help features as the Function List, but adds fields in which you can see the result of a completed function, as well as the result of any larger formula of which it is part.

[[Image:CG3Ch3F2.png|thumb|none|500px|''Functions page of Function Wizard.'']]

You can also select the ''Structure'' tab to see a tree view of the parts of the formula. The main advantage over the Function List is that each argument is entered in its own field, making it easier to manage. The price of this reliability is slower input, but this is often a small price to pay, since precision is generally more important than speed when creating a spreadsheet.

[[Image:CG3Ch3F3.png|thumb|none|500px|''Structure page of Function Wizard.'']]

Another advantage of the Function Wizard is that you can reduce the window as you are adding each argument. At the end of each input field for an argument is the Shrink button [[Image:CalcShrinkIcon.png]]. The Shrink button temporarily removes all parts of the wizard except the current input field so that you can see the spreadsheet beneath. When you are finished entering the argument’s value, click the button again to return to the entire Function Wizard.

[[Image:CG3Ch3F4.png|thumb|none|500px|''Function Wizard after shrinking.'']]

Finally, as with many other features in OpenOffice.org, you can create a macro for any favorite function formula, and assign it to a tool bar, menu, or keystroke combination.

No matter how you enter a formula, take a moment to check its structure before using it. If it looks right, press the ''Enter'' key or select the '''Accept''' button from the Function toolbar to add it to the cell and get its result (the Accept button is the green check mark beside the Input line).

If you see the formula in the cell instead of the result, then Formulas are selected for display in '''Tools > Options > OpenOffice.org Calc > View > Display'''. Unselect the checkbox beside it, and the result will display. However, you can still see the formula in the formula bar field.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Using functions

2009-09-18T05:36:27Z

Kirk: /* Advanced structure */

{{DISPLAYTITLE:Understanding functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Creating formulas
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Finding and fixing errors
}}
Calc includes over 350 functions to help you analyze and reference data. Many of these functions are for use with numbers, but many others are used with dates and times, or even text. A function may be as simple as adding two numbers together, or finding the average of a list of numbers. Alternatively, it may be as complex as calculating the standard deviation of a sample, or a hyperbolic tangent of a number. See a list of all functions in '''[[Documentation/How_Tos/Calc: Functions listed by category|functions listed by category]]'''.

Typically, the name of a function is an abbreviated description of what the function does. For instance, the FV function gives the future value of an investment, while BIN2HEX converts a binary number to a hexadecimal number. By tradition, functions are entered entirely in upper case letters, although Calc will read them correctly if they are in lower or mixed case, too.

A few basic functions are somewhat similar to operators. Examples:
:"+", this operator will add two numbers together for a result. SUM() on the other hand will add a contiguous '''''range''''' of numbers together.
:"*", this operator will multiply to numbers together for a result. PRODUCT() does the same for multiplying, that SUM() does for adding.

Each function has a number of ''arguments'' used in the calculations. These arguments may or may not have their own name. Your task is to enter the arguments needed to run the function. In some cases, the arguments have pre-defined choices, and you may need to refer to the online help or Appendix B (Description of Functions) in this book to understand them. More often, however, an argument is a value that you enter manually, or one already entered in a cell or range of cells on the spreadsheet. In Calc, you can enter values from other cells by typing in their name or range, or by selecting cells with the mouse. Should the values in the cells change, the result of the function will be automatically updated.

For compatibility, functions and their arguments in Calc have almost identical names to their counterparts in Microsoft Excel. However, both Excel and Calc have functions that the other lacks. Occasionally, too, functions with the same names in Calc and Excel have different arguments, or slightly different names for the same argument—neither of which can be imported to the other. However, perhaps nine-tenths of functions can be imported between Calc and Excel without any problems.

== Understanding the structure of functions ==
All functions have a similar structure. If you use the right tool for entering a function, you can escape learning this structure, but it is still worth knowing for troubleshooting.

To give a typical example, the structure of a function to find cells that match entered search criteria is:

<nowiki>= DCOUNT (Database;Database field;Search_criteria)</nowiki>

Since a function cannot exist on its' own, it must always be part of a formula. Consequently, even if the function represents the entire formula, there must be an "=" sign at the start of the formula. Regardless of where in the formula a function is, the Function will start with the function's name, DCOUNT in the example above. After the name of the function comes its arguments. All arguments are required, unless specifically listed as optional.

Arguments are added within the brackets (parentheses) and separated by semicolons. Many arguments will be a number. A Calc function can take up to thirty numbers as an argument. That may not sound like much at first. However, when you realize that the number can be not only a number or a single cell, but also an array or range of cells that contain several or even hundreds of cells, then the apparent limitation vanishes.

Depending on the nature of the function arguments may be entered as follow:

:{|Border="1"
|"text data"||The quotes establish that text or string data has been entered
|-
|9||In this case the number nine has been entered as a number
|-
|"9"||In this case the number nine is being entered as text
|-
|A1|| The address for whatever is in Cell A1 is being entered
|}

== Advanced structure ==
A formula, is limited by the fact that it can only do one function at a time. You need to make sure that functions are done in the right order if the formula is going to work.

To help set the order for functions in a multiple-function formula, you use parentheses within parentheses. When the formula is run, Calc does the innermost function first, then works outwards. For example, in the simple calculation <nowiki>=2+(5*7)</nowiki>, Calc multiples 5 by 7 first. Only then is 2 added to the result to get 37.

The placement of functions within sets of parentheses is called ''nesting''. Basically, nesting reduces a function that could run on its own to an argument in the formula. For example, in =2+(5*7), the formula (5*7) is nested within the larger formula of =2+(5*7). In other words, the nested function becomes an argument of another function.

This relation is more obvious when doing a calculation using a function with a name. For all purposes,

<nowiki>=SUM(2;PRODUCT(5;7))</nowiki>

is the same formula as <nowiki>=2+(5*7)</nowiki>. However, when SUM and PRODUCT are used, then the relation is clearer. The fact that the PRODUCT function comes after a semicolon and in a set of parentheses for the SUM function makes it clear that PRODUCT is an argument for SUM. In addition, the fact that the inner pair of parentheses is around (5;7) makes clear that this operation is done before the one defined by the outer pair of parentheses.

To get an idea of what nested functions can do, imagine that you are designing a self-directed learning module. During the module, students do three quizzes, and enter the results in cells A1, A2, and A3. In A4, you can create a nested formula that begins by averaging the results of the quizzes with the formula <nowiki>=AVERAGE(A1:A3)</nowiki>. The formula then uses the IF function to give the student feedback that depends upon the average grade on the quizzes. The entire formula would read:

<nowiki>=IF(AVERAGE(A1:A3) >85; "Congratulations! You are ready to advance to the next module";
"Failed. Please review the material again. If necessary, contact your instructor for help")</nowiki>

Depending on the average, the student would receive the message for either congratulations or failure.

Notice that the nested formula for the average does not require its own equal sign. The one at the start of the equation is enough for both formulas.

If you are new to spreadsheets, the best way to think of functions is as a scripting language. We've used simple examples to explain more clearly, but, through nesting of functions, a Calc formula can quickly become complex.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

'''New in 3.1''' 
Calc now keeps the syntax of a formula displayed in a tooltip next to the cell as a handy memory aid as you type.

A more reliable method is to use the ''Function List''. Available from the '''Insert''' menu, the Function List automatically docks as a pane on the right side of the Calc editing window. If you wish, you can ''Control+double-click'' on a blank space at the top of the pane to undock this pane and make it a floating window.

The Function List includes a brief description of each function and its arguments; highlight the function and look at the bottom of the pane to see the description. If necessary, hover the cursor over the division between the list and the description; when the cursor becomes a two-headed arrow, drag it upwards to increase the space for the description. Double-click on a function’s name to add it to the current cell, together with placeholders for each of the function’s arguments.

Using the Function List is almost as fast as manual entry, and has the advantage of not requiring that you memorize a formula that you want to use. In theory, it should also be less error-prone. In practice, though, some users may fumble when replacing the placeholders with values. Another handy feature is the ability to display the last formulas used.

[[Image:CG3Ch3F1.png|thumb|none|500px|''Function List docked to right side of Calc window.'']]

The most commonly used input method is the ''Function Wizard''. To open the Function Wizard, select '''Insert > Function''', or click its button on the Function tool bar, or press ''Ctrl+F2''. Once open, the Function Wizard provides the same help features as the Function List, but adds fields in which you can see the result of a completed function, as well as the result of any larger formula of which it is part.

[[Image:CG3Ch3F2.png|thumb|none|500px|''Functions page of Function Wizard.'']]

You can also select the ''Structure'' tab to see a tree view of the parts of the formula. The main advantage over the Function List is that each argument is entered in its own field, making it easier to manage. The price of this reliability is slower input, but this is often a small price to pay, since precision is generally more important than speed when creating a spreadsheet.

[[Image:CG3Ch3F3.png|thumb|none|500px|''Structure page of Function Wizard.'']]

Another advantage of the Function Wizard is that you can reduce the window as you are adding each argument. At the end of each input field for an argument is the Shrink button [[Image:CalcShrinkIcon.png]]. The Shrink button temporarily removes all parts of the wizard except the current input field so that you can see the spreadsheet beneath. When you are finished entering the argument’s value, click the button again to return to the entire Function Wizard.

[[Image:CG3Ch3F4.png|thumb|none|500px|''Function Wizard after shrinking.'']]

Finally, as with many other features in OpenOffice.org, you can create a macro for any favorite function formula, and assign it to a tool bar, menu, or keystroke combination.

No matter how you enter a formula, take a moment to check its structure before using it. If it looks right, press the ''Enter'' key or select the '''Accept''' button from the Function toolbar to add it to the cell and get its result (the Accept button is the green check mark beside the Input line).

If you see the formula in the cell instead of the result, then Formulas are selected for display in '''Tools > Options > OpenOffice.org Calc > View > Display'''. Unselect the checkbox beside it, and the result will display. However, you can still see the formula in the formula bar field.

Documentation/OOo3 User Guides/Calc Guide/Using functions

2009-09-18T05:34:17Z

Kirk: /* Understanding the structure of functions */

{{DISPLAYTITLE:Understanding functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Creating formulas
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Finding and fixing errors
}}
Calc includes over 350 functions to help you analyze and reference data. Many of these functions are for use with numbers, but many others are used with dates and times, or even text. A function may be as simple as adding two numbers together, or finding the average of a list of numbers. Alternatively, it may be as complex as calculating the standard deviation of a sample, or a hyperbolic tangent of a number. See a list of all functions in '''[[Documentation/How_Tos/Calc: Functions listed by category|functions listed by category]]'''.

Typically, the name of a function is an abbreviated description of what the function does. For instance, the FV function gives the future value of an investment, while BIN2HEX converts a binary number to a hexadecimal number. By tradition, functions are entered entirely in upper case letters, although Calc will read them correctly if they are in lower or mixed case, too.

A few basic functions are somewhat similar to operators. Examples:
:"+", this operator will add two numbers together for a result. SUM() on the other hand will add a contiguous '''''range''''' of numbers together.
:"*", this operator will multiply to numbers together for a result. PRODUCT() does the same for multiplying, that SUM() does for adding.

Each function has a number of ''arguments'' used in the calculations. These arguments may or may not have their own name. Your task is to enter the arguments needed to run the function. In some cases, the arguments have pre-defined choices, and you may need to refer to the online help or Appendix B (Description of Functions) in this book to understand them. More often, however, an argument is a value that you enter manually, or one already entered in a cell or range of cells on the spreadsheet. In Calc, you can enter values from other cells by typing in their name or range, or by selecting cells with the mouse. Should the values in the cells change, the result of the function will be automatically updated.

For compatibility, functions and their arguments in Calc have almost identical names to their counterparts in Microsoft Excel. However, both Excel and Calc have functions that the other lacks. Occasionally, too, functions with the same names in Calc and Excel have different arguments, or slightly different names for the same argument—neither of which can be imported to the other. However, perhaps nine-tenths of functions can be imported between Calc and Excel without any problems.

== Understanding the structure of functions ==
All functions have a similar structure. If you use the right tool for entering a function, you can escape learning this structure, but it is still worth knowing for troubleshooting.

To give a typical example, the structure of a function to find cells that match entered search criteria is:

<nowiki>= DCOUNT (Database;Database field;Search_criteria)</nowiki>

Since a function cannot exist on its' own, it must always be part of a formula. Consequently, even if the function represents the entire formula, there must be an "=" sign at the start of the formula. Regardless of where in the formula a function is, the Function will start with the function's name, DCOUNT in the example above. After the name of the function comes its arguments. All arguments are required, unless specifically listed as optional.

Arguments are added within the brackets (parentheses) and separated by semicolons. Many arguments will be a number. A Calc function can take up to thirty numbers as an argument. That may not sound like much at first. However, when you realize that the number can be not only a number or a single cell, but also an array or range of cells that contain several or even hundreds of cells, then the apparent limitation vanishes.

Depending on the nature of the function arguments may be entered as follow:

:{|Border="1"
|"text data"||The quotes establish that text or string data has been entered
|-
|9||In this case the number nine has been entered as a number
|-
|"9"||In this case the number nine is being entered as text
|-
|A1|| The address for whatever is in Cell A1 is being entered
|}

== Advanced structure ==
As well as being used on its own, a function can be an argument in a larger formula. A formula, however, is limited by the fact that it can only do one function at a time. You need to make sure that functions are done in the right order if the formula is going to work.

To help set the order for functions in a multiple-function formula, you use parentheses within parentheses. When the formula is run, Calc does the innermost function first, then works outwards. For example, in the simple calculation <nowiki>=2+(5*7)</nowiki>, Calc multiples 5 by 7 first. Only then is 2 added to the result to get 37.

The placement of functions within sets of parentheses is called ''nesting''. Basically, nesting reduces a function that could run on its own to an argument in the formula. For example, in =2+(5*7), the formula (5*7) is nested within the larger formula of =2+(5*7). In other words, the nested function becomes an argument of another function.

This relation is more obvious when doing a calculation using a function with a name. For all purposes,

<nowiki>=SUM(2;PRODUCT(5;7))</nowiki>

is the same formula as <nowiki>=2+(5*7)</nowiki>. However, when SUM and PRODUCT are used, then the relation is clearer. The fact that the PRODUCT function comes after a semicolon and in a set of parentheses for the SUM function makes it clear that PRODUCT is an argument for SUM. In addition, the fact that the inner pair of parentheses is around (5;7) makes clear that this operation is done before the one defined by the outer pair of parentheses.

To get an idea of what nested functions can do, imagine that you are designing a self-directed learning module. During the module, students do three quizzes, and enter the results in cells A1, A2, and A3. In A4, you can create a nested formula that begins by averaging the results of the quizzes with the formula <nowiki>=AVERAGE(A1:A3)</nowiki>. The formula then uses the IF function to give the student feedback that depends upon the average grade on the quizzes. The entire formula would read:

<nowiki>=IF(AVERAGE(A1:A3) >85; "Congratulations! You are ready to advance to the next module";
"Failed. Please review the material again. If necessary, contact your instructor for help")</nowiki>

Depending on the average, the student would receive the message for either congratulations or failure.

Notice that the nested formula for the average does not require its own equal sign. The one at the start of the equation is enough for both formulas.

If you are new to spreadsheets, the best way to think of functions is as a scripting language. We've used simple examples to explain more clearly, but, through nesting of functions, a Calc formula can quickly become complex.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

'''New in 3.1''' 
Calc now keeps the syntax of a formula displayed in a tooltip next to the cell as a handy memory aid as you type.

A more reliable method is to use the ''Function List''. Available from the '''Insert''' menu, the Function List automatically docks as a pane on the right side of the Calc editing window. If you wish, you can ''Control+double-click'' on a blank space at the top of the pane to undock this pane and make it a floating window.

The Function List includes a brief description of each function and its arguments; highlight the function and look at the bottom of the pane to see the description. If necessary, hover the cursor over the division between the list and the description; when the cursor becomes a two-headed arrow, drag it upwards to increase the space for the description. Double-click on a function’s name to add it to the current cell, together with placeholders for each of the function’s arguments.

Using the Function List is almost as fast as manual entry, and has the advantage of not requiring that you memorize a formula that you want to use. In theory, it should also be less error-prone. In practice, though, some users may fumble when replacing the placeholders with values. Another handy feature is the ability to display the last formulas used.

[[Image:CG3Ch3F1.png|thumb|none|500px|''Function List docked to right side of Calc window.'']]

The most commonly used input method is the ''Function Wizard''. To open the Function Wizard, select '''Insert > Function''', or click its button on the Function tool bar, or press ''Ctrl+F2''. Once open, the Function Wizard provides the same help features as the Function List, but adds fields in which you can see the result of a completed function, as well as the result of any larger formula of which it is part.

[[Image:CG3Ch3F2.png|thumb|none|500px|''Functions page of Function Wizard.'']]

You can also select the ''Structure'' tab to see a tree view of the parts of the formula. The main advantage over the Function List is that each argument is entered in its own field, making it easier to manage. The price of this reliability is slower input, but this is often a small price to pay, since precision is generally more important than speed when creating a spreadsheet.

[[Image:CG3Ch3F3.png|thumb|none|500px|''Structure page of Function Wizard.'']]

Another advantage of the Function Wizard is that you can reduce the window as you are adding each argument. At the end of each input field for an argument is the Shrink button [[Image:CalcShrinkIcon.png]]. The Shrink button temporarily removes all parts of the wizard except the current input field so that you can see the spreadsheet beneath. When you are finished entering the argument’s value, click the button again to return to the entire Function Wizard.

[[Image:CG3Ch3F4.png|thumb|none|500px|''Function Wizard after shrinking.'']]

Finally, as with many other features in OpenOffice.org, you can create a macro for any favorite function formula, and assign it to a tool bar, menu, or keystroke combination.

No matter how you enter a formula, take a moment to check its structure before using it. If it looks right, press the ''Enter'' key or select the '''Accept''' button from the Function toolbar to add it to the cell and get its result (the Accept button is the green check mark beside the Input line).

If you see the formula in the cell instead of the result, then Formulas are selected for display in '''Tools > Options > OpenOffice.org Calc > View > Display'''. Unselect the checkbox beside it, and the result will display. However, you can still see the formula in the formula bar field.

Talk:Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-18T05:28:57Z

Kirk:

Delete the chapter " Break formulas into parts and combine the parts"! The formula editor (Insert > Object > Formula) is for typesetting formulas in texts and is very different from calculating formulas.

[[User:Regina|Regina]] 00:04, 27 May 2009 (UTC)

Indeed they are different and the bit on Math should not have been there. But I think the idea is correct: several cells can each hold part of a formula, with another cell combining the results from those cells into another calculation.

[[User:jeanweber|Jean]] 14 Sept 2009

I think the structure of the chapters is not good. If the user does not know anything, he first needs to learn how to use simple expressions, using functions are the second step.

Using expressions should cover entering an expression, distinguish the shown expression result and the formula itself, using cell references, absolute and relative addressing, drag-fill, series, using labels and names and distinguish the use of them, access to external data, remarks on accuracy, precision and binary-format.

The next chapter can be about functions. The description has to cover simple functions like SUM, the real array functions, forcing expressions to array mode, the group of the Database functions and SUBTOTAL, calculating with date and time, functions with conditions like COUNTIF and the group of LOOKUP-functions, working with texts, creating named expressions and BASIC functions. (Not necessary in that order.)

[[User:Regina|Regina]] 22:54, 2 June 2009 (UTC)

Just completed an initial cleanup of this page, and have eliminated the more obvious errors and problems. I will probably do a more complete going next after I done an initial cleanup of the other sections. In the meantime feel free to spot and/or cleanup anything that I've missed, while I work on the other pages in this chapter. --[[User:Kirk|Kirk]] 05:28, 18 September 2009 (UTC)

Documentation/OOo3 User Guides/Calc Guide/Using functions

2009-09-18T05:21:40Z

Kirk: /* Understanding the structure of functions */

{{DISPLAYTITLE:Understanding functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Creating formulas
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Finding and fixing errors
}}
Calc includes over 350 functions to help you analyze and reference data. Many of these functions are for use with numbers, but many others are used with dates and times, or even text. A function may be as simple as adding two numbers together, or finding the average of a list of numbers. Alternatively, it may be as complex as calculating the standard deviation of a sample, or a hyperbolic tangent of a number. See a list of all functions in '''[[Documentation/How_Tos/Calc: Functions listed by category|functions listed by category]]'''.

Typically, the name of a function is an abbreviated description of what the function does. For instance, the FV function gives the future value of an investment, while BIN2HEX converts a binary number to a hexadecimal number. By tradition, functions are entered entirely in upper case letters, although Calc will read them correctly if they are in lower or mixed case, too.

A few basic functions are somewhat similar to operators. Examples:
:"+", this operator will add two numbers together for a result. SUM() on the other hand will add a contiguous '''''range''''' of numbers together.
:"*", this operator will multiply to numbers together for a result. PRODUCT() does the same for multiplying, that SUM() does for adding.

Each function has a number of ''arguments'' used in the calculations. These arguments may or may not have their own name. Your task is to enter the arguments needed to run the function. In some cases, the arguments have pre-defined choices, and you may need to refer to the online help or Appendix B (Description of Functions) in this book to understand them. More often, however, an argument is a value that you enter manually, or one already entered in a cell or range of cells on the spreadsheet. In Calc, you can enter values from other cells by typing in their name or range, or by selecting cells with the mouse. Should the values in the cells change, the result of the function will be automatically updated.

For compatibility, functions and their arguments in Calc have almost identical names to their counterparts in Microsoft Excel. However, both Excel and Calc have functions that the other lacks. Occasionally, too, functions with the same names in Calc and Excel have different arguments, or slightly different names for the same argument—neither of which can be imported to the other. However, perhaps nine-tenths of functions can be imported between Calc and Excel without any problems.

== Understanding the structure of functions ==
All functions have a similar structure. If you use the right tool for entering a function, you can escape learning this structure, but it is still worth knowing for troubleshooting.

To give a typical example, the structure of a function to find cells that match entered search criteria is:

<nowiki>= DCOUNT (Database;Database field;Search_criteria)</nowiki>

Since a function cannot exist on its' own, it must always be part of a formula. Consequently, even if the function represents the entire formula, there must be an "=" sign at the start of the formula. Regardless of where in the formula a function is, the Function will start with the function's name, DCOUNT in the example above. After the name of the function comes its arguments. All arguments are required, unless specifically listed as optional.

Arguments are added within the brackets (parentheses) and separated by semicolons, with no space between the arguments and the semicolons. Many arguments will be a number. A Calc function can take up to thirty numbers as an argument. That may not sound like much at first. However, when you realize that the number can be not only a number or a single cell, but also an array or range of cells that contain several or even hundreds of cells, then the apparent limitation vanishes.

Depending on the nature of the function arguments may be entered as follow:

:{|Border="1"
|"text data"||The quotes establish that text or string data has been entered
|-
|9||In this case the number nine has been entered as a number
|-
|"9"||In this case the number nine is being entered as text
|-
|A1|| The address for whatever is in Cell A1 is being entered
|}

== Advanced structure ==
As well as being used on its own, a function can be an argument in a larger formula. A formula, however, is limited by the fact that it can only do one function at a time. You need to make sure that functions are done in the right order if the formula is going to work.

To help set the order for functions in a multiple-function formula, you use parentheses within parentheses. When the formula is run, Calc does the innermost function first, then works outwards. For example, in the simple calculation <nowiki>=2+(5*7)</nowiki>, Calc multiples 5 by 7 first. Only then is 2 added to the result to get 37.

The placement of functions within sets of parentheses is called ''nesting''. Basically, nesting reduces a function that could run on its own to an argument in the formula. For example, in =2+(5*7), the formula (5*7) is nested within the larger formula of =2+(5*7). In other words, the nested function becomes an argument of another function.

This relation is more obvious when doing a calculation using a function with a name. For all purposes,

<nowiki>=SUM(2;PRODUCT(5;7))</nowiki>

is the same formula as <nowiki>=2+(5*7)</nowiki>. However, when SUM and PRODUCT are used, then the relation is clearer. The fact that the PRODUCT function comes after a semicolon and in a set of parentheses for the SUM function makes it clear that PRODUCT is an argument for SUM. In addition, the fact that the inner pair of parentheses is around (5;7) makes clear that this operation is done before the one defined by the outer pair of parentheses.

To get an idea of what nested functions can do, imagine that you are designing a self-directed learning module. During the module, students do three quizzes, and enter the results in cells A1, A2, and A3. In A4, you can create a nested formula that begins by averaging the results of the quizzes with the formula <nowiki>=AVERAGE(A1:A3)</nowiki>. The formula then uses the IF function to give the student feedback that depends upon the average grade on the quizzes. The entire formula would read:

<nowiki>=IF(AVERAGE(A1:A3) >85; "Congratulations! You are ready to advance to the next module";
"Failed. Please review the material again. If necessary, contact your instructor for help")</nowiki>

Depending on the average, the student would receive the message for either congratulations or failure.

Notice that the nested formula for the average does not require its own equal sign. The one at the start of the equation is enough for both formulas.

If you are new to spreadsheets, the best way to think of functions is as a scripting language. We've used simple examples to explain more clearly, but, through nesting of functions, a Calc formula can quickly become complex.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

'''New in 3.1''' 
Calc now keeps the syntax of a formula displayed in a tooltip next to the cell as a handy memory aid as you type.

A more reliable method is to use the ''Function List''. Available from the '''Insert''' menu, the Function List automatically docks as a pane on the right side of the Calc editing window. If you wish, you can ''Control+double-click'' on a blank space at the top of the pane to undock this pane and make it a floating window.

The Function List includes a brief description of each function and its arguments; highlight the function and look at the bottom of the pane to see the description. If necessary, hover the cursor over the division between the list and the description; when the cursor becomes a two-headed arrow, drag it upwards to increase the space for the description. Double-click on a function’s name to add it to the current cell, together with placeholders for each of the function’s arguments.

Using the Function List is almost as fast as manual entry, and has the advantage of not requiring that you memorize a formula that you want to use. In theory, it should also be less error-prone. In practice, though, some users may fumble when replacing the placeholders with values. Another handy feature is the ability to display the last formulas used.

[[Image:CG3Ch3F1.png|thumb|none|500px|''Function List docked to right side of Calc window.'']]

The most commonly used input method is the ''Function Wizard''. To open the Function Wizard, select '''Insert > Function''', or click its button on the Function tool bar, or press ''Ctrl+F2''. Once open, the Function Wizard provides the same help features as the Function List, but adds fields in which you can see the result of a completed function, as well as the result of any larger formula of which it is part.

[[Image:CG3Ch3F2.png|thumb|none|500px|''Functions page of Function Wizard.'']]

You can also select the ''Structure'' tab to see a tree view of the parts of the formula. The main advantage over the Function List is that each argument is entered in its own field, making it easier to manage. The price of this reliability is slower input, but this is often a small price to pay, since precision is generally more important than speed when creating a spreadsheet.

[[Image:CG3Ch3F3.png|thumb|none|500px|''Structure page of Function Wizard.'']]

Another advantage of the Function Wizard is that you can reduce the window as you are adding each argument. At the end of each input field for an argument is the Shrink button [[Image:CalcShrinkIcon.png]]. The Shrink button temporarily removes all parts of the wizard except the current input field so that you can see the spreadsheet beneath. When you are finished entering the argument’s value, click the button again to return to the entire Function Wizard.

[[Image:CG3Ch3F4.png|thumb|none|500px|''Function Wizard after shrinking.'']]

Finally, as with many other features in OpenOffice.org, you can create a macro for any favorite function formula, and assign it to a tool bar, menu, or keystroke combination.

No matter how you enter a formula, take a moment to check its structure before using it. If it looks right, press the ''Enter'' key or select the '''Accept''' button from the Function toolbar to add it to the cell and get its result (the Accept button is the green check mark beside the Input line).

If you see the formula in the cell instead of the result, then Formulas are selected for display in '''Tools > Options > OpenOffice.org Calc > View > Display'''. Unselect the checkbox beside it, and the result will display. However, you can still see the formula in the formula bar field.

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-18T05:17:06Z

Kirk: /* Introduction */

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
By convention, only three kinds of data can be entered in a cell. Text, Numbers, and Formulas. You can enter formulas in two ways, either in the cell itself, or at the input line. Either way you will need to start it with one of the following symbols: "=", "+" or "-". Starting with anything else will cause the formula to be treated as if it were text.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Inserting data is accomplished simply by typing the data in the cell and moving to the next cell or pressing Enter. With formulas the equal sign denotes that instead of the cell being a data holder, the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5e.png]]

|-
|
| [[Image:CG3Ch3F5d.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Notice that the formula was shown as =B3 + B4. The plus sign denotes addition as the operation being performed upon the data within cells B3 and B4. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These back references to find data to perform a calculation can be found anywhere in the worksheet being worked on or upon any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or <nowiki>#</nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
Reference operators merge the values held in each individual cell within the range. Reference operators can be an individual cell identified by the column identifier located along the upper edge of the spreadsheet and a numeric identifier found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''The Cell Reference Operator.'']]

A range is also a reference operator referenced in formulas, functions and logical operators. The range for left to right operations refers to the upper left cell running to the right and downward to the right bottommost cell as shown below.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference Operator for a range.'']]

In the upper left corner of the figure above, the range A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range. This same range could also be created by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

Another reference operator involves the use of the '!' sign. If data appears in range A1:B6 as well as range B5:C12, using a formula such as SUM(A1:B6!B5:C12) will yield the sum of cells B5 and B6.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluates the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Using functions

2009-09-18T05:14:14Z

Kirk:

{{DISPLAYTITLE:Understanding functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Creating formulas
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Finding and fixing errors
}}
Calc includes over 350 functions to help you analyze and reference data. Many of these functions are for use with numbers, but many others are used with dates and times, or even text. A function may be as simple as adding two numbers together, or finding the average of a list of numbers. Alternatively, it may be as complex as calculating the standard deviation of a sample, or a hyperbolic tangent of a number. See a list of all functions in '''[[Documentation/How_Tos/Calc: Functions listed by category|functions listed by category]]'''.

Typically, the name of a function is an abbreviated description of what the function does. For instance, the FV function gives the future value of an investment, while BIN2HEX converts a binary number to a hexadecimal number. By tradition, functions are entered entirely in upper case letters, although Calc will read them correctly if they are in lower or mixed case, too.

A few basic functions are somewhat similar to operators. Examples:
:"+", this operator will add two numbers together for a result. SUM() on the other hand will add a contiguous '''''range''''' of numbers together.
:"*", this operator will multiply to numbers together for a result. PRODUCT() does the same for multiplying, that SUM() does for adding.

Each function has a number of ''arguments'' used in the calculations. These arguments may or may not have their own name. Your task is to enter the arguments needed to run the function. In some cases, the arguments have pre-defined choices, and you may need to refer to the online help or Appendix B (Description of Functions) in this book to understand them. More often, however, an argument is a value that you enter manually, or one already entered in a cell or range of cells on the spreadsheet. In Calc, you can enter values from other cells by typing in their name or range, or by selecting cells with the mouse. Should the values in the cells change, the result of the function will be automatically updated.

For compatibility, functions and their arguments in Calc have almost identical names to their counterparts in Microsoft Excel. However, both Excel and Calc have functions that the other lacks. Occasionally, too, functions with the same names in Calc and Excel have different arguments, or slightly different names for the same argument—neither of which can be imported to the other. However, perhaps nine-tenths of functions can be imported between Calc and Excel without any problems.

== Understanding the structure of functions ==
All functions have a similar structure. If you use the right tool for entering a function, you can escape learning this structure, but it is still worth knowing for troubleshooting.

To give a typical example, the structure of a function to find cells that match entered search criteria is:

<nowiki>= DCOUNT (Database;Database field;Search_criteria)</nowiki>

By convention, only three kinds of data can be entered in a cell. Text, Numbers, and Formulas. To distinguish Formulas from Text, it is necessary to always start a formula with an "=" sign. Since a function cannot exist on its' own, it must always be part of a formula. Consequently, even if the function represents the entire formula, there must be an "=" sign at the start of the formula. Regardless of where in the formula a function is, the Function will start with the function's name, DCOUNT in the above. After the name of the function comes its arguments. All arguments are required, unless specifically listed as optional.

Arguments are added within the brackets (parentheses) and separated by semicolons, with no space between the arguments and the semicolons. Many arguments are a number. A Calc function can take up to thirty numbers as an argument. That may not sound like much at first. However, when you realize that the number can be not only a number or a single cell, but also an array or range of cells that contain several or even hundreds of cells, then the apparent limitation vanishes.

Depending on the nature of the function arguments may be entered as follow:

:{|Border="1"
|"text data"||The quotes establish that text or string data has been entered
|-
|9||In this case the number nine has been entered as a number
|-
|"9"||In this case the number nine is being entered as text
|-
|A1|| The address for whatever is in Cell A1 is being entered
|}

== Advanced structure ==
As well as being used on its own, a function can be an argument in a larger formula. A formula, however, is limited by the fact that it can only do one function at a time. You need to make sure that functions are done in the right order if the formula is going to work.

To help set the order for functions in a multiple-function formula, you use parentheses within parentheses. When the formula is run, Calc does the innermost function first, then works outwards. For example, in the simple calculation <nowiki>=2+(5*7)</nowiki>, Calc multiples 5 by 7 first. Only then is 2 added to the result to get 37.

The placement of functions within sets of parentheses is called ''nesting''. Basically, nesting reduces a function that could run on its own to an argument in the formula. For example, in =2+(5*7), the formula (5*7) is nested within the larger formula of =2+(5*7). In other words, the nested function becomes an argument of another function.

This relation is more obvious when doing a calculation using a function with a name. For all purposes,

<nowiki>=SUM(2;PRODUCT(5;7))</nowiki>

is the same formula as <nowiki>=2+(5*7)</nowiki>. However, when SUM and PRODUCT are used, then the relation is clearer. The fact that the PRODUCT function comes after a semicolon and in a set of parentheses for the SUM function makes it clear that PRODUCT is an argument for SUM. In addition, the fact that the inner pair of parentheses is around (5;7) makes clear that this operation is done before the one defined by the outer pair of parentheses.

To get an idea of what nested functions can do, imagine that you are designing a self-directed learning module. During the module, students do three quizzes, and enter the results in cells A1, A2, and A3. In A4, you can create a nested formula that begins by averaging the results of the quizzes with the formula <nowiki>=AVERAGE(A1:A3)</nowiki>. The formula then uses the IF function to give the student feedback that depends upon the average grade on the quizzes. The entire formula would read:

<nowiki>=IF(AVERAGE(A1:A3) >85; "Congratulations! You are ready to advance to the next module";
"Failed. Please review the material again. If necessary, contact your instructor for help")</nowiki>

Depending on the average, the student would receive the message for either congratulations or failure.

Notice that the nested formula for the average does not require its own equal sign. The one at the start of the equation is enough for both formulas.

If you are new to spreadsheets, the best way to think of functions is as a scripting language. We've used simple examples to explain more clearly, but, through nesting of functions, a Calc formula can quickly become complex.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

'''New in 3.1''' 
Calc now keeps the syntax of a formula displayed in a tooltip next to the cell as a handy memory aid as you type.

A more reliable method is to use the ''Function List''. Available from the '''Insert''' menu, the Function List automatically docks as a pane on the right side of the Calc editing window. If you wish, you can ''Control+double-click'' on a blank space at the top of the pane to undock this pane and make it a floating window.

The Function List includes a brief description of each function and its arguments; highlight the function and look at the bottom of the pane to see the description. If necessary, hover the cursor over the division between the list and the description; when the cursor becomes a two-headed arrow, drag it upwards to increase the space for the description. Double-click on a function’s name to add it to the current cell, together with placeholders for each of the function’s arguments.

Using the Function List is almost as fast as manual entry, and has the advantage of not requiring that you memorize a formula that you want to use. In theory, it should also be less error-prone. In practice, though, some users may fumble when replacing the placeholders with values. Another handy feature is the ability to display the last formulas used.

[[Image:CG3Ch3F1.png|thumb|none|500px|''Function List docked to right side of Calc window.'']]

The most commonly used input method is the ''Function Wizard''. To open the Function Wizard, select '''Insert > Function''', or click its button on the Function tool bar, or press ''Ctrl+F2''. Once open, the Function Wizard provides the same help features as the Function List, but adds fields in which you can see the result of a completed function, as well as the result of any larger formula of which it is part.

[[Image:CG3Ch3F2.png|thumb|none|500px|''Functions page of Function Wizard.'']]

You can also select the ''Structure'' tab to see a tree view of the parts of the formula. The main advantage over the Function List is that each argument is entered in its own field, making it easier to manage. The price of this reliability is slower input, but this is often a small price to pay, since precision is generally more important than speed when creating a spreadsheet.

[[Image:CG3Ch3F3.png|thumb|none|500px|''Structure page of Function Wizard.'']]

Another advantage of the Function Wizard is that you can reduce the window as you are adding each argument. At the end of each input field for an argument is the Shrink button [[Image:CalcShrinkIcon.png]]. The Shrink button temporarily removes all parts of the wizard except the current input field so that you can see the spreadsheet beneath. When you are finished entering the argument’s value, click the button again to return to the entire Function Wizard.

[[Image:CG3Ch3F4.png|thumb|none|500px|''Function Wizard after shrinking.'']]

Finally, as with many other features in OpenOffice.org, you can create a macro for any favorite function formula, and assign it to a tool bar, menu, or keystroke combination.

No matter how you enter a formula, take a moment to check its structure before using it. If it looks right, press the ''Enter'' key or select the '''Accept''' button from the Function toolbar to add it to the cell and get its result (the Accept button is the green check mark beside the Input line).

If you see the formula in the cell instead of the result, then Formulas are selected for display in '''Tools > Options > OpenOffice.org Calc > View > Display'''. Unselect the checkbox beside it, and the result will display. However, you can still see the formula in the formula bar field.

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-15T02:23:36Z

Kirk: /* Order of calculation */

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
You can enter formulas in two ways, either in the cell itself, or at the input line. Either way you will need to start it with one of the following symbols: "=", "+" or "-". Starting with anything else will cause the formula to be treated as if it were text.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Inserting data is accomplished simply by typing the data in the cell and moving to the next cell or pressing Enter. With formulas the equal sign denotes that instead of the cell being a data holder, the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5e.png]]

|-
|
| [[Image:CG3Ch3F5d.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Notice that the formula was shown as =B3 + B4. The plus sign denotes addition as the operation being performed upon the data within cells B3 and B4. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These back references to find data to perform a calculation can be found anywhere in the worksheet being worked on or upon any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or <nowiki>#</nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
Reference operators merge the values held in each individual cell within the range. Reference operators can be an individual cell identified by the column identifier located along the upper edge of the spreadsheet and a numeric identifier found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''The Cell Reference Operator.'']]

A range is also a reference operator referenced in formulas, functions and logical operators. The range for left to right operations refers to the upper left cell running to the right and downward to the right bottommost cell as shown below.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference Operator for a range.'']]

In the upper left corner of the figure above, the range A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range. This same range could also be created by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

Another reference operator involves the use of the '!' sign. If data appears in range A1:B6 as well as range B5:C12, using a formula such as SUM(A1:B6!B5:C12) will yield the sum of cells B5 and B6.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluates the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-15T02:15:56Z

Kirk: /* Operator types */

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
You can enter formulas in two ways, either in the cell itself, or at the input line. Either way you will need to start it with one of the following symbols: "=", "+" or "-". Starting with anything else will cause the formula to be treated as if it were text.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Inserting data is accomplished simply by typing the data in the cell and moving to the next cell or pressing Enter. With formulas the equal sign denotes that instead of the cell being a data holder, the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5e.png]]

|-
|
| [[Image:CG3Ch3F5d.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Notice that the formula was shown as =B3 + B4. The plus sign denotes addition as the operation being performed upon the data within cells B3 and B4. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These back references to find data to perform a calculation can be found anywhere in the worksheet being worked on or upon any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or <nowiki>#</nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
Reference operators merge the values held in each individual cell within the range. Reference operators can be an individual cell identified by the column identifier located along the upper edge of the spreadsheet and a numeric identifier found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''The Cell Reference Operator.'']]

A range is also a reference operator referenced in formulas, functions and logical operators. The range for left to right operations refers to the upper left cell running to the right and downward to the right bottommost cell as shown below.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference Operator for a range.'']]

In the upper left corner of the figure above, the range A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range. This same range could also be created by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

Another reference operator involves the use of the '!' sign. If data appears in range A1:B6 as well as range B5:C12, using a formula such as SUM(A1:B6!B5:C12) will yield the sum of cells B5 and B6.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluations the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-15T02:15:11Z

Kirk: /* Descriptive operators */ There is no such thing as a Descriptive operator. What this section was describing is an aspect of Formatting and has nothing to do with creating a formula.

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
You can enter formulas in two ways, either in the cell itself, or at the input line. Either way you will need to start it with one of the following symbols: "=", "+" or "-". Starting with anything else will cause the formula to be treated as if it were text.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Inserting data is accomplished simply by typing the data in the cell and moving to the next cell or pressing Enter. With formulas the equal sign denotes that instead of the cell being a data holder, the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5e.png]]

|-
|
| [[Image:CG3Ch3F5d.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Notice that the formula was shown as =B3 + B4. The plus sign denotes addition as the operation being performed upon the data within cells B3 and B4. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These back references to find data to perform a calculation can be found anywhere in the worksheet being worked on or upon any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or <nowiki>#</nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, descriptive, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
Reference operators merge the values held in each individual cell within the range. Reference operators can be an individual cell identified by the column identifier located along the upper edge of the spreadsheet and a numeric identifier found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''The Cell Reference Operator.'']]

A range is also a reference operator referenced in formulas, functions and logical operators. The range for left to right operations refers to the upper left cell running to the right and downward to the right bottommost cell as shown below.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference Operator for a range.'']]

In the upper left corner of the figure above, the range A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range. This same range could also be created by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

Another reference operator involves the use of the '!' sign. If data appears in range A1:B6 as well as range B5:C12, using a formula such as SUM(A1:B6!B5:C12) will yield the sum of cells B5 and B6.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluations the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-15T02:08:16Z

Kirk: /* Operators in formulas */

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
You can enter formulas in two ways, either in the cell itself, or at the input line. Either way you will need to start it with one of the following symbols: "=", "+" or "-". Starting with anything else will cause the formula to be treated as if it were text.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Inserting data is accomplished simply by typing the data in the cell and moving to the next cell or pressing Enter. With formulas the equal sign denotes that instead of the cell being a data holder, the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5e.png]]

|-
|
| [[Image:CG3Ch3F5d.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Notice that the formula was shown as =B3 + B4. The plus sign denotes addition as the operation being performed upon the data within cells B3 and B4. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These back references to find data to perform a calculation can be found anywhere in the worksheet being worked on or upon any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or <nowiki>#</nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, descriptive, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Descriptive operators ===
Currency symbols are perhaps the most commonly used descriptive operators found in Calc. Calc handles as currency an amount like $0.97 or £0.97 entered into a cell formatted as general or currency. However, it does not handle other currency types entered in this fashion. For other currencies, it is best to format the cells as the specific currency type, such as Yen (¥). To do this, right-click on the affected cells and select Formatting Cells. On the tab Numbers tab, select Currency. In the Format list, select the appropriate currency type.

When entering amounts, it is not necessary to enter a currency symbol. Some currency symbols such as the Yen may not display.

[[Image:CG3Ch3F6.png|thumb|none|500px|''Currency symbols.'']]

{{Documentation/Caution| Users experienced in the use of an adding machine may experience difficulty with data entry, with resulting loss of data or incorrect results displaying. Adding machine users typically enter numbers from left to right without entering a decimal point. For example, the entry of 97 will display as 0.97. In cells formatted as currency, the entry of 97 will display currency for the locale selected such as $97 or £97, not $0.97 or £0.97.}}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
Reference operators merge the values held in each individual cell within the range. Reference operators can be an individual cell identified by the column identifier located along the upper edge of the spreadsheet and a numeric identifier found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''The Cell Reference Operator.'']]

A range is also a reference operator referenced in formulas, functions and logical operators. The range for left to right operations refers to the upper left cell running to the right and downward to the right bottommost cell as shown below.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference Operator for a range.'']]

In the upper left corner of the figure above, the range A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range. This same range could also be created by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

Another reference operator involves the use of the '!' sign. If data appears in range A1:B6 as well as range B5:C12, using a formula such as SUM(A1:B6!B5:C12) will yield the sum of cells B5 and B6.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluations the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-14T21:14:24Z

Kirk: /* Operators in formulas */

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
You can enter formulas in two ways, either in the cell itself, or at the input line. Either way you will need to start it with one of the following symbols: "=", "+" or "-". Starting with anything else will cause the formula to be treated as if it were text.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Inserting data is accomplished simply by typing the data in the cell and moving to the next cell or pressing Enter. With formulas the equal sign denotes that instead of the cell being a data holder, the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5e.png]]

|-
|
| [[Image:CG3Ch3F5d.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Notice that the formula was shown as =B3 + B4. The plus sign denotes addition as the operation being performed upon the data within cells B3 and B4. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These back references to find data to perform a calculation can be found anywhere in the worksheet being worked on or upon any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or </nowiki>#<nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, descriptive, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Descriptive operators ===
Currency symbols are perhaps the most commonly used descriptive operators found in Calc. Calc handles as currency an amount like $0.97 or £0.97 entered into a cell formatted as general or currency. However, it does not handle other currency types entered in this fashion. For other currencies, it is best to format the cells as the specific currency type, such as Yen (¥). To do this, right-click on the affected cells and select Formatting Cells. On the tab Numbers tab, select Currency. In the Format list, select the appropriate currency type.

When entering amounts, it is not necessary to enter a currency symbol. Some currency symbols such as the Yen may not display.

[[Image:CG3Ch3F6.png|thumb|none|500px|''Currency symbols.'']]

{{Documentation/Caution| Users experienced in the use of an adding machine may experience difficulty with data entry, with resulting loss of data or incorrect results displaying. Adding machine users typically enter numbers from left to right without entering a decimal point. For example, the entry of 97 will display as 0.97. In cells formatted as currency, the entry of 97 will display currency for the locale selected such as $97 or £97, not $0.97 or £0.97.}}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
Reference operators merge the values held in each individual cell within the range. Reference operators can be an individual cell identified by the column identifier located along the upper edge of the spreadsheet and a numeric identifier found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''The Cell Reference Operator.'']]

A range is also a reference operator referenced in formulas, functions and logical operators. The range for left to right operations refers to the upper left cell running to the right and downward to the right bottommost cell as shown below.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference Operator for a range.'']]

In the upper left corner of the figure above, the range A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range. This same range could also be created by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

Another reference operator involves the use of the '!' sign. If data appears in range A1:B6 as well as range B5:C12, using a formula such as SUM(A1:B6!B5:C12) will yield the sum of cells B5 and B6.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluations the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Using functions

2009-09-14T21:11:06Z

Kirk: /* Advanced structure */

{{DISPLAYTITLE:Understanding functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Creating formulas
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Finding and fixing errors
}}
Calc includes over 350 functions to help you analyze and reference data. Many of these functions are for use with numbers, but many others are used with dates and times, or even text. A function may be as simple as adding two numbers together, or finding the average of a list of numbers. Alternatively, it may be as complex as calculating the standard deviation of a sample, or a hyperbolic tangent of a number. See a list of all functions in '''[[Documentation/How_Tos/Calc: Functions listed by category|functions listed by category]]'''.

Typically, the name of a function is an abbreviated description of what the function does. For instance, the FV function gives the future value of an investment, while BIN2HEX converts a binary number to a hexadecimal number. By tradition, functions are entered entirely in upper case letters, although Calc will read them correctly if they are in lower or mixed case, too.

A few basic functions are somewhat similar to operators. Examples:
:"+", this operator will add two numbers together for a result. SUM() on the other hand will add a contiguous '''''range''''' of numbers together.
:"*", this operator will multiply to numbers together for a result. PRODUCT() does the same for multiplying, that SUM() does for adding.

Each function has a number of ''arguments'' used in the calculations. These arguments may or may not have their own name. Your task is to enter the arguments needed to run the function. In some cases, the arguments have pre-defined choices, and you may need to refer to the online help or Appendix B (Description of Functions) in this book to understand them. More often, however, an argument is a value that you enter manually, or one already entered in a cell or range of cells on the spreadsheet. In Calc, you can enter values from other cells by typing in their name or range, or—unlike the case in some spreadsheets—by selecting cells with the mouse. Should the values in the cells change, the result of the function will be automatically updated.

Strictly speaking, when all the arguments are entered and a function is ready to run, it becomes a ''formula''. These terms are sometimes used interchangeably, but the distinction is worth preserving, because a formula can use functions as an argument.

For compatibility, functions and their arguments in Calc have almost identical names to their counterparts in Microsoft Excel. However, both Excel and Calc have functions that the other lacks. Occasionally, too, functions with the same names in Calc and Excel have different arguments, or slightly different names for the same argument—neither of which can be imported to the other. However, perhaps nine-tenths of functions can be imported between Calc and Excel without any problems.

== Understanding the structure of functions ==
All functions have a similar structure. If you use the right tool for entering a function, you can escape learning this structure, but it is still worth knowing for troubleshooting.

To give a typical example, the structure of a function to find cells that match entered search criteria is:

<nowiki>= DCOUNT (Database;Database field;Search_criteria)</nowiki>

By convention, only three kinds of data can be entered in a cell. Text, Numbers, and Formulas. To distinguish Formulas from Text, it is necessary to always start a formula with an "=" sign. Since a function cannot exist on its' own, it must always be part of a formula. Consequently, even if the function represents the entire formula, there must be an "=" sign at the start of the formula. Regardless of where in the formula a function is, the Function will start with the function's name, DCOUNT in the above. After the name of the function comes its arguments. All arguments are required, unless specifically listed as optional.

Arguments are added within the brackets (parentheses) and separated by semicolons, with no space between the arguments and the semicolons. Many arguments are a number. A Calc function can take up to thirty numbers as an argument. That may not sound like much at first. However, when you realize that the number can be not only a number or a single cell, but also an array or range of cells that contain several or even hundreds of cells, then the apparent limitation vanishes.

Depending on the nature of the function arguments may be entered as follow:

:{|Border="1"
|"text data"||The quotes establish that text or string data has been entered
|-
|9||In this case the number nine has been entered as a number
|-
|"9"||In this case the number nine is being entered as text
|-
|A1|| The address for whatever is in Cell A1 is being entered
|}

== Advanced structure ==
As well as being used on its own, a function can be an argument in a larger formula. A formula, however, is limited by the fact that it can only do one function at a time. You need to make sure that functions are done in the right order if the formula is going to work.

To help set the order for functions in a multiple-function formula, you use parentheses within parentheses. When the formula is run, Calc does the innermost function first, then works outwards. For example, in the simple calculation <nowiki>=2+(5*7)</nowiki>, Calc multiples 5 by 7 first. Only then is 2 added to the result to get 37.

The placement of functions within sets of parentheses is called ''nesting''. Basically, nesting reduces a function that could run on its own to an argument in the formula. For example, in =2+(5*7), the formula (5*7) is nested within the larger formula of =2+(5*7). In other words, the nested function becomes an argument of another function.

This relation is more obvious when doing a calculation using a function with a name. For all purposes,

<nowiki>=SUM(2;PRODUCT(5;7))</nowiki>

is the same formula as <nowiki>=2+(5*7)</nowiki>. However, when SUM and PRODUCT are used, then the relation is clearer. The fact that the PRODUCT function comes after a semicolon and in a set of parentheses for the SUM function makes it clear that PRODUCT is an argument for SUM. In addition, the fact that the inner pair of parentheses is around (5;7) makes clear that this operation is done before the one defined by the outer pair of parentheses.

To get an idea of what nested functions can do, imagine that you are designing a self-directed learning module. During the module, students do three quizzes, and enter the results in cells A1, A2, and A3. In A4, you can create a nested formula that begins by averaging the results of the quizzes with the formula <nowiki>=AVERAGE(A1:A3)</nowiki>. The formula then uses the IF function to give the student feedback that depends upon the average grade on the quizzes. The entire formula would read:

<nowiki>=IF(AVERAGE(A1:A3) >85; "Congratulations! You are ready to advance to the next module";
"Failed. Please review the material again. If necessary, contact your instructor for help")</nowiki>

Depending on the average, the student would receive the message for either congratulations or failure.

Notice that the nested formula for the average does not require its own equal sign. The one at the start of the equation is enough for both formulas.

If you are new to spreadsheets, the best way to think of functions is as a scripting language. We've used simple examples to explain more clearly, but, through nesting of functions, a Calc formula can quickly become complex.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

'''New in 3.1''' 
Calc now keeps the syntax of a formula displayed in a tooltip next to the cell as a handy memory aid as you type.

A more reliable method is to use the ''Function List''. Available from the '''Insert''' menu, the Function List automatically docks as a pane on the right side of the Calc editing window. If you wish, you can ''Control+double-click'' on a blank space at the top of the pane to undock this pane and make it a floating window.

The Function List includes a brief description of each function and its arguments; highlight the function and look at the bottom of the pane to see the description. If necessary, hover the cursor over the division between the list and the description; when the cursor becomes a two-headed arrow, drag it upwards to increase the space for the description. Double-click on a function’s name to add it to the current cell, together with placeholders for each of the function’s arguments.

Using the Function List is almost as fast as manual entry, and has the advantage of not requiring that you memorize a formula that you want to use. In theory, it should also be less error-prone. In practice, though, some users may fumble when replacing the placeholders with values. Another handy feature is the ability to display the last formulas used.

[[Image:CG3Ch3F1.png|thumb|none|500px|''Function List docked to right side of Calc window.'']]

The most commonly used input method is the ''Function Wizard''. To open the Function Wizard, select '''Insert > Function''', or click its button on the Function tool bar, or press ''Ctrl+F2''. Once open, the Function Wizard provides the same help features as the Function List, but adds fields in which you can see the result of a completed function, as well as the result of any larger formula of which it is part.

[[Image:CG3Ch3F2.png|thumb|none|500px|''Functions page of Function Wizard.'']]

You can also select the ''Structure'' tab to see a tree view of the parts of the formula. The main advantage over the Function List is that each argument is entered in its own field, making it easier to manage. The price of this reliability is slower input, but this is often a small price to pay, since precision is generally more important than speed when creating a spreadsheet.

[[Image:CG3Ch3F3.png|thumb|none|500px|''Structure page of Function Wizard.'']]

Another advantage of the Function Wizard is that you can reduce the window as you are adding each argument. At the end of each input field for an argument is the Shrink button [[Image:CalcShrinkIcon.png]]. The Shrink button temporarily removes all parts of the wizard except the current input field so that you can see the spreadsheet beneath. When you are finished entering the argument’s value, click the button again to return to the entire Function Wizard.

[[Image:CG3Ch3F4.png|thumb|none|500px|''Function Wizard after shrinking.'']]

Finally, as with many other features in OpenOffice.org, you can create a macro for any favorite function formula, and assign it to a tool bar, menu, or keystroke combination.

No matter how you enter a formula, take a moment to check its structure before using it. If it looks right, press the ''Enter'' key or select the '''Accept''' button from the Function toolbar to add it to the cell and get its result (the Accept button is the green check mark beside the Input line).

If you see the formula in the cell instead of the result, then Formulas are selected for display in '''Tools > Options > OpenOffice.org Calc > View > Display'''. Unselect the checkbox beside it, and the result will display. However, you can still see the formula in the formula bar field.

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-14T21:10:35Z

Kirk: /* Introduction */

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
You can enter formulas in two ways, either in the cell itself, or at the input line. Either way you will need to start it with one of the following symbols: "=", "+" or "-". Starting with anything else will cause the formula to be treated as if it were text.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Inserting data is accomplished simply by typing the data in the cell and moving to the next cell or pressing Enter. With formulas the equal sign denotes that instead of the cell being a data holder, the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5d.png]]

|-
|
| [[Image:CG3Ch3F5e.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Notice that the formula was shown as =B3 + B4. The plus sign denotes addition as the operation being performed upon the data within cells B3 and B4. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These back references to find data to perform a calculation can be found anywhere in the worksheet being worked on or upon any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or </nowiki>#<nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, descriptive, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Descriptive operators ===
Currency symbols are perhaps the most commonly used descriptive operators found in Calc. Calc handles as currency an amount like $0.97 or £0.97 entered into a cell formatted as general or currency. However, it does not handle other currency types entered in this fashion. For other currencies, it is best to format the cells as the specific currency type, such as Yen (¥). To do this, right-click on the affected cells and select Formatting Cells. On the tab Numbers tab, select Currency. In the Format list, select the appropriate currency type.

When entering amounts, it is not necessary to enter a currency symbol. Some currency symbols such as the Yen may not display.

[[Image:CG3Ch3F6.png|thumb|none|500px|''Currency symbols.'']]

{{Documentation/Caution| Users experienced in the use of an adding machine may experience difficulty with data entry, with resulting loss of data or incorrect results displaying. Adding machine users typically enter numbers from left to right without entering a decimal point. For example, the entry of 97 will display as 0.97. In cells formatted as currency, the entry of 97 will display currency for the locale selected such as $97 or £97, not $0.97 or £0.97.}}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
Reference operators merge the values held in each individual cell within the range. Reference operators can be an individual cell identified by the column identifier located along the upper edge of the spreadsheet and a numeric identifier found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''The Cell Reference Operator.'']]

A range is also a reference operator referenced in formulas, functions and logical operators. The range for left to right operations refers to the upper left cell running to the right and downward to the right bottommost cell as shown below.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference Operator for a range.'']]

In the upper left corner of the figure above, the range A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range. This same range could also be created by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

Another reference operator involves the use of the '!' sign. If data appears in range A1:B6 as well as range B5:C12, using a formula such as SUM(A1:B6!B5:C12) will yield the sum of cells B5 and B6.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluations the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-14T18:58:21Z

Kirk: /* Introduction */

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
You can enter formulas in two ways, either in the cell itself, or at the input line. Either way you will need to start it with one of the following symbols: "=", "+" or "-". Starting with anything else will cause the formula to be treated as if it were text.

'''New in 3.1''' 
Calc now keeps the syntax of a formula displayed in a tooltip next to the cell as a handy memory aid as you type.

A more reliable method is to use the ''Function List''. Available from the '''Insert''' menu, the Function List automatically docks as a pane on the right side of the Calc editing window. If you wish, you can ''Control+double-click'' on a blank space at the top of the pane to undock this pane and make it a floating window.

The Function List includes a brief description of each function and its arguments; highlight the function and look at the bottom of the pane to see the description. If necessary, hover the cursor over the division between the list and the description; when the cursor becomes a two-headed arrow, drag it upwards to increase the space for the description. Double-click on a function’s name to add it to the current cell, together with placeholders for each of the function’s arguments.

Using the Function List is almost as fast as manual entry, and has the advantage of not requiring that you memorize a formula that you want to use. In theory, it should also be less error-prone. In practice, though, some users may fumble when replacing the placeholders with values. Another handy feature is the ability to display the last formulas used.

[[Image:CG3Ch3F1.png|thumb|none|500px|''Function List docked to right side of Calc window.'']]

The most commonly used input method is the ''Function Wizard''. To open the Function Wizard, select '''Insert > Function''', or click its button on the Function tool bar, or press ''Ctrl+F2''. Once open, the Function Wizard provides the same help features as the Function List, but adds fields in which you can see the result of a completed function, as well as the result of any larger formula of which it is part.

[[Image:CG3Ch3F2.png|thumb|none|500px|''Functions page of Function Wizard.'']]

You can also select the ''Structure'' tab to see a tree view of the parts of the formula. The main advantage over the Function List is that each argument is entered in its own field, making it easier to manage. The price of this reliability is slower input, but this is often a small price to pay, since precision is generally more important than speed when creating a spreadsheet.

[[Image:CG3Ch3F3.png|thumb|none|500px|''Structure page of Function Wizard.'']]

Another advantage of the Function Wizard is that you can reduce the window as you are adding each argument. At the end of each input field for an argument is the Shrink button [[Image:CalcShrinkIcon.png]]. The Shrink button temporarily removes all parts of the wizard except the current input field so that you can see the spreadsheet beneath. When you are finished entering the argument’s value, click the button again to return to the entire Function Wizard.

[[Image:CG3Ch3F4.png|thumb|none|500px|''Function Wizard after shrinking.'']]

Finally, as with many other features in OpenOffice.org, you can create a macro for any favorite function formula, and assign it to a tool bar, menu, or keystroke combination.

No matter how you enter a formula, take a moment to check its structure before using it. If it looks right, press the ''Enter'' key or select the '''Accept''' button from the Function toolbar to add it to the cell and get its result (the Accept button is the green check mark beside the Input line).

If you see the formula in the cell instead of the result, then Formulas are selected for display in '''Tools > Options > OpenOffice.org Calc > View > Display'''. Unselect the checkbox beside it, and the result will display. However, you can still see the formula in the formula bar field.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Inserting data is accomplished simply by typing the data in the cell and moving to the next cell or pressing Enter. With formulas the equal sign denotes that instead of the cell being a data holder, the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5d.png]]

|-
|
| [[Image:CG3Ch3F5e.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Notice that the formula was shown as =B3 + B4. The plus sign denotes addition as the operation being performed upon the data within cells B3 and B4. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These back references to find data to perform a calculation can be found anywhere in the worksheet being worked on or upon any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or </nowiki>#<nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, descriptive, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Descriptive operators ===
Currency symbols are perhaps the most commonly used descriptive operators found in Calc. Calc handles as currency an amount like $0.97 or £0.97 entered into a cell formatted as general or currency. However, it does not handle other currency types entered in this fashion. For other currencies, it is best to format the cells as the specific currency type, such as Yen (¥). To do this, right-click on the affected cells and select Formatting Cells. On the tab Numbers tab, select Currency. In the Format list, select the appropriate currency type.

When entering amounts, it is not necessary to enter a currency symbol. Some currency symbols such as the Yen may not display.

[[Image:CG3Ch3F6.png|thumb|none|500px|''Currency symbols.'']]

{{Documentation/Caution| Users experienced in the use of an adding machine may experience difficulty with data entry, with resulting loss of data or incorrect results displaying. Adding machine users typically enter numbers from left to right without entering a decimal point. For example, the entry of 97 will display as 0.97. In cells formatted as currency, the entry of 97 will display currency for the locale selected such as $97 or £97, not $0.97 or £0.97.}}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
Reference operators merge the values held in each individual cell within the range. Reference operators can be an individual cell identified by the column identifier located along the upper edge of the spreadsheet and a numeric identifier found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''The Cell Reference Operator.'']]

A range is also a reference operator referenced in formulas, functions and logical operators. The range for left to right operations refers to the upper left cell running to the right and downward to the right bottommost cell as shown below.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference Operator for a range.'']]

In the upper left corner of the figure above, the range A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range. This same range could also be created by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

Another reference operator involves the use of the '!' sign. If data appears in range A1:B6 as well as range B5:C12, using a formula such as SUM(A1:B6!B5:C12) will yield the sum of cells B5 and B6.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluations the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Creating formulas

2009-09-14T18:14:32Z

Kirk: /* Introduction */

{{DISPLAYTITLE:Creating formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
==Introduction==
You can enter formulas in several ways.

The quickest way to enter a formula is to start typing, either in the cell itself, or at the input line. If you are typing in the cell, as soon as you type an operator, such as an equal sign or less than sign <nowiki>(<)</nowiki>, then the formula tools become active on the Formula bar.

The trouble with both these methods is that typos are easy to make. Also, unless you are entering a formula that you use all the time, you may not remember its structure. For this reason, manual input of a formula is best for basic formulas or ones that you use all the time.

'''New in 3.1''' 
Calc now keeps the syntax of a formula displayed in a tooltip next to the cell as a handy memory aid as you type.

A more reliable method is to use the ''Function List''. Available from the '''Insert''' menu, the Function List automatically docks as a pane on the right side of the Calc editing window. If you wish, you can ''Control+double-click'' on a blank space at the top of the pane to undock this pane and make it a floating window.

The Function List includes a brief description of each function and its arguments; highlight the function and look at the bottom of the pane to see the description. If necessary, hover the cursor over the division between the list and the description; when the cursor becomes a two-headed arrow, drag it upwards to increase the space for the description. Double-click on a function’s name to add it to the current cell, together with placeholders for each of the function’s arguments.

Using the Function List is almost as fast as manual entry, and has the advantage of not requiring that you memorize a formula that you want to use. In theory, it should also be less error-prone. In practice, though, some users may fumble when replacing the placeholders with values. Another handy feature is the ability to display the last formulas used.

[[Image:CG3Ch3F1.png|thumb|none|500px|''Function List docked to right side of Calc window.'']]

The most commonly used input method is the ''Function Wizard''. To open the Function Wizard, select '''Insert > Function''', or click its button on the Function tool bar, or press ''Ctrl+F2''. Once open, the Function Wizard provides the same help features as the Function List, but adds fields in which you can see the result of a completed function, as well as the result of any larger formula of which it is part.

[[Image:CG3Ch3F2.png|thumb|none|500px|''Functions page of Function Wizard.'']]

You can also select the ''Structure'' tab to see a tree view of the parts of the formula. The main advantage over the Function List is that each argument is entered in its own field, making it easier to manage. The price of this reliability is slower input, but this is often a small price to pay, since precision is generally more important than speed when creating a spreadsheet.

[[Image:CG3Ch3F3.png|thumb|none|500px|''Structure page of Function Wizard.'']]

Another advantage of the Function Wizard is that you can reduce the window as you are adding each argument. At the end of each input field for an argument is the Shrink button [[Image:CalcShrinkIcon.png]]. The Shrink button temporarily removes all parts of the wizard except the current input field so that you can see the spreadsheet beneath. When you are finished entering the argument’s value, click the button again to return to the entire Function Wizard.

[[Image:CG3Ch3F4.png|thumb|none|500px|''Function Wizard after shrinking.'']]

Finally, as with many other features in OpenOffice.org, you can create a macro for any favorite function formula, and assign it to a tool bar, menu, or keystroke combination.

No matter how you enter a formula, take a moment to check its structure before using it. If it looks right, press the ''Enter'' key or select the '''Accept''' button from the Function toolbar to add it to the cell and get its result (the Accept button is the green check mark beside the Input line).

If you see the formula in the cell instead of the result, then Formulas are selected for display in '''Tools > Options > OpenOffice.org Calc > View > Display'''. Unselect the checkbox beside it, and the result will display. However, you can still see the formula in the formula bar field.

== Operators in formulas ==
Each cell on the worksheet can be used as a data holder or a place for data calculations. Inserting data is accomplished simply by typing the data in the cell and moving to the next cell or pressing Enter. With formulas the equal sign denotes that instead of the cell being a data holder, the cell will be used for a calculation. A mathematical calculation like 15 + 46 can be accomplished as shown below.

{{Documentation/Note| To enter the <nowiki>=</nowiki> symbol for a purpose other than creating a formula as described in this chapter, type an apostrophe or single quotation mark before the data; for example, <nowiki>'=</nowiki> means different things to different people. Calc treats everything after the single quotation symbol as text.}}

{| class="prettytable"
| '''''Simple Calculation in 1 Cell'''''
| '''''Calculation by Reference'''''

|-
| [[Image:CG3Ch3F5a.png]]
| [[Image:CG3Ch3F5b.png]]

|-
| [[Image:CG3Ch3F5c.png]]
| [[Image:CG3Ch3F5d.png]]

|-
|
| [[Image:CG3Ch3F5e.png]]

|}
''A simple calculation.''

While the calculation on the left was accomplished in only one cell, the real power is shown on the right where the data is placed in cells and the calculation is performed using references back to the cells. In this case, cells B3 and B4 were the data holders with B5 the cell where the calculation was performed. Notice that the formula was shown as =B3 + B4. The plus sign denotes addition as the operation being performed upon the data within cells B3 and B4. All formulas build upon this concept. Other ways of entering formulas are shown in Table 1.

These back references to find data to perform a calculation can be found anywhere in the worksheet being worked on or upon any other worksheet in the workbook that is opened. If the data needed was on different worksheets they would be referenced by referring to the worksheet, for example <nowiki>=SUM(</nowiki>Sheet2.B12+Sheet3.A11).

''Table 1: Common ways to enter formulas.''

{| class="prettytable"
! Formula
! Description

|-
| <nowiki>=A1+10</nowiki>
| Displays the contents of cell A1 plus 10.

|-
| <nowiki>=A1*16%</nowiki>
| Displays 16% of the contents of A1.

|-
| <nowiki>=A1 * A2</nowiki>
| Displays the result of the multiplication of A1 and A2.

|-
| <nowiki>=ROUND(A1;1)</nowiki>
| Displays the contents of cell A1 rounded to one decimal place.

|-
| <nowiki>=EFFECTIVE(5%;12)</nowiki>
| Calculates the effective interest for 5% annual nominal interest with 12 payments a year.

|-
| <nowiki>=B8-SUM(B10:B14)</nowiki>
| Calculates B8 minus the sum of the cells B10 to B14.

|-
| <nowiki>=SUM(B8;SUM(B10:B14))</nowiki>
| Calculates the sum of cells B10 to B14 and adds the value to B8.

|-
| <nowiki>=SUM(B1:B65536)</nowiki>
| Sums all numbers in column B.

|-
| <nowiki>=AVERAGE(BloodSugar)</nowiki>
| Displays the average of a named range defined under the name BloodSugar.

|-
| <nowiki>=IF(C31>140; "HIGH"; "OK")</nowiki>
| Displays the results of a conditional analysis of data from two sources. If C31 = 144, then HIGH is displayed, otherwise OK is displayed.

|}

{{Documentation/Note| Users of Lotus 1-2-3®, Quattro Pro® and other spreadsheet software may be familiar with formulas that begin with <nowiki>+, -, =, (, @, ., $,</nowiki> or </nowiki>#<nowiki>. A mathematical formula would look like +D2+C2 or +2*3. Functions begin with the <nowiki>@</nowiki> symbol such as <nowiki>@SUM(D2..D7)</nowiki>, <nowiki>@COS(@DEGTORAD(30))</nowiki> and <nowiki>@IRR(GUESS;CASHFLOWS)</nowiki>. Ranges are identified such as <nowiki>A1..D3</nowiki>.}}

Functions can be identified in Table 1 with a word, for example ROUND, followed by parentheses enclosing references or numbers.

It is also possible to establish ranges for inclusion by naming them using '''Insert > Names''', for example BloodSugar representing a range such as B3:B10. Logical functions can also be performed as represented by the IF statement which results in a conditional response based upon the data in the identified cell.

== Operator types ==
You can use the following operators in OpenOffice.org Calc: arithmetic, comparative, descriptive, text, and reference.

=== Arithmetic operators ===
The addition, subtraction, multiplication and division operators return numerical results. The Negation and Percent operators identify a characteristic of the number found in the cell, for example -37. The example for Exponentiation illustrates how to enter a number that is being multiplied by itself a certain number of times, for example 23 <nowiki>= 2*2*2.</nowiki>

''Table 2: Arithmetical operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| + (Plus)
| Addition
| <nowiki>=1+1</nowiki>

|-
| - (Minus)
| Subtraction
| <nowiki>=2-1</nowiki>

|-
| - (Minus)
| Negation
| -5

|-
| <nowiki>* (asterisk)</nowiki>
| Multiplication
| <nowiki>=2*2</nowiki>

|-
| / (Slash)
| Division
| <nowiki>=10/5</nowiki>

|-
| % (Percent)
| Percent
| 15%

|-
| ^ (Caret)
| Exponentiation
| 2^3

|}

=== Comparative operators ===
Comparative operators are found in formulas that use the IF function and return either a true or false answer; for example, <nowiki>=IF(B6>G12; 127; 0)</nowiki> which, loosely translated, means if the contents of cell B6 are greater than the contents of cell G12, then return the number 127, otherwise return the number 0.

A direct answer of TRUE or FALSE can be obtained by entering a formula such as =B6>B12. If the numbers found in the referenced cells are accurately represented, the answer TRUE is returned, otherwise FALSE is returned.

''Table 3: Comparative operators''

{| class="prettytable"
| '''''Operator'''''
| '''''Name'''''
| '''''Example'''''

|-
| <nowiki>= (equal sign)</nowiki>
| Equal
| A1=B1

|-
| > (Greater than)
| Greater than
| A1>B1

|-
| <nowiki>< (Less than)</nowiki>
| Less than
| <nowiki>A1<B1</nowiki>

|-
| >= (Greater than or equal to)
| Greater than or equal to
| A1>=B1

|-
| <nowiki><= (Less than or equal to)</nowiki>
| Less than or equal to
| <nowiki>A1<=B1</nowiki>

|-
| <nowiki><> (Inequality)</nowiki>
| Inequality
| <nowiki>A1<>B1</nowiki>

|}

=== Descriptive operators ===
Currency symbols are perhaps the most commonly used descriptive operators found in Calc. Calc handles as currency an amount like $0.97 or £0.97 entered into a cell formatted as general or currency. However, it does not handle other currency types entered in this fashion. For other currencies, it is best to format the cells as the specific currency type, such as Yen (¥). To do this, right-click on the affected cells and select Formatting Cells. On the tab Numbers tab, select Currency. In the Format list, select the appropriate currency type.

When entering amounts, it is not necessary to enter a currency symbol. Some currency symbols such as the Yen may not display.

[[Image:CG3Ch3F6.png|thumb|none|500px|''Currency symbols.'']]

{{Documentation/Caution| Users experienced in the use of an adding machine may experience difficulty with data entry, with resulting loss of data or incorrect results displaying. Adding machine users typically enter numbers from left to right without entering a decimal point. For example, the entry of 97 will display as 0.97. In cells formatted as currency, the entry of 97 will display currency for the locale selected such as $97 or £97, not $0.97 or £0.97.}}

=== Text operators ===
It is common for users to place text in spreadsheets. To provide for variability in what and how this type of data is displayed, text can be joined together in pieces coming from different places on the spreadsheet. Below is an example.

[[Image:CG3Ch3F7a.png]]

[[Image:CG3Ch3F7b.png]]

''Text Concatenation.''

In this example, specific pieces of the text were found in three different cells. To join these segments together, the formula also adds required spaces and punctuation housed within quotation marks resulting in a formula of <nowiki>=B6 & " " & C6 & ", " D6</nowiki>. The result is the concatenation into a correctly formatted date for this locale.

Taking this example further, the result cell is defined as a name, then text concatenation is performed using this defined name.

[[Image:CG3Ch3F8.png|thumb|none|500px|''Defining a name for a range of cells.'']]

[[Image:CG3Ch3F9.png|thumb|none|500px|''Naming a cell or range of cells for inclusion in a formula.'']]

[[Image:CG3Ch3F10a.png]]

[[Image:CG3Ch3F10b.png]]

[[Image:CG3Ch3F10c.png]]

''Defining Names on a worksheet.''

=== Reference operators ===
Reference operators merge the values held in each individual cell within the range. Reference operators can be an individual cell identified by the column identifier located along the upper edge of the spreadsheet and a numeric identifier found along the side of the spreadsheet. On spreadsheets read from left to right, the upper left cell is A1. The figure below shows these identifiers for Cell A1.

[[Image:CG3Ch3F11.png|thumb|none|500px|''The Cell Reference Operator.'']]

A range is also a reference operator referenced in formulas, functions and logical operators. The range for left to right operations refers to the upper left cell running to the right and downward to the right bottommost cell as shown below.

[[Image:CG3Ch3F12.png|thumb|none|500px|''Reference Operator for a range.'']]

In the upper left corner of the figure above, the range A1:D12 is shown, corresponding to the cells included in the drag operation with the mouse to highlight the range. This same range could also be created by entering in the Name Box directly as shown below. After pressing ''Enter'', the same range is selected.

[[Image:CG3Ch3F13.png|thumb|none|500px|''Direct entry of Reference Operator into Name Box.'']]

A reference operator can also be created by defining a named area by selecting the menu item '''Insert > Names > Define''', pressing ''Ctrl+F3'', or clicking the icon, if it shows on your toolbar.

Another reference operator involves the use of the '!' sign. If data appears in range A1:B6 as well as range B5:C12, using a formula such as SUM(A1:B6!B5:C12) will yield the sum of cells B5 and B6.

== Order of calculation ==
''Order of calculation'' refers to the sequence that numerical operations are performed. Division and multiplication are performed before addition or subtraction. There is a common tendency to expect calculations to be made from left to right as the equation would be read in English. Calc evaluations the entire formula, then based upon programming precedence breaks the formula down executing multiplication and division operations before other operations. Due to this fact when creating formulas you should test your formula to make sure that the correct result is being obtained. An example of order of calculation in operation follows.

''Table 4 – Order of Calculation''

{| class="prettytable"
| '''''Left To Right Calculation'''''
| '''''Ordered Calculation'''''

|-
| 1+3*2+3 = 11
| <nowiki>=1+3*2+3 result 10</nowiki>

|-
| 1+3=4, then 4 X 2 = 8, then 8 + 3 = 11
| 3*2=6, then 1 + 6 + 3 = 10

|-
| Another possible intention could be:
| The program resolves the multiplication of 3 X 2 before dealing with the numbers being added.

|-
| 1+3*2+3 = 20
|

|}

If you intend for the result to be either of the two possible solutions on the left, the way to achieve these results would be to order the formula as:

{| class="prettytable"
| ((1+3) * 2)+3 = 11
| (1+3) * (2+3) = 20

|}

{{Documentation/Note| Consider using parentheses grouping operations to avoid obtaining incorrect calculations, e.g. <nowiki>= B4+G12*C4/M12</nowiki> becoming <nowiki>=((B4+G12)*C4)/M12</nowiki>.}}

== Calculations linking sheets ==
Another powerful feature of Calc is the ability to link data through several worksheets. The naming of worksheets can be helpful to identify where specific data may be found. A name such a Payroll or Boise Sales is much more meaningful than Sheet1. The function named SHEET() returns the sheet number in the collection of spreadsheets. With this function, if you are currently on the third sheet counting from the left along the worksheet tabs, the number 3 is returned. If you drag the worksheets around to different locations among the tabs, the number will return the number referring to the current position of this worksheet.

{{Documentation/Caution| Users may experience a problem when creating a formula that references other worksheets. If you use the function <nowiki>SHEET()</nowiki> the number of the current worksheet appears even if you enter the name of the worksheet desired, e.g., <nowiki>=SHEET(Branch4)</nowiki> and you have as the top worksheet named CombinedOperations. This function only refers to the current or top worksheet and not to other worksheets found in the collection or file.}}

An example of calculations obtaining data from other work can be seen in a business setting where a business combines its branch operations into a single worksheet.

{| class="prettytable"
| [[Image:CG3Ch3F14a.png]]
| Sheet containing data for Branch 1.

|-
| [[Image:CG3Ch3F14b.png]]
| Sheet containing data for Branch 2.

|-
| [[Image:CG3Ch3F14c.png]]
| Sheet containing data for Branch 3.

|-
| [[Image:CG3Ch3F14d.png]]
| Sheet containing combined data for all branches.

|}
''Combining data from several sheets into a single sheet.''

To accomplish the links, it can be easier if the Function Wizard is used.

# Open the Function Wizard by clicking the f(x) button on the toolbar, or by selecting '''Insert > Function''', or by pressing ''Ctrl+F2''.
# Select a category of functions to shorten the list, then scroll down through the named functions and select the required one. When you select a function, its description appears on the right-hand side of the dialog. Double-click on the required function.
# The wizard now displays an area to the right where you can enter data manually in text boxes or click the '''Shrink''' button [[Image:]] to shrink the wizard so you can select the cells from the worksheet.
# To select cells, either click directly upon the needed cell or hold down the left mouse button and drag to select the needed area.
# When the area has been selected, click the '''Shrink''' button again to return to the wizard.
# If multiple ranges are needed, then select the next text box below the first and perform the same task for the next range. The wizard will accept in the Sum function up to 30 such ranges.

The following figures show how to create the combined sheet shown in the example above.

[[Image:CG3Ch3F15.png|thumb|none|500px|''Selecting the SUM function in the Function Wizard.'']]

[[Image:CG3Ch3F16.png|thumb|none|500px|''Further steps in selecting cells containing data.'']]

[[Image:CG3Ch3F17.png|thumb|none|500px|''Completed entries in Function Wizard.'']]

== Strategies for creating formulas ==
There are several broad approaches when making a decision to create a formula. In deciding on an approach, consider how many other people will need to use the worksheets, the life of the worksheets, and the variations that could be encountered from use.

=== Enter a unique formula in each cell ===
The first and most basic strategy is to view whatever formulas are needed as simple and with a limited use life. The strategy is then to place a unique formula in each appropriate cell.

=== Break formulas into parts and combine the parts ===
The second strategy is similar, but instead you break down longer formulas into smaller parts and then combine the parts into the whole.

Editor's note: This needs some explanation, but it is NOT about the "formula editor" (Math).

=== Use the Basic editor to create functions ===
A third strategy is to use the Basic editor and create your own functions. This approach would be used where the result would greatly simplify the use of the spreadsheet by the end user and keep the formulas simple with a better chance of avoiding errors. This approach also can make the maintenance easier by having corrections or updates kept in one central location. The use of macros is described in Chapter 12 of this book.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Formulas and Functions

2009-09-14T18:09:49Z

Kirk:

{{DISPLAYTITLE:Using Formulas and Functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Removing personal data
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Creating formulas
}}
This is Chapter '''7''' of the '''OpenOffice.org 3 Calc Guide''', produced by the [http://oooauthors.org/ OOoAuthors group].


==Formulas==

Up to now, we have been entering one of two basic types of data into each cell that we have been using, Numbers and Text. However, it is not always the case that we will know what the contents should be. Often what should be there is dependent on the contents of other cells. This is handled by a third type of data known as the formula. Formulas are equations using ''numbers'' and ''variables'' to get a result. In a spreadsheet, the ''variables'' are cell locations that hold the data needed for the equation to be completed.

==Using functions==

A ''function'' is a pre-defined calculation entered in a cell to help you analyze or manipulate data in a spreadsheet. All you have to do is add the arguments, and the calculation is automatically made for you. This helps to facilitate the creation of the formulas needed to get the results that you are looking for.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Formulas and Functions

2009-09-14T05:23:17Z

Kirk:

Documentation/OOo3 User Guides/Calc Guide/Functions and Formulas

2009-09-14T05:21:42Z

Kirk: moved Documentation/OOo3 User Guides/Calc Guide/Functions and Formulas to Documentation/OOo3 User Guides/Calc Guide/Formulas and Functions: Reflect better topic sequencing

#REDIRECT [[Documentation/OOo3 User Guides/Calc Guide/Formulas and Functions]]

Documentation/OOo3 User Guides/Calc Guide/Formulas and Functions

2009-09-14T05:21:42Z

Kirk: moved Documentation/OOo3 User Guides/Calc Guide/Functions and Formulas to Documentation/OOo3 User Guides/Calc Guide/Formulas and Functions: Reflect better topic sequencing

{{DISPLAYTITLE:Using Functions and Creating Formulas}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Removing personal data
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Using functions
}}
This is Chapter '''7''' of the '''OpenOffice.org 3 Calc Guide''', produced by the [http://oooauthors.org/ OOoAuthors group].


==Using functions==

A ''function'' is a pre-defined calculation entered in a cell to help you analyze or manipulate data in a spreadsheet. All you have to do is add the arguments, and the calculation is automatically made for you. Functions are the main reason for spreadsheets. If you understand functions, then you can start to use the real power of a spreadsheet.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide

2009-09-14T05:19:52Z

Kirk:

{{DISPLAYTITLE:Spreadsheets with OpenOffice.org 3.x Calc - DRAFT}}

This section contains the draft text of the user guide titled '''OpenOffice.org 3.x Calc Guide'''.

The sequence of chapters has changed since an earlier draft of this book. The list below shows the current sequence.

[[Documentation/OOo3_User_Guides/Calc Guide/Introducing Calc | Chapter 1 Introducing Calc]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Enter edit format | Chapter 2 Entering, Editing, and Formatting Data]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Charts and Graphs | Chapter 3 Creating Charts and Graphs]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Styles and Templates | Chapter 4 Using Styles and Templates]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Graphics in Calc | Chapter 5 Graphics in Calc]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Printing exporting emailing | Chapter 6 Printing, Exporting, and E-mailing]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Formulas and Functions | Chapter 7 Using Formulas and Functions]] 
[[Documentation/OOo3_User_Guides/Calc Guide/DataPilot | Chapter 8 DataPilot]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Data Analysis | Chapter 9 Data Analysis]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Linking Calc Data | Chapter 10 Linking Calc Data]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Sharing and Reviewing | Chapter 11 Sharing and Reviewing]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Calc Macros | Chapter 12 Calc Macros]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Calc as a Simple Database | Chapter 13 Calc as a Simple Database]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Customizing Calc | Chapter 14 Setting up and Customizing Calc]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Keyboard Shortcuts | Appendix A Keyboard Shortcuts]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Description of Functions | Appendix B Description of Functions]] 
[[Documentation/OOo3_User_Guides/Calc Guide/Calc Error Codes | Appendix C Calc Error Codes]]

Documentation/OOo3 User Guides/Calc Guide/Using functions

2009-09-14T05:08:02Z

Kirk: /* Understanding the structure of functions */

{{DISPLAYTITLE:Understanding functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Functions and Formulas
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Creating formulas
}}
Calc includes over 350 functions to help you analyze and reference data. Many of these functions are for use with numbers, but many others are used with dates and times, or even text. A function may be as simple as adding two numbers together, or finding the average of a list of numbers. Alternatively, it may be as complex as calculating the standard deviation of a sample, or a hyperbolic tangent of a number. See a list of all functions in '''[[Documentation/How_Tos/Calc: Functions listed by category|functions listed by category]]'''.

Typically, the name of a function is an abbreviated description of what the function does. For instance, the FV function gives the future value of an investment, while BIN2HEX converts a binary number to a hexadecimal number. By tradition, functions are entered entirely in upper case letters, although Calc will read them correctly if they are in lower or mixed case, too.

A few basic functions are somewhat similar to operators. Examples:
:"+", this operator will add two numbers together for a result. SUM() on the other hand will add a contiguous '''''range''''' of numbers together.
:"*", this operator will multiply to numbers together for a result. PRODUCT() does the same for multiplying, that SUM() does for adding.

Each function has a number of ''arguments'' used in the calculations. These arguments may or may not have their own name. Your task is to enter the arguments needed to run the function. In some cases, the arguments have pre-defined choices, and you may need to refer to the online help or Appendix B (Description of Functions) in this book to understand them. More often, however, an argument is a value that you enter manually, or one already entered in a cell or range of cells on the spreadsheet. In Calc, you can enter values from other cells by typing in their name or range, or—unlike the case in some spreadsheets—by selecting cells with the mouse. Should the values in the cells change, the result of the function will be automatically updated.

Strictly speaking, when all the arguments are entered and a function is ready to run, it becomes a ''formula''. These terms are sometimes used interchangeably, but the distinction is worth preserving, because a formula can use functions as an argument.

For compatibility, functions and their arguments in Calc have almost identical names to their counterparts in Microsoft Excel. However, both Excel and Calc have functions that the other lacks. Occasionally, too, functions with the same names in Calc and Excel have different arguments, or slightly different names for the same argument—neither of which can be imported to the other. However, perhaps nine-tenths of functions can be imported between Calc and Excel without any problems.

== Understanding the structure of functions ==
All functions have a similar structure. If you use the right tool for entering a function, you can escape learning this structure, but it is still worth knowing for troubleshooting.

To give a typical example, the structure of a function to find cells that match entered search criteria is:

<nowiki>= DCOUNT (Database;Database field;Search_criteria)</nowiki>

By convention, only three kinds of data can be entered in a cell. Text, Numbers, and Formulas. To distinguish Formulas from Text, it is necessary to always start a formula with an "=" sign. Since a function cannot exist on its' own, it must always be part of a formula. Consequently, even if the function represents the entire formula, there must be an "=" sign at the start of the formula. Regardless of where in the formula a function is, the Function will start with the function's name, DCOUNT in the above. After the name of the function comes its arguments. All arguments are required, unless specifically listed as optional.

Arguments are added within the brackets (parentheses) and separated by semicolons, with no space between the arguments and the semicolons. Many arguments are a number. A Calc function can take up to thirty numbers as an argument. That may not sound like much at first. However, when you realize that the number can be not only a number or a single cell, but also an array or range of cells that contain several or even hundreds of cells, then the apparent limitation vanishes.

Depending on the nature of the function arguments may be entered as follow:

:{|Border="1"
|"text data"||The quotes establish that text or string data has been entered
|-
|9||In this case the number nine has been entered as a number
|-
|"9"||In this case the number nine is being entered as text
|-
|A1|| The address for whatever is in Cell A1 is being entered
|}

== Advanced structure ==
As well as being used on its own, a function can be an argument in a larger formula. A formula, however, is limited by the fact that it can only do one function at a time. You need to make sure that functions are done in the right order if the formula is going to work.

To help set the order for functions in a multiple-function formula, you use parentheses within parentheses. When the formula is run, Calc does the innermost function first, then works outwards. For example, in the simple calculation <nowiki>=2+(5*7)</nowiki>, Calc multiples 5 by 7 first. Only then is 2 added to the result to get 37.

The placement of functions within sets of parentheses is called ''nesting''. Basically, nesting reduces a function that could run on its own to an argument in the formula. For example, in =2+(5*7), the formula (5*7) is nested within the larger formula of =2+(5*7). In other words, the nested function becomes an argument of another function.

This relation is more obvious when doing a calculation using a function with a name. For all purposes,

<nowiki>=SUM(2;PRODUCT(5;7))</nowiki>

is the same formula as <nowiki>=2+(5*7)</nowiki>. However, when SUM and PRODUCT are used, then the relation is clearer. The fact that the PRODUCT function comes after a semicolon and in a set of parentheses for the SUM function makes it clear that PRODUCT is an argument for SUM. In addition, the fact that the inner pair of parentheses is around (5;7) makes clear that this operation is done before the one defined by the outer pair of parentheses.

To get an idea of what nested functions can do, imagine that you are designing a self-directed learning module. During the module, students do three quizzes, and enter the results in cells A1, A2, and A3. In A4, you can create a nested formula that begins by averaging the results of the quizzes with the formula <nowiki>=AVERAGE(A1:A3)</nowiki>. The formula then uses the IF function to give the student feedback that depends upon the average grade on the quizzes. The entire formula would read:

<nowiki>=IF(AVERAGE(A1:A3) >85; "Congratulations! You are ready to advance to the next module";
"Failed. Please review the material again. If necessary, contact your instructor for help")</nowiki>

Depending on the average, the student would receive the message for either congratulations or failure.

Notice that the nested formula for the average does not require its own equal sign. The one at the start of the equation is enough for both formulas.

If you are new to spreadsheets, the best way to think of functions is as a scripting language. We've used simple examples to explain more clearly, but, through nesting of functions, a Calc formula can quickly become complex.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

Documentation/OOo3 User Guides/Calc Guide/Using functions

2009-09-14T04:32:40Z

Kirk: Fixed paragraph comparing functions with existing operators.

{{DISPLAYTITLE:Understanding functions}}
{{Documentation/CG3Ch3TOC
|ShowPrevNext=block
|PrevPage=Documentation/OOo3_User_Guides/Calc Guide/Functions and Formulas
|NextPage=Documentation/OOo3_User_Guides/Calc Guide/Creating formulas
}}
Calc includes over 350 functions to help you analyze and reference data. Many of these functions are for use with numbers, but many others are used with dates and times, or even text. A function may be as simple as adding two numbers together, or finding the average of a list of numbers. Alternatively, it may be as complex as calculating the standard deviation of a sample, or a hyperbolic tangent of a number. See a list of all functions in '''[[Documentation/How_Tos/Calc: Functions listed by category|functions listed by category]]'''.

Typically, the name of a function is an abbreviated description of what the function does. For instance, the FV function gives the future value of an investment, while BIN2HEX converts a binary number to a hexadecimal number. By tradition, functions are entered entirely in upper case letters, although Calc will read them correctly if they are in lower or mixed case, too.

A few basic functions are somewhat similar to operators. Examples:
:"+", this operator will add two numbers together for a result. SUM() on the other hand will add a contiguous '''''range''''' of numbers together.
:"*", this operator will multiply to numbers together for a result. PRODUCT() does the same for multiplying, that SUM() does for adding.

Each function has a number of ''arguments'' used in the calculations. These arguments may or may not have their own name. Your task is to enter the arguments needed to run the function. In some cases, the arguments have pre-defined choices, and you may need to refer to the online help or Appendix B (Description of Functions) in this book to understand them. More often, however, an argument is a value that you enter manually, or one already entered in a cell or range of cells on the spreadsheet. In Calc, you can enter values from other cells by typing in their name or range, or—unlike the case in some spreadsheets—by selecting cells with the mouse. Should the values in the cells change, the result of the function will be automatically updated.

Strictly speaking, when all the arguments are entered and a function is ready to run, it becomes a ''formula''. These terms are sometimes used interchangeably, but the distinction is worth preserving, because a formula can use functions as an argument.

For compatibility, functions and their arguments in Calc have almost identical names to their counterparts in Microsoft Excel. However, both Excel and Calc have functions that the other lacks. Occasionally, too, functions with the same names in Calc and Excel have different arguments, or slightly different names for the same argument—neither of which can be imported to the other. However, perhaps nine-tenths of functions can be imported between Calc and Excel without any problems.

== Understanding the structure of functions ==
Except for simple functions such as + or *, all functions have a similar structure. If you use the right tool for entering a function, you can escape learning this structure, but it is still worth knowing for troubleshooting.

To give a typical example, the structure of a function to find cells that match entered search criteria is:

<nowiki>= DCOUNT (Database;Database field;Search_criteria)</nowiki>

Like most functions, this one starts with an equal sign. It is followed by DCOUNT, the name of the function. After the name of the function comes its arguments. All arguments are required, unless specifically listed as optional.

Arguments are added within the brackets (parentheses) and separated by semicolons, with no space between the arguments and the semicolons. Many arguments are a number. A Calc function can take up to thirty numbers as an argument. That may not sound like much at first. However, when you realize that the number can be not only a number or a single cell, but also an array or range of cells that contain several or even hundreds of cells, then the apparent limitation vanishes.

Other arguments may be a column label, a mathematical constant, or a value unique to that function.

Depending on the function, arguments may have to be entered with straight quotation marks. However, this requirement is not consistent. Otherwise similar formulas may differ only in this requirement, and no simple rule tells you which is which. You simply have to know or check the requirements in the online help.

The only exception to these structural rules are basic arithmetical functions entered with symbols. For example, instead of entering <nowiki>=SUM(2;3)</nowiki>, you can enter <nowiki>=2+3</nowiki>.

== Advanced structure ==
As well as being used on its own, a function can be an argument in a larger formula. A formula, however, is limited by the fact that it can only do one function at a time. You need to make sure that functions are done in the right order if the formula is going to work.

To help set the order for functions in a multiple-function formula, you use parentheses within parentheses. When the formula is run, Calc does the innermost function first, then works outwards. For example, in the simple calculation <nowiki>=2+(5*7)</nowiki>, Calc multiples 5 by 7 first. Only then is 2 added to the result to get 37.

The placement of functions within sets of parentheses is called ''nesting''. Basically, nesting reduces a function that could run on its own to an argument in the formula. For example, in =2+(5*7), the formula (5*7) is nested within the larger formula of =2+(5*7). In other words, the nested function becomes an argument of another function.

This relation is more obvious when doing a calculation using a function with a name. For all purposes,

<nowiki>=SUM(2;PRODUCT(5;7))</nowiki>

is the same formula as <nowiki>=2+(5*7)</nowiki>. However, when SUM and PRODUCT are used, then the relation is clearer. The fact that the PRODUCT function comes after a semicolon and in a set of parentheses for the SUM function makes it clear that PRODUCT is an argument for SUM. In addition, the fact that the inner pair of parentheses is around (5;7) makes clear that this operation is done before the one defined by the outer pair of parentheses.

To get an idea of what nested functions can do, imagine that you are designing a self-directed learning module. During the module, students do three quizzes, and enter the results in cells A1, A2, and A3. In A4, you can create a nested formula that begins by averaging the results of the quizzes with the formula <nowiki>=AVERAGE(A1:A3)</nowiki>. The formula then uses the IF function to give the student feedback that depends upon the average grade on the quizzes. The entire formula would read:

<nowiki>=IF(AVERAGE(A1:A3) >85; "Congratulations! You are ready to advance to the next module";
"Failed. Please review the material again. If necessary, contact your instructor for help")</nowiki>

Depending on the average, the student would receive the message for either congratulations or failure.

Notice that the nested formula for the average does not require its own equal sign. The one at the start of the equation is enough for both formulas.

If you are new to spreadsheets, the best way to think of functions is as a scripting language. We've used simple examples to explain more clearly, but, through nesting of functions, a Calc formula can quickly become complex.

{{CCBY}}
[[Category: Calc Guide (Documentation)]]

API/Samples/Java/Database/TableStructure(SDBCX)

2009-08-17T04:54:37Z

Kirk:

== Table Structure (extended) ==
Beside the database meta data interface, the interfaces in the namespace com.sun.star.sdbcx.* supports a different more objective orientated way on looking at the database.

<source lang="java">
public void displayTableProperties() throws com.sun.star.uno.Exception
{
// the variable xTabSup is a XTablesSupplier which you get from the XDriver in conjunction with the connection
XNameAccess xTables = xTabSup.getTables();
String[] aTableNames = xTables.getElementNames();
if ( 0 != aTableNames.length )
{
Object table = xTables.getByName(aTableNames[0]);
XPropertySet xProp = (XPropertySet) UnoRuntime.queryInterface(XPropertySet.class, table);
System.out.println("Name: " + xProp.getPropertyValue(NAME));
System.out.println("CatalogName: " + xProp.getPropertyValue("CatalogName"));
System.out.println("SchemaName: " + xProp.getPropertyValue("SchemaName"));
System.out.println("Description: " + xProp.getPropertyValue("Description"));
// the following property is optional so we first must check if it exists
if ( xProp.getPropertySetInfo().hasPropertyByName(TYPE) )
{
System.out.println("Type: " + xProp.getPropertyValue(TYPE));
}
System.out.println("Columns:");
XColumnsSupplier columnsSupplier = (XColumnsSupplier) UnoRuntime.queryInterface(XColumnsSupplier.class, table);
printColumns(columnsSupplier);
System.out.println("Keys:");
printKeys(columnsSupplier);
}
}
//###########################################################
// 15. example
// print all columns of a XColumnsSupplier
//###########################################################
public static void printColumns(final XColumnsSupplier xColumnsSup) throws com.sun.star.uno.Exception, SQLException
{
System.out.println("Example printColumns");
// the table must be at least support a XColumnsSupplier interface
System.out.println("--- Columns ---");
XNameAccess xColumns = xColumnsSup.getColumns();
String[] aColumnNames = xColumns.getElementNames();
for ( int i = 0; i <= aColumnNames.length - 1; i++ )
{
System.out.println(" " + aColumnNames[i]);
}
}
//###########################################################
// 16. example
// print all keys inclusive the columns of a key
//###########################################################

public static void printKeys(final XColumnsSupplier xColumnsSup) throws com.sun.star.uno.Exception, SQLException
{
System.out.println("Example printKeys");
XKeysSupplier xKeysSup = (XKeysSupplier) UnoRuntime.queryInterface(XKeysSupplier.class, xColumnsSup);
if ( xKeysSup != null )
{
System.out.println("--- Keys ---");
XIndexAccess xKeys = xKeysSup.getKeys();
for ( int i = 0; i < xKeys.getCount(); i++ )
{
Object key = xKeys.getByIndex(i);
XPropertySet xProp = (XPropertySet) UnoRuntime.queryInterface(XPropertySet.class, key);
System.out.println(" " + xProp.getPropertyValue(NAME));
XColumnsSupplier xKeyColumnsSup = (XColumnsSupplier) UnoRuntime.queryInterface(XColumnsSupplier.class, xProp);
printColumns(xKeyColumnsSup);
}
}
}
</source>

[[category:API]]