Versions Compared

Key

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

...

Open Source is a form of licensing agreement that allows users to freely modify an existing project, generate a new project, or even derive a larger project from an existing one, enhancing the original work. Works which use these licenses are often made collaboratively, and over time a culture of practices and norms have developed to facilitate this process. At its best, this Open Source culture enables the equal exchange of ideas within a community to harness group creativity, ease of use, and flexibility.  Open Source software is typically free of charge, and often so too is support, provided on a community-driven and best effort basis. Using (as opposed to making) Open Source software often incurs a lower total cost of ownership than its closed source and proprietary alternatives.

At GIZ and openIMIS, our diverse network of partners and collaborators demands that we work with a variety of software tools and platforms. This diversity can result in incompatible standards and licenses being used, causing compatibility issues when working across different groups. This manual provides best practices for reducing friction and avoiding incompatibilities during collaboration, drawn from our experience at openIMIS. This guide also understands the advantages of using proprietary solutions such as those provided by Microsoft and Adobe, and describes working compromises which minimize inconvenience and disruption. In places we recommend the use of desktop applications for creating documents and assets, while providing web-based alternatives in case installing local software is not possible. We prioritise widely supported standardised data formats throughout.

The goal for these guidelines is to provide a pragmatic approach in order to enable collaborators to easily work together on and with design elements create an impact collaboration across the openIMIS ecosystem. In addition, following these guidelines will improve the interoperability across openIMIS contributors and partner projects, including other GIZ projects. 

Info

These guidelines are intended to be used as recommendations and inspiration as opposed to fixed requirements. 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.

...

In a world where paper documents are being rapidly supplanted 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. GIZ is also facing this challenge. Just as pens and pencils are available from many manufacturers and vendors , document file formats and the applications which use them need to be supported by and available from multiple vendors. This guarantees long-term access to data, even if individual vendor companies disappear, change strategy, or dramatically change their prices. The digital format in which information is stored can either be “open” or “closed”. An Open Standard is one which is available for everyone to use, free of charge, and capable of being built upon – for example into new software products, without any limitations. Developers can use these to produce multiple software packages, services, and products by using these formats. 

...

There is no standardized process for converting proprietary formats to Open Standards. It always depends on the complexity of the format and the files, and varies from format to format. For example, converting a file from .ai to .svg using Adobe Illustrator may be as easy as exporting as .svg from the software, but sometimes something can go wrong in the process, which may go undetected until the results are closely inspected. These edge cases are the hardest ones to work around – usually an error in an .ai to .svg conversation may require rewriting or recreating the assets and then export them as .svg to ensure maximum compatibility.

...

Creating design assets for openIMIS

There are many downloadable tools and online platforms which can help you to convert Open Standards. In this section, we will present some ways to convert Open Standards in desktop software, online platforms, and finally in a command line.

LibreOffice

...

Software Code

...

Open Source

...

Platform

...

Linux, Windows, macOS

While using LibreOffice, you can convert files manually by using the Save As option and choosing the format. You can also convert files directly in the command line.

You can run LibreOffice from the command line to quickly convert one or more files. For example, to transform a LibreOffice Impress slide deck to PDF, you'd type the following:

Code Block
soffice --headless --convert-to pdf mySlides.odp

Replace pdf with the file extension of the format that you want to convert your file to, if something other than PDF is desired. The --headless option means LibreOffice will run only on the command line and exit after completing the requested task.

Turning to the command line is a great way to convert several files at once. If, for example, you want to convert all of the Microsoft Word documents in a folder to the Open Document Text format (used by LibreOffice Writer and many others) then you'd type:

Code Block
soffice --headless --convert-to odt *.docx

The conversion takes far less time than opening all files in LibreOffice Writer and doing the file format conversion manually.

Info

This section focuses on the conversion feature of the LibreOffice suite in general. In the following chapters, LibreOffice Draw, Writer and Impress are specifically mentioned for the relevant document file formats they are commonly used for.

Pandoc

...

Software Code

...

Open Source

...

Platform

...

Linux, Windows, macOS

