doohoyi/zine_maker
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Extra tweaks

Browse source
This commit is contained in:
Mara Karagianni 2021-12-13 01:07:03 +02:00
parent b519ca6e96
commit 32387d6e73
1 changed files with 29 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -1,7 +1,9 @@
# Introduction # Introduction
This zine helps in navigating the zine_maker code, a small software tool derived from pyPDF library. The code is written in Python, and provides a few scripts for creating covers, colophones, content, and also signatures for preparing a PDF for the printer. The scripts run with python version 3.x.x and we can feed to the scripts inputs and outputs. As an input, we give the path to a text file, which shall create the text and images content of the zine, and as an output we give a the path/filename of our choice. We can also run the scripts with no input nor output, in which case, they take as default parameters the readme text from the text/ folder and produce an output to either of the folders covers, colophones, body, or zines, depending on which script we are running every time.
This zine helps in navigating the zine_maker code, a small software tool derived from pyPDF library. The code is written in Python, and provides a few scripts for creating covers, colophons, content, and also signatures for preparing a PDF for the printer. The scripts run with python version 3.x.x and we can feed to the scripts inputs and outputs. As an input, we give the path to a text file, which shall create the text and images content of the zine, and as an output we give a the path/filename of our choice. We can also run the scripts with no input nor output, in which case, they take as default parameters the readme text from the text/ folder and produce an output to either of the folders covers, colophons, body, or zines, depending on which script we are running each time.
# Get the code! # Get the code!
## Download the source code ## Download the source code
It is being under active development by the author and can be cloned and/or downloaded from https://git.systerserver.net/mara/zine_maker. It is being under active development by the author and can be cloned and/or downloaded from https://git.systerserver.net/mara/zine_maker.
To download the project, near the top of the gitlab page, click on the download icon next to "Find file". To download the project, near the top of the gitlab page, click on the download icon next to "Find file".
@ -10,6 +12,7 @@ You can choose which type of archived folder you want, and then open it in your
tar -xvf zine_maker.tar -C /home/user/destination # for tarred file tar -xvf zine_maker.tar -C /home/user/destination # for tarred file
unzip zinme_maker.zip -d /home/user/destination # for zipped file unzip zinme_maker.zip -d /home/user/destination # for zipped file
``` ```
## OR use git clone: ## OR use git clone:
``` ```
git clone https://zine:DskM_8XxtKt-Wym1xHd1@git.systerserver.net/mara/zine_maker.git git clone https://zine:DskM_8XxtKt-Wym1xHd1@git.systerserver.net/mara/zine_maker.git
@ -17,18 +20,21 @@ cd zine_maker
``` ```
# Requirements # Requirements
You need python3 running on the computer
Basic requirements are listed here.
Python3 should be installed on the computer
https://www.python.org/downloads/ https://www.python.org/downloads/
And also the pip command And also the pip command if it didn't get installed with Python
https://pip.pypa.io/en/stable/installation/ https://pip.pypa.io/en/stable/installation/
Once these are installed, from within zine_maker run: Once these are installed, from within zine_maker folder run:
`pip install -r requirements.txt` `pip install -r requirements.txt`
# Miscellaneous # Miscellaneous
## Fonts
##Fonts
The source code comes with some fonts under the fonts folder. You can use your The source code comes with some fonts under the fonts folder. You can use your
fonts of preference by adding them either in the fonts folder and edit the fonts of preference by adding them either in the fonts folder and edit the
files cover.py, colophon.py and doc_pdf.py to give the new names. Or add your files cover.py, colophon.py and doc_pdf.py to give the new names. Or add your
@ -53,26 +59,31 @@ sed -e "s/\r//g" file > newfile
Extensive info can be find at: Extensive info can be find at:
https://www.cyberciti.biz/faq/sed-remove-m-and-line-feeds-under-unix-linux-bsd-appleosx/ https://www.cyberciti.biz/faq/sed-remove-m-and-line-feeds-under-unix-linux-bsd-appleosx/
## About the text style ## Layout
All the font styling happens in the zine_maker function create_pages(). The All the font styling happens in the zine_maker function create_pages(). The
input text is parsed for specific tags or symbols in the begining of the line input text is parsed for specific tags or symbols in the begining of each line
and change the font color and size accordingly. We can add more or edit and changes to the font color and size happen accordingly. We can add more or edit
existing ones, directly in the zine_maker code. existing rules, directly in the zine_maker code.
## For merging the cover, body and colophon ## Parameters
There are many pdf merger tools, one that is command line based is pdfunite The python scripts cover.py, colophon.py and doc_pdf.py take a text input and an output filename. If we give no input/output, the default input is the related readme files under covers/body/colophons/
## Merge
For merging the cover, body and colophon pdf files, there are many pdf merger tools. One that is command line based and is used in this tutorial is pdfunite
http://linux-commands-examples.com/pdfunite http://linux-commands-examples.com/pdfunite
## Before printing ## Print
For shuffling the final pdf and prepare it for printing you need the pdfseparate command For shuffling the final pdf and prepare it for printing you need the pdfseparate command
http://www.linux-commands-examples.com/pdfseparate http://www.linux-commands-examples.com/pdfseparate
it is used inside the shuffle_pdf.py file (see details at the end of this README). it is used inside the shuffle_pdf.py file (see details at the end of this README).
## For making use of images in the script ## Images
For making use of images in the script
image magick needs to be installed image magick needs to be installed
http://www.imagemagick.org/ http://www.imagemagick.org/
# Run the code! # Run the code!
## Make the content of the pdf ## Make the content of the pdf
The default parameters included in the script would create a zine from this The default parameters included in the script would create a zine from this
readme: readme:
@ -105,21 +116,23 @@ Same, the default parameters included in the script would create the colophon fo
OR try-out the other colophon samples: OR try-out the other colophon samples:
`python colophon.py text/colophon.txt colophones/colophon.pdf` `python colophon.py text/colophon.txt colophons/colophon.pdf`
OR add your own colophon text file and replace respectively: OR add your own colophon text file and replace respectively:
`python colophon.py text/<your-colophon>.txt colophones/<output-colophon>.pdf` `python colophon.py text/<your-colophon>.txt colophons/<output-colophon>.pdf`
# Make a screen PDF # Make a screen PDF
## For the final pdf - screen version ## For the final pdf - screen version
from the terminal run: from the terminal run:
`pdfunite covers/cover.pdf body/body.pdf colophones/colophon.pdf zines/final.pdf` `pdfunite covers/cover.pdf body/body.pdf colophons/colophon.pdf zines/final.pdf`
You shall substitute the file paths to the your own corresponding /path/filenames You shall substitute the file paths to the your own corresponding /path/filenames
# Make a printable zine # Make a printable zine
## To prepare signatures for printing the zine ## To prepare signatures for printing the zine
The default parameters take the zines/zinemaker_screen.pdf and output The default parameters take the zines/zinemaker_screen.pdf and output
zinemaker{random_number}.pdf zinemaker{random_number}.pdf