Commit 9b230784 authored by Ivica Ico Bukvic's avatar Ivica Ico Bukvic
Browse files

removed docs and made them dynamically updateable from the community repository

parent 7ffd21c9
K 25
svn:wc:ra_dav:version-url
V 43
/svnroot/pure-data/!svn/ver/16502/trunk/doc
END
Makefile
K 25
svn:wc:ra_dav:version-url
V 52
/svnroot/pure-data/!svn/ver/16488/trunk/doc/Makefile
END
TODO
K 25
svn:wc:ra_dav:version-url
V 47
/svnroot/pure-data/!svn/ver/4825/trunk/doc/TODO
END
font_sizes.pd
K 25
svn:wc:ra_dav:version-url
V 56
/svnroot/pure-data/!svn/ver/7666/trunk/doc/font_sizes.pd
END
10
dir
16561
https://pure-data.svn.sourceforge.net/svnroot/pure-data/trunk/doc
https://pure-data.svn.sourceforge.net/svnroot/pure-data
2012-10-31T20:55:52.754533Z
16502
jancsika1
df7eb9d6-776f-4174-a42d-0ffd8d5d5b5d
doxygen
dir
Makefile
file
2012-10-27T19:37:57.438485Z
7a68a872b3d3bca50b2cad43dcf05253
2012-10-24T18:24:23.380035Z
16488
eighthave
11242
media
dir
TODO
file
2012-05-04T00:47:43.915819Z
c421703d7d23cf534e7e31ac40f76a7e
2006-04-06T23:37:04.000000Z
4825
eighthave
666
font_sizes.pd
file
2012-05-04T00:47:43.915819Z
b176c4b93edf3a4741c87ba8139bbe92
2007-05-15T05:17:20.000000Z
7666
eighthave
8786
tutorials
dir
pddp
dir
additional
dir
#==============================================================================#
#
# Centralized build system for "doc".
#
# see for instructions: http://puredata.org/docs/developer/build
# <hans@at.or.at>
#
#==============================================================================#
CWD := $(shell pwd)
# these are designed to be overridden by the packages/Makefile
cvs_root_dir := $(shell cd $(CWD)/.. && pwd)
DESTDIR = $(CWD)/build/
BUILDLAYOUT_DIR = $(cvs_root_dir)/packages
CURL := curl --connect-timeout 600 --max-time 3600
# default target
all:
@echo "this currently does nothing"
include $(BUILDLAYOUT_DIR)/Makefile.buildlayout
#==============================================================================#
#
# OVERARCHING BUILD TARGETS
#
#==============================================================================#
DOC_TARGETS = media messageoddness pd_fileformat pd-msg pddp \
tutorials
# clean up after everything is installed
final_setup:
chmod -R ugo-w $(pddocdir)
install: $(objectsdir) $(helpdir) $(manualsdir) $(examplesdir) \
$(patsubst %, %_install,$(DOC_TARGETS))
@echo " "
@echo "doc install succeeded!"
#==============================================================================#
#
# PROJECT-SPECIFIC TARGETS
#
#==============================================================================#
#------------------------------------------------------------------------------#
# TEMPLATE
TEMPLATE_NAME = template
template_install: $(manualsdir)
install -d $(helpdir)$(manualsdir)/$(TEMPLATE_NAME)
install -p $(doc_src)/template/*.* \
$(helpdir)$(manualsdir)/$(TEMPLATE_NAME)
template_clean:
-rm -f -- $(helpdir)$(manualsdir)/$(TEMPLATE_NAME)/*.*
-rmdir -- $(helpdir)$(manualsdir)/$(TEMPLATE_NAME)
#------------------------------------------------------------------------------#
# EXTERNALS-HOWTO
EXTERNALS-HOWTO_NAME = Externals-HOWTO
externals-howto_install: $(manualsdir)
install -d $(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/pd-externals-HOWTO.pdf > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/pd-externals-HOWTO.pdf
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/HOWTO-externals-en.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/HOWTO-externals-en.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node1.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node1.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node2.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node2.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node3.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node3.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node4.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node4.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node5.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node5.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node6.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node6.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node7.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node7.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node8.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node8.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node9.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node9.html
-$(CURL) http://iem.kug.ac.at/pd/externals-HOWTO/node10.html > \
$(DESTDIR)$(manualsdir)/$(EXTERNALS-HOWTO_NAME)/node10.html
externals-howto_clean:
#------------------------------------------------------------------------------#
# MEDIA
MEDIA_NAME = media
media_install: $(pddocdir)
install -d $(DESTDIR)$(pddocdir)/$(MEDIA_NAME)
install -p $(doc_src)/media/*.* \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)
# ln is cp on MinGW, so these won't work since the target files don't exist at
# the time that the media_install target is generally run. For MinGW, this is
# instead handled in packages/win32_inno/pd-inno.iss.in
ifneq (MINGW,$(findstring MINGW,$(UNAME)))
# random sound files
ln -s ../../doc/sound/bell.aiff \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/bell.aiff
ln -s ../../doc/sound/voice.wav \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/voice.wav
ln -s ../../doc/sound/voice2.wav \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/voice2.wav
ln -s ../../extra/bsaylor/examples/noiseburst.wav \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/noiseburst.wav
ln -s ../../extra/ekext/examples/stink.wav \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/stink.wav
ln -s ../../extra/ekext/examples/beauty.wav \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/beauty.wav
ln -s ../../extra/ekext/examples/drummach.wav \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/drummach.wav
# Gem videos
ln -s ../../extra/Gem/examples/data/alea.mpg \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/alea.mpg
ln -s ../../extra/Gem/examples/data/homer.avi \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/homer.avi
ln -s ../../extra/Gem/examples/data/anim-1.mov \
$(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/anim-1.mov
endif
media_clean:
-rm -f -- $(DESTDIR)$(pddocdir)/$(MEDIA_NAME)/*.*
-rmdir -- $(DESTDIR)$(pddocdir)/$(MEDIA_NAME)
#------------------------------------------------------------------------------#
# MESSAGEODDNESS
MESSAGEODDNESS_NAME = MessageOddness
messageoddness_install: $(manualsdir)
install -d $(DESTDIR)$(manualsdir)/$(MESSAGEODDNESS_NAME)
install -p $(doc_src)/additional/messageoddness/*.* \
$(DESTDIR)$(manualsdir)/$(MESSAGEODDNESS_NAME)
messageoddness_clean:
-rm -f -- $(DESTDIR)$(manualsdir)/$(MESSAGEODDNESS_NAME)/*.*
-rmdir -- $(DESTDIR)$(manualsdir)/$(MESSAGEODDNESS_NAME)
#------------------------------------------------------------------------------#
# PD-MSG
PD-MSG_NAME = pd-msg
pd-msg_install: $(manualsdir)
install -d $(DESTDIR)$(manualsdir)/$(PD-MSG_NAME)
install -p $(doc_src)/additional/pd-msg/*.txt \
$(DESTDIR)$(manualsdir)/$(PD-MSG_NAME)
for dir in $(shell cd $(doc_src)/additional/pd-msg && ls -d [1-5].*); do \
echo "Including $$dir in $(PD-MSG_NAME)"; \
install -d $(DESTDIR)$(manualsdir)/$(PD-MSG_NAME)/$$dir; \
install -p $(doc_src)/additional/pd-msg/$$dir/*.* \
$(DESTDIR)$(manualsdir)/$(PD-MSG_NAME)/$$dir; \
done
pd-msg_clean:
#------------------------------------------------------------------------------#
# PD_FILEFORMAT
PD_FILEFORMAT_NAME = Pd
pd_fileformat_install: $(manualsdir)
install -d $(DESTDIR)$(manualsdir)/$(PD_FILEFORMAT_NAME)
install -p $(doc_src)/additional/pd-fileformat.html \
$(DESTDIR)$(manualsdir)/$(PD_FILEFORMAT_NAME)/Pd_File_Format.html
pd_fileformat_clean:
#------------------------------------------------------------------------------#
# PDDP
pddp_install: $(helpdir)
install -p $(doc_src)/pddp/*.pd $(DESTDIR)$(helpdir)
# this file is used in key-help.pd
install -p $(doc_src)/pddp/glossary.txt $(DESTDIR)$(helpdir)
install -p $(doc_src)/pddp/keyboard_fun.txt $(DESTDIR)$(helpdir)
pddp_clean:
#------------------------------------------------------------------------------#
# TUTORIALS
tutorials_install: $(manualsdir)
# start-here
install -d "$(DESTDIR)$(manualsdir)/+ Start Here"
install -p $(doc_src)/tutorials/start-here/*.* "$(DESTDIR)$(manualsdir)/+ Start Here"
# pddrums
install -d $(DESTDIR)$(manualsdir)/PdDrums
install -p $(doc_src)/tutorials/footils/pddrums/*.* $(DESTDIR)$(manualsdir)/PdDrums
# playnow
install -d $(DESTDIR)$(manualsdir)/PlayNow
install -p $(doc_src)/tutorials/playnow/*.* $(DESTDIR)$(manualsdir)/PlayNow
# cognition
install -d $(DESTDIR)$(manualsdir)/Cognition
install -p $(doc_src)/tutorials/cognition/*.* $(DESTDIR)$(manualsdir)/Cognition
# intro
install -d $(DESTDIR)$(manualsdir)/0.Intro
install -p $(doc_src)/tutorials/intro/*.* $(DESTDIR)$(manualsdir)/0.Intro
install -p $(externals_src)/pddp/+pager.pd $(DESTDIR)$(manualsdir)/0.Intro
# sound
install -d $(DESTDIR)$(manualsdir)/1.Sound
install -p $(doc_src)/tutorials/sound/*.* $(DESTDIR)$(manualsdir)/1.Sound
install -p $(externals_src)/pddp/+pager.pd $(DESTDIR)$(manualsdir)/1.Sound
# visual
install -d $(DESTDIR)$(manualsdir)/2.Image
install -p $(doc_src)/tutorials/visual/*.* $(DESTDIR)$(manualsdir)/2.Image
install -p $(externals_src)/pddp/+pager.pd $(DESTDIR)$(manualsdir)/2.Image
# networking
install -d $(DESTDIR)$(manualsdir)/3.Networking
install -p $(doc_src)/tutorials/networking/*.* $(DESTDIR)$(manualsdir)/3.Networking
install -p $(externals_src)/pddp/+pager.pd $(DESTDIR)$(manualsdir)/3.Networking
# physical
# install -d $(manualsdir)/4.Physical
# install -p $(doc_src)/tutorials/physical/*.* $(manualsdir)/4.Physical
# install -p $(externals_src)/pddp/+pager.pd $(manualsdir)/4.Physical
tutorials_clean:
-rm -f -- $(DESTDIR)$(manualsdir)/PdDrums/*.*
-rmdir -- $(DESTDIR)$(manualsdir)/PdDrums
-rm -f -- $(DESTDIR)$(manualsdir)/PlayNow/*.*
-rmdir -- $(DESTDIR)$(manualsdir)/PlayNow
-rm -f -- $(DESTDIR)$(manualsdir)/0.Intro/*.*
-rmdir -- $(DESTDIR)$(manualsdir)/0.Intro
-rm -f -- $(DESTDIR)$(manualsdir)/1.Sound/*.*
-rmdir -- $(DESTDIR)$(manualsdir)/1.Sound
-rm -f -- $(DESTDIR)$(manualsdir)/0.Intro/Visual/*.*
-rmdir -- $(DESTDIR)$(manualsdir)/0.Intro/Visual
-rm -f -- $(DESTDIR)$(manualsdir)/3.Networking/*.*
-rmdir -- $(DESTDIR)$(manualsdir)/3.Networking
-rm -f -- $(DESTDIR)$(manualsdir)/4.Physical/*.*
-rmdir -- $(DESTDIR)$(manualsdir)/4.Physical
#==============================================================================#
#
# DEVELOPER'S TARGETS
#
#==============================================================================#
# make the symlinks necessary to simulate the installed environment
devsymlinks:
test -e $(doc_src)/2.control.examples || \
ln -s $(pd_src)/doc/2.control.examples $(doc_src)/2.control.examples
test -e $(doc_src)/3.audio.examples || \
ln -s $(pd_src)/doc/3.audio.examples $(doc_src)/3.audio.examples
# pd <= 0.38-4 has 4.fft.examples
test -e $(doc_src)/4.fft.examples || \
ln -s $(pd_src)/doc/4.fft.examples $(doc_src)/4.fft.examples
# pd > 0.38-4 has 4.data.structures
test -e $(doc_src)/4.data.structures || \
ln -s $(pd_src)/doc/4.data.structures $(doc_src)/4.data.structures
test -e $(doc_src)/7.stuff || \
ln -s $(pd_src)/doc/7.stuff $(doc_src)/7.stuff
test -e $(doc_src)/sound || \
ln -s $(pd_src)/doc/sound $(doc_src)/sound
# put the pddp support objects in the path
test -e $(doc_src)/pddp/pddp || \
ln -s $(externals_src)/pddp $(doc_src)/pddp/pddp
#==============================================================================#
#
# CLEAN TARGETS
#
#==============================================================================#
# the destination-specific clean targets are in Makefile.buildlayout
clean: $(patsubst %, %_clean,$(DOC_TARGETS))
distclean: clean cruft_clean
test_locations:
@echo "PD_VERSION: $(PD_VERSION)"
@echo "PACKAGE_VERSION: $(PACKAGE_VERSION)"
@echo "CWD $(CWD)"
@echo "DESTDIR $(DESTDIR)"
@echo "PREFIX $(prefix)"
@echo "BINDIR $(bindir)"
@echo "LIBDIR $(libdir)"
@echo "OBJECTSDIR $(objectsdir)"
@echo "PDDOCDIR $(pddocdir)"
@echo "LIBPDDIR $(libpddir)"
@echo "LIBPDBINDIR $(libpdbindir)"
@echo "HELPDIR $(helpdir)"
@echo "MANUALSDIR $(manualsdir)"
@echo "EXAMPLESDIR $(examplesdir)"
- add externals HOWTO to manuals/Pd
- create Makefile for Pd-extended build system
- add pd-fileformat doc: http://student-kmt.hku.nl/%7Etjeerd/pd/pd_fileformat.html
- replace [pddp] with "pddp" in all help files so that it doesn't cause bugs
with the pddp/pddp.pd meta file, and other things in the future. Here's a
pattern: sed -n 's|obj \([0-9]*\) \([0-9]*\) pddp;|msg \1 \2 pddp;|p' *.pd
- add doc/pddp/about, help, etc. to doc/Makefile
- mv doc/pddp/pddp.pd to doc/pddp/about/pddp-about.pd
- add [symbol 1( and [1 ( test messages to the bottom right example in
[pd some odd cases of list handling] in
doc/pddp/all_about_lists_vs_anythings.pd
#N canvas 26 165 1002 607 10;
#X obj 351 386 cnv 15 69 16 empty empty 69x16 2 12 0 9 -128992 -66577
0;
#X obj 351 355 cnv 15 78 20 empty empty 78x20 2 12 0 9 -128992 -66577
0;
#X obj 695 387 cnv 15 70 17 empty empty 70x17 2 12 0 9 -128992 -66577
0;
#X text 161 389 Mac OS X;
#X text 160 357 Windows;
#X text 161 417 GNU/Linux;
#X obj 775 387 cnv 15 70 17 empty empty 70x17 2 12 0 9 -128992 -66577
0;
#X obj 865 387 cnv 15 60 15 empty empty 60x15 2 12 0 9 -128992 -66577
0;
#X obj 520 173 cnv 15 100 60 empty empty courier10 20 12 0 8 -233017
-66577 0;
#X msg 539 177 courier10;
#X obj 650 103 cnv 15 100 60 empty empty courier10 20 12 0 9 -233017
-66577 0;
#X msg 670 105 courier10;
#X text 651 124 Windows/0.39.2-extended-test7;
#X obj 695 357 cnv 15 60 17 empty empty 60x17 2 12 0 9 -128992 -66577
0;
#X obj 775 357 cnv 15 60 17 empty empty 60x17 2 12 0 9 -128992 -66577
0;
#X obj 351 416 cnv 15 87 19 empty empty 87x19 2 12 0 9 -128992 -66577
0;
#X text 17 314 these represent the size of this message box:;
#X msg 346 313 courier10;
#X text 15 1 the fonts line up on these platforms:;
#X obj 139 35 cnv 15 100 60 empty empty courier10 20 12 0 9 -233017
-66577 0;
#X msg 157 41 courier10;
#X text 350 335 0.39.2-extended-test7;
#X text 697 335 0.39-2;
#X text 777 334 0.40-2;
#X text 857 334 devel 0.39-1test1;
#X obj 501 386 cnv 15 69 16 empty empty 69x16 2 12 0 9 -128992 -66577
0;
#X text 500 335 0.38.4-extended;
#X obj 612 387 cnv 15 70 17 empty empty 70x17 2 12 0 9 -128992 -66577
0;
#X text 614 335 0.38-4;
#X text 18 444 these represent the size of this comment:;
#X obj 140 240 cnv 15 100 60 empty empty courier10 20 12 0 10 -233017
-66577 0;
#X msg 158 243 courier10;
#X obj 232 500 cnv 7 52 7 empty empty 52x7 2 15 0 11 -128992 -66577
0;
#X text 163 499 Mac OS X;
#X text 162 467 Windows;
#X text 163 527 GNU/Linux;
#X obj 784 500 cnv 7 63 8 empty empty 63x8 2 15 0 11 -128992 -66577
0;
#X obj 506 500 cnv 7 62 7 empty empty 62x7 2 15 0 11 -128992 -66577
0;
#X obj 20 170 cnv 15 100 60 empty empty courier10 20 12 0 12 -233017
-66577 0;
#X msg 39 174 courier10;
#X text 47 212 12 pt;
#X text 176 284 10pt;
#X text 686 140 9 pt;
#X obj 20 35 cnv 15 100 60 empty empty courier10 20 12 0 12 -233017
-66577 0;
#X msg 39 39 courier10;
#X text 47 77 12 pt;
#X text 40 64 0.38-4;
#X text 40 199 0.40-2;
#X text 139 64 devel 0.39-1test1;
#X text 32 16 ---------- Mac OS X ----------;
#X obj 614 500 cnv 7 63 8 empty empty 63x8 2 15 0 11 -128992 -66577
0;
#X text 435 442 ----------------------------------------------------------
;
#X text 445 312 ----------------------------------------------------------
;
#X obj 699 500 cnv 7 63 8 empty empty 63x8 2 15 0 11 -128992 -66577
0;
#X obj 21 102 cnv 15 100 60 empty empty courier10 20 12 0 12 -233017
-66577 0;
#X msg 40 106 courier10;
#X text 48 144 12 pt;
#X text 41 131 0.39-2;
#X text 141 78 9 pt (closest);
#X obj 870 500 cnv 6 53 6 empty empty 53x6 2 15 0 11 -128992 -66577
0;
#X obj 520 103 cnv 15 100 60 empty empty courier10 20 12 0 8 -233017
-66577 0;
#X msg 539 107 courier10;
#X text 548 124 0.39-2;
#X text 542 16 ---------- Windows ----------;
#X text 528 140 8 pt (closest);
#X text 549 197 0.40-2;
#X obj 699 470 cnv 5 51 5 empty empty 51x5 2 15 0 11 -128992 -66577
0;
#X text 526 213 8 pt (closest);
#X obj 784 470 cnv 5 51 5 empty empty 51x5 2 15 0 11 -128992 -66577
0;
#X text 296 443 courier10;
#X obj 269 102 cnv 15 100 60 empty empty courier10 20 12 0 8 -233017
-66577 0;
#X msg 288 106 courier10;
#X text 297 123 0.39-2;
#X text 272 16 ---------- GNU/Linux ----------;
#X obj 381 242 cnv 15 100 60 empty empty courier10 20 12 0 8 -233017
-66577 0;
#X msg 399 246 courier10;
#X text 382 263 0.39.2-extended-RC1;
#X text 417 279 8 pt;
#X text 307 139 8 pt;
#X obj 695 414 cnv 15 69 17 empty empty 69x17 2 12 0 9 -128992 -66577
0;
#X obj 700 530 cnv 7 61 8 empty empty 61x8 2 15 0 11 -128992 -66577
0;
#X obj 233 416 cnv 15 62 17 empty empty 62x17 2 12 0 9 -128992 -66577
0;
#X obj 380 103 cnv 15 100 60 empty empty courier8 20 12 0 8 -233017
-66577 0;
#X msg 399 106 courier10;
#X text 416 140 8 pt;
#X text 381 124 0.39.2-extended-test7;
#X obj 355 529 cnv 7 80 10 empty empty 80x10 2 15 0 11 -128992 -66577
0;
#X obj 269 170 cnv 15 100 60 empty empty courier10 20 12 0 10 -233017
-66577 0;
#X msg 290 175 courier10;
#X text 298 194 0.40-2;
#X text 275 210 10 pt (closest);
#X obj 785 530 cnv 7 61 8 empty empty 61x8 2 15 0 11 -128992 -66577
0;
#N canvas 0 22 466 290 instructions 0;
#X text 18 45 If the sizing was all working nicely \, the fonts would
line up exactly on the top section when both are set to 10 point since
they are the same font. That is what we are trying to achieve. But