Pandoc is a software tool that allows you to convert various text markup files. It supports (among other) .pdf, .docs, and .odt. It offers a detailed guide with instructions for you to follow for installation and use.

You're not just limited to straight conversions. You can, for example, add a table of contents, typographic quotes, custom headers, and syntax highlighting to the resulting file. Take a look at Pandoc's documentation for details and the Open Standards it allows you to convert.

Zamzar

...

Software Code

...

Proprietary

...

Platform

...

Online Browser

Zamzar is an online file conversion platform that lets you convert documents, images, videos, sound, and many more Open Standards. As you are not required to install it, you can use it from any browser, even mobile.

Info

Note: We cannot endorse the use of third party tools that are not independently audited. Use at your own risk.

BatchPhoto Espresso

...

Software Code

...

Proprietary

...

Platform

...

Online Browser

BatchPhoto Espresso is another free online image converter, which means you don't need to download any software to use it.

After uploading an image, BatchPhoto lets you choose another format to convert it into, resize, crop, and rotate it, as well as add special effects like gray scale conversion and swirl, overlay text, and adjust brightness, contrast, and sharpness, among other basic edits.

BatchPhoto Espresso also lets you rename the picture and choose a quality and size before saving it to your device. It can be used on any operating system that supports a web browser, including Windows, Linux, and macOS.

Info

Note: We cannot endorse the use of third party tools that are not independently audited. Use at your own risk.

Licensing

When you create a piece of software, in most countries it's automatically protected by copyright. This means that all rights to your work are protected by copright, and nobody else may reproduce, distribute, or create derivative works from your work without permission from the copyright holder.

This disables others from using your work, and may lead to nobody using your work, which may defeat the purpose of sharing it. If you want to share your work, but also want to retain some degree of control, then it's important to choose a suitable license which grants certain rights but not others.

Creative Commons Licenses

The Creative Commons is a family of licenses first created by Stanford law professor Lawrence Lessig to encourage creative people to offer up their creative works for others to legally build upon and share, including text, music, pictures, and video.

Creative Commons licenses are standardised, easy-to-understand, copyright licenses which allow creators of content to communicate which rights they reserve and which rights they give away for the benefit of others. Creative Commons licenses build upon, rather than replace, copyright. They mean you don't have to negotiate individually over specific rights for works you produce, and have been tested in court. Crucially, the licenses were designed specifically to work over the internet, so that content that is offered under the terms of the Creative Commons is easy to search for, discover, and use. Around 500 million works have been licensed under Creative Commons since it launched.

Creative Commons is not an appropriate license for software code. It is a better fit for creative assets (like images and audio) used in software projects. The Creative Commons tool provides convenient advice on which Creative Commons license to choose.

There are several types of Creative Commons Licenses such as:

Attribution (CC BY)

This lets other people distribute, remix, and build upon your work – even commercially – as long as they credit you. This is the most flexible of licenses.

Attribution-ShareAlike (CC BY-SA)

This lets other people distribute, remix and build upon your work – even commercially – as long as they credit you and license their new creations under the same terms. All new works based on yours will therefore have the same license. This is the license used by Wikipedia.

Attribution-NoDerivs (CC BY-ND)

This license allows for redistribution, commercial and non-commercial, as long as it is not changed and is credited to you.

Attribution-NonCommercial (CC BY-NC)

This lets other people distribute, remix, and build upon your work as long as they credit you and don't use it for commercial projects – this means it cannot be sold or used for profit. The creator has to attribute you to the original work, they don't have to license the works that they created based on yours with the same terms.

Attribution-NonCommercial-ShareAlike (CC BY-NC-SA)

This lets other people distribute, remix and build upon your work as long as they credit you and don't use it for commercial projects. They also have to license their new creations under identical terms.

Attribution-NonCommercial-NoDerivs (CC BY-NC-ND)

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.

Best licensing practices for openIMIS content

For content (including graphics, video, audio, and similar creative assets) we use the Creative Commons Attribution-ShareAlike 4.0 International License. That ensures openIMIS assets can be remixed by other users and creators, yet openIMIS is credited and work that is based on our assets need to have the same license (so that others may benefit from the same freedoms in future).

