Freevo

- User Documentation

# WebsiteMaintenance

Site Index:

1. Introduction
2. CVS
3. Gensite.py
   1. Template and content files
   2. News page
4. Screenshots
5. Uploading new website files
6. Publishing changes via rsync

## Introduction

The website is hosted on Sourceforge. All developers with CVS access are welcome to help keeping it updated!

## CVS

The website HTML templates and scripts are stored in CVS as the website component. It can be checked out and modified if you're a developer.

## Gensite.py

The `gensite.py` application will generate the website HTML documents from template and content files. Run it with no arguments after changing the other files.

### Template and content files

Please see the source code of gensite.py for a list of the template and content files that are used to build the website.

### News page

The news.txt file is processed by `gensite.py` to generate the front newspage. It has simple text format that is transformed into HTML.

Please note that the format is a little tricky sometimes, check the results carefully before uploading to the real site.

## Screenshots

There is a script called gen_ss.py that processes Freevo BMP screenshots (key F10) and generates JPGs and HTML docs.

The screenshots have to be taken in the following order:

1. Main menu, the cursor should be on the second row.

2. TV Guide with programs and logos, put the cursor somewhere in the middle.

3. Movie browsing. Use a directory with images.

4. Music browsing. Use a directory with images.

5. Playing music. Choose a song with an image.

6. Image browsing, choose an image with a preview.

Please use the arial font for screenshots, it looks better than the default builtin kimberly font. Also use 800x600 resolution.

Copy Arial from the website to the fonts dir:

-     cd skins/fonts ; wget http://freevo.sourceforge.net/Arial_Bold.ttf

Create a directory for the new screenshots (named after the skin):

-     mkdir ss_raw/blue_round1

Copy the screenshots:

-     cp /tmp/freevo_ss* ss_raw/blue_round1

Run this script to scale the pics, generate thumbnails and content_screenshots.html:

-     ./gen_ss.py

The output is in ss/[skin]/*.jpg

You must run gensite.py after this script!

Also, please note that content_about.html refers to the blue_round1 skin.

## Uploading new website files

The website documents should be uploaded to the test area where it can be tested before it is made part of the official site:

-     scp -r *html *.css *.gif *.gif *jpg *ico ss <USERNAME>@freevo.sf.net:/home/groups/f/fr/freevo/htdocs/tentative

When you're satisifed you can upload to the real site which is at the same place without the `/tentative` at the end.

## Publishing changes via rsync

If you make small changes to the website, it may be preferable to only upload those changes, in that case, you can use the following rsync command:

    rsync --exclude=".cvsignore" --cvs-exclude --exclude="gen*.py" --exclude="content_*.html" --exclude=template_main.html -av --compress -e ssh /var/www/website/ freevo:/home/groups/f/fr/freevo/htdocs/

You should probably change '/var/www/website' to wherever your local copy of the website is. This command is also preferred to the 'scp' method because it won't upload the template files which are fairly useless on the live website.

last edited 2005-01-04 14:27:29 by BHeremans
current version: http://freevo.sourceforge.net/cgi-bin/doc/WebsiteMaintenance