Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Following these guidelines whenever possible will improve the interoperability across openIMIS contributors and partner projects, including other GIZ projects.  The goal for these guidelines is to provide a pragmatic approach in order to create an impact across the openIMIS open systems. Fully switching to open source is not likely or practical for many organisations and this guide provides best practises.

In a world where paper documents increasingly get replaced by electronic records, long term access to the data becomes critical. This is especially the case for legal contracts and government documents that stay valid and relevant over decades, or even longer. GIZ is also facing this challenge.

Info

These guides are to be used as recommendations and inspiration as opposed to rules of thumb. If you have questions or are not sure about something, the best thing to do is file an issue on our Jira Service Desk to start a conversation with other openIMIS contributors.


Open Formats

Why open formats?

In a world where paper documents increasingly get replaced by electronic records, long term access to the data becomes critical. This is especially the case for legal contracts and government documents that stay valid and relevant over decades, or even longer. GIZ is also facing this challenge. 

...

What are open formats?

Just as paper and pens have been available from multiple manufacturers and vendors , document file formats and the applications creating these file formats need to be supported by and available from multiple vendors. This guarantees long-term access to data, even if companies disappear, change their strategies or dramatically change their prices. The formats in which information is published can either be “open” or “closed”. Open format means the software and format are available to anyone, free of charge, and available for people to build into their own software and products without limitation set by intellectual property rights. Developers can use these to produce multiple software packages, services, and products by using these formats. 

...

The openIMIS project will be primarily focussed focused on image and text documentation purposes. This includes branding assets, marketing material, and communication kits. Vector files should always be stored as .svg instead of the proprietary .ai (limited to being used only in Adobe Illustrator). In this case, .svg is the open format that can easily be read and modified without vendor lock-in or being inaccessible due to license losses. As it is at its essence a version of XML, it can be modified without even using a GUI application such as Inkscape.

...

Creative Commons is not an appropriate license for software code. It is a better fit for creative assets (like images or audio) used in software projects. If you are still not 100 percent sure which license you want to use, you can use the Creative Commons tool.

There are several types of Creative Commons Licenses such as:

...

This license is the most restrictive, only allowing others to download your works and share them with others as long as they credit you, but they can't change them in any way or use them commercially.If you are still not 100 percent sure which license you want to use, you can use the Creative Commons tool.

Best licensing practices for openIMIS content

...

It is integrated with the advanced graphics capabilities of LibreOffice Draw and Math components. Slideshows can be further enhanced using Fontwork special effects texts, as well as sound and video clips. Impress is compatible with Microsoft PowerPoint file format and can also save your work in numerous graphics formats, including Macromedia Flash (SWF).

Info

Please refrain from using SmartGraphics in PowerPoint documents. They have limited compatibility with LibreOffice file formats and require troubleshooting to fix.

Confluence

Software Code

Open Source

Platform

Linux, Windows, macOS

Recommended Project Formats

.md

Recommended Export Formats

.md, .odt, .docx,

...