Skip to content

Commit

Permalink
uploaded docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sthivaios committed May 18, 2024
1 parent 32593fe commit 5363324
Show file tree
Hide file tree
Showing 14 changed files with 379 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .idea/runConfigurations/PDF.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions Writerside/c.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE categories
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
<categories>
<category id="wrs" name="Writerside documentation" order="1"/>
</categories>
12 changes: 12 additions & 0 deletions Writerside/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<variables></variables>
<build-profile instance="imgal">
<variables>
<noindex-content>false</noindex-content>
</variables>
</build-profile>

</buildprofiles>
Binary file added Writerside/images/install_python.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions Writerside/imgal.tree
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">

<instance-profile id="imgal"
name="Imgal"
start-page="Introduction.md">

<toc-element topic="Introduction.md"/>
<toc-element topic="Creating-an-Image-gallery.md">
<toc-element topic="Prerequisites.md">
<toc-element topic="windows-prereq.md"/>
<toc-element topic="linux-prereq.md"/>
</toc-element>
</toc-element>
</instance-profile>
21 changes: 21 additions & 0 deletions Writerside/redirection-rules.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
<rules>
<!-- format is as follows
<rule id="<unique id>">
<accepts>page.html</accepts>
</rule>
-->
<rule id="267e1bcb">
<description>Created after removal of "About Imgal" from Imgal</description>
<accepts>starter-topic.html</accepts>
</rule>
<rule id="51fccc26">
<description>Created after removal of "Prerequisites" from Imgal</description>
<accepts>Prerequisites.html</accepts>
</rule>
<rule id="695937f4">
<description>Created after removal of "Section Starting Page" from Imgal</description>
<accepts>Section-Starting-Page.html</accepts>
</rule>
</rules>
27 changes: 27 additions & 0 deletions Writerside/topics/Creating-an-Image-gallery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Creating an Image gallery

### Prerequisites

To use Imgal you need Python and the Pillow package installed. Learn how to do that [here](Prerequisites.md).

### Organizing your files before creating the gallery

Extract the Imgal zip file.

In a folder, place the `imagal.py` file and the `templates` folder found in the zip file.

In the same folder, create another folder, and place your images in it.

### Creating the image gallery

In your Terminal or Powershell, go to the directory where the `imgal.py` file is.

Then run the command :
```Shell
python imgal.py
```

Now follow the instructions of the program. When it's done, you will find the website structure in the
folder where the images were stored. You can then delete the `templates` folder and `imgal.py`.

**You can now upload the gallery to your web server.**
13 changes: 13 additions & 0 deletions Writerside/topics/Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Introduction

### What is Imgal

Imgal is a program for creating photo galleries. It's written in Python.

Imgal is completely opensource and the code can be found on GitHub.

You can find example/demo image libraries created with Imgal at [](https://demo.imgal.kioydiolabs.org).

### Creating gallery with Imgal

Learn how to create an image gallery with Imgal
6 changes: 6 additions & 0 deletions Writerside/topics/Prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Prerequisites

To install the prerequisites for Imgal, choose the appropriate guide below :

- [Windows](windows-prereq.md)
- [Linux](linux-prereq.md)
27 changes: 27 additions & 0 deletions Writerside/topics/linux-prereq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Linux Prerequisites Installation

### Installing Python

To install Python, open the Terminal and run the command below

```Shell
sudo apt update && sudo apt install python3 -y
```

### Installing the Pillow package

After you have installed Python, you need to install the Pillow package that's used for resizing images and creating thumbails.

To do that, open the Terminal and run the following command

```Shell
pip install Pillow
```

<note>If the command above doesn't work, or you get an error that pip could not be found, run the command below instead</note>

```Shell
python -m install Pillow
```

**You now have all the prerequisites you need installed! Go back to [Creating an image gallery](Creating-an-Image-gallery.md) to learn how to create a gallery!**
27 changes: 27 additions & 0 deletions Writerside/topics/windows-prereq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Windows Prerequisites Installation

### Installing Python

To install Python, go to [](https://www.python.org/downloads/) and download the latest version.

<img src="install_python.png" height="300"></img>

Then, run the executable and follow the installation instructions.

### Installing the Pillow package

After you have installed Python, you need to install the Pillow package that's used for resizing images and creating thumbails.

To do that, open Powershell and run the following command

```Shell
pip install Pillow
```

<note>If the command above doesn't work, or you get an error that pip could not be found, run the command below instead</note>

```Shell
python -m install Pillow
```

**You now have all the prerequisites you need installed! Go back to [Creating an image gallery](Creating-an-Image-gallery.md) to learn how to create a gallery!**
5 changes: 5 additions & 0 deletions Writerside/v.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
<vars>
<var name="product" value="Writerside"/>
</vars>
8 changes: 8 additions & 0 deletions Writerside/writerside.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">

<ihp version="2.0">
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<instance src="imgal.tree"/>
</ihp>
Loading

0 comments on commit 5363324

Please sign in to comment.