[svn:parrot] r47679 - in branches/html_cleanup: . docs/index

coke at svn.parrot.org coke at svn.parrot.org
Fri Jun 18 00:43:18 UTC 2010


Author: coke
Date: Fri Jun 18 00:43:17 2010
New Revision: 47679
URL: https://trac.parrot.org/parrot/changeset/47679

Log:
Begin to remap layout of generated html using a simple json layout
(intended to replace config-in-code of Parrot::Docs::Section::*)

(pick JSON as we might eventually do this with parrot.)

Added:
   branches/html_cleanup/docs/index/
   branches/html_cleanup/docs/index/developer.json   (contents, props changed)
   branches/html_cleanup/docs/index/index.json   (contents, props changed)
   branches/html_cleanup/docs/index/ops.json   (contents, props changed)
   branches/html_cleanup/docs/index/pct_tutorial.json   (contents, props changed)
   branches/html_cleanup/docs/index/pdds.json   (contents, props changed)
   branches/html_cleanup/docs/index/pmcs.json   (contents, props changed)
   branches/html_cleanup/docs/index/tools.json   (contents, props changed)
Modified:
   branches/html_cleanup/MANIFEST

Modified: branches/html_cleanup/MANIFEST
==============================================================================
--- branches/html_cleanup/MANIFEST	Fri Jun 18 00:29:10 2010	(r47678)
+++ branches/html_cleanup/MANIFEST	Fri Jun 18 00:43:17 2010	(r47679)
@@ -1,7 +1,7 @@
 # ex: set ro:
 # $Id$
 #
-# generated by tools/dev/mk_manifest_and_skip.pl Mon Jun 14 16:49:50 2010 UT
+# generated by tools/dev/mk_manifest_and_skip.pl Fri Jun 18 00:35:06 2010 UT
 #
 # See below for documentation on the format of this file.
 #
@@ -409,6 +409,13 @@
 docs/imcc/README                                            [doc]
 docs/imcc/imcfaq.pod                                        [doc]
 docs/imcc/operation.pod                                     [doc]
+docs/index/developer.json                                   [doc]
+docs/index/index.json                                       [doc]
+docs/index/ops.json                                         [doc]
+docs/index/pct_tutorial.json                                [doc]
+docs/index/pdds.json                                        [doc]
+docs/index/pmcs.json                                        [doc]
+docs/index/tools.json                                       [doc]
 docs/intro.pod                                              [doc]
 docs/memory_internals.pod                                   [doc]
 docs/multidispatch.pod                                      [doc]

Added: branches/html_cleanup/docs/index/developer.json
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ branches/html_cleanup/docs/index/developer.json	Fri Jun 18 00:43:17 2010	(r47679)
@@ -0,0 +1,33 @@
+{
+   "page" : "ops",
+   "content" : [
+      {
+         "source" : [
+            "docs/parrotbyte.pod",
+            "docs/packfile-c.pod",
+            "docs/memory_internals.pod",
+            "docs/vtables.pod",
+            "docs/embed.pod",
+            "docs/porting_intro.pod"
+         ],
+         "type" : "group",
+         "title" : "Internals"
+      },
+      {
+         "source" : "docs/dev/*",
+         "type" : "group",
+         "title" : "Development Notes"
+      },
+      {
+         "source" : [
+            "docs/user/pir/*",
+            "docs/pmc/array.pod",
+            "docs/pmc/struct.pod",
+            "docs/pmc/subs.pod"
+         ],
+         "type" : "group",
+         "title" : "Articles"
+      }
+   ],
+   "title" : "Opcodes"
+}

Added: branches/html_cleanup/docs/index/index.json
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ branches/html_cleanup/docs/index/index.json	Fri Jun 18 00:43:17 2010	(r47679)
@@ -0,0 +1,68 @@
+{
+   "page" : "index",
+   "content" : [
+      {
+         "source" : [
+            "docs/intro.pod",
+            "docs/book/pct/ch02_getting_started.pod",
+            "docs/parrot.pod",
+            "docs/project/roles_responsibilities.pod",
+            "docs/parrothist.pod",
+            "DONORS.pod",
+            "docs/glossary.pod",
+            "docs/project/support_policy.pod"
+         ],
+         "type" : "group",
+         "title" : "Introduction"
+      },
+      {
+         "source" : [
+            "docs/running.pod",
+            "docs/tests.pod",
+            "docs/gettingstarted.pod",
+            "docs/submissions.pod"
+         ],
+         "type" : "group",
+         "title" : "Working with Parrot"
+      },
+      {
+         "source" : [
+            "docs/book/pct/ch03_compiler_tools.pod",
+            ":PCT_tutorial",
+            "docs/book/pct/ch04_pge.pod",
+            "docs/book/pct/ch05_nqp.pod",
+            "docs/compiler_faq.pod"
+         ],
+         "type" : "group",
+         "title" : "Implementing Languages on Parrot"
+      },
+      {
+         "source" : [
+            "docs/overview.pod",
+            ":pdds",
+            ":pmcs",
+            ":ops",
+            ":developer",
+            ":tools",
+            "editor/README.pod"
+         ],
+         "type" : "group",
+         "title" : "Design, Internals & Development"
+      },
+      {
+         "source" : [
+            "docs/book/pir/*"
+         ],
+         "type" : "group",
+         "title" : "PIR Book"
+      },
+      {
+         "source" : [
+            "docs/book/pir/*"
+         ],
+         "type" : "group",
+         "title" : "PCT Book"
+      }
+   ],
+   "title" : "Home"
+}

