Recently Added Interaction Toolbox Platform

Wiki-engine (edit)

Semantic outlines in PIPI self-documentation.

Contents (edit)

[hide]
  1. Names
  2. Intro
  3. System
  4. Adaption
  5. Engineering
  6. DevOps
  7. Mission Control
  8. Research
  9. Discussion
  10. XRef

Intro (edit)

Short Description (edit)

Semantic outlines used in PIPI self-documentation.

Description (edit)

The Wiki Engine has the semantic outline the Doc Engine uses to produce system documentation.

Summary (edit)

PIPI8 could automatically create self-documentation through linked web pages. Refactoring PIPI8 to make PIPI9 broke the document generator.

This document is not a research report. It is a “fit for purpose” exercise to redraft a workable documentation code template for automatically generating hundreds of web pages and PDFs from live working software. Each page will be specific to one system inside PIPI Server. Each page section (with a h3 or h4 label) will have an edit button that opens up a web form to edit the underlying system directly or add a note.

The document omits the h5 and h6 level sections to simplify everything and includes examples of graphs and diagrams to give a sense of the final documentation's content and look.

Some systems will need alternate or additional sections. The Ontology Engine's documentation requirements differ significantly from the UI (User-Interface) or the Algorithm Engine.

Why This Engine

Creating the simpler Wiki Engine for internal documentation of PIPI removed dependency on the more complex and richer internal CMS system.

It automatically creates a wiki-style set of static web pages in HTML format for each internal object with a namespace. Each page can also have textural notes and images added directly by a human.

Each page uses object-type-specific templates.

Editing each system uses forms linked to its Wiki documentation page, updating the system and its Wiki page simultaneously.

The Pipi Wiki Engine can import into each relevant wiki page.
Examples include;

  • DevOps Logs.
  • Feature Requests.
  • Help Desk Logs.

CMS Engine can then import the Wiki-created web pages and incorporate them into richer content for other uses, including PDF documentation sets, training material, user documentation, DevDocs, and slides.

Next Steps

The document generator is database driven. The actual final layout will use style sheets (CSS3 and XSLT).

A matching Google Sheet, “PIPI Docs Template”, with the same information as this document in another format, once edited and completed, was imported back into a PIPI database on 4 August 2023.

The first crudely rendered html pages should be available by the end of August 2023. The generation of automated self-documentation by the PIPI Server version 9 is a work in progress and will likely evolve based on results and learnings.

Research

The generated systems documentation of the PIPI Server is for the use of Researchers (mathematicians, data scientists, complexity scientists, philosophers etc.), not developers and end users.

Development

DevOps teams will have access to generated developer documentation (Dev Docs), the IDE (Integrated Development Environment), etc.

End User

End users will have access to alternative developed contextual help files, etc.

Displays html code using EncodeForHtml()

<p>PIPI8 could automatically create self-documentation through linked web pages. Refactoring PIPI8 to make PIPI9 broke the document generator.</p>
<p>This document is not a research report. It is a &ldquo;fit for purpose&rdquo; exercise to redraft a workable documentation code template for automatically generating hundreds of web pages and PDFs from live working software. Each page will be specific to one system inside PIPI Server. Each page section (with a <abbr title="Heading 3">h3</abbr> or <abbr title="Heading 4">h4</abbr> label) will have an edit button that opens up a web form to edit the underlying system directly or add a note.</p>
<p>The document omits the h5 and h6 level sections to simplify everything and includes examples of graphs and diagrams to give a sense of the final documentation's content and look.</p>
<p>Some systems will need alternate or additional sections. The Ontology Engine's documentation requirements differ significantly from the UI (User-Interface) or the Algorithm Engine.</p>
<h4>Why This Engine</h4>
<p>Creating the simpler Wiki Engine for internal documentation of PIPI removed dependency on the more complex and richer internal CMS system.</p>
<p>It automatically creates a wiki-style set of static web pages in HTML format for each internal object with a namespace. Each page can also have textural notes and images added directly by a human.</p>
<p>Each page uses object-type-specific templates.</p>
<p>Editing each system uses forms linked to its Wiki documentation page, updating the system and its Wiki page simultaneously.</p>
<p>The Pipi Wiki Engine can import into each relevant wiki page.<br>
  Examples include;</p>
<ul>
  <li>DevOps Logs.</li>
  <li>Feature Requests.</li>
  <li>Help Desk Logs.</li>