Info

For more details and questions on other licensing (such as software code) you can visit the License page on the openIMIS wiki.

Creating design assets for openIMIS

There are lots of tools available to create visual assets (graphics) for any need. While the current industry standard is Adobe Creative Cloud, openIMIS tries to keep proprietary software and standards to a minimum. When this was not possible or difficult, the minimum we aim for are Open Standards. In the following, we will go through recommended tools, the various file formats they support, and limitations they pose in different conversion settings.

Recommended project formats are file formats we suggest to use as source files for assets, while recommended export formats are those we suggest for file outputs

GIMP

...

Software Code

...

Open Source

...

Platform

...

Linux, Windows, macOS

...

Recommended Project Formats

...

.XCF

...

Recommended Export Formats

...

.JPG, .PNG

GIMP is a free and open-source graphics editor used for image retouching and editing, free-form drawing, converting between different image formats, and more specialized tasks. GIMP can be used for opening and changing many types of file formats. GIMP is released under GPLv3+ licenses and is available for Linux, macOS, and Microsoft Windows. It further offers a Wiki page where it gives explanations and detailed information as to how to use and understand the product.

GIMP is an alternative to Adobe Photoshop, recommended for creation of raster (non-vector) graphics It outputs Open Standard files, it's extensible, flexible, and easy to use. The latest version of GIMP provides several new features with an easier-to-use user interface.

Info

GIMP can also open and work with .psd (Adobe Photoshop files), but with a reduced feature set and less-than-ideal end results. GIMP may not preserve all text information or layer styles but if you have no access to Photoshop it might be a good enough solution. We recommend outputting to .xcf (GIMP files) so they can be shared and reused easily in the future.

Inkscape

...

Software Code

...

Open Source

...

Platform

lots of tools available to create visual assets (graphics) for any need. While the current industry standard is Adobe Creative Cloud, openIMIS tries to keep proprietary software and standards to a minimum. When this was not possible or difficult, the minimum we aim for are Open Standards. In the following, we will go through recommended tools, the various file formats they support, and limitations they pose in different conversion settings.

Recommended project formats are file formats we suggest to use as source files for assets, while recommended export formats are those we suggest for file outputs

GIMP

Software Code

Open Source

Platform

Linux, Windows, macOS

Recommended Project Formats

.XCF

Recommended Export Formats

.JPG, .PNG

GIMP is a free and open-source graphics editor used for image retouching and editing, free-form drawing, converting between different image formats, and more specialized tasks. GIMP can be used for opening and changing many types of file formats. GIMP is released under GPLv3+ licenses and is available for Linux, macOS, and Microsoft Windows. It further offers a Wiki page where it gives explanations and detailed information as to how to use and understand the product.

GIMP is an alternative to Adobe Photoshop, recommended for creation of raster (non-vector) graphics It outputs Open Standard files, it's extensible, flexible, and easy to use. The latest version of GIMP provides several new features with an easier-to-use user interface.

Info

GIMP can also open and work with .psd (Adobe Photoshop files), but with a reduced feature set and less-than-ideal end results. GIMP may not preserve all text information or layer styles but if you have no access to Photoshop it might be a good enough solution. We recommend outputting to .xcf (GIMP files) so they can be shared and reused easily in the future.

Inkscape

Software Code

Open Source

Platform

Linux, Windows, macOS

Recommended Project Formats

.SVG (Inkscape SVG)

Recommended Export Formats

.SVG (plain SVG), .JPG, .PNG, .PDF

Inkscape is a free and open-source vector graphics editor. This multi-platform application can be used to create and edit vector graphics such as illustrations, diagrams, line arts, charts, logos, icons, and complex paintings. Inkscape's primary vector graphics format is the Open Standard Scalable Vector Graphics (SVG); however, many other formats can be imported and exported. It is licensed under the General Public License (GPL).

Inkscape is an open alternative to Adobe Illustrator and recommend for creation of vector graphics for the openIMIS project. It can output SVG files and PNG raster graphics. The interface is relatively self-explanatory; almost everything is accessible from a single drop-down menu or icon.

