69 replies to this topic

[Psycho Mantis]

Is there a way to make the snippet list the sites alphabetically?
Like this:

- level 1 a
-- level 2 a/a
-- level 2 a/b
- level 1 b
-- level 2 b/a
-- level 2 b/b
etc.

with the a's and b's in level to always coresponding to the level 1 item of course.

Edited by Psycho Mantis, 04 October 2005 - 11:16 AM.

[cathode]

I love this snippet, but I have pretty much confirmed that the selfAsLink is not really working correctly, it's always false even whet I set it to true... has anyone else noticed this?

Thanks!

[jaredc]

VERSION UPDATE 0.6i

** 0.6i **
- Fixed bug that was keeping current page from being a link when $selfAsLink
is set to true.
- Also did a little more elegant method of detecting if the function has been
declared already.

Edited by jaredc, 20 January 2006 - 03:32 PM.

[jaredc]

I've seen several sites using this snippet where the description gets outputed below the page link instead of directly after it, how can I do this with my own sitemap which uses this snippet?

It's a style issue. The description is enclosed in a span:

<span class="LSM_description">...</span>

So all you have to do is define in your stylesheet that you want that span displayed as a block.

Is there a way to make the snippet list the sites alphabetically?

Yes. There is no config option for this, but the hack is easy enough. Change this line (about 75):

$children = $funcEtomite->getAllChildren($listParent, 'menuindex', 'ASC', 'id, pagetitle, description, parent, alias, longtitle, published');

To:

$children = $funcEtomite->getAllChildren($listParent, 'pagetitle', 'ASC', 'id, pagetitle, description, parent, alias, longtitle, published');

Sorry to be so slow in responding to these issues!

[lloyd_borrett]

G'day,

Just where is ListSiteMap 0.6i ?

In the Snippet library, it's still 0.6h.

I'd spotted some problems with ListSiteMap 0.6h (showDescription, removeNewLines, not stripping " out of title attributes), plus I needed to be able to pass showDescription in the snippet call.

So I had already started to produce my own ListSiteMap 0.6i as follows:

// --------------------
// Snippet: ListSiteMap
// --------------------
// Version: 0.6i
// Date: 2005.07.08
// jaredc@honeydewdesign.com
//
// This snippet was designed to show a nested
// list site map with each pagetitle being a
// link to that page. It will not include
// unpublished folders/pages OR its children,
// even if the children ARE published.

// 0.6i changes by Lloyd Borrett - 2006-04-15
// Strip " out of title attributes
// Fixed problems with removeNewLine and selfAsLink
// Added show description as a parameter

// Config
   // $siteMapRoot [int]
   // The parent ID of your root. Default 0. Can be set in 
   // snippet call with LSM_root (to doc id 10 for example):
   // [[ListSiteMap?LSM_root=10]]
   $siteMapRoot = 0;

   // $showDescription [true | false]
   // Specify if you would like to include the description
   // with the page title link. Can be set in snippet call
   // with LSM_desc as 1 for true or 0 for false
   // [[ListSiteMap?LSM_desc=0]]
   $showDescription = false;

   // $titleOfLinks [ string ]
   // What database field do you want the title of your links to be?
   // The default is pagetitle because it is always a valid (not empty)
   // value, but if you prefer it can be any of the following:
   // id, pagetitle, description, parent, alias, longtitle
   $titleOfLinks = 'pagetitle';
   
   // $removeNewLines [ true | false ]
   // If you want new lines removed from code, set to true. This is generally
   // better for IE when lists are styled vertically. 
   $removeNewLines = true;
   
   // $maxLevels [ int ]
   // Maximum number of levels to include. The default 0 will allow all
   // levels. Also settable with snippet variable LSM_levels:
   // [[ListSiteMap?LSM_levels=2]]
   $maxLevels = 0;
   
   // $selfAsLink [ true | false ]
   // Define if the current page should be a link (true) or not (false)
   $selfAsLink = true;
   
   // $showUnpubs [ true | false ]
   // Decide to include items in unpublished folders. This will show the
   // unpublished items as well. No links will be made for the unpublished items
   // but they will be shown in the structure. You will not likely want to do
   // this but the option is yours.
   $showUnpubs = false;

// Styles
//
// .LSM_currentPage    span surrounding current page if $selfAsLink is false
// .LSM_unpubPage      span surrounding unpublished page
// .LSM_description    description of page
// .LSM_N              ul style where N is the level of nested list- starting at 0

// ###########################################
// End config, the rest takes care of itself #
// ###########################################