</ul>
<p>CMS Engine can then import the Wiki-created web pages and incorporate them into richer content for other uses, including PDF documentation sets, training material, user documentation, DevDocs, and slides.</p>
<h4>Next Steps</h4>
<p>The document generator is database driven. The actual final layout will use style sheets (<abbr title="Cascading Style Sheet 3">CSS3</abbr> and XSLT).</p>
<p>A matching Google Sheet, &ldquo;PIPI Docs Template&rdquo;, with the same information as this document in another format, once edited and completed, was imported back into a PIPI database on 4 August 2023. </p>
<p>The first crudely rendered html pages should be available by the end of August 2023. The generation of automated self-documentation by the PIPI Server version 9 is a work in progress and will likely evolve based on results and learnings.</p>
<h4>Research</h4>
<p>The generated systems documentation of the PIPI Server is for the use of Researchers (mathematicians, data scientists, complexity scientists, philosophers etc.), not developers and end users.</p>
<h4>Development</h4>
<p>DevOps teams will have access to generated developer documentation (Dev Docs), the <abbr title="Integrated Development Environment">IDE</abbr> (Integrated Development Environment), etc.</p>
<h4>End User</h4>
<p>End users will have access to alternative developed contextual help files, etc.</p>

System (edit)

Environment (edit)

  • Doc Engine

Locations (edit)

Something goes here

Siblings (edit)

Subsystems (edit)

Relationships (edit)

Something goes here

Reservoir (edit)

Something goes here

DNA (edit)

Something goes here

Messaging (edit)

  • Tag1
  • Tag2

Adaption (edit)

Messages (edit)

20230201_ 2300:03:19 Some Message

Workflows (edit)

  • Workflow1
  • Workflow2

Parameters (edit)

  • Parameter1
  • Parameter2

Markov Chain (edit)

Something goes here.

Fuzzy Logic (edit)

Something goes here

States (edit)

  • State1
  • State2
  • State3

Engineering (edit)

Code (edit)

Language

  • CFML

Package

  • pkgWiki

Classes

Methods & Properties

Some HTML with BOLD text 
Some HTML with <b>BOLD</b> text

Data (edit)

Databases

  • sys-cor-eng-doc-wik
Schema
  • sys-cor-eng-doc-wik
#
Table Name
Description
Row Count
Disk Space
1
tblPipiSomethingClassType
32
16K
2
tblPipiSomethingClass
546
454K
3
tblPipSomethingFact
200
464K
4
tblPipiSomethingInstance
0
16K

Algorithms (edit)

  • Algorithm1
  • Algorithm2

DevOps (edit)

Help Desk (edit)

# Status Last Message Requester Subject Assignee
1 Open 20/08/2023 13:24 K F Bollum FAQ K U Howeth
2 Closed   T Chang YouTube embedding K U Howeth
3 On Hold   Mary Kim   K U Howeth
4 Pending   Auckland User Group   K U Howeth
5 Solved   Idaho Transport   K U Howeth

Feature Requests (edit)

Feature Requests
# Votes Status Issue Solution Semantic Outline
5 2356 Done Backend documentation Edit tblpipiWikiPageClass  
1 12 Next Namespace engine Fix Wiki Engine  
19 1 Underway Document Wiki Engine PIPI Docs Template  

OKR (edit)

Objective 1 - Increase uptime by 20%

Item Priority Team Timeline Due Date Progress % Target %
Key Result 1 5 DevOps Jan 2023 - Mar 2023 31/03/2023 32% 75
Key Result 2 4 DevOps     45% 69
Some thing here 4 DevOps       78
  2 DevOps       81
  1 DevOps       68

Release Testing (edit)

Release Testing
# Ver. Status Date Note Type Result
4 344 Yet to Start 20230801 Something here is crazy Canary  
3 344 Underway 20230723   Feature Flag  
2 343 Done 20230721   Feature Flag FAIL
1 343 Done 20230419   Auto SUCCESS

Chat (edit)

Mission Control (edit)

Public Cloud (edit)

Network (edit)

Security (edit)

Fibre Connect (edit)

Private Cloud (edit)

Research (edit)

Glossary (edit)

A list of terms with definitions.

