5a2a287752bfffefea112e55c390398568dbb8fa
3 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
Viktor Szakats
|
c1bde05495 |
2016-10-26 12:50 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
- extras/hbdoc/_tmplate.prg
- extras/hbdoc/hbdoc.ch
* extras/hbdoc/_genbase.prg
* extras/hbdoc/_genhtml.prg
* extras/hbdoc/_gentxt.prg
* extras/hbdoc/_genxml.prg
* extras/hbdoc/hbdoc.hbp
* extras/hbdoc/hbdoc.prg
+ improve readability by paragraphs spacing in DESCRIPTION sections
+ improve divs in section content for better control via CSS
+ improve readability of tables with borders and
header hightlights
* change default output to single-file
+ add support for the old <table>/<fixed> tags in html output until they
are converted to something better
+ add support for <b>/<b>, <URL:url>, Markdown `inline code`,
_emphasis_, *bold*, character escaping \*, line separators ===/---,
and fenced code using triple backticks.
Very limited and not with standard compliance or completeness
in mind, just to be able to use some basic formatting.
; TODO: Markdown URL and lists, then replace all <b>,<URL>,<fixed>
markup with Markdown equivalents in docs
+ better localization support
+ add support for one file per component output via -output-component
cmdline option
% assemble output in memory and write to disk in a single call
% integrate external header
% replace almost all internal arrays with hashes
% replace self-modifying class and macro expansion with
regular hashes
% internal cleanups
% switch to simpler method for sort weighting
+ merge category/subcategory values into tag list. It
means they will be now be included in the output
% cleanup/fix/simplify value expansions for 'compliance',
'status' and 'platform' fields
% cleanup the way output engines are handles internally
+ add support for 'TAGS' entry to replace/extend the rigid and
ambiguous CATEGORY/SUBCATEGORY-based categorization. It is meant
to be a comma-separated list of freeform tags, possibly with a set
of standard common tags, with the freedom to use anything else deemed
useful by component/doc authors.
+ add footer showing the build date of the doc
+ include Git revision the doc is based on, link to the relevant
source tree version.
* various code refactoring steps to avoid unnecessary
classes, arrays, macro evaluation, and using undocumented
functions
% various HTML5 tag improvements and optimizations
+ load HBX file contents and lookup each referenced
symbol. Emit warning in verbose mode, if docs refers
to non-existing one.
(this replaces slow and broken logic based on hbextern.ch)
+ use core hbdoc API to load the documentation instead
of locally rolled logic
* always show those content problems that are considered
fatal and the input doc to be skipped
+ filter docs to English language by default
+ add ability to choose language using a command-line option
! fix faulty validation logic that resulted in
erronously skipping certain entries
+ identify docs' 'component' property automatically
! fix to not eat empty lines from examples
+ convert "see also" items to links (this works correctly only
in single file output mode)
! fix to not break words (f.e. URLs) when outputting HTML
% use shorter class names
! fix invalid element ID generated
! fix RTE when trying to create output by category
% delete dummy "HTML2" output mode
* convert more ASCII chars to better Unicode equivalents
+ mark more text as code automatically
* drop MS-DOS compatibility
* src/rtl/hbdoc.prg
! fix filling '_LANG' property with the correct value
* switch to use LF instead of CRLF in the field contents
* contrib/hbct/doc/en/*.txt
* contrib/hbgd/doc/en/hbgd.txt
* contrib/hbgt/doc/en/hbgt.txt
* contrib/hbmisc/doc/en/dates2.txt
* contrib/hbnf/doc/en/*.txt
* contrib/rddads/doc/en/adsfuncs.txt
* doc/en/*.txt
* cleanups and fixes
! casing
! fix to always delimit "see also" items with comma (",")
! fix various casing issues and old typos
! various fixes after detecting them using updated hbdoc
! eliminate/fix various rare/unnecessary/invalid field values
! move some embedded docs from hbdoc into their respective
doc sources
! fix a typo
* use backtick
* replace code copyright with reference to COPYING.txt (=LICENSE.txt)
+ mark tables without a header or with double height header
; Above patches come from 3.4 fork commits below:
2016-10-26 12:43 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-26 12:34 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-26 12:20 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-26 03:21 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-26 02:47 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-25 15:05 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-25 14:51 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-25 14:30 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-25 13:19 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-25 12:35 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-25 11:47 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-25 02:48 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-24 22:26 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-24 18:35 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-24 17:58 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-24 16:12 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-24 15:44 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-24 03:36 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-24 02:40 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-24 00:23 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-23 23:09 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-23 16:39 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-23 16:10 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-10-23 13:15 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
|
||
|
Viktor Szakats
|
da5de0c27b |
2016-10-21 07:54 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
* extras/hbdoc/_genbase.prg
* extras/hbdoc/_genhtml.prg
* extras/hbdoc/_gentxt.prg
* extras/hbdoc/_genxml.prg
* extras/hbdoc/_tmplate.prg
* extras/hbdoc/hbdoc.ch
* extras/hbdoc/hbdoc.css
* extras/hbdoc/hbdoc.hbp
* extras/hbdoc/hbdoc.prg
! fix linter problems in generated html
* html5/css cleanups
* use VF IO
! fix double close in hbdoc
! fix file handle leak in hbdoc
* use Class(y) syntax in class definitions
* remove internal file references
% use hb_AScanI()
! use hb_ATokens() instead of hand-rolled line splitting,
making this code EOL agnostic
% use hb_cwd(), hb_FName*(), hb_DirSep*() (also fixes potential portability issues)
* cleanups/opts
* cleaned doc tags
% force disable LTO at link-time
! typo in comment
; notice that you can regenerate the docs
for the Harbour website (https://harbour.github.io/doc/)
using this command:
extras/hbdoc$ hbmk2 hbdoc -run -runflag=-format=html -runflag=-output-single
or in this fork, using this command:
extras/hbdoc$ hbmk2 hbdoc -run
; for NF doc parsing I created an internal API long ago
(it is used by HBIDE f.e.):
hbmk2 -find __hbdoc_
usage examples in Harbour:
grep -R __hbdoc_ *
% optimized string handling / temp variable usage, IFs cleaned
% enabled -kmo build options
% cleaned header inclusion
% reworked to not use PUBLIC vars at all
% avoided some more macro expansions
% converted a public var to hb_StrReplace() with hash
* minor cleanups and optimizations
* use PROTECTED obj vars
% use SWITCH
% merged some nested branches
* use #if 0 for commented code
% cleaned some array declarations
% use hb_FNameExt()
* avoid one macro expansion
+ added -run flags to regenarate docs for Harbour website
* cleaned .AND./.OR. ambiguity
% converted PUBLIC var to STATIC
; Above patches come from 3.4 fork commits below:
2016-09-20 02:31 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-09-19 18:51 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2016-09-19 18:03 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2015-07-18 17:57 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2015-06-28 11:27 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2015-06-05 20:47 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2015-03-17 13:54 UTC+0100 Viktor Szakats (vszakats users.noreply.github.com)
2014-12-13 03:15 UTC+0100 Viktor Szakats (vszakats users.noreply.github.com)
2014-07-15 23:04 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2014-06-21 12:46 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2014-06-20 15:38 UTC+0200 Viktor Szakats (vszakats users.noreply.github.com)
2014-02-12 01:58 UTC+0100 Viktor Szakáts (vszakats users.noreply.github.com)
2014-02-03 21:07 UTC+0100 Viktor Szakáts (vszakats users.noreply.github.com)
2014-02-03 19:19 UTC+0100 Viktor Szakáts (vszakats users.noreply.github.com)
2014-02-03 18:37 UTC+0100 Viktor Szakáts (vszakats users.noreply.github.com)
2014-02-03 18:22 UTC+0100 Viktor Szakáts (vszakats users.noreply.github.com)
2014-02-03 17:45 UTC+0100 Viktor Szakáts (vszakats users.noreply.github.com)
; plus various minor maintenance updates from multiple other commits
|
||
|
vszakats
|
a4a357a18b |
2013-03-15 11:12 UTC+0100 Viktor Szakats (harbour syenar.net)
* /harbour/* -> /*
* moved whole Harbour source tree one level up to
avoid single 'harbour' top dir
|