// Initialize
$siteMapRoot = (isset($LSM_root))? $LSM_root : $siteMapRoot;
$maxLevels = (isset($LSM_levels))? $LSM_levels : $maxLevels;
if (isset($LSM_desc)) {
  if ($LSM_desc == '0') {
    $showDescription = false;
  } else if ($LSM_desc == '1') {
    $showDescription = true;
  }
}
$ie = ($removeNewLines)? '' : "\n";

// Overcome single use limitation on functions
global $MakeMapDefined;

if(!isset($MakeMapDefined)){
  function MakeMap($funcEtomite, $listParent, $listLevel, $description, $titleOfLinks,$maxLevels,$su,$ie,$selfAsLink){
    $children = $funcEtomite->getAllChildren($listParent, 'menuindex', 'ASC', 'id, pagetitle, description, parent, alias, longtitle, published');
    $output .= '<ul class="LSM_'.$listLevel.'">'.$ie;
    foreach($children as $child){
    
      // skip unpubs unless desired
      if (!$su && !$child['published']) continue;
      
      $descText = ($description)? ' <span class="LSM_description">'.$child['description'].'</span>' : '';
      $output .= '<li>';
      if (!$selfAsLink && ($child['id'] == $funcEtomite->documentIdentifier)){
        $output .= '<span class="LSM_currentPage">'.$child['pagetitle'].'</span>';
      } else if (!$child['published']){
        $output .= '<span class="LSM_unpubPage">'.$child['pagetitle'].'</span>';
      } else {
        $output .= '<a href="[~'.$child['id'].'~]" title="'.str_replace('"',"'",$child[$titleOfLinks]).'">'.$child['pagetitle'].'</a>';
      }
      $output .= $descText;
      if ($funcEtomite->getAllChildren($child['id']) && (($maxLevels==0) || ($maxLevels > $listLevel+1 ))){
        $output .= MakeMap($funcEtomite,$child['id'],$listLevel+1,$description,$titleOfLinks,$maxLevels,$su,$ie,$selfAsLink);
      }
      $output .= '</li>'.$ie;
    }
    $output .= '</ul>'.$ie;
    return $output;
  }
  $MakeMapDefined = true;
}

return MakeMap($etomite, $siteMapRoot, 0, $showDescription, $titleOfLinks,$maxLevels,$showUnpubs,$ie,$selfAsLink);

Best Regards, Lloyd.

Edited by lloyd_borrett, 15 April 2006 - 12:13 AM.

[lloyd_borrett]

G'day,

In order to created a slighty more graphical way of listing a site map, I've taken ListSiteMap, made some changes to the XHTML it outputs, plus added some additional CSS details to my Mollio stylesheet.

You can see it in action at: http://www.scubadoctor.com.au/site-map.htm.

The CSS changes aren't really specific to the Mollio template. You could add the details in this sitemap.css file to just about any CSS file and get it to still work.

The sitemap.css file is expecting to get its images from an image sub-directory below where the CSS file is.

I've broken some of ListSiteMap's options in creating this version. I just didn't need to continue support for them in order to get what I wanted. If you still do, then feel free to make the changes required for those options to work again.

You will find the snippet, CSS file and images required in the attached sitemap.zip file.

Best Regards, Lloyd.

 Sitemap.zip   5.25KB   121 downloads

Edited by lloyd_borrett, 10 September 2007 - 09:57 PM.

[PaulD]

Great site map, because I can easily change the images I am playing with it for a main 'ish' navigation.

I love your drop down menus, especially when they are highlighted in blue for a current page and the list is long like the contact page. Is it easy to change the backgrounds like that - it looks like it might be very complicated.

Paul

[lloyd_borrett]

G'day Paul,

It's a bit off topic, but those drop down menus are a standard part of the Mollio template. Just two image files are used. The "grey" one is used for the non-highlighted menu, and a "blue" one is used for the highlighted menus.

The same grey image file is used as the background for the feature boxes as well.

The Mollio template designer has even made the Adobe Photoshop files he used to build the graphics used by the template available. I simply used those Photoshop files to create my "blue" Scuba Doctor versions.

Best Regards, Lloyd.

[0zz]

I am using this snippet to dislay ..mm well, site map!

but my file structure includes unpublished folders with published documents:

--Page 1
--Page 2
--Folder 1
----Folder 2 (unpublished)
------Page 3
------Page 4
--Folder 3

And the snippet "stops" at the unpublished folder and does not display the published pages inside..
So, I only get:

--Page 1
--Page 2
--Folder 1
--Folder 3

Is there a way to change that? I've tryed increase "Levels" setting, but it doesn't help..

Thanks a lot!

