Source Code

Introduction

This group of pages aims to document some of the important files within the Scribus source code. Scribus has a lot of files and lots of classes within to bring the functionality to the user. There's some basic organisation into directories to distinguish files/classes and their purpose, however the file trees are generally quite large.

Root Directory (Scribus)

The directory contains the main build files for building with CMake (primarily on Unix-like platforms):

• CMakeLists.txt
• ConfigureChecks.cmake
• cmake_uninstall.cmake.in
• config.h.cmake

Various documentation files are included as well such as:

• README
• README.MacOSX
• AUTHORS
• BUILDING
• ...

After that, there are a number of directories per the below:

• cmake - This directory contains the additional files to find additional resources on the system for building the code
• devel-doc - This directory contains the files required to build the doxygen based source file documentation. Some classes are better documented than others. :) You can build this documentation by running make in that directory. It takes a while to run through all the source code though. Then you can open the index.html file in your favourite web browser.
• resources - This directory contains a lot of important files for Scribus to run, and are installed with the main Scribus program. Examples are icons, fonts, GUI translation files, document templates, etc.

Most importantly, there is the scribus directory. This directory is the root of the real source code tree and contains the most important files for the source of Scribus.