Subversion Repositories oidplus

Rev

Rev 365 | Rev 475 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
387 daniel-mar 1 
 
2 
About the folder "userdata/resources"
3 
-------------------------------------
4 
 
5 
This folder is used by the plugin "publicPages/500_resources"
6 
(Section "Documents and resources")
7 
 
8 
Its contents will be merged with "res/" from the root directory.
9 
"res/" contains the default resources which are part of the OIDplus
10 
main installation (you shall not change or add anything to that folder),
11 
while "userdata/resources" contains resources that you add yourself
12 
(e.g. your impress, privacy statement, additional resources,
13 
hyperlinks to your websites and products, etc.)
14 
 
15 
Valid contents:
16 
- Subfolders
17 
- *.html files
18 
- *.link files (will be converted to a hyperlink in the menu on the left)
19 
- *.url files (will be converted to a hyperlink in the menu on the left.
20 
               No internationalization possible, therefore deprecated!)
21 
 
22 
Icons:
23 
	You can define custom icons for any any file or folder by placing PNG files
24 
	with the following file names:
25 
 
26 
	Assume the ressource file <filename>.html , then the icon files are:
27 
	<filename>_big.png        (Big icon in the content-pane)
28 
	<filename>_big$dede.png   (German-specific icon)
29 
	<filename>_tree.png       (Icon in the tree view, 16x16)
30 
	<filename>_tree$dede.png  (German-specific tree icon)
31 
 
32 
	The same applies for folders.
33 
 
34 
Internationalization of *.html files:
35 
	Title: The title is taken from the HTML headline.
36 
	To create a file with multiple languages, create them like this:
37 
		example.html      <-- this is the file in the default language ("enus" = English USA)
38 
		example$dede.html <-- this is the file for German ("dede")
39 
	Attention: The main file (without language code) needs to exist, so this is NOT possible:
40 
		example$enus.html <-- DO NOT USE
41 
		example$dede.html
42 
 
43 
Internationalization of *.link files:
44 
	Title:
45 
		.link files are like .url files, but they have an attribute for defining a title.
46 
	The file format is like this:
47 
		[Link]
48 
		Title="Report a bug"
49 
		URL="https://www.viathinksoft.com/thinkbug/thinkbug.php?id=97"
50 
	To create an URL with multiple languages, create them like this:
51 
		example.link      <-- this is the file in the default language ("enus" = English USA)
52 
		example$dede.link <-- this is the file for German ("dede")
53 
	Attention: The main file (without language code) needs to exist, so this is NOT possible:
54 
		example$enus.link <-- DO NOT USE
55 
		example$dede.link
56 
 
57 
Internationalization of *.url files:
58 
	.url files are the normal files that can be created using Microsoft Windows.
59 
	Internationalization of *.url files is not possible.
60 
	Title:
61 
		The title is taken from the file name.
62 
	You need to create two entries which are always both visible in the menu,
63 
	independent from the chosen language:
64 
	- "Report a bug.url"
65 
	- "Einen Fehler melden.url"
66 
 
67 
Internationalization of Folder names:
68 
	By default, the folder title is the name of the directory.
69 
	To change it, you can place a folder.ini with the following contents:
70 
		[Folder]
71 
		Title="Object Identifiers"
72 
	For multilinguality, e.g. create folder$dede.ini for a German name
73 
		[Folder]
74 
		Title="Objekt-Bezeichner (OID)"
75 
	Please note that the URL is always the same and exposes the real directory name:
76 
		...?goto=oidplus:resources$Object Identifiers/