Kontent - Managing Duplicate Information

Websites tend to contain a lot of duplicate information, for instance:

It would be very time consuming and error prone to manually copy and paste these parts into every webpage.

I can think of a number of options for managing this situation such as:

Server side includes (SSI) or php include

This allows html files to be included into other html files, this including is done in realtime when the webpage is requested from the web. This allows a section of html to be included in many pages without any physical duplication.

html does not have an 'include' tag so it is embedded in a comment as follows:

<!--#include src="hostDirectoryPath\filea.htm" -->
text in base file
<!--#include virtual="hostDirectoryPath\fileb.htm" -->

However this option does have some problems such as,

Eric has pointed out (here) that it would be better to use <?php include("myfile.html") ?>

Local includes

This option might allow similar functionality to SSI, but instead uses kontent to combine the html on the local computer. This means there would be 2 file trees on the local computer, the first tree is edited directly by the user, the second tree is then generated automatically from the first, this can then be previewed before being uploaded to the server. This would not have the disadvantages of SSI and could be more flexible, for example, links from file 'a' might be relative to the file itself or relative to the file that included it.

It might be possible to allow several layers of includes, in other words an include inside another include inside another include and so on. This would require a mechanism to specify which level in the file hierarchy any links are relative to.

Templates and Library items

Dreamweaver uses templates and library items to include common information in web pages.

It uses comment tags to show where the template elements occur in the file, the template information is included in every file that uses it but this duplication is managed by dreamweaver to make sure that any changes to the template are copied into every file that uses it.

The extra information to manage this is uploaded to the server but it is ignored by the browser because it is encoded as a comment as follows:

<html>
<!-- #BeginTemplate "/Templates/softwarePageKontent.dwt" -->
<head>
<!-- #BeginEditable "doctitle" -->
<title>kontent - managing duplicate information - Martin Baker</title>
<!-- #EndEditable -->

The advantage of this is that all the information is included in the file and it can be previewed and tested locally. The disadvantages are:

Includes from Database

This is similar to local includes but instead of including from a file we include text from a database. This database might not necessarily be a relational database I think it would be better to use an XML file.

This would have a lot of advantages, it could make it easier to check and update this information across the website. However, it does have limitations, I don't think it would be very practical to include large chunks of text from the database. Due to this it would be good to combine this method with one of the other methods on this page.

Frames

The common information is included as a html frame. This means that a frame can be included in many web pages and therefore avoid duplicating data.

However the frames mechanism has a number of disadvantages,

One possibility might be to use frames when the files are edited locally but convert to a complete page for uploading to the server, this would be similar to the local includes method above.

Conclusion

I suggest using both local includes and includes from a database. I would welcome any views on this.


metadata block
see also:

 

Correspondence about this page

Book Shop - Further reading.

Where I can, I have put links to Amazon for books that are relevant to the subject, click on the appropriate country flag to get more details of the book or to buy it from them.

cover Processing XML with Java: A Guide to SAX, DOM, JDOM, JAXP, and TrAX

Other Java books

Commercial Software Shop

Where I can, I have put links to Amazon for commercial software, not directly related to this site, but related to the subject being discussed, click on the appropriate country flag to get more details of the software or to buy it from them.

cover JBuilder - There is also a free version of Jbuilder at borland website . However its licence conditions are quite restrictive so you may prefer another java IDE.

This site may have errors. Don't use for critical systems.

Copyright (c) 1998-2017 Martin John Baker - All rights reserved - privacy policy.