Term Defintion
CAS Complex Adaptive System, i.e. something with emergent properties and can adapt. E.g. biological cell, living organism, ecosystem
GCP Google Cloud Platform
h1 HTMl semantic header level 1, i.e. Page Title
JHH John Henry Holland. An American Scientist
OKR Objectives - Key Results
A popular work methodology at Google, AWS etc., used to organise high-performance teams around objectives.

Hypothesis (edit)

Hypothesis 1

  • Experiment 1
  • Experiment 2

Hypothesis 2

  • Experiment 3
  • Experiment 4

Notes (edit)

Note 1 (Title | Author | Date)

Some text

Note 2 (Title | Author | Date)

Some text

Note 3 (Title | Author | Date)

Some text

XRef (edit)

References (edit)

  1. [1] Daintith, John, ed. (2009), "IT", A Dictionary of Physics, Oxford University Press, ISBN 978-0-1992-3399-1, retrieved 1 August 2012
  2. [2] Cooke-Yarborough, E. H. (June 1998), "Some early transistor applications in the UK", Engineering Science & Education Journal, 7 (3): 100–106, doi:10.1049/esej:19980301, ISSN 0963-7346

Further Reading (edit)

  • Holland, John (1992). Adaptation in Natural and Artificial Systems. Cambridge, MA: MIT Press. ISBN 978-0262581110.
  • Holland, John Hidden Order: How Adaptation Builds Complexity (1995, Basic Books); reviewed by Mark S. Miller in Reason
  • Holland, John Emergence: From Chaos to Order (1998, Basic Books)
  • Holland, John Signals and Boundaries: Building Blocks for Complex Adaptive Systems (2012, MIT Press)
  • Holland, John Complexity: A Very Short Introduction (2014, Oxford University Press)
  • Toward an Information Systems Ontology https://link.springer.com/chapter/10.1007/978-3-031-06516-3_5

Articles (edit)

  • "A universal computer capable of executing an arbitrary number of subprograms simultaneously", in: Proc. Eastern Joint Comp. Conf. (1959), pp. 108–112
  • "Iterative circuit computers", in: Proc. Western Joint Comp. Conf. (1960), pp. 259–265
  • "Outline for a logical theory of adaptive systems", in: JACM, Vol 9 (1962), no. 3, pp. 279–314
  • "Hierarchical descriptions, universal spaces, and adaptive systems", in: Arthur W. Burks, editor. Essays on Cellular Automata (1970). University of Illinois Press
  • "Using Classifier Systems to Study Adaptive Nonlinear Networks", in: Daniel L. Stein, editor. Lectures in the Sciences of Complexity (1989). Addison Wesley
  • "Concerning the Emergence of Tag-Mediated Lookahead in Classifier Systems", in: Stephanie Forrest, editor. Emergent Computation: self-organizing, collective, and cooperative phenomena in natural and computing networks (1990). MIT Press
  • "The Royal Road for Genetic Algorithms: Fitness Landscapes and GA Performance", in: Francisco J. Varela, Paul Bourgine, editors. Toward a Practice of Autonomous Systems: proceedings of the first European Conference on Artificial Life (1992). MIT Press
  • "Echoing Emergence: objectives, rough definitions, and speculations for ECHO-class models", in George A. Cowan, David Pines, David Meltzer, editors. Complexity: metaphors, models, and reality (1994), Addison-Wesley
  • "Can There Be A Unified Theory of Complex Adaptive Systems?", in: Harold J. Morowitz, Jerome L. Singer, editors. The Mind, The Brain, and Complex Adaptive Systems (1995). Addison-Wesley
  • "Board Games", in: John Brockman, editor. The Greatest Inventions of the Past 2000 Years (2000). Phoenix
  • "What is to Come and How to Predict It.", in: John Brockman, editor. The Next Fifty Years: science in the first half of the twenty-first century (2002). Weidenfeld & Nicolson

See Also (edit)

  • Docs Engine
  • Metadata Engine
  • Render Engine
  • PIPI Server Documentation
  • PIPI Version History

External Links (edit)

Keywords (edit)

Sharing (edit)

How to cite this page: Jo Sutherland. 'Prebbleton Nature Park Volunteers', pipiWiki - The encyclopedia of ecological restoration in New Zealand, updated 10-Oct-2008

URL to be used as a Reference Link: http://www.pipiWiki.org.nz/en/prebbleton-nature-park-volunteers.html

HTML Code To Embed Article: To Be Fixed, see statista

Updated (edit)

This page was last modified on 29 September 2024 by Ajabbi contributors.