This is going to be the software that openIMIS will use the most to create digital assets, as its a well-supported project and the current version is stable. While there is plenty of other proprietary and/or Open Source software that can create SVGs (including Adobe Illustrator), Inkscape is the one that we recommend. Try it, and start building up some knowledge and experience around the software. If it’s not a suitable option for your needs, Adobe Illustrator can still be used, but keep in mind that output should only be in the SVG format.

LibreOffice Draw

Software Code

Open Source

Platform

Linux, Windows, macOS

Recommended Project Formats

.odg

Recommended Export Formats

.SVG (plain SVG), .JPG, .PNG, .PDF

LibreOffice Draw is a free and Open Source vector graphics editor. Draw lets you produce anything from a quick sketch to a complex plan and gives you the means to communicate with graphics or diagrams, flowcharts and even technical drawings. It supports Open Standards that allow you to use documents from other programs so you don't have to isolate yourself or your workflow into a LibreOffice world. LibreOffice Draw uses Open Document Format for Office Applications (ODF) (.odg graphics extension) as its default output format as an international standard file format.

LibreOffice Draw can be useful to edit PDFs as an alternative to Adobe Acrobat. While text and font might not translate well, it often does the job when a small edit in a PDF is needed.

Diagrams.net

Software Code

Open Source

Platform

Web Browser, Linux, Windows, macOS

Recommended Project Formats

.drawio

Recommended Export Formats

.SVG, .PNG

Diagrams.net (formerly draw.io) is an Open Source online platform created to help you design flowcharts, process diagrams, org charts, UML, ER diagrams, network diagrams and much more. You can create your own custom shape libraries or use their large collection of shape libraries which offer hundreds of visual elements, making it plain and easy working with metadata to pack more useful information into your diagrams. With numerous shape libraries offering hundreds of visual elements, Diagrams.net covers every use case you can think of for creating diagrams by embedding them within Atlassian Confluence and Jira software.

Draw.io lets you import and export files into Open Standards such as .svg, .png, .jpeg, .pdf, and .xml.

We recommend using diagrams.net together with its native Confluence integration. Especially in situations where you might be unable to install software on your device. It can be used from the web browser and store files on the cloud or your device. While designed as a flowchart and diagrams application, it can also replace the need for a vector editor as Inkscape, especially for basic communication design tasks.

Publishing Documents

Open Standards are not exclusive to design. Text documents are a crucial part of openIMIS work processes and are often required to be compatible with design tools. These formats often overlap, and we will go through the most important types of document formats, which can impact the design. While these formats are often overlapping, we will cover the primary types of documents that have an impact on design processes.

LibreOffice Writer

Software Code

Open Source

Platform

Linux, Windows, macOS

Recommended Project Formats

.odt

Recommended Export Formats

.odt, .docx*, .pdf, .epub

LibreOffice Writer is part of the Open Source LibreOffice suite and can export files to HTML, XHTML, XML, Adobe Portable Document Format (PDF), and several versions of Microsoft Word files.

The key difference between LibreOffice and Microsoft is that LibreOffice is an Open Source and free suite of office products, while Microsoft Office is a proprietary office suite that requires users to purchase a license. Both will run on multiple platforms, and both offer similar functionality – with the exception that Microsoft Office will not run natively on Linux.

Info

docx - odt compatibility

( * ) .docx is a format created by Microsoft, and is not recommended to be used at openIMIS related processes. While considered an open format, it does not fulfill the requirements to be an Open Standard.

However, if needed, LibreOffice Writer has good .docx support. Editing .docx files in LibreOffice works most of the time, but you should be aware of the limitations when converting between .docx and .odt files. Microsoft Support lists the .docx formatting features that the .odt format does not support. This list is written from Microsoft’s perspective, and is not kept up to date. You can see the full comparison from the LibreOffice side as well. Neither presentation is objective and some independent research and decision-making might be required.

