Skip to content

Commit 07c4635

Browse files
Fix documentation links (#81)
* see if User Guide is converted to html * display ford version * add pages folder and info to the ford build * see if the HTML files are generated * reorganize docs files, now builds and links
1 parent 2b725af commit 07c4635

4 files changed

Lines changed: 103 additions & 75 deletions

File tree

‎Docs/FTObjectLibraryProject.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
11
project: FTObjectLibrary
22
src_dir: ../Source
33
output_dir: ./HTMLdocs
4+
page_dir: ./pages
45
summary: A Fortran library for reference counted object and container classes.
56
author: David A. Kopriva
67
author_description: Department of Mathematics, The Florida State University
78
email: kopriva@math.fsu.edu
89
website: https://www.math.fsu.edu/~kopriva
9-
graph: true
10+
graph: true
1011
project_github: https://github.com/trixi-framework/FTObjectLibrary
1112
source: false
1213
predocmark:>
1314

1415
# Overview
1516

16-
FTObjectLibrary provides a collection of reference counted Fortran 2003 classes to
17+
FTObjectLibrary provides a collection of reference counted Fortran 2003 classes to
1718
facilitate writing generic object oriented Fortran programs. Reference counting
1819
is implemented to assist with memory management so that the lifespans of objects
1920
are properly maintained and are so that objects are deleted only when no other references are made to them.
20-
21+
2122
The library includes three categories of classes:
2223

2324
* Value classes
@@ -36,7 +37,7 @@ Included in the library are the following standard container classes:
3637
- FTStack is a subclass of FTLinkedList that adds the usual push, pop, and peek routines.
3738
- FTSparseMatrix associates a double index (i,j) to an FTObject. Basically this is a two dimensional sparse matrix of pointers to FTObjects.
3839
- FTMultiIndexTable associates an integer array keys(:) to an FTObject. Basically this is an m--dimensional sparse matrix of pointers to FTObjects.
39-
- FTDictionary is an ``associative container'', that associates a string to another FTObject.
40+
- FTDictionary is an ``associative container'', that associates a string to another FTObject.
4041
- FTValueDictionary is a subclass of FTDictionary that has additional methods to store and retrieve
4142
values.
4243
- FTMutableObjectArray is a mutable one-dimensional array class that can store any FTObject
@@ -46,11 +47,11 @@ values.
4647

4748
# Documentation
4849

49-
Documentation can be found in the [user's guide](UsersGuide.md).
50+
Documentation can be found in the [user's guide](page/UsersGuide.html).
5051

5152
# Examples
5253

53-
Examples can be found in the [Examples](../Examples) directory and in the [Testing](../Testing) directory. The examples include a simple reverse Polish calculator using a stack, and another showing the use of a linked list. The testing directory includes tests that can be run on the library, which themselves serve as examples of the use of all of the classes.
54+
Examples can be found in the [Examples](https://github.com/trixi-framework/FTObjectLibrary/tree/main/Examples) directory and in the [Testing](https://github.com/trixi-framework/FTObjectLibrary/tree/main/Testing) directory. The examples include a simple reverse Polish calculator using a stack, and another showing the use of a linked list. The testing directory includes tests that can be run on the library, which themselves serve as examples of the use of all of the classes.
5455

5556
# Building the Library
5657

@@ -73,3 +74,7 @@ make
7374
```
7475

7576
That will create the necessary files in that directory, which can be moved to somewhere else as desired.
77+
78+
# News
79+
80+
Notable additions are documented in the [News](page/News.html)
Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1+
---
2+
title: News
3+
---
4+
5+
[Back to the main documentation](../index.html)
6+
17
# News
28

3-
July 29, 2026
9+
## July 29, 2026
410

511
FTOL now has two versions, as necessary for procedures that need to distinguish between objects declared as TYPE and those declared as CLASS. See the documentation and the tests for examples.
612

7-
May 11, 2025
13+
## May 11, 2025
814

915
The stringValue() and stringValueForKey() functions now use allocated strings, so the requestedLength argument is no longer necessary. Existing code can continue to use the older versions, but those versions are deprecated and undocumented.

0 commit comments

Comments
 (0)