bin/README | 9 ++++++ distro-configs/README | 14 ++++++++++ icon-themes/README | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ icon-themes/README.txt | 45 --------------------------------- rsc/README | 38 ++++++++++++++++++++++------ scaddins/README | 4 ++ 6 files changed, 123 insertions(+), 53 deletions(-)
New commits: commit 1f63bd653cad40ec1d6aa111cc66959a93d120ce Author: Michael Meeks <michael.me...@suse.com> Date: Wed Feb 8 11:17:22 2012 +0000 Add and expand more readme files for module documentation diff --git a/bin/README b/bin/README new file mode 100644 index 0000000..72dbdcd --- /dev/null +++ b/bin/README @@ -0,0 +1,9 @@ +Tools and scripts used during the build + +This direction has a number of key pieces that are used during the +build, or are simply generally useful. One example is + +bin/find-german-comments <directory> + +which will try to detect and extract all the German comments in a +given source code hireachy / directory. \ No newline at end of file diff --git a/distro-configs/README b/distro-configs/README new file mode 100644 index 0000000..f22328f --- /dev/null +++ b/distro-configs/README @@ -0,0 +1,14 @@ +Pre-canned distribution / platform configurations + +When the software is configured for a platform, since we run on so +many platforms, detecting the best sequence of configure options to +get it building is hard. + +Instead we have a text file containing the recommended (often the +distributed) version of these parameters, one per distribution or +significant platform. These are interpreted by autogen.sh and +eventually end up passed to configure. Thus: + +./autogen.sh --with-distro=LibreOfficeAndroid + +might build a version tweaked for Android. diff --git a/icon-themes/README b/icon-themes/README new file mode 100644 index 0000000..7655710 --- /dev/null +++ b/icon-themes/README @@ -0,0 +1,66 @@ +Icon repository for the applications + +All of the icons, separated by themes are included in this +directory. These icons are built into .zip files, and re-ordered / +packed for efficiency reasons based on our UI configuration by the +packimages/ module. + +An icon theme does not need to contain all images, since these can be +layered one on top of another. + +In general the layering is done like this: + +<leaf theme> +tango +industrial +galaxy + +The classic theme is left primarily for historical interest, rather +than intended to be packaged. + + +How to add a new image set: +--------------------------- + +- Create a directory for it here (let's call it e.g. new_set) + +- Add its images_ name to CUSTOM_IMAGE_SETS in + postprocess/packimages/pack/makefile.mk + +- Add its gid to the Files section of gid_Module_Root_Brand in + scp2/source/ooo/module_hidden_ooo.scp and add a corresponding File entry + to scp2/source/ooo/file_ooo.scp (see for example + gid_Brand_File_ImagesCrystal_Zip) + +- Add a vcl constant for it in vcl/inc/settings.hxx, e.g. + #define STYLE_SYMBOLS_NEW_SET ((ULONG)5) + +- Map the vcl constant to its real name in + ::rtl::OUString StyleSettings::GetCurrentSymbolsStyleName() const + and + ULONG StyleSettings::ImplNameToSymbolsStyle( const ::rtl::OUString &rName ) const + both in vcl/source/app/settings.cxx, e.g. + case STYLE_SYMBOLS_NEW_SET: return ::rtl::OUString::createFromAscii( "new_set" ); + and + else if ( rName == ::rtl::OUString::createFromAscii( "new_set" ) ) + return STYLE_SYMBOLS_NEW_SET; + +- Add localized item names to 'ListBox LB_ICONSTYLE' to + 'StringList [ de ]' + and 'StringList [ en-US ]', e.g. + < "New set" ; > ; + both in cui/source/options/optgdlg.src + +- Add all known localizations of the new item to svx/source/dialog/localize.sdf, e.g. + svx source\dialog\optgdlg.src 0 stringlist OFA_TP_VIEW.LB_ICONSTYLE 6 0 cs New set 2002-02-02 02:02:02 + the check box item will not be visible in the other localizations otherwise, see http://www.openoffice.org/issues/show_bug.cgi?id=74982 + +- Add the new_set to 'SymbolsStyle' property + in officecfg/registry/schema/org/openoffice/Office/Common.xcs. + +- The default theme for various desktops (KDE, GNOME, ...) is defined in + ULONG StyleSettings::GetCurrentSymbolsStyle() const in + vcl/source/app/settings.cxx + +- The fallback for particular icons is defined in + postprocess/packimages/pack/makefile.mk diff --git a/icon-themes/README.txt b/icon-themes/README.txt deleted file mode 100644 index e6514d8..0000000 --- a/icon-themes/README.txt +++ /dev/null @@ -1,45 +0,0 @@ -How to add a new image set: ---------------------------- - -- Create a directory for it here (let's call it e.g. new_set) - -- Add its images_ name to CUSTOM_IMAGE_SETS in - postprocess/packimages/pack/makefile.mk - -- Add its gid to the Files section of gid_Module_Root_Brand in - scp2/source/ooo/module_hidden_ooo.scp and add a corresponding File entry - to scp2/source/ooo/file_ooo.scp (see for example - gid_Brand_File_ImagesCrystal_Zip) - -- Add a vcl constant for it in vcl/inc/settings.hxx, e.g. - #define STYLE_SYMBOLS_NEW_SET ((ULONG)5) - -- Map the vcl constant to its real name in - ::rtl::OUString StyleSettings::GetCurrentSymbolsStyleName() const - and - ULONG StyleSettings::ImplNameToSymbolsStyle( const ::rtl::OUString &rName ) const - both in vcl/source/app/settings.cxx, e.g. - case STYLE_SYMBOLS_NEW_SET: return ::rtl::OUString::createFromAscii( "new_set" ); - and - else if ( rName == ::rtl::OUString::createFromAscii( "new_set" ) ) - return STYLE_SYMBOLS_NEW_SET; - -- Add localized item names to 'ListBox LB_ICONSTYLE' to - 'StringList [ de ]' - and 'StringList [ en-US ]', e.g. - < "New set" ; > ; - both in cui/source/options/optgdlg.src - -- Add all known localizations of the new item to svx/source/dialog/localize.sdf, e.g. - svx source\dialog\optgdlg.src 0 stringlist OFA_TP_VIEW.LB_ICONSTYLE 6 0 cs New set 2002-02-02 02:02:02 - the check box item will not be visible in the other localizations otherwise, see http://www.openoffice.org/issues/show_bug.cgi?id=74982 - -- Add the new_set to 'SymbolsStyle' property - in officecfg/registry/schema/org/openoffice/Office/Common.xcs. - -- The default theme for various desktops (KDE, GNOME, ...) is defined in - ULONG StyleSettings::GetCurrentSymbolsStyle() const in - vcl/source/app/settings.cxx - -- The fallback for particular icons is defined in - postprocess/packimages/pack/makefile.mk diff --git a/rsc/README b/rsc/README index 09e2cd5..ed940f7 100644 --- a/rsc/README +++ b/rsc/README @@ -1,10 +1,32 @@ Resource Compiler. -There is some German documentation about it in a subdirectory called [git:rsc/doku]. -Seems to be very old (January 1992). - -From rsc.sdw (in German): -The StarView Resource Compiler (rsc) is used, to convert the system-independent -resources in the description files to native description files which in turn are -compiled efficiently (runtime) by the system's native resource compiler in binary -resources. +This compiler converts .src files and .hrc equivalents into binary +.res files. The basic idea is that this provides a map between +integer identifiers and the resources: string, pixmap (only the +file-name), and VCL control properties. + +In more detail: + +Typically we would have a .hrc file with entries like this: + +#define SID_STR_FOO 1234 + +And then a .src file with some entries like this: + +String SID_STR_FOO +{ + Text [ en-US ] = "Foo !" ; +}; + +This is compiled into a binary resource file, we have many of these +which live in program/resource/ and then tends to get used in the code +thus: + +String aStr( ResId( SID_STR_FOO ) ); + +It is important to note that any appearance of hierarchical structure +in the .src files is in fact a mirage. The file is compiled at root +into a plain map<integer,resource>. + +There is some German documentation about it in a subdirectory called +[git:rsc/doku]. Seems to be very old (January 1992). diff --git a/scaddins/README b/scaddins/README index b27348c..3ad6de6 100644 --- a/scaddins/README +++ b/scaddins/README @@ -1,4 +1,8 @@ Extra functions for calc. +These provide UNO components that implement more exotic calc +functions. If you want to do the same, here can be a good place to +start. + See also: [http://wiki.services.openoffice.org/wiki/Scaddins] _______________________________________________ Libreoffice-commits mailing list Libreoffice-commits@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/libreoffice-commits