Guidelines for choosing document formats:

  • Generally, it’s recommended to use the native file format of the application you are using. If you are using LibreOffice Writer, save file formats as .odt, if you use Microsoft Word, save files as .docx. In case you have both LibreOffice and Microsoft Office installed, prioritize saving .odt files with LibreOffice Writer

  • In Microsoft Word, always save files as .docx if your file does not contain macros and the .docm format only if your file does contain macros.

  • Some Microsoft Office features might not be available in LibreOffice Writer by default, but might be available via LibreOffice extensions or experimental features. Check them out in case you are missing any feature.

  • There is really no basic instruction guide on file compatibility dos and don’ts. A good rule of thumb is to avoid using non-traditional document elements l in order to maximize compatibility.

LibreOffice Impress

Software Code

Open Source

Platform

Linux, Windows, macOS

Recommended Project Formats

.odp

Recommended Export Formats

.odp, .pdf, .gif

LibreOffice Impress is a tool for creating multimedia presentations and slide shows.

Impress provides common multimedia presentation features, such as special effects, animations, and drawing tools.

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 the Microsoft PowerPoint file format and can also save your work in numerous graphics formats, including Macromedia Flash (SWF).

Info

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

Info

LibreOffice Impress can be also used to insert vector graphics into presentation slides. Having vector graphics instead of raster graphics allows you to change colors, effects and sizes right within the presentation file. This is not possible natively in Microsoft Office Powerpoint. An external tutorial shows how to do exactly that.

Confluence

Software Code

Open Source

Platform

Linux, Windows, macOS

Recommended Project Formats

.md

Recommended Export Formats

.md, .odt, docx,

Confluence is an online proprietary publishing platform, designed for collaborative projects work. It is also compatible with multiple software or open platforms, from writing a document in markdown language to organizing team meetings in the same cloud. Confluence can be also used to convert office documents including but not limited to .docx and .odt file formats. This is ideal if you need to edit Microsoft Office or LibreOffice documents without any installed software while still avoiding Google services.

Cryptpad

Software Code

Open Source

Platform

Linux, Windows, macOS

Recommended Project Formats

.SVG (Inkscape SVG)md

Recommended Export Formats

.SVG (plain SVG), .JPG, .PNG, .PDF

Inkscape is a free and open-source vector graphics editor. This multi-platform application can be used to create and edit vector graphics such as illustrations, diagrams, line arts, charts, logos, icons, and complex paintings. Inkscape's primary vector graphics format is the Open Standard Scalable Vector Graphics (SVG); however, many other formats can be imported and exported. It is licensed under the General Public License (GPL).

Inkscape is an open alternative to Adobe Illustrator and recommend for creation of vector graphics for the openIMIS project. It can output SVG files and PNG raster graphics. The interface is relatively self-explanatory; almost everything is accessible from a single drop-down menu or icon.

This is going to be the software that openIMIS will use the most to create digital assets, as its a well-supported project and the current version is stable. While there is plenty of other proprietary and/or Open Source software that can create SVGs (including Adobe Illustrator), Inkscape is the one that we recommend. Try it, and start building up some knowledge and experience around the software. If it’s not a suitable option for your needs, Adobe Illustrator can still be used, but keep in mind that output should only be in the SVG format.

LibreOffice Draw

...

Software Code

...

Open Source

...

Platform

...

Linux, Windows, macOS

...

Recommended Project Formats

...

.odg

...

Recommended Export Formats

...

.SVG (plain SVG), .JPG, .PNG, .PDF

LibreOffice Draw is a free and Open Source vector graphics editor. Draw lets you produce anything from a quick sketch to a complex plan and gives you the means to communicate with graphics or diagrams, flowcharts and even technical drawings. It supports Open Standards that allow you to use documents from other programs so you don't have to isolate yourself or your workflow into a LibreOffice world. LibreOffice Draw uses Open Document Format for Office Applications (ODF) (.odg graphics extension) as its default output format as an international standard file format.

LibreOffice Draw can be useful to edit PDFs as an alternative to Adobe Acrobat. While text and font might not translate well, it often does the job when a small edit in a PDF is needed.

Diagrams.net

...

Software Code

...

Open Source

...

Platform

...

Web Browser, Linux, Windows, macOS

...

Recommended Project Formats

...

.drawio

...

Recommended Export Formats

...

.SVG, .PNG

