mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-12-23 12:26:59 +01:00
Added docs for FolderServeWebPage, and BrowsableFolderServeWebPage.
This commit is contained in:
parent
25230bee02
commit
5b16231128
@ -1,8 +1,22 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="BrowsableFolderServeWebPage" inherits="FolderServeWebPage" version="3.7">
|
<class name="BrowsableFolderServeWebPage" inherits="FolderServeWebPage" version="3.7">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
|
The [BrowsableFolderServeWebPage] class adds folder listing functionality on top of [FolderServeWebPage].
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
|
The [BrowsableFolderServeWebPage] class adds folder listing functionality on top of [FolderServeWebPage]. Fundamentally it's the same as the Apache webserver's directory listing.
|
||||||
|
As an example let's take this folder:
|
||||||
|
[code]content_folder/
|
||||||
|
-- ct/
|
||||||
|
---- ctf.jpg
|
||||||
|
-- file1.md
|
||||||
|
-- test.jpg[/code]
|
||||||
|
A [FolderServeWebPage] is pointed to the [code]content_folder[/code] folder, it's set as a child of a [WebRoot], and it's uri segment is [code]served_files[/code]:
|
||||||
|
[code]Opening: http://127.0.0.1/served_files will send a generated html directory listing.
|
||||||
|
Opening: http://127.0.0.1/served_files/file1.md will send page1.md.
|
||||||
|
Opening: http://127.0.0.1/served_files/test.jpg will send page2.md.
|
||||||
|
Opening: http://127.0.0.1/served_files/ct will send a generated html directory listing.
|
||||||
|
Opening: http://127.0.0.1/served_files/ct/ctf.jpg will send ctf.jpg.[/code]
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
@ -10,6 +24,7 @@
|
|||||||
</methods>
|
</methods>
|
||||||
<members>
|
<members>
|
||||||
<member name="should_render_menu" type="bool" setter="set_should_render_menu" getter="get_should_render_menu" default="true">
|
<member name="should_render_menu" type="bool" setter="set_should_render_menu" getter="get_should_render_menu" default="true">
|
||||||
|
Whether to call [code]render_menu()[/code] when a directory listing is returned.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
<constants>
|
<constants>
|
||||||
|
@ -1,8 +1,22 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="FolderServeWebPage" inherits="WebNode" version="3.7">
|
<class name="FolderServeWebPage" inherits="WebNode" version="3.7">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
|
The [FolderServeWebPage] class serves files.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
|
The [FolderServeWebPage] class just serves files found in [code]serve_folder[/code], and it's subfolders. If a file does not exists, it sends a 404 error.
|
||||||
|
As an example let's take this folder:
|
||||||
|
[code]content_folder/
|
||||||
|
-- ct/
|
||||||
|
---- ctf.jpg
|
||||||
|
-- file1.md
|
||||||
|
-- test.jpg[/code]
|
||||||
|
A [FolderServeWebPage] is pointed to the [code]content_folder[/code] folder, it's set as a child of a [WebRoot], and it's uri segment is [code]served_files[/code]:
|
||||||
|
[code]Opening: http://127.0.0.1/served_files will send a 404 error.
|
||||||
|
Opening: http://127.0.0.1/served_files/file1.md will send page1.md.
|
||||||
|
Opening: http://127.0.0.1/served_files/test.jpg will send page2.md.
|
||||||
|
Opening: http://127.0.0.1/served_files/ct will send a 404 error.
|
||||||
|
Opening: http://127.0.0.1/served_files/ct/ctf.jpg will send ctf.jpg.[/code]
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
@ -10,11 +24,13 @@
|
|||||||
<method name="load">
|
<method name="load">
|
||||||
<return type="void" />
|
<return type="void" />
|
||||||
<description>
|
<description>
|
||||||
|
Refresh the internal [FileCache].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
<members>
|
<members>
|
||||||
<member name="serve_folder" type="String" setter="set_serve_folder" getter="get_serve_folder" default="""">
|
<member name="serve_folder" type="String" setter="set_serve_folder" getter="get_serve_folder" default="""">
|
||||||
|
The folder that will get served.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
<constants>
|
<constants>
|
||||||
|
Loading…
Reference in New Issue
Block a user