Edited by 0zz, 10 June 2006 - 11:40 AM.

[Jelmer]

I think this option in the config part of the snippet will do the trick:

// $showUnpubs [ true | false ]
   // Decide to include items in unpublished folders. This will show the
   // unpublished items as well. No links will be made for the unpublished items
   // but they will be shown in the structure. You will not likely want to do
   // this but the option is yours.
   $showUnpubs = false;

[lloyd_borrett]

G'day,

As I recall, there is a $showUnpubs configuration variable in the snippet.

Set it to true, instead of false, and you should get the unpublished documents being listed as well.

Best Regards, Lloyd Borrett.

[0zz]

Thank you, Jelmer and lloyd_borret, I wonder why I didn't notice this setting myself.. :)

[brainshock]

Hi. I'm using this snippet for am navigation.
I cannot solve my problem: I'm trying to modify this snippet so that it only shows the next level under the active link (I have a site with e.g. 6 levels; when I'm currently at level 3 I want the visitor to see all levels above level 3 and all links in level 4; levels 5 and 6 are invisible).

Then another problem: when I'm at level 3 I want that the parent links (level 2 and 1) are "active" (have a css-class).

// Config
   // $siteMapRoot [int]
   // The parent ID of your root. Default 0. Can be set in 
   // snippet call with LSM_root (to doc id 10 for example):
   // [[ListSiteMap?LSM_root=10]]
   $siteMapRoot = 56;

   // $showDescription [true | false]
   // Specify if you would like to include the description
   // with the page title link.
   $showDescription = false;

   // $titleOfLinks [ string ]
   // What database field do you want the title of your links to be?
   // The default is pagetitle because it is always a valid (not empty)
   // value, but if you prefer it can be any of the following:
   // id, pagetitle, description, parent, alias, longtitle
   $titleOfLinks = 'pagetitle';
   
   // $removeNewLines [ true | false ]
   // If you want new lines removed from code, set to true. This is generally
   // better for IE when lists are styled vertically. 
   $removeNewLines = false;
   
   // $maxLevels [ int ]
   // Maximum number of levels to include. The default 0 will allow all
   // levels. Also settable with snippet variable LSM_levels:
   // [[ListSiteMap?LSM_levels=2]]
   //$maxLevels = 0;
   
   
   // $selfAsLink [ true | false ]
   // Define if the current page should be a link (true) or not
   // (false)
   $selfAsLink = true;
   
   // $showUnpubs [ true | false ]
   // Decide to include items in unpublished folders. This will show the
   // unpublished items as well. No links will be made for the unpublished items
   // but they will be shown in the structure. You will not likely want to do
   // this but the option is yours.
   $showUnpubs = false;

// Styles
//
// .LSM_currentPage	span surrounding current page if $selfAsLink is false
// .LSM_description	description of page
// .LSM_N			  ul style where N is the level of nested list- starting at 0

// ###########################################
// End config, the rest takes care of itself #



// ###########################################

// Initialize
$siteMapRoot = (isset($LSM_root))? $LSM_root : $siteMapRoot;
$maxLevels = (isset($LSM_levels))? $LSM_levels : $maxLevels;
$ie = "";

// Overcome single use limitation on functions
global $MakeMapDefined;

if(!isset($MakeMapDefined)){
  function MakeMap($funcEtomite, $listParent, $listLevel, $description, $titleOfLinks,$maxLevels,$su){
	$children = $funcEtomite->getAllChildren($listParent, 'menuindex', 'ASC', 'id, pagetitle, description, parent, alias, longtitle, published, deleted');
	// $output .= "" . '<ul class="navlist'.$listLevel.'">'.$ie;
		foreach($children as $child){
	
	  // skip unpubs unless desired
	  if (!$su && !$child['published']) continue;
	  if($child['deleted']) continue;

	  $descText = ($description)? ' <span class="LSM_description">'.$child['description'].'</span>' : '';

	  //$output .= '<li class="level' . $listLevel . '">';

	  if($child['id'] == $funcEtomite->documentIdentifier){
		$aktiverlink = ' activel' . $listLevel;
	  }
	  
	  if (!$selfAsLink && ($child['id'] == $funcEtomite->documentIdentifier)){
		$output .= '<li class="level' . $listLevel . $aktiverlink . '"><a href="' . '[~'. $child['id'].'~]' . '" title="'.$child[$titleOfLinks].'">'.$child['pagetitle'].'</a></li>'."\n";
	  } else if (!$child['published']){
		$output .= $child['pagetitle'];
	  }else{
		$output .= '<li class="level' . $listLevel . '"><a href="' . '[~'. $child['id'].'~]' . '" title="'.$child[$titleOfLinks].'">'.$child['pagetitle'].'</a></li>'."\n";
	  }
	  $output .= $descText;
	  if ($funcEtomite->getAllChildren($child['id']) && (($maxLevels==0) || ($maxLevels > $listLevel+1 ))){
		$output .= MakeMap($funcEtomite,$child['id'],$listLevel+1,$description,$titleOfLinks,$maxLevels,$su);
	  }
	  //$output .= '</li>'."\n";
	  }

	// $output .= '</ul>'.$ie;
	return $output;
  }
  $MakeMapDefined = true;
}