Added: branches/html_cleanup/docs/index/ops.json
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ branches/html_cleanup/docs/index/ops.json	Fri Jun 18 00:43:17 2010	(r47679)
@@ -0,0 +1,16 @@
+{
+   "page" : "ops",
+   "content" : [
+      {
+         "source" : "src/ops/*.ops",
+         "type" : "group",
+         "title" : "Opcode Libraries"
+      },
+      {
+         "source" : "src/dynoplibs/*.ops",
+         "type" : "group",
+         "title" : "Dynamic Opcode Libraries"
+      }
+   ],
+   "title" : "Opcodes"
+}

Added: branches/html_cleanup/docs/index/pct_tutorial.json
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ branches/html_cleanup/docs/index/pct_tutorial.json	Fri Jun 18 00:43:17 2010	(r47679)
@@ -0,0 +1,21 @@
+{
+   "page" : "PCT_Tutorial",
+   "content" : [
+      {
+         "source" : [
+            "examples/languages/squaak/doc/tutorial_episode_1.pod",
+            "examples/languages/squaak/doc/tutorial_episode_2.pod",
+            "examples/languages/squaak/doc/tutorial_episode_3.pod",
+            "examples/languages/squaak/doc/tutorial_episode_4.pod",
+            "examples/languages/squaak/doc/tutorial_episode_5.pod",
+            "examples/languages/squaak/doc/tutorial_episode_6.pod",
+            "examples/languages/squaak/doc/tutorial_episode_7.pod",
+            "examples/languages/squaak/doc/tutorial_episode_8.pod",
+            "examples/languages/squaak/doc/tutorial_episode_9.pod"
+         ],
+         "type" : "group",
+         "title" : "Tutorial of Parrot Compiler Tools"
+      }
+   ],
+   "title" : "PCT_Tutorial"
+}

Added: branches/html_cleanup/docs/index/pdds.json
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ branches/html_cleanup/docs/index/pdds.json	Fri Jun 18 00:43:17 2010	(r47679)
@@ -0,0 +1,11 @@
+{
+   "page" : "pdds",
+   "content" : [
+      {
+         "source" : "docs/pdds/**",
+         "type" : "group",
+         "title" : "Design Documents"
+      }
+   ],
+   "title" : "Parrot Design Documents (PDDs)"
+}

Added: branches/html_cleanup/docs/index/pmcs.json
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ branches/html_cleanup/docs/index/pmcs.json	Fri Jun 18 00:43:17 2010	(r47679)
@@ -0,0 +1,35 @@
+{
+   "page" : "pmc",
+   "content" : [
+      {
+         "source" : [
+            "tools/dev/gen_class.pl"
+         ],
+         "type" : "group",
+         "title" : "Tools"
+      },
+      {
+         "source" : [
+            "src/pmc/default.pmc",
+            "src/pmc/scalar.pmc"
+         ],
+         "type" : "group",
+         "title" : "Abstract PMCs"
+      },
+      {
+         "source" : "src/pmc/*.pmc",
+         "type" : "group",
+         "title" : "Abstract PMCs",
+         "exclude" : [
+            "src/pmc/default.pmc",
+            "src/pmc/scalar.pmc"
+         ]
+      },
+      {
+         "source" : "src/dynpmc/*.pmc",
+         "type" : "group",
+         "title" : "Dynamic PMCs"
+      }
+   ],
+   "title" : "PMCs"
+}

Added: branches/html_cleanup/docs/index/tools.json
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ branches/html_cleanup/docs/index/tools.json	Fri Jun 18 00:43:17 2010	(r47679)
@@ -0,0 +1,74 @@
+{
+   "page" : "tools",
+   "content" : [
+      {
+         "source" : [
+            "tools/dev/as2c.pl",
+            "tools/build/vtable_h.pl",
+            "tools/build/vtable_extend.pl"
+         ],
+         "type" : "group",
+         "title" : "Configuration"
+      },
+      {
+         "source" : [
+            "docs/configuration.pod",
+            "tools/build/c2str.pl",
+            "tools/build/parrot_config_c.pl",
+            "tools/build/pmc2c.pl",
+            "tools/dev/install_files.pl",
+            "tools/dev/mk_manifest_and_skip.pl",
+            "tools/dev/symlink.pl",
+            "tools/dev/mk_native_pbc"
+         ],
+         "type" : "group",
+         "title" : "Building"
+      },
+      {
+         "source" : [
+            "parrotbug",
+            "tools/dev/manicheck.pl",
+            "docs/tests.pod"
+         ],
+         "type" : "group",
+         "title" : "Testing"
+      },
+      {
+         "source" : [
+            "tools/dev/lib_deps.pl",
+            "tools/dev/parrot_coverage.pl",
+            "tools/docs/write_docs.pl"
+         ],
+         "type" : "group",
+         "title" : "Documentation"
+      },
+      {
+         "source" : [
+            "tools/dev/bench_op.pir",
+            "tools/dev/parrotbench.pl"
+         ],
+         "type" : "group",
+         "title" : "Benchmarking"
+      },
+      {
+         "source" : [
+            "tools/dev/list_unjitted.pl",
+            "tools/dev/gen_class.pl",
+            "tools/dev/nm.pl",
+            "tools/util/ncidef2pasm.pl",
+            "tools/dev/pbc_header.pl"
+         ],
+         "type" : "group",
+         "title" : "Utilities"
+      },
+      {
+         "source" : [
+            "docs/debug.pod",
+            "docs/debugger.pod"
+         ],
+         "type" : "group",
+         "title" : "Debugging"
+      }
+   ],
+   "title" : "Tools"
+}


More information about the parrot-commits mailing list