Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • 5608dcc
  • /
  • README
Raw File Download
Permalinks

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge Iframe embedding
swh:1:cnt:920e8b8ae7912f24e563f065fe1a245a98e2eb24
directory badge Iframe embedding
swh:1:dir:5608dcc648f5694d481e889306766d42729f5cd8
Citations

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
README
All invocations of 'make' have to be done inside of your build/ dir after running cmake!

Building manual
---------------------------------------------------------
To build the usermanual you need to install the following tools:
  xsltproc (plus optionally saxon), fop and gnome-doc-utils (for xml2po)

XSLT processor saxon is able to give a nicely looking html usermanual with
correctly displayed images and screenshots. If saxon is not found, xsltproc
will be used as a fallback. Expect inconsistent screenshot and image dimensions in
that case.


Writing guidelines
---------------------------------------------------------
There are some format rulings and you easily can following it by copy an already existing
docbook file such if you are going to write a new example use darkroom/examples/crossdeveloping.xml
as a template for your own example.

Do NOT change table layouts etc. we want the document consistent!

Each section should be tagged with status "draft" <sect2 status="draft">...</sect2>
when someone have reviewed your section you should change status to "final" to get
the section into final usermanual document and also the translators will get this text for
translations.



Building the usermanual
---------------------------------------------------------
To generate the usermanual you need the tools xsltproc,poxml and fop this document will include
draft sections and is used fo reviewing...

make



Building the final usermanual
---------------------------------------------------------
Generating a final usermanual which would not include the sections with status "draft" this
is for producing a manual for distribution...

make darktable-usermanual-final.pdf



Building the translated manual
--------------------------------------------------------
When building a translated manual all chapters are included, also sections with status "draft" will occur.

make darktable-usermanual-<language code>



Translators
--------------------------------------------------------
To add you language just edit po/LINGUAS and add your language code. Make sure to rerun cmake after this change.

For updating the po file just enter the build directory and execute

make update-usermanual-<language code>

Software Heritage — Copyright (C) 2015–2025, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Contact— JavaScript license information— Web API

back to top