return MakeMap($etomite, $siteMapRoot, 0, $showDescription, $titleOfLinks,$maxLevels,$showUnpubs);

Any ideas?

[jaredc]

This really isn't the snippet you're looking for. LSM works by starting at some node and working DOWN through the tree. You are looking for a snippet that looks at a node (namely current doc) and looks UP.

There are other navigation snippets that do this but I'm not terribly well versed in them any more as I've not been an active user in a while. I know I wrote ListMenu to be UPward looking, but not sure it will do one level down too.

[lloyd_borrett]

G'day,

While starting on a new site today, I noticed that the ListSiteMap snippet lists deleted documents. So I've produced this version which doesn't include deleted documents and their children in the list.

/**
 * --------------------
 * Snippet: ListSiteMap
 * --------------------
 * Version: 0.6j
 * Date: 2007-03-02
 * Original author: jaredc@honeydewdesign.com 2005-07-08

 * This snippet was designed to show a nested
 * list site map with each pagetitle being a
 * link to that page. It will not include
 * unpublished folders/pages OR its children,
 * even if the children ARE published.

 * Changes by Lloyd Borrett

 * Version: 0.6i-starscribe 2006-04-21
 * Adapted for use with Mollio-ScubaDoc templates
 * Strip " out of title attributes
 * Fixed problems with removeNewLine and selfAsLink
 * Added show description as a parameter

* Version: 0.6j 2007-03-02
 * Modified to not list deleted documents

 */

// Config 

// $siteMapRoot [int]
// The parent ID of your root. Default 0. Can be set in
// snippet call with LSM_root (to doc id 10 for example):
// [[ListSiteMap?LSM_root=10]]
$siteMapRoot = 0; 

// $showDescription [true | false]
// Specify if you would like to include the description
// with the page title link. Can be set in snippet call
// with LSM_desc as 1 for true or 0 for false
// [[ListSiteMap?LSM_desc=0]]
$showDescription = true; 

// $titleOfLinks [ string ]
// What database field do you want the title of your links to be?
// The default is pagetitle because it is always a valid (not empty)
// value, but if you prefer it can be any of the following:
// id, pagetitle, description, parent, alias, longtitle
$titleOfLinks = 'pagetitle'; 

// $removeNewLines [ true | false ]
// If you want new lines removed from code, set to true. This is generally
// better for IE when lists are styled vertically.
$removeNewLines = false; 

// $maxLevels [ int ]
// Maximum number of levels to include. The default 0 will allow all
// levels. Also settable with snippet variable LSM_levels:
// [[ListSiteMap?LSM_levels=2]]
$maxLevels = 0; 

// $selfAsLink [ true | false ]
// Define if the current page should be a link (true) or not (false)
$selfAsLink = true; 

// $showUnpubs [ true | false ]
// Decide to include items in unpublished folders. This will show the
// unpublished items as well. No links will be made for the unpublished items
// but they will be shown in the structure. You will not likely want to do
// this but the option is yours.
$showUnpubs = false;

// Styles

// .LSM_currentPage	span surrounding current page if $selfAsLink is false
// .LSM_unpubPage	  span surrounding unpublished page
// .LSM_description	description of page
// .LSM_N			  ul style where N is the level of nested list- starting at 0

// ###########################################
// End config, the rest takes care of itself #
// ###########################################

// Initialize
$siteMapRoot = (isset($LSM_root))? $LSM_root : $siteMapRoot;
$maxLevels = (isset($LSM_levels))? $LSM_levels : $maxLevels;
if (isset($LSM_desc)) {
	if ($LSM_desc == '0') {
		$showDescription = false;
	} else if ($LSM_desc == '1') {
		$showDescription = true;
	} 
} 
$ie = ($removeNewLines)? '' : "\n";

// Overcome single use limitation on functions
global $MakeMapDefined;