Diagrams.net (formerly draw.io) is an Open Source online platform created to help you design flowcharts, process diagrams, org charts, UML, ER diagrams, network diagrams and much more. You can create your own custom shape libraries or use their large collection of shape libraries which offer hundreds of visual elements, making it plain and easy working with metadata to pack more useful information into your diagrams. With numerous shape libraries offering hundreds of visual elements, Diagrams.net covers every use case you can think of for creating diagrams by embedding them within Atlassian Confluence and Jira software.

...

Publishing Documents

Open Standards are not exclusive to design. Text documents are a crucial part of openIMIS work processes and are often required to be compatible with design tools. These formats often overlap, and we will go through the most important types of document formats, which can impact the design. While these formats are often overlapping, we will cover the primary types of documents that have an impact on design processes.

LibreOffice Writer

...

Software Code

...

Open Source

...

Platform

...

Linux, Windows, macOS

...

Recommended Project Formats

...

.odt

...

Recommended Export Formats

...

.odt, .docx*, .pdf, .epub

LibreOffice Writer is part of the Open Source LibreOffice suite and can export files to HTML, XHTML, XML, Adobe Portable Document Format (PDF), and several versions of Microsoft Word files.

The key difference between LibreOffice and Microsoft is that LibreOffice is an Open Source and free suite of office products, while Microsoft Office is a proprietary office suite that requires users to purchase a license. Both will run on multiple platforms, and both offer similar functionality – with the exception that Microsoft Office will not run natively on Linux.

Info

docx - odt compatibility

( * ) .docx is a format created by Microsoft, and is not recommended to be used at openIMIS related processes. While considered an open format, it does not fulfill the requirements to be an Open Standard.

However, if needed, LibreOffice Writer has good .docx support. Editing .docx files in LibreOffice works most of the time, but you should be aware of the limitations when converting between .docx and .odt files. Microsoft Support lists the .docx formatting features that the .odt format does not support. This list is written from Microsoft’s perspective, and is not kept up to date. You can see the full comparison from the LibreOffice side as well. Neither presentation is objective and some independent research and decision-making might be required.

Guidelines for choosing document formats:

  • Generally, it’s recommended to use the native file format of the application you are using. If you are using LibreOffice Writer, save file formats as .odt, if you use Microsoft Word, save files as .docx. In case you have both LibreOffice and Microsoft Office installed, prioritize saving .odt files with LibreOffice Writer

  • In Microsoft Word, always save files as .docx if your file does not contain macros and the .docm format only if your file does contain macros.

  • Some Microsoft Office features might not be available in LibreOffice Writer by default, but might be available via LibreOffice extensions or experimental features. Check them out in case you are missing any feature.

  • There is really no basic instruction guide on file compatibility dos and don’ts. A good rule of thumb is to avoid using non-traditional document elements l in order to maximize compatibility.

LibreOffice Impress

...

Software Code

...

Open Source

...

Platform

...

Linux, Windows, macOS

...

Recommended Project Formats

...

.odp

...

Recommended Export Formats

...

.odp, .pdf, .gif

LibreOffice Impress is a tool for creating multimedia presentations and slide shows.

Impress provides common multimedia presentation features, such as special effects, animations, and drawing tools.

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 the Microsoft PowerPoint file format and can also save your work in numerous graphics formats, including Macromedia Flash (SWF).

Info

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

Info

LibreOffice Impress can be also used to insert vector graphics into presentation slides. Having vector graphics instead of raster graphics allows you to change colors, effects and sizes right within the presentation file. This is not possible natively in Microsoft Office Powerpoint. An external tutorial shows how to do exactly that.

Confluence

...

Software Code

...

Open Source

...

Platform

...

Linux, Windows, macOS

...

Recommended Project Formats

...

.md

...

Recommended Export Formats

...

.md, .odt, docx,

Confluence is an online proprietary publishing platform, designed for collaborative projects work. It is also compatible with multiple software or open platforms, from writing a document in markdown language to organizing team meetings in the same cloud. Confluence can be also used to convert office documents including but not limited to .docx and .odt file formats. This is ideal if you need to edit Microsoft Office or LibreOffice documents without any installed software while still avoiding Google services.

Cryptpad

...

Software Code

...

Open Source

...

Platform

...

Linux, Windows, macOS

...

Recommended Project Formats

...

.md

...

Recommended Export Formats

...

.md

...

If your project is more advanced, you can also use their pad for creating code files, a smart board where you can design your ideas, polls or even a task manager that helps you keep track of your To Do list. Everything is compatible with Open Standards if you want to export them and attach into different projects to share them with your team, or even using an embedded code by attaching it in your file.

Cryptpad offers a drive where every record is stored, encrypted and you can see all the projects you have been working on and other projects your teammates have shared with you.

Scribus

...

Software Code

...

Open Source

...

Platform

...

Linux, Windows, macOS

...

Recommended Project Formats

...

.md

...

Recommended Export Formats

...

.pdf

...

Scribus is an alternative software to Adobe InDesign, used for preparing brochures, lay-outing, print files etc. It can work with CMYK (used for print) and RGB (digital).

...

md


Cryptpad is an online Open Source platform that helps you create quick collaborative documents. It offers a sheet pad and a presentation pad equivalent to LibreOffice Impress where you can export the file in an .md format.

If your project is more advanced, you can also use their pad for creating code files, a smart board where you can design your ideas, polls or even a task manager that helps you keep track of your To Do list. Everything is compatible with Open Standards if you want to export them and attach into different projects to share them with your team, or even using an embedded code by attaching it in your file.

Cryptpad offers a drive where every record is stored, encrypted and you can see all the projects you have been working on and other projects your teammates have shared with you.

Scribus

Software Code

Open Source

Platform

Linux, Windows, macOS

Recommended Project Formats

.md

Recommended Export Formats

.pdf


Scribus is free and open-source desktop publishing software available for most desktop operating systems. It is designed for layout, typesetting, and preparation of files for professional-quality image-setting equipment. Scribus can also create animated and interactive PDF presentations and forms. Example uses include writing newspapers, brochures, newsletters, posters, and books. It is released under the GNU General Public License.

Scribus is an alternative software to Adobe InDesign, used for preparing brochures, lay-outing, print files etc. It can work with CMYK (used for print) and RGB (digital).

Info

While mentioned as an alternative to Adobe InDesign, Scribus is criticized for a limited and buggy feature set. If you are working on design deliverables for digital mediums (RGB) you might want to use Inkscape if possible. If needed for print you will need to use Scribus as the only open source option out there.

File Conversion Tools

There are many downloadable tools and online platforms which can help you to convert Open Standards. In this section, we will present some ways to convert Open Standards in desktop software, online platforms, and finally in a command line.

LibreOffice

Software Code

Open Source

Platform

Linux, Windows, macOS

While using LibreOffice, you can convert files manually by using the Save As option and choosing the format. You can also convert files directly in the command line.

You can run LibreOffice from the command line to quickly convert one or more files. For example, to transform a LibreOffice Impress slide deck to PDF, you'd type the following:

Code Block
soffice --headless --convert-to pdf mySlides.odp

Replace pdf with the file extension of the format that you want to convert your file to, if something other than PDF is desired. The --headless option means LibreOffice will run only on the command line and exit after completing the requested task.

Turning to the command line is a great way to convert several files at once. If, for example, you want to convert all of the Microsoft Word documents in a folder to the Open Document Text format (used by LibreOffice Writer and many others) then you'd type:

Code Block
soffice --headless --convert-to odt *.docx

The conversion takes far less time than opening all files in LibreOffice Writer and doing the file format conversion manually.

Info

This section focuses on the conversion feature of the LibreOffice suite in general. In the following chapters, LibreOffice Draw, Writer and Impress are specifically mentioned for the relevant document file formats they are commonly used for.

Pandoc

Software Code

Open Source

Platform

Linux, Windows, macOS

Pandoc is a software tool that allows you to convert various text markup files. It supports (among other) .pdf, .docs, and .odt. It offers a detailed guide with instructions for you to follow for installation and use.