if (!isset($MakeMapDefined)) {
	function MakeMap($funcEtomite, $listParent, $listLevel, $description, $titleOfLinks, $maxLevels, $su, $ie, $selfAsLink)
	{
		$children = $funcEtomite->getAllChildren($listParent, 'menuindex', 'ASC', 'id, pagetitle, description, parent, alias, longtitle, published, deleted');
		if ($listLevel == 0) {
			$output .= '<ul class="last">' . $ie;
		} else {
			$output .= '<ul>' . $ie;
		} 

		$lastChild = count($children);
		$thisChild = 0;
		foreach($children as $child) {
			$thisChild++; 
			// skip unpubs unless desired
			if ((!$su && !$child['published']) || $child['deleted']) continue; 
			// has children?
			$hasChildren = $funcEtomite->getAllChildren($child['id']);

			$descText = ($description)? $child['description'] : '';
			if (($thisChild == $lastChild) && ($listLevel != 0)) {
				$output .= '<li class="last">';
			} else {
				$output .= '<li>';
			} 
			// if (!$selfAsLink && ($child['id'] == $funcEtomite->documentIdentifier)){
			// $output .= '<span class="LSM_currentPage">'.$child['pagetitle'].'</span>';
			// } else if (!$child['published']){
			// $output .= '<span class="LSM_unpubPage">'.$child['pagetitle'].'</span>';
			// } else {
			$output .= '<a href="[~' . $child['id'] . '~]"';
			$output .= ' title="' . trim(str_replace('"', "'", $child[$titleOfLinks])) . '"';
			if ($hasChildren) {
				$output .= ' class="folder"';
			} 
			$output .= '>' . $child['pagetitle'] . '</a>';
			// }
			if ($descText != '') {
				$output .= ' <small>' . $descText . '</small>';
			} 
			if ($hasChildren && (($maxLevels == 0) || ($maxLevels > $listLevel + 1))) {
				$output .= MakeMap($funcEtomite, $child['id'], $listLevel + 1, $description, $titleOfLinks, $maxLevels, $su, $ie, $selfAsLink);
			} 
			$output .= '</li>' . $ie;
		} 
		$output .= '</ul>' . $ie;
		return $output;
	} 
	$MakeMapDefined = true;
} 

$output = '<div id="sitemap">' . $ie;
$output .= MakeMap($etomite, $siteMapRoot, 0, $showDescription, $titleOfLinks, $maxLevels, $showUnpubs, $ie, $selfAsLink);
$output .= '</div> <!-- end sitemap -->' . $ie;
return $output;

Best Regards, Lloyd Borrett.

Edited by lloyd_borrett, 02 March 2007 - 09:36 AM.

[Ralph]

G'day,

While starting on a new site today, I noticed that the ListSiteMap snippet lists deleted documents. So I've produced this version which doesn't include deleted documents and their children in the list.

<<< SNIP >>>

Best Regards, Lloyd Borrett.

Wouldn't it have been easier to just change getAllChildren() to getActiveChildren() as, if I'm not mistaken, has been mentioned elsewhere...???

[Jim Browski]

Sorry, LLoyd, but this is not working ...

If I use your snippet as posted i get the following error:

Missing argument 8 for MakeMap(), called in /.../index.php(591) : eval()'d code on line 109

Seems like the "$ie" (or "$removeNewLines") is not set/processed as suggested.

[cathode]

I've been using a version of this snippet that is more semantic, using ul, li, and h1, h2, etc for the formatting instead of the fieldsets.

I'd love for that to be rolled into this version... I'd be willing to do it once the bugs are worked out. Or, it may be easier to include this update into my version.

[Jim Browski]

I've been using a version of this snippet that is more semantic, using ul, li, and h1, h2, etc for the formatting instead of the fieldsets.

The ListSiteMap-Snippet that ships with etomite does not generate any "fieldset" at all.
(See http://www.etomite.c...=...ost&p=32982)
Nevertheless I would like to see the use of h1-h4 for nested sites.

But there is another issue regarding XHTML1.1-compatability:
ListSiteMap generates entries like this:

<ul>
   <li>
	  <a href="#">Content</a>
	  <ul></ul>
   </li>
</ul>

That happens if pages do not have any child. Empty <ul> elements are not allowed in XHTML1.1, so the above code is not valid. Maybe one could also adress this issue while modifying this snippet. I will take a look at this.

[lloyd_borrett]

G'day,

I'm not sure what the problem is because it's working just fine for me.

My first thought was to switch to using getActiveChildren, but one of the options of the snippet is to show unpublished documents. I never use that option, but I guess if it's there, some people might be.

I'll take a look at the

<ul></ul>

problem soon.

Best Regards, Lloyd Borrett.