You're not just limited to straight conversions. You can, for example, add a table of contents, typographic quotes, custom headers, and syntax highlighting to the resulting file. Take a look at Pandoc's documentation for details and the Open Standards it allows you to convert.

Zamzar

Software Code

Proprietary

Platform

Online Browser

Zamzar is an online file conversion platform that lets you convert documents, images, videos, sound, and many more Open Standards. As you are not required to install it, you can use it from any browser, even mobile.

Info

Note: We cannot endorse the use of third party tools that are not independently audited. Use at your own risk.

BatchPhoto Espresso

Software Code

Proprietary

Platform

Online Browser

BatchPhoto Espresso is another free online image converter, which means you don't need to download any software to use it.

After uploading an image, BatchPhoto lets you choose another format to convert it into, resize, crop, and rotate it, as well as add special effects like gray scale conversion and swirl, overlay text, and adjust brightness, contrast, and sharpness, among other basic edits.

BatchPhoto Espresso also lets you rename the picture and choose a quality and size before saving it to your device. It can be used on any operating system that supports a web browser, including Windows, Linux, and macOS.

Info

Note: We cannot endorse the use of third party tools that are not independently audited. Use at your own risk.

Licensing

When you create a piece of software, in most countries it's automatically protected by copyright. This means that all rights to your work are protected by copright, and nobody else may reproduce, distribute, or create derivative works from your work without permission from the copyright holder.

This disables others from using your work, and may lead to nobody using your work, which may defeat the purpose of sharing it. If you want to share your work, but also want to retain some degree of control, then it's important to choose a suitable license which grants certain rights but not others.

Creative Commons Licenses

The Creative Commons is a family of licenses first created by Stanford law professor Lawrence Lessig to encourage creative people to offer up their creative works for others to legally build upon and share, including text, music, pictures, and video.

Creative Commons licenses are standardised, easy-to-understand, copyright licenses which allow creators of content to communicate which rights they reserve and which rights they give away for the benefit of others. Creative Commons licenses build upon, rather than replace, copyright. They mean you don't have to negotiate individually over specific rights for works you produce, and have been tested in court. Crucially, the licenses were designed specifically to work over the internet, so that content that is offered under the terms of the Creative Commons is easy to search for, discover, and use. Around 500 million works have been licensed under Creative Commons since it launched.

Creative Commons is not an appropriate license for software code. It is a better fit for creative assets (like images and audio) used in software projects. The Creative Commons tool provides convenient advice on which Creative Commons license to choose.

There are several types of Creative Commons Licenses such as:

Attribution (CC BY)

This lets other people distribute, remix, and build upon your work – even commercially – as long as they credit you. This is the most flexible of licenses.

Attribution-ShareAlike (CC BY-SA)

This lets other people distribute, remix and build upon your work – even commercially – as long as they credit you and license their new creations under the same terms. All new works based on yours will therefore have the same license. This is the license used by Wikipedia.

Attribution-NoDerivs (CC BY-ND)

This license allows for redistribution, commercial and non-commercial, as long as it is not changed and is credited to you.

Attribution-NonCommercial (CC BY-NC)

This lets other people distribute, remix, and build upon your work as long as they credit you and don't use it for commercial projects – this means it cannot be sold or used for profit. The creator has to attribute you to the original work, they don't have to license the works that they created based on yours with the same terms.

Attribution-NonCommercial-ShareAlike (CC BY-NC-SA)

This lets other people distribute, remix and build upon your work as long as they credit you and don't use it for commercial projects. They also have to license their new creations under identical terms.

Attribution-NonCommercial-NoDerivs (CC BY-NC-ND)

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.

Best licensing practices for openIMIS content

For content (including graphics, video, audio, and similar creative assets) we use the Creative Commons Attribution-ShareAlike 4.0 International License. That ensures openIMIS assets can be remixed by other users and creators, yet openIMIS is credited and work that is based on our assets need to have the same license (so that others may benefit from the same freedoms in future).

Info

For more details and questions on other licensing (such as software code) you can visit the License page on the openIMIS wiki.

Design Resources

Fonts

Info

For greatest compatibility, we suggest using openly licensed fonts. These are usually under a SIL Open Font license or